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.

ConfigureLoadTester

sink Operator

Configures a load tester device for measuring system performance.

This configuration operator can be linked to a data IO operator, such as LoadTesterData, using a shared DeviceName. The load tester device can be configured to produce and consume data at user-defined sizes and rates to stress test various communication links and measure closed-loop response latency using a high-resolution hardware timer.

Inputs & Outputs

Configures a load testing 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.

The original sequence modified by adding additional configuration actions required to configure a load testing device.

Properties

Property	Type	Description
Enable Configuration	bool	Gets or sets a value specifying whether the load testing device is enabled.
FramesPerSecond Configuration	uint	Gets or sets a value specifying the rate at which frames are produced in Hz.
ReceivedWords Configuration	uint	Gets or sets the number of incrementing, unsigned 16-bit integers sent with each read frame. These data are produced by the controller and are used to impose a load on the controller to host communication. These data can be used in downstream computational operations that model the computational load imposed by a closed-loop algorithm.
TransmittedWords Configuration	uint	Gets or sets the number of repetitions of the 32-bit integer dummy words sent with each write frame. These data are produced by the host and are used to impose a load on host to controller commutation. They are discarded by the controller when they are received.
DeviceName Configuration	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 Configuration	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.