Table of Contents
TIP

This is a device configuration operator. Aggregate configuration operators are recommended in lieu of device configuration operators for interfacing with Open Ephys Onix hardware.

ConfigureHarpSyncInput

sink Operator

Configures the ONIX breakout board's Harp sync input.

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

Harp is a standard for asynchronous real-time data acquisition and experimental control in neuroscience. It includes a clock synchronization protocol which allows Harp devices to be connected to a shared clock line and continuously self-synchronize their clocks to a precision of tens of microseconds. This means that all experimental events are timestamped on the same clock and no post-hoc alignment of timing is necessary.

The Harp clock signal is transmitted over a serial line every second. Every time the Harp sync input device in the ONIX breakout board detects a full Harp synchronization packet, a new data frame is emitted pairing the current value of the Harp clock with the local ONIX acquisition clock.

Logging the sequence of all Harp synchronization packets can greatly facilitate post-hoc analysis and interpretation of timing signals. For more information see https://harp-tech.org/.

ConfigureHarpSyncInput Workflow

Inputs & Outputs

Configures a ONIX breakout board Harp sync input device.

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

A sequence of ContextTask instances that hold configuration actions.

right-arrow
representation of a sink operator
right-arrow

The original sequence modified by adding additional configuration actions required to configure a ONIX breakout board Harp sync input device.

Properties

Property Type Description
Enable bool

Gets or sets a value specifying whether the Harp sync input device is enabled.

Source HarpSyncSource

Gets or sets a value specifying the physical Harp clock input source.

In standard ONIX breakout boards, the Harp mini-jack connector on the side of the breakout is configured to receive Harp clock synchronization signals.

In early access versions of the ONIX breakout board, the Harp mini-jack connector is configured for output only, so a special adapter is needed to transmit the Harp clock synchronization signal to the breakout clock input zero.

Breakout = 0
ClockAdapter = 1
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 Open Neuro Interface (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 Open Neuro Interface (ONI) compliant acquisition system.