Duty Cycle

SetCycleState

SetCycleState
(
CycleState
, 
)

Enables or disables the duty cycle or session intervals. The duty cycle is enabled by default.

Note: Use this call to disable the duty cycle prior to using the trigger function. If left enabled, the duty cycle will continue while triggering.

Params
CycleState
integer
required

Value of either 0 or 1
0 = Disable duty cycle
1 = Enable duty cycle

required
Return Value

SetSessionIntervalTimeMs

SetSessionIntervalTimeMs
(
Milliseconds
, 
)

Set the ON portion of the duty cycle. Enter the number of milliseconds that stimulation shall be ON while in cycling mode.

Params
Milliseconds
integer
required

102 ms - 24 hours

required
Return Value

SetSessionIntervalBreakMs

SetSessionIntervalBreakMs
(
Milliseconds
, 
)

Set the OFF portion of the duty cycle. Enter the number of milliseconds that Stimulation shall be off while in cycling mode.

Params
Milliseconds
integer
required

0 ms - 24 hours

required
Return Value

ReadCycleState

ReadCycleState
(
, 
)

Use this call to determine if the Duty Cycle state is enabled/disabled.

Params
required
required
Return Value
CycleState
boolean

True = The Cycle state is enabled, and duty cycling will occur as configured.
‍False = The Cycle state is disabled, and duty cycling will not occur.

ReadSessionIntervalTime

ReadSessionIntervalTime
(
, 
)

Gets the ON portion of the duty cycle in milliseconds.

Params
required
required
Return Value
Milliseconds
integer

A value in the range of 100 ms - 24 hours in milliseconds.

ReadSessionIntervalBreak

ReadSessionIntervalBreak
(
, 
)

Gets the OFF portion of the duty cycle in milliseconds.

Params
required
required
Return Value
Milliseconds
integer

A value in the range of 10 ms - 24 hours in milliseconds.

On this page
Method