This documentation supports the latest PCIe host firmware, the latest OpenEphys.Onix1 package, and Bonsai 2.9+.

Table of Contents
TIP

This is a Device configuration operator. Device Group configuration operators are recommended instead of Device configuration operators for interfacing with Open Ephys Onix hardware.

ConfigureHeadstage64ElectricalStimulator

sink Operator

Configures a headstage-64 onboard electrical stimulator.

This configuration operator can be linked to a data IO operator, such as Headstage64ElectricalStimulatorTrigger, using a shared DeviceName.

ConfigureHeadstage64ElectricalStimulator Workflow

Inputs & Outputs

Configure a headstage-64 onboard electrical stimulator.

This will schedule configuration actions to be applied by a StartAcquisition instance prior to data acquisition.

A sequence of ContextTask instances that holds configuration actions.

right-arrow
representation of a sink operator
right-arrow

The original sequence modified by adding additional configuration actions required to configure a headstage-64 onboard electrical stimulator.

Properties

Property Type Description
Arm bool

Gets or sets the device arm state.

If set to true, then the electrical stimulator's ±15V power supplies will be turned on and the electrical stimulator circuit will respect triggers. If set to false, the power supplies will be shut down and triggers will be ignored. It takes ~10 milliseconds for the power supplies to to stabilize.

BurstPulseCount uint

Gets or sets the number of pulses per burst.

InterBurstInterval uint

Gets or sets the duration of the inter-burst interval within a stimulus train in μsec.

InterPhaseCurrent double

Gets or sets the amplitude of the interphase current of each pulse in μA.

InterPhaseInterval uint

Gets or sets the duration of the interphase interval of each pulse in μsec.

InterPulseInterval uint

Gets or sets the duration of the inter-pulse interval within a single burst in μsec.

PhaseOneCurrent double

Gets or sets the amplitude of the first phase of each pulse in μA.

PhaseOneDuration uint

Gets or sets the duration of the first phase of each pulse in μsec.

PhaseTwoCurrent double

Gets or sets the amplitude of the second phase of each pulse in μA.

PhaseTwoDuration uint

Gets or sets the duration of the second phase of each pulse in μsec.

TrainBurstCount uint

Gets or sets the number of bursts in a stimulus train.

TriggerDelay uint

Gets or sets a delay from receiving a trigger to the start of stimulus sequence application in μsec.

DeviceName string

Gets or sets a unique device name.

The device name provides a unique, human-readable identifier that is used to link software elements for configuration, control, and data streaming to hardware. For instance, it can be used to link configuration operators to data IO operators within a workflow. This value is usually not set manually, but is assigned in a MultiDeviceFactory to correspond to a fixed address with a piece of hardware such as a headstage. This address is used for software communication.

DeviceAddress uint

Gets or sets the device address.

This is a fully-qualified numerical hardware address of a device within the device table produced by an ONI-compliant acquisition system. This value is usually not set manually, but is assigned in a MultiDeviceFactory to correspond to a fixed address with a piece of hardware such as a headstage. This address is used for hardware communication.

DeviceType Type

Gets or sets the device identity.

This type provides a device identity to each device within the device table produced by an ONI-compliant acquisition system.