Class PulsePalDevice

Namespace: Bonsai.PulsePal

Assembly: Bonsai.PulsePal.dll

Represents a Pulse Pal device.

public sealed class PulsePalDevice : IDisposable

Inheritance: object

PulsePalDevice

Implements: IDisposable

Inherited Members: object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Constructors

PulsePalDevice(string): Initializes a new instance of the PulsePalDevice class using the specified port name.

Properties

FirmwareVersion: Gets the version of the firmware used by the Pulse Pal device.

IsOpen: Gets a value indicating the open or closed status of the PulsePalDevice object.

Methods

AbortPulseTrains(): Terminates all pulse trains currently playing on the device.

Close(): Closes the port connection, sets the IsOpen property to false and disposes of the internal SerialPort object.

Open(CancellationToken): Opens a new serial port connection to the Pulse Pal device.

SendCustomPulseTrain(CustomTrainId, PulseOnset[]): Sends a sequence of onset times and voltages describing a train of pulses.

SendCustomPulseTrain(CustomTrainId, double[,]): Sends a sequence of onset times and voltages describing a train of pulses.

SendCustomPulseTrain(CustomTrainId, double[], double[]): Sends a sequence of onset times and voltages describing a train of pulses.

SendCustomWaveform(CustomTrainId, double, double[]): Sends a sequence of voltages describing a train of continuous monophasic pulses, with periodic onset times.

SetBiphasic(OutputChannel, bool): Sets the specified output channel to produce either monophasic or biphasic square pulses.

SetBurstDuration(OutputChannel, double): Sets the duration of a pulse burst when using burst mode.

SetClientId(string): Sets a 6-character string to indicate the connected application's name, at the top of the PulsePal's thumb joystick menu tree.

SetContinuousLoop(OutputChannel, bool): Sets an output channel to play its pulse train indefinitely when triggered, without needing to be re-triggered.

SetCustomTrainIdentity(OutputChannel, CustomTrainId): Sets the identity of the custom train used to specify pulse times and voltages on an output channel.

SetCustomTrainLoop(OutputChannel, bool): Sets an output channel to loop its custom pulse train.

SetCustomTrainTarget(OutputChannel, CustomTrainTarget): Sets the interpretation of pulse times in the custom train configured on the specified output channel.

SetFixedVoltage(OutputChannel, double): Sets a constant voltage on an output channel.

SetInterBurstInterval(OutputChannel, double): Sets the duration of the off-time between bursts.

SetInterPhaseInterval(OutputChannel, double): Sets the interval between the first and second phases of biphasic pulses on a specified output channel.

SetInterPulseInterval(OutputChannel, double): Sets the interval between pulses on a specified output channel.

SetPhase1Duration(OutputChannel, double): Sets the duration for the first phase of each pulse on a specified output channel.

SetPhase1Voltage(OutputChannel, double): Sets the voltage for the first phase of each pulse on a specified output channel.

SetPhase2Duration(OutputChannel, double): Sets the duration for the second phase of each pulse on a specified output channel.

SetPhase2Voltage(OutputChannel, double): Sets the voltage for the second phase of each pulse on a specified output channel.

SetPulseTrainDelay(OutputChannel, double): Sets a delay between the arrival of a trigger and when the channel begins its pulse train.

SetPulseTrainDuration(OutputChannel, double): Sets the duration of the entire pulse train.

SetRestingVoltage(OutputChannel, double): Sets the resting voltage on a specified output channel, i.e. the voltage between phases, pulses and pulse trains.

SetTriggerMode(TriggerChannel, TriggerMode): Sets the behavior of a trigger channel.

SetTriggerOnChannel1(OutputChannel, bool): Links or unlinks an output channel to trigger channel 1.

SetTriggerOnChannel2(OutputChannel, bool): Links or unlinks an output channel to trigger channel 2.

TriggerOutputChannels(ChannelTriggers): Begins the stimulation pulse train on the specified output channels.

UpdateDisplay(string): Writes a text string to the Pulse Pal oLED display.

UpdateDisplay(string, string): Writes text strings to the Pulse Pal oLED display.

Edit this page