Device Configuration
Factory Reset
Factory reset can be useful when reusing Pulse Generators across multiple use cases or end users. Alternatively, to maintain custom device settings while clearing the device history, see Clear History under the History section.
FactoryReset
FactoryReset(, )Factory Reset will reset the Pulse Generator to the manufacturer's default settings. All custom settings and device history logs will be erased.
Lock Screen
The Pulse Generator screen locks, just like your phone, to prevent accidental button presses and changes to stimulation while wearing the Pulse Generator in an ambulatory setting. By default, the screen will dim after 15 seconds of inactivity and locks after 30 seconds of inactivity. Use the following commands to modify the screen behavior as needed.
SetDimTimeMs
SetDimTimeMs(Milliseconds, )Sets the duration of inactivity required before the Pulse Generator screen will dim.
Input a value from 0 – 24 hours in milliseconds.
SetLockTimeMs
SetLockTimeMs(Milliseconds, )Sets the duration of inactivity required before the Pulse Generator screen will lock.
Note, inputting the value of 0 will disable the lock screen but will not disable the screen from dimming.
Input a value from 0 – 24 hours in milliseconds.
Stimulation
StartStimulation
StartStimulation(Channel, )Toggles ON stimulation for the corresponding channel based on the provided Channel input parameter.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
StopStimulation
StopStimulation(Channel, )Toggles OFF stimulation for the corresponding channel based on the provided Channel input parameter.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
ReadStimulationState
ReadStimulationState(Channel, )Returns the current stimulation for the corresponding channel based on the provided Channel input parameter.
Note: Channels can be toggled ON with an amplitude of 0. Use the ReadAmplitude() call to determine the amplitude delivered.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
Returns State value of 0 or 1.
0 = OFF
1 = ON
Amplitude
SetAmplitude
SetAmplitude(Channel, Amplitude)Sets the amplitude for the given channel. An amplitude input of 0 sets the amplitude to 0.0 mA. An amplitude input of 50 sets the amplitude to 5.0 mA.
Note: Changes to the amplitude while stimulation is ON will be instantaneous and will not ramp.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
Integer value from 0-50
ReadAmplitude
ReadAmplitude(Channel, )Gets the amplitude for the specified channel as shown on the Pulse Generator.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
Integer value from 0-50
Impedance
ReadImpedanceValue
ReadImpedanceValue(Channel, )Returns the current impedance for the specified channel in Ohms.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
Example: 10000
Frequency
SetFrequency
SetFrequency(Channel, Frequency)Sets the frequency for the given channel in Hz.
Note: See the Sparrow Link Instructions for Use for documentation on our frequency combinations that are unsupported or output a nominal value +/-15% of the selected frequencies.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
Accepted integer values: 1, 5, 10, 15, 20, 25, 30, 40, 50, 75, 100, 125, 150
ReadFrequency
ReadFrequency(Channel, )Returns the current frequency for the specified channel in Hz.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
Example: 15
Pulse Width
SetPulseWidth
SetPulseWidth(Channel, PulseWidth)Sets the pulse width for the given channel in µS.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
Accepted integer values: 50, 100, 150, 250, 350, 500, 750
ReadPulseWidth
ReadPulseWidth(Channel, )Returns the pulse width for the specified channel in µS.
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
Example: 250
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.
Value of either 0 or 1
0 = Disable duty cycle
1 = Enable duty cycle
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.
102 ms - 24 hours
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.
0 ms - 24 hours
ReadCycleState
ReadCycleState(, )Use this call to determine if the Duty Cycle state is enabled/disabled.
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.
A value in the range of 100 ms - 24 hours in milliseconds.
Ramping
SetStepType
SetStepType(StepType, )Sets the step type to either the default ramping algorithm of 0.1 mA increase per second, or enables the setting of a custom ramp-up time.
Note: You must enable this setting before setting a custom ramp time with the SetFixedTimeMs() call.
Value of either 0 or 1
0 = Use the default ramping algorithm of 0.1 mA increase per second
1 = Enables the setting of a custom ramp-up time.
SetFixedTimeMs
SetFixedTimeMs(Milliseconds, )Sets a custom fixed ramp-up time. When stimulation is toggled ON, stimulation will ramp-up to the target strength in the duration input in milliseconds.
50 mS – 60 seconds
SetRampDownMs
SetRampDownMs(Milliseconds, )Sets a custom fixed ramp-down time. When stimulation is toggled OFF, stimulation will ramp-down to 0 mA in the duration input in milliseconds.
50 mS – 3 seconds
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.
Value of either 0 or 1
0 = Disable the sham state
1 = Enable the sham state
Value of either 0 or 1
0 = Disable error notifications
1 = Enable error notifications
SetShamState
SetShamState(Value, )Enable or disable sham for specific channels.
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.
ReadShamMessage
ReadShamMessage(, )Gets the global Sham state for stimulation and Error Notifications.
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.
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.
Triggering
When the Sparrow Link Pulse Generator is set to Trigger Mode, the screen will lock and read “ Trigger Mode Enabled.” This feature blinds and prevents an end user from viewing or modifying the stimulation.
Always configure the stimulation parameters as desired before entering Trigger Mode. This includes:
- Cycle times
- Ramp times
- Pulse width
- Frequency
- Amplitude
Before entering Trigger mode, turn off all stimulation. If the stimulation is ON when entering Trigger mode, it will continue to cycle as set by the cycle ON and OFF times. Changes to stimulation other than Trigger ON and OFF may result in failed commands or dropped connections.
SetTriggerMode
SetTriggerMode(Value, )Enable or disable triggering for specific channel(s).
0 = Exit the trigger state.
1 = Enable triggering for the Inner channel via Channel A on the Hub.
2 = Enable triggering for the Outer channel via Channel B on the Hub
3 = Enable triggering for BOTH the Inner and Outer channels via Channel A & B on the Hub.
SetTrigger
SetTrigger(Value, )If you want to run triggering from a console or script, enable trigger mode, then use the SetTrigger() command below to toggle stimulation ON and OFF. You do not need to use the SetTrigger() command when triggering from the BNC connections, channels A or B.
0 = Turn the trigger OFF. Stimulation will turn off.
1 = Trigger ON the Inner channel.
2 = Trigger ON the Outer channel.
3 = Trigger ON BOTH the Inner and Outer channels.
SetTriggerLog
SetTriggerLog(Value, )To improve response rates while rapidly triggering, use SetTriggerLog() below to turn OFF the logging of triggering events. By default, logging of trigger events will be ON.
0 = Turn OFF the logging of Trigger events.
1 = Turn ON the logging of Trigger events