Sham & Error Notifications

SetSham

SetSham
(
Sham
, 
Message
)

Enables or disables the sham state. Shammed stimulation is disabled by default.

Note: Before setting a sham channel state with the SetShameState() call, you must enable this setting.

Params
Sham
integer
required

Value of either 0 or 1
0 = Disable the sham state
1 = Enable the sham state

Message
integer
required

Value of either 0 or 1
0 = Disable error notifications
1 = Enable error notifications

Return Value

SetShamState

SetShamState
(
Value
, 
)

Enable or disable sham for specific channels.

Params
Value
integer
required

0 = Disable sham for all channels.
1 = Enable sham for ONLY the Inner channel. The Inner channel will not output stimulation.
2 = Enable sham for ONLY the Outer channel. The Outer channel will not output stimulation.
3 = Enable sham for BOTH the Inner and Outer channels.

required
Return Value

ReadShamMessage

ReadShamMessage
(
, 
)

Gets the global Sham state for stimulation and Error Notifications.

Params
required
required
Return Value
ShamState
integer

Integer value of 256, 257, 1 or 0

256 = Sham state is disabled and Error Notifications are ON.
‍257 = Sham State is Enabled and Error Notifications are ON.
‍1 = Sham state is Enabled and Error Notifications are OFF.
‍0 = Sham state is disabled and Error Notifications are OFF.

ReadShamState

ReadShamState
(
, 
)

Returns sham state for channels.

Params
required
required
Return Value
Value
integer

0 = Sham is disabled for all channels.
1 = Sham is enabled for ONLY the Inner channel. The Inner channel will not output stimulation.
2 = Sham is enabled for ONLY the Outer channel. The Outer channel will not output stimulation.
3 = Sham is enabled for BOTH the Inner and Outer channels.

On this page
Method