Modules
harp.devices.analoginput
#
AdcChannel
#
Bases: IntEnum
Available target analog channels to be targeted for threshold events.
Attributes:
| Name | Type | Description |
|---|---|---|
CHANNEL0 |
int
|
No description currently available |
CHANNEL1 |
int
|
No description currently available |
CHANNEL2 |
int
|
No description currently available |
CHANNEL3 |
int
|
No description currently available |
NONE |
int
|
No description currently available |
AnalogDataPayload
dataclass
#
AnalogDataPayload(Channel0: int, Channel1: int, Channel2: int, Channel3: int)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
Channel0
|
int
|
|
required |
Channel1
|
int
|
|
required |
Channel2
|
int
|
|
required |
Channel3
|
int
|
|
required |
AnalogInput
#
Bases: Device
AnalogInput class for controlling the device.
read_acquisition_state()
#
Reads the contents of the AcquisitionState register.
Returns:
| Type | Description |
|---|---|
bool
|
Value read from the AcquisitionState register. |
read_analog_data()
#
Reads the contents of the AnalogData register.
Returns:
| Type | Description |
|---|---|
AnalogDataPayload
|
Value read from the AnalogData register. |
read_di0_trigger()
#
Reads the contents of the DI0Trigger register.
Returns:
| Type | Description |
|---|---|
TriggerConfig
|
Value read from the DI0Trigger register. |
read_digital_input_state()
#
Reads the contents of the DigitalInputState register.
Returns:
| Type | Description |
|---|---|
DigitalInputs
|
Value read from the DigitalInputState register. |
read_digital_output_clear()
#
Reads the contents of the DigitalOutputClear register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the DigitalOutputClear register. |
read_digital_output_set()
#
Reads the contents of the DigitalOutputSet register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the DigitalOutputSet register. |
read_digital_output_state()
#
Reads the contents of the DigitalOutputState register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the DigitalOutputState register. |
read_digital_output_toggle()
#
Reads the contents of the DigitalOutputToggle register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the DigitalOutputToggle register. |
read_do0_pulse_width()
#
Reads the contents of the DO0PulseWidth register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO0PulseWidth register. |
read_do0_sync()
#
Reads the contents of the DO0Sync register.
Returns:
| Type | Description |
|---|---|
SyncConfig
|
Value read from the DO0Sync register. |
read_do0_target_channel()
#
Reads the contents of the DO0TargetChannel register.
Returns:
| Type | Description |
|---|---|
AdcChannel
|
Value read from the DO0TargetChannel register. |
read_do0_threshold()
#
Reads the contents of the DO0Threshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO0Threshold register. |
read_do0_time_above_threshold()
#
Reads the contents of the DO0TimeAboveThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO0TimeAboveThreshold register. |
read_do0_time_below_threshold()
#
Reads the contents of the DO0TimeBelowThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO0TimeBelowThreshold register. |
read_do1_target_channel()
#
Reads the contents of the DO1TargetChannel register.
Returns:
| Type | Description |
|---|---|
AdcChannel
|
Value read from the DO1TargetChannel register. |
read_do1_threshold()
#
Reads the contents of the DO1Threshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO1Threshold register. |
read_do1_time_above_threshold()
#
Reads the contents of the DO1TimeAboveThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO1TimeAboveThreshold register. |
read_do1_time_below_threshold()
#
Reads the contents of the DO1TimeBelowThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO1TimeBelowThreshold register. |
read_do2_target_channel()
#
Reads the contents of the DO2TargetChannel register.
Returns:
| Type | Description |
|---|---|
AdcChannel
|
Value read from the DO2TargetChannel register. |
read_do2_threshold()
#
Reads the contents of the DO2Threshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO2Threshold register. |
read_do2_time_above_threshold()
#
Reads the contents of the DO2TimeAboveThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO2TimeAboveThreshold register. |
read_do2_time_below_threshold()
#
Reads the contents of the DO2TimeBelowThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO2TimeBelowThreshold register. |
read_do3_target_channel()
#
Reads the contents of the DO3TargetChannel register.
Returns:
| Type | Description |
|---|---|
AdcChannel
|
Value read from the DO3TargetChannel register. |
read_do3_threshold()
#
Reads the contents of the DO3Threshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO3Threshold register. |
read_do3_time_above_threshold()
#
Reads the contents of the DO3TimeAboveThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO3TimeAboveThreshold register. |
read_do3_time_below_threshold()
#
Reads the contents of the DO3TimeBelowThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO3TimeBelowThreshold register. |
read_range_and_filter()
#
Reads the contents of the RangeAndFilter register.
Returns:
| Type | Description |
|---|---|
RangeAndFilterConfig
|
Value read from the RangeAndFilter register. |
read_sampling_rate()
#
Reads the contents of the SamplingRate register.
Returns:
| Type | Description |
|---|---|
SamplingRateMode
|
Value read from the SamplingRate register. |
read_sync_output()
#
Reads the contents of the SyncOutput register.
Returns:
| Type | Description |
|---|---|
StartSyncOutputTarget
|
Value read from the SyncOutput register. |
write_acquisition_state(value)
#
Writes a value to the AcquisitionState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool
|
Value to write to the AcquisitionState register. |
required |
write_di0_trigger(value)
#
Writes a value to the DI0Trigger register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
TriggerConfig
|
Value to write to the DI0Trigger register. |
required |
write_digital_output_clear(value)
#
Writes a value to the DigitalOutputClear register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the DigitalOutputClear register. |
required |
write_digital_output_set(value)
#
Writes a value to the DigitalOutputSet register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the DigitalOutputSet register. |
required |
write_digital_output_state(value)
#
Writes a value to the DigitalOutputState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the DigitalOutputState register. |
required |
write_digital_output_toggle(value)
#
Writes a value to the DigitalOutputToggle register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the DigitalOutputToggle register. |
required |
write_do0_pulse_width(value)
#
Writes a value to the DO0PulseWidth register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO0PulseWidth register. |
required |
write_do0_sync(value)
#
Writes a value to the DO0Sync register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
SyncConfig
|
Value to write to the DO0Sync register. |
required |
write_do0_target_channel(value)
#
Writes a value to the DO0TargetChannel register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AdcChannel
|
Value to write to the DO0TargetChannel register. |
required |
write_do0_threshold(value)
#
Writes a value to the DO0Threshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO0Threshold register. |
required |
write_do0_time_above_threshold(value)
#
Writes a value to the DO0TimeAboveThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO0TimeAboveThreshold register. |
required |
write_do0_time_below_threshold(value)
#
Writes a value to the DO0TimeBelowThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO0TimeBelowThreshold register. |
required |
write_do1_target_channel(value)
#
Writes a value to the DO1TargetChannel register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AdcChannel
|
Value to write to the DO1TargetChannel register. |
required |
write_do1_threshold(value)
#
Writes a value to the DO1Threshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO1Threshold register. |
required |
write_do1_time_above_threshold(value)
#
Writes a value to the DO1TimeAboveThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO1TimeAboveThreshold register. |
required |
write_do1_time_below_threshold(value)
#
Writes a value to the DO1TimeBelowThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO1TimeBelowThreshold register. |
required |
write_do2_target_channel(value)
#
Writes a value to the DO2TargetChannel register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AdcChannel
|
Value to write to the DO2TargetChannel register. |
required |
write_do2_threshold(value)
#
Writes a value to the DO2Threshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO2Threshold register. |
required |
write_do2_time_above_threshold(value)
#
Writes a value to the DO2TimeAboveThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO2TimeAboveThreshold register. |
required |
write_do2_time_below_threshold(value)
#
Writes a value to the DO2TimeBelowThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO2TimeBelowThreshold register. |
required |
write_do3_target_channel(value)
#
Writes a value to the DO3TargetChannel register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AdcChannel
|
Value to write to the DO3TargetChannel register. |
required |
write_do3_threshold(value)
#
Writes a value to the DO3Threshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO3Threshold register. |
required |
write_do3_time_above_threshold(value)
#
Writes a value to the DO3TimeAboveThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO3TimeAboveThreshold register. |
required |
write_do3_time_below_threshold(value)
#
Writes a value to the DO3TimeBelowThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO3TimeBelowThreshold register. |
required |
write_range_and_filter(value)
#
Writes a value to the RangeAndFilter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
RangeAndFilterConfig
|
Value to write to the RangeAndFilter register. |
required |
write_sampling_rate(value)
#
Writes a value to the SamplingRate register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
SamplingRateMode
|
Value to write to the SamplingRate register. |
required |
write_sync_output(value)
#
Writes a value to the SyncOutput register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
StartSyncOutputTarget
|
Value to write to the SyncOutput register. |
required |
AnalogInputRegisters
#
Bases: IntEnum
Enum for all available registers in the AnalogInput device.
Attributes:
| Name | Type | Description |
|---|---|---|
ACQUISITION_STATE |
int
|
Enables the data acquisition. |
ANALOG_DATA |
int
|
Value from a single read of all ADC channels. |
DIGITAL_INPUT_STATE |
int
|
State of the digital input pin 0. |
RANGE_AND_FILTER |
int
|
Sets the range and LowPass filter cutoff of the ADC. |
SAMPLING_RATE |
int
|
Sets the sampling frequency of the ADC. |
DI0_TRIGGER |
int
|
Configuration of the digital input pin 0. |
DO0_SYNC |
int
|
Configuration of the digital output pin 0. |
DO0_PULSE_WIDTH |
int
|
Pulse duration (ms) for the digital output pin 0. The pulse will only be emitted when DO0Sync == Pulse. |
DIGITAL_OUTPUT_SET |
int
|
Set the specified digital output lines. |
DIGITAL_OUTPUT_CLEAR |
int
|
Clear the specified digital output lines. |
DIGITAL_OUTPUT_TOGGLE |
int
|
Toggle the specified digital output lines |
DIGITAL_OUTPUT_STATE |
int
|
Write the state of all digital output lines. An event will be emitted when the value of any pin was changed by a threshold event. |
SYNC_OUTPUT |
int
|
Digital output that will be set when acquisition starts. |
DO0_TARGET_CHANNEL |
int
|
Target ADC channel that will be used to trigger a threshold event on DO0 pin. |
DO1_TARGET_CHANNEL |
int
|
Target ADC channel that will be used to trigger a threshold event on DO1 pin. |
DO2_TARGET_CHANNEL |
int
|
Target ADC channel that will be used to trigger a threshold event on DO2 pin. |
DO3_TARGET_CHANNEL |
int
|
Target ADC channel that will be used to trigger a threshold event on DO3 pin. |
DO0_THRESHOLD |
int
|
Value used to threshold an ADC read, and trigger DO0 pin. |
DO1_THRESHOLD |
int
|
Value used to threshold an ADC read, and trigger DO1 pin. |
DO2_THRESHOLD |
int
|
Value used to threshold an ADC read, and trigger DO2 pin. |
DO3_THRESHOLD |
int
|
Value used to threshold an ADC read, and trigger DO3 pin. |
DO0_TIME_ABOVE_THRESHOLD |
int
|
Time (ms) above threshold value that is required to trigger a DO0 pin event. |
DO1_TIME_ABOVE_THRESHOLD |
int
|
Time (ms) above threshold value that is required to trigger a DO1 pin event. |
DO2_TIME_ABOVE_THRESHOLD |
int
|
Time (ms) above threshold value that is required to trigger a DO2 pin event. |
DO3_TIME_ABOVE_THRESHOLD |
int
|
Time (ms) above threshold value that is required to trigger a DO3 pin event. |
DO0_TIME_BELOW_THRESHOLD |
int
|
Time (ms) below threshold value that is required to trigger a DO0 pin event. |
DO1_TIME_BELOW_THRESHOLD |
int
|
Time (ms) below threshold value that is required to trigger a DO1 pin event. |
DO2_TIME_BELOW_THRESHOLD |
int
|
Time (ms) below threshold value that is required to trigger a DO2 pin event. |
DO3_TIME_BELOW_THRESHOLD |
int
|
Time (ms) below threshold value that is required to trigger a DO3 pin event. |
Device
#
The Device class provides the interface for interacting with Harp devices. This implementation of the Harp device was based on the official documentation available on the harp-tech website.
Attributes:
| Name | Type | Description |
|---|---|---|
WHO_AM_I |
int
|
The device ID number. A list of devices can be found here |
DEFAULT_DEVICE_NAME |
str
|
The device name, i.e. "Behavior". This name is derived by cross-referencing the |
HW_VERSION_H |
int
|
The major hardware version |
HW_VERSION_L |
int
|
The minor hardware version |
ASSEMBLY_VERSION |
int
|
The version of the assembled components |
HARP_VERSION_H |
int
|
The major Harp core version |
HARP_VERSION_L |
int
|
The minor Harp core version |
FIRMWARE_VERSION_H |
int
|
The major firmware version |
FIRMWARE_VERSION_L |
int
|
The minor firmware version |
DEVICE_NAME |
str
|
The device name stored in the Harp device |
SERIAL_NUMBER |
(int, optional)
|
The serial number of the device |
__enter__()
#
Support for using Device with 'with' statement.
Returns:
| Type | Description |
|---|---|
Device
|
The Device instance |
__exit__(exc_type, exc_val, exc_tb)
#
Cleanup resources when exiting the 'with' block.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
exc_type
|
Exception type or None
|
Type of the exception that caused the context to be exited |
required |
exc_val
|
Exception or None
|
Exception instance that caused the context to be exited |
required |
exc_tb
|
traceback or None
|
Traceback if an exception occurred |
required |
__init__(serial_port, dump_file_path=None, read_timeout_s=1, timeout_strategy=TimeoutStrategy.RAISE)
#
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
serial_port
|
str
|
The serial port used to establish the connection with the Harp device. It must be denoted as |
required |
dump_file_path
|
Optional[str]
|
The binary file to which all Harp messages will be written |
None
|
read_timeout_s
|
float
|
TODO |
1
|
alive_en(enable)
#
Sets the ALIVE_EN bit of the device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
enable
|
bool
|
If True, enables the ALIVE_EN bit. If False, disables it |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the operation was successful, False otherwise |
connect()
#
Connects to the Harp device.
disconnect()
#
Disconnects from the Harp device.
dump_registers()
#
Asserts the DUMP bit to dump the values of all core and app registers as Harp Read Reply Messages. More information on the DUMP bit can be found here.
Returns:
| Type | Description |
|---|---|
list
|
The list containing the reply Harp messages for all the device's registers |
event_count()
#
Gets the number of events in the event queue.
Returns:
| Type | Description |
|---|---|
int
|
The number of events in the event queue |
get_events()
#
Gets all events from the event queue.
Returns:
| Type | Description |
|---|---|
list
|
The list containing every Harp event message that were on the queue |
info()
#
Prints the device information.
load()
#
Loads the data stored in the device's common registers.
mute_reply(enable)
#
Sets the MUTE_REPLY bit of the device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
enable
|
bool
|
If True, the Replies to all the Commands are muted. If False, un-mutes them |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the operation was successful, False otherwise |
op_led_en(enable)
#
Sets the operation LED of the device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
enable
|
bool
|
If True, enables the operation LED. If False, disables it |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the operation was successful, False otherwise |
read_float(address)
#
Reads the value of a register of type Float.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be read |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message that will contain the value read from the register |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
read_operation_ctrl()
#
Reads the OPERATION_CTRL register of the device.
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
read_s16(address)
#
Reads the value of a register of type S16.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be read |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message that will contain the value read from the register |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
read_s32(address)
#
Reads the value of a register of type S32.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be read |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message that will contain the value read from the register |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
read_s64(address)
#
Reads the value of a register of type S64.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be read |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message that will contain the value read from the register |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
read_s8(address)
#
Reads the value of a register of type S8.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be read |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message that will contain the value read from the register |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
read_u16(address)
#
Reads the value of a register of type U16.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be read |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message that will contain the value read from the register |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
read_u32(address)
#
Reads the value of a register of type U32.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be read |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message that will contain the value read from the register |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
read_u64(address)
#
Reads the value of a register of type U64.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be read |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message that will contain the value read from the register |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
read_u8(address)
#
Reads the value of a register of type U8.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be read |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message that will contain the value read from the register |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
reset_device(reset_mode=ResetMode.RST_DEF)
#
Resets the device and reboots with all the registers with the default values. Beware that the EEPROM will be erased. More information on the reset device register can be found here.
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
send(message, *, expect_reply=True, timeout_strategy=None)
#
Sends a Harp message and (optionally) waits for a reply.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message
|
HarpMessage
|
The HarpMessage to be sent to the device |
required |
expect_reply
|
bool
|
If False, do not wait for a reply (fire-and-forget) |
True
|
timeout_strategy
|
TimeoutStrategy | None
|
Override the device-level timeout strategy for this call |
None
|
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage | None
|
Reply (or None when allowed by the timeout strategy or expect_reply=False) |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
set_clock_config(clock_config)
#
Sets the clock configuration of the device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
clock_config
|
ClockConfig
|
The clock configuration value |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
set_mode(mode)
#
Sets the operation mode of the device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mode
|
DeviceMode
|
The new device mode value |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
set_timestamp_offset(timestamp_offset)
#
When the value of this register is above 0 (zero), the device's timestamp will be offset by this amount. The register is sensitive to 500 microsecond increments. This register is non-volatile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timestamp_offset
|
int
|
The timestamp offset value |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
visual_en(enable)
#
Sets the status led of the device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
enable
|
bool
|
If True, enables the status led. If False, disables it |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the operation was successful, False otherwise |
write_float(address, value)
#
Writes the value of a register of type Float.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be written on |
required |
value
|
float | list[float]
|
The value to be written to the register |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
write_operation_ctrl(mode=None, mute_rpl=None, visual_en=None, op_led_en=None, alive_en=None)
#
Writes the OPERATION_CTRL register of the device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
mode
|
OperationMode
|
The new operation mode value |
None
|
mute_rpl
|
bool
|
If True, the Replies to all the Commands are muted |
None
|
visual_en
|
bool
|
If True, enables the status led |
None
|
op_led_en
|
bool
|
If True, enables the operation LED |
None
|
alive_en
|
bool
|
If True, enables the ALIVE_EN bit |
None
|
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
write_s16(address, value)
#
Writes the value of a register of type S16.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be written on |
required |
value
|
int | list[int]
|
The value to be written to the register |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
write_s32(address, value)
#
Writes the value of a register of type S32.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be written on |
required |
value
|
int | list[int]
|
The value to be written to the register |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
write_s64(address, value)
#
Writes the value of a register of type S64.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be written on |
required |
value
|
int | list[int]
|
The value to be written to the register |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
write_s8(address, value)
#
Writes the value of a register of type S8.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be written on |
required |
value
|
int | list[int]
|
The value to be written to the register |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
write_u16(address, value)
#
Writes the value of a register of type U16.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be written on |
required |
value
|
int | list[int]
|
The value to be written to the register |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
write_u32(address, value)
#
Writes the value of a register of type U32.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be written on |
required |
value
|
int | list[int]
|
The value to be written to the register |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
write_u64(address, value)
#
Writes the value of a register of type U64.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be written on |
required |
value
|
int | list[int]
|
The value to be written to the register |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
write_u8(address, value)
#
Writes the value of a register of type U8.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
address
|
int
|
The register to be written on |
required |
value
|
int | list[int]
|
The value to be written to the register |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The reply to the Harp message |
Raises:
| Type | Description |
|---|---|
HarpTimeoutError
|
If no reply is received and the effective strategy requires raising |
DigitalInputs
#
Bases: IntFlag
Available digital input lines.
Attributes:
| Name | Type | Description |
|---|---|---|
DI0 |
int
|
No description currently available |
DigitalOutputs
#
Bases: IntFlag
Specifies the state of port digital output lines.
Attributes:
| Name | Type | Description |
|---|---|---|
DO0 |
int
|
No description currently available |
DO1 |
int
|
No description currently available |
DO2 |
int
|
No description currently available |
DO3 |
int
|
No description currently available |
DO0_CHANGED |
int
|
No description currently available |
DO1_CHANGED |
int
|
No description currently available |
DO2_CHANGED |
int
|
No description currently available |
DO4_CHANGED |
int
|
No description currently available |
HarpMessage
#
The HarpMessage class implements the Harp message as described in the protocol.
Attributes:
| Name | Type | Description |
|---|---|---|
frame |
bytearray
|
The bytearray containing the whole Harp message |
message_type |
MessageType
|
The message type |
length |
int
|
The length parameter of the Harp message |
address |
int
|
The address of the register to which the Harp message refers to |
port |
int
|
Indicates the origin or destination of the Harp message in case the device is a hub of Harp devices. The value 255 points to the device itself (default value). |
payload_type |
PayloadType
|
The payload type |
checksum |
int
|
The sum of all bytes contained in the Harp message |
address
property
#
The address of the register to which the Harp message refers to.
Returns:
| Type | Description |
|---|---|
int
|
The address of the register to which the Harp message refers to |
checksum
property
#
The sum of all bytes contained in the Harp message.
Returns:
| Type | Description |
|---|---|
int
|
The sum of all bytes contained in the Harp message |
frame
property
#
The bytearray containing the whole Harp message.
Returns:
| Type | Description |
|---|---|
bytearray
|
The bytearray containing the whole Harp message |
length
property
#
The length parameter of the Harp message.
Returns:
| Type | Description |
|---|---|
int
|
The length parameter of the Harp message |
message_type
property
#
payload
property
#
The payload sent in the write Harp message.
Returns:
| Type | Description |
|---|---|
Union[int, list[int]]
|
The payload sent in the write Harp message |
payload_type
property
#
port
property
writable
#
Indicates the origin or destination of the Harp message in case the device is a hub of Harp devices. The value 255 points to the device itself (default value).
Returns:
| Type | Description |
|---|---|
int
|
The port value |
__repr__()
#
Prints debug representation of the reply message.
Returns:
| Type | Description |
|---|---|
str
|
The debug representation of the reply message |
__str__()
#
Prints friendly representation of a Harp message.
Returns:
| Type | Description |
|---|---|
str
|
The representation of the Harp message |
calculate_checksum()
#
Calculates the checksum of the Harp message.
Returns:
| Type | Description |
|---|---|
int
|
The value of the checksum |
create(message_type, address, payload_type, value=None)
staticmethod
#
Creates a Harp message.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message_type
|
MessageType
|
The message type. It can only be of type READ or WRITE |
required |
address
|
int
|
The address of the register that the message will interact with |
required |
payload_type
|
PayloadType
|
The payload type |
required |
value
|
Optional[int | list[int] | float | list[float]]
|
The payload of the message. If message_type == MessageType.WRITE, the value cannot be None |
None
|
parse(frame)
staticmethod
#
Parses a bytearray to a (reply) Harp message.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
frame
|
bytearray
|
The bytearray will be parsed into a (reply) Harp message |
required |
Returns:
| Type | Description |
|---|---|
ReplyHarpMessage
|
The Harp message object parsed from the original bytearray |
HarpReadException
#
Bases: HarpException
Exception raised when there is an error reading from a register in the Harp device.
HarpWriteException
#
Bases: HarpException
Exception raised when there is an error writing to a register in the Harp device.
MessageType
#
Bases: IntEnum
An enumeration of the allowed message types of a Harp message. More information on the MessageType byte of a Harp message can be found here.
Attributes:
| Name | Type | Description |
|---|---|---|
READ |
int
|
The value that corresponds to a Read Harp message (1) |
WRITE |
int
|
The value that corresponds to a Write Harp message (2) |
EVENT |
int
|
The value that corresponds to an Event Harp message (3). Messages of this type are only meant to be send by the device |
READ_ERROR |
int
|
The value that corresponds to a Read Error Harp message (9). Messages of this type are only meant to be send by the device |
WRITE_ERROR |
int
|
The value that corresponds to a Write Error Harp message (10). Messages of this type are only meant to be send by the device |
PayloadType
#
Bases: IntEnum
An enumeration of the allowed payload types of a Harp message. More information on the PayloadType byte of a Harp message can be found here.
Attributes:
| Name | Type | Description |
|---|---|---|
U8 |
int
|
The value that corresponds to a message of type U8 |
S8 |
int
|
The value that corresponds to a message of type S8 |
U16 |
int
|
The value that corresponds to a message of type U16 |
S16 |
int
|
The value that corresponds to a message of type S16 |
U32 |
int
|
The value that corresponds to a message of type U32 |
S32 |
int
|
The value that corresponds to a message of type S32 |
U64 |
int
|
The value that corresponds to a message of type U64 |
S64 |
int
|
The value that corresponds to a message of type S64 |
Float |
int
|
The value that corresponds to a message of type Float |
Timestamp |
int
|
The value that corresponds to a message of type Timestamp. This is not a valid PayloadType, but it is used to indicate that the message has a timestamp. |
TimestampedU8 |
int
|
The value that corresponds to a message of type TimestampedU8 |
TimestampedS8 |
int
|
The value that corresponds to a message of type TimestampedS8 |
TimestampedU16 |
int
|
The value that corresponds to a message of type TimestampedU16 |
TimestampedS16 |
int
|
The value that corresponds to a message of type TimestampedS16 |
TimestampedU32 |
int
|
The value that corresponds to a message of type TimestampedU32 |
TimestampedS32 |
int
|
The value that corresponds to a message of type TimestampedS32 |
TimestampedU64 |
int
|
The value that corresponds to a message of type TimestampedU64 |
TimestampedS64 |
int
|
The value that corresponds to a message of type TimestampedS64 |
TimestampedFloat |
int
|
The value that corresponds to a message of type TimestampedFloat |
RangeAndFilterConfig
#
Bases: IntEnum
Available settings to set the range (Volt) and LowPass filter cutoff (Hz) of the ADC.
Attributes:
| Name | Type | Description |
|---|---|---|
RANGE_5V_LOW_PASS_1500HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_3000HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_6000HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_10300HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_13700HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_15000HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_1500HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_3000HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_6000HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_11900HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_18500HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_22000HZ |
int
|
No description currently available |
ReplyHarpMessage
#
Bases: HarpMessage
A response message from a Harp device.
Attributes:
| Name | Type | Description |
|---|---|---|
payload |
Union[int, list[int]]
|
The message payload formatted as the appropriate type |
timestamp |
float
|
The Harp timestamp at which the message was sent |
is_error
property
#
Indicates if this HarpMessage is an error message or not.
Returns:
| Type | Description |
|---|---|
bool
|
Returns True if this HarpMessage is an error message, False otherwise. |
timestamp
property
#
The Harp timestamp at which the message was sent.
Returns:
| Type | Description |
|---|---|
float
|
The Harp timestamp at which the message was sent |
__init__(frame)
#
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
frame
|
bytearray
|
The Harp message in bytearray format |
required |
payload_as_string()
#
Returns the payload as a str.
Returns:
| Type | Description |
|---|---|
str
|
The payload parsed as a str |
SamplingRateMode
#
Bases: IntEnum
Available sampling frequency settings of the ADC.
Attributes:
| Name | Type | Description |
|---|---|---|
SAMPLING_RATE_1000HZ |
int
|
No description currently available |
SAMPLING_RATE_2000HZ |
int
|
No description currently available |
StartSyncOutputTarget
#
Bases: IntEnum
Available digital output pins that are able to be triggered on acquisition start.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
DO0 |
int
|
No description currently available |
DO1 |
int
|
No description currently available |
DO2 |
int
|
No description currently available |
DO3 |
int
|
No description currently available |
SyncConfig
#
Bases: IntEnum
Available configurations when using DO0 pin to report firmware events.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
HEARTBEAT |
int
|
No description currently available |
PULSE |
int
|
No description currently available |
TriggerConfig
#
Bases: IntEnum
Available configurations for when using DI0 as an acquisition trigger.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
START_ON_RISING_EDGE |
int
|
No description currently available |
START_ON_FALLING_EDGE |
int
|
No description currently available |
SAMPLE_ON_RISING_EDGE |
int
|
No description currently available |
harpdevice
#
AdcChannel
#
Bases: IntEnum
Available target analog channels to be targeted for threshold events.
Attributes:
| Name | Type | Description |
|---|---|---|
CHANNEL0 |
int
|
No description currently available |
CHANNEL1 |
int
|
No description currently available |
CHANNEL2 |
int
|
No description currently available |
CHANNEL3 |
int
|
No description currently available |
NONE |
int
|
No description currently available |
AnalogDataPayload
dataclass
#
AnalogDataPayload(Channel0: int, Channel1: int, Channel2: int, Channel3: int)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
Channel0
|
int
|
|
required |
Channel1
|
int
|
|
required |
Channel2
|
int
|
|
required |
Channel3
|
int
|
|
required |
AnalogInput
#
Bases: Device
AnalogInput class for controlling the device.
read_acquisition_state()
#
Reads the contents of the AcquisitionState register.
Returns:
| Type | Description |
|---|---|
bool
|
Value read from the AcquisitionState register. |
read_analog_data()
#
Reads the contents of the AnalogData register.
Returns:
| Type | Description |
|---|---|
AnalogDataPayload
|
Value read from the AnalogData register. |
read_di0_trigger()
#
Reads the contents of the DI0Trigger register.
Returns:
| Type | Description |
|---|---|
TriggerConfig
|
Value read from the DI0Trigger register. |
read_digital_input_state()
#
Reads the contents of the DigitalInputState register.
Returns:
| Type | Description |
|---|---|
DigitalInputs
|
Value read from the DigitalInputState register. |
read_digital_output_clear()
#
Reads the contents of the DigitalOutputClear register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the DigitalOutputClear register. |
read_digital_output_set()
#
Reads the contents of the DigitalOutputSet register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the DigitalOutputSet register. |
read_digital_output_state()
#
Reads the contents of the DigitalOutputState register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the DigitalOutputState register. |
read_digital_output_toggle()
#
Reads the contents of the DigitalOutputToggle register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the DigitalOutputToggle register. |
read_do0_pulse_width()
#
Reads the contents of the DO0PulseWidth register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO0PulseWidth register. |
read_do0_sync()
#
Reads the contents of the DO0Sync register.
Returns:
| Type | Description |
|---|---|
SyncConfig
|
Value read from the DO0Sync register. |
read_do0_target_channel()
#
Reads the contents of the DO0TargetChannel register.
Returns:
| Type | Description |
|---|---|
AdcChannel
|
Value read from the DO0TargetChannel register. |
read_do0_threshold()
#
Reads the contents of the DO0Threshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO0Threshold register. |
read_do0_time_above_threshold()
#
Reads the contents of the DO0TimeAboveThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO0TimeAboveThreshold register. |
read_do0_time_below_threshold()
#
Reads the contents of the DO0TimeBelowThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO0TimeBelowThreshold register. |
read_do1_target_channel()
#
Reads the contents of the DO1TargetChannel register.
Returns:
| Type | Description |
|---|---|
AdcChannel
|
Value read from the DO1TargetChannel register. |
read_do1_threshold()
#
Reads the contents of the DO1Threshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO1Threshold register. |
read_do1_time_above_threshold()
#
Reads the contents of the DO1TimeAboveThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO1TimeAboveThreshold register. |
read_do1_time_below_threshold()
#
Reads the contents of the DO1TimeBelowThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO1TimeBelowThreshold register. |
read_do2_target_channel()
#
Reads the contents of the DO2TargetChannel register.
Returns:
| Type | Description |
|---|---|
AdcChannel
|
Value read from the DO2TargetChannel register. |
read_do2_threshold()
#
Reads the contents of the DO2Threshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO2Threshold register. |
read_do2_time_above_threshold()
#
Reads the contents of the DO2TimeAboveThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO2TimeAboveThreshold register. |
read_do2_time_below_threshold()
#
Reads the contents of the DO2TimeBelowThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO2TimeBelowThreshold register. |
read_do3_target_channel()
#
Reads the contents of the DO3TargetChannel register.
Returns:
| Type | Description |
|---|---|
AdcChannel
|
Value read from the DO3TargetChannel register. |
read_do3_threshold()
#
Reads the contents of the DO3Threshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO3Threshold register. |
read_do3_time_above_threshold()
#
Reads the contents of the DO3TimeAboveThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO3TimeAboveThreshold register. |
read_do3_time_below_threshold()
#
Reads the contents of the DO3TimeBelowThreshold register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DO3TimeBelowThreshold register. |
read_range_and_filter()
#
Reads the contents of the RangeAndFilter register.
Returns:
| Type | Description |
|---|---|
RangeAndFilterConfig
|
Value read from the RangeAndFilter register. |
read_sampling_rate()
#
Reads the contents of the SamplingRate register.
Returns:
| Type | Description |
|---|---|
SamplingRateMode
|
Value read from the SamplingRate register. |
read_sync_output()
#
Reads the contents of the SyncOutput register.
Returns:
| Type | Description |
|---|---|
StartSyncOutputTarget
|
Value read from the SyncOutput register. |
write_acquisition_state(value)
#
Writes a value to the AcquisitionState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool
|
Value to write to the AcquisitionState register. |
required |
write_di0_trigger(value)
#
Writes a value to the DI0Trigger register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
TriggerConfig
|
Value to write to the DI0Trigger register. |
required |
write_digital_output_clear(value)
#
Writes a value to the DigitalOutputClear register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the DigitalOutputClear register. |
required |
write_digital_output_set(value)
#
Writes a value to the DigitalOutputSet register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the DigitalOutputSet register. |
required |
write_digital_output_state(value)
#
Writes a value to the DigitalOutputState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the DigitalOutputState register. |
required |
write_digital_output_toggle(value)
#
Writes a value to the DigitalOutputToggle register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the DigitalOutputToggle register. |
required |
write_do0_pulse_width(value)
#
Writes a value to the DO0PulseWidth register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO0PulseWidth register. |
required |
write_do0_sync(value)
#
Writes a value to the DO0Sync register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
SyncConfig
|
Value to write to the DO0Sync register. |
required |
write_do0_target_channel(value)
#
Writes a value to the DO0TargetChannel register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AdcChannel
|
Value to write to the DO0TargetChannel register. |
required |
write_do0_threshold(value)
#
Writes a value to the DO0Threshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO0Threshold register. |
required |
write_do0_time_above_threshold(value)
#
Writes a value to the DO0TimeAboveThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO0TimeAboveThreshold register. |
required |
write_do0_time_below_threshold(value)
#
Writes a value to the DO0TimeBelowThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO0TimeBelowThreshold register. |
required |
write_do1_target_channel(value)
#
Writes a value to the DO1TargetChannel register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AdcChannel
|
Value to write to the DO1TargetChannel register. |
required |
write_do1_threshold(value)
#
Writes a value to the DO1Threshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO1Threshold register. |
required |
write_do1_time_above_threshold(value)
#
Writes a value to the DO1TimeAboveThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO1TimeAboveThreshold register. |
required |
write_do1_time_below_threshold(value)
#
Writes a value to the DO1TimeBelowThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO1TimeBelowThreshold register. |
required |
write_do2_target_channel(value)
#
Writes a value to the DO2TargetChannel register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AdcChannel
|
Value to write to the DO2TargetChannel register. |
required |
write_do2_threshold(value)
#
Writes a value to the DO2Threshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO2Threshold register. |
required |
write_do2_time_above_threshold(value)
#
Writes a value to the DO2TimeAboveThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO2TimeAboveThreshold register. |
required |
write_do2_time_below_threshold(value)
#
Writes a value to the DO2TimeBelowThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO2TimeBelowThreshold register. |
required |
write_do3_target_channel(value)
#
Writes a value to the DO3TargetChannel register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AdcChannel
|
Value to write to the DO3TargetChannel register. |
required |
write_do3_threshold(value)
#
Writes a value to the DO3Threshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO3Threshold register. |
required |
write_do3_time_above_threshold(value)
#
Writes a value to the DO3TimeAboveThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO3TimeAboveThreshold register. |
required |
write_do3_time_below_threshold(value)
#
Writes a value to the DO3TimeBelowThreshold register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DO3TimeBelowThreshold register. |
required |
write_range_and_filter(value)
#
Writes a value to the RangeAndFilter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
RangeAndFilterConfig
|
Value to write to the RangeAndFilter register. |
required |
write_sampling_rate(value)
#
Writes a value to the SamplingRate register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
SamplingRateMode
|
Value to write to the SamplingRate register. |
required |
write_sync_output(value)
#
Writes a value to the SyncOutput register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
StartSyncOutputTarget
|
Value to write to the SyncOutput register. |
required |
AnalogInputRegisters
#
Bases: IntEnum
Enum for all available registers in the AnalogInput device.
Attributes:
| Name | Type | Description |
|---|---|---|
ACQUISITION_STATE |
int
|
Enables the data acquisition. |
ANALOG_DATA |
int
|
Value from a single read of all ADC channels. |
DIGITAL_INPUT_STATE |
int
|
State of the digital input pin 0. |
RANGE_AND_FILTER |
int
|
Sets the range and LowPass filter cutoff of the ADC. |
SAMPLING_RATE |
int
|
Sets the sampling frequency of the ADC. |
DI0_TRIGGER |
int
|
Configuration of the digital input pin 0. |
DO0_SYNC |
int
|
Configuration of the digital output pin 0. |
DO0_PULSE_WIDTH |
int
|
Pulse duration (ms) for the digital output pin 0. The pulse will only be emitted when DO0Sync == Pulse. |
DIGITAL_OUTPUT_SET |
int
|
Set the specified digital output lines. |
DIGITAL_OUTPUT_CLEAR |
int
|
Clear the specified digital output lines. |
DIGITAL_OUTPUT_TOGGLE |
int
|
Toggle the specified digital output lines |
DIGITAL_OUTPUT_STATE |
int
|
Write the state of all digital output lines. An event will be emitted when the value of any pin was changed by a threshold event. |
SYNC_OUTPUT |
int
|
Digital output that will be set when acquisition starts. |
DO0_TARGET_CHANNEL |
int
|
Target ADC channel that will be used to trigger a threshold event on DO0 pin. |
DO1_TARGET_CHANNEL |
int
|
Target ADC channel that will be used to trigger a threshold event on DO1 pin. |
DO2_TARGET_CHANNEL |
int
|
Target ADC channel that will be used to trigger a threshold event on DO2 pin. |
DO3_TARGET_CHANNEL |
int
|
Target ADC channel that will be used to trigger a threshold event on DO3 pin. |
DO0_THRESHOLD |
int
|
Value used to threshold an ADC read, and trigger DO0 pin. |
DO1_THRESHOLD |
int
|
Value used to threshold an ADC read, and trigger DO1 pin. |
DO2_THRESHOLD |
int
|
Value used to threshold an ADC read, and trigger DO2 pin. |
DO3_THRESHOLD |
int
|
Value used to threshold an ADC read, and trigger DO3 pin. |
DO0_TIME_ABOVE_THRESHOLD |
int
|
Time (ms) above threshold value that is required to trigger a DO0 pin event. |
DO1_TIME_ABOVE_THRESHOLD |
int
|
Time (ms) above threshold value that is required to trigger a DO1 pin event. |
DO2_TIME_ABOVE_THRESHOLD |
int
|
Time (ms) above threshold value that is required to trigger a DO2 pin event. |
DO3_TIME_ABOVE_THRESHOLD |
int
|
Time (ms) above threshold value that is required to trigger a DO3 pin event. |
DO0_TIME_BELOW_THRESHOLD |
int
|
Time (ms) below threshold value that is required to trigger a DO0 pin event. |
DO1_TIME_BELOW_THRESHOLD |
int
|
Time (ms) below threshold value that is required to trigger a DO1 pin event. |
DO2_TIME_BELOW_THRESHOLD |
int
|
Time (ms) below threshold value that is required to trigger a DO2 pin event. |
DO3_TIME_BELOW_THRESHOLD |
int
|
Time (ms) below threshold value that is required to trigger a DO3 pin event. |
DigitalInputs
#
Bases: IntFlag
Available digital input lines.
Attributes:
| Name | Type | Description |
|---|---|---|
DI0 |
int
|
No description currently available |
DigitalOutputs
#
Bases: IntFlag
Specifies the state of port digital output lines.
Attributes:
| Name | Type | Description |
|---|---|---|
DO0 |
int
|
No description currently available |
DO1 |
int
|
No description currently available |
DO2 |
int
|
No description currently available |
DO3 |
int
|
No description currently available |
DO0_CHANGED |
int
|
No description currently available |
DO1_CHANGED |
int
|
No description currently available |
DO2_CHANGED |
int
|
No description currently available |
DO4_CHANGED |
int
|
No description currently available |
RangeAndFilterConfig
#
Bases: IntEnum
Available settings to set the range (Volt) and LowPass filter cutoff (Hz) of the ADC.
Attributes:
| Name | Type | Description |
|---|---|---|
RANGE_5V_LOW_PASS_1500HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_3000HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_6000HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_10300HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_13700HZ |
int
|
No description currently available |
RANGE_5V_LOW_PASS_15000HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_1500HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_3000HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_6000HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_11900HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_18500HZ |
int
|
No description currently available |
RANGE_10V_LOW_PASS_22000HZ |
int
|
No description currently available |
SamplingRateMode
#
Bases: IntEnum
Available sampling frequency settings of the ADC.
Attributes:
| Name | Type | Description |
|---|---|---|
SAMPLING_RATE_1000HZ |
int
|
No description currently available |
SAMPLING_RATE_2000HZ |
int
|
No description currently available |
StartSyncOutputTarget
#
Bases: IntEnum
Available digital output pins that are able to be triggered on acquisition start.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
DO0 |
int
|
No description currently available |
DO1 |
int
|
No description currently available |
DO2 |
int
|
No description currently available |
DO3 |
int
|
No description currently available |
SyncConfig
#
Bases: IntEnum
Available configurations when using DO0 pin to report firmware events.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
HEARTBEAT |
int
|
No description currently available |
PULSE |
int
|
No description currently available |
TriggerConfig
#
Bases: IntEnum
Available configurations for when using DI0 as an acquisition trigger.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
START_ON_RISING_EDGE |
int
|
No description currently available |
START_ON_FALLING_EDGE |
int
|
No description currently available |
SAMPLE_ON_RISING_EDGE |
int
|
No description currently available |