Modules
harp.devices.ledarray
#
AuxDigitalOutputs
#
Bases: IntFlag
Specifies the state of the auxiliary digital output lines.
Attributes:
| Name | Type | Description |
|---|---|---|
AUX0_SET |
int
|
No description currently available |
AUX1_SET |
int
|
No description currently available |
AUX0_CLEAR |
int
|
No description currently available |
AUX1_CLEAR |
int
|
No description currently available |
DO0SyncConfig
#
Bases: IntEnum
Available configurations when using digital output pin 0 to report firmware events.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
MIMIC_LED0_ENABLE_POWER |
int
|
No description currently available |
MIMIC_LED0_ENABLE_BEHAVIOR |
int
|
No description currently available |
MIMIC_LED0_ENABLE_LED |
int
|
No description currently available |
DO1SyncConfig
#
Bases: IntEnum
Available configurations when using digital output pin 1 to report firmware events.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
MIMIC_LED1_ENABLE_POWER |
int
|
No description currently available |
MIMIC_LED1_ENABLE_BEHAVIOR |
int
|
No description currently available |
MIMIC_LED1_ENABLE_LED |
int
|
No description currently available |
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 |
DigitalInputTriggerConfig
#
Bases: IntEnum
Available configurations when using digital inputs as an acquisition trigger.
Attributes:
| Name | Type | Description |
|---|---|---|
LED0_ENABLE_POWER |
int
|
No description currently available |
LED0_ENABLE_BEHAVIOR |
int
|
No description currently available |
LED0_ENABLE_LED |
int
|
No description currently available |
LED1_ENABLE_POWER |
int
|
No description currently available |
LED1_ENABLE_BEHAVIOR |
int
|
No description currently available |
LED1_ENABLE_LED |
int
|
No description currently available |
NONE |
int
|
No description currently available |
DigitalInputs
#
Bases: IntFlag
Specifies the state of port digital input lines.
Attributes:
| Name | Type | Description |
|---|---|---|
DI0 |
int
|
No description currently available |
DI1 |
int
|
No description currently available |
DigitalOutputs
#
Bases: IntFlag
Specifies the state of port digital output lines.
Attributes:
| Name | Type | Description |
|---|---|---|
DO0_SET |
int
|
No description currently available |
DO1_SET |
int
|
No description currently available |
DO0_CLEAR |
int
|
No description currently available |
DO1_CLEAR |
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.
LedArray
#
Bases: Device
LedArray class for controlling the device.
read_aux_digital_output_state()
#
Reads the contents of the AuxDigitalOutputState register.
Returns:
| Type | Description |
|---|---|
AuxDigitalOutputs
|
Value read from the AuxDigitalOutputState register. |
read_aux_led_power()
#
Reads the contents of the AuxLedPower register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the AuxLedPower register. |
read_digital_input_state()
#
Reads the contents of the DigitalInputState register.
Returns:
| Type | Description |
|---|---|
DigitalInputs
|
Value read from the DigitalInputState register. |
read_digital_input_trigger()
#
Reads the contents of the DigitalInputTrigger register.
Returns:
| Type | Description |
|---|---|
DigitalInputTriggerPayload
|
Value read from the DigitalInputTrigger 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_sync()
#
Reads the contents of the DigitalOutputSync register.
Returns:
| Type | Description |
|---|---|
DigitalOutputSyncPayload
|
Value read from the DigitalOutputSync register. |
read_enable_events()
#
Reads the contents of the EnableEvents register.
Returns:
| Type | Description |
|---|---|
LedArrayEvents
|
Value read from the EnableEvents register. |
read_enable_led()
#
Reads the contents of the EnableLed register.
Returns:
| Type | Description |
|---|---|
LedState
|
Value read from the EnableLed register. |
read_enable_led_mode()
#
Reads the contents of the EnableLedMode register.
Returns:
| Type | Description |
|---|---|
LedState
|
Value read from the EnableLedMode register. |
read_enable_power()
#
Reads the contents of the EnablePower register.
Returns:
| Type | Description |
|---|---|
LedState
|
Value read from the EnablePower register. |
read_led0_power()
#
Reads the contents of the Led0Power register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0Power register. |
read_led0_pulse_repeat_counter()
#
Reads the contents of the Led0PulseRepeatCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseRepeatCounter register. |
read_led0_pulse_time_off()
#
Reads the contents of the Led0PulseTimeOff register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseTimeOff register. |
read_led0_pulse_time_on()
#
Reads the contents of the Led0PulseTimeOn register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseTimeOn register. |
read_led0_pulse_time_pulse_counter()
#
Reads the contents of the Led0PulseTimePulseCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseTimePulseCounter register. |
read_led0_pulse_time_tail()
#
Reads the contents of the Led0PulseTimeTail register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseTimeTail register. |
read_led0_pwm_duty_cycle()
#
Reads the contents of the Led0PwmDutyCycle register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led0PwmDutyCycle register. |
read_led0_pwm_duty_cycle_real()
#
Reads the contents of the Led0PwmDutyCycleReal register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led0PwmDutyCycleReal register. |
read_led0_pwm_frequency()
#
Reads the contents of the Led0PwmFrequency register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led0PwmFrequency register. |
read_led0_pwm_pulse_counter()
#
Reads the contents of the Led0PwmPulseCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PwmPulseCounter register. |
read_led0_pwm_real()
#
Reads the contents of the Led0PwmReal register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led0PwmReal register. |
read_led1_power()
#
Reads the contents of the Led1Power register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1Power register. |
read_led1_pulse_repeat_counter()
#
Reads the contents of the Led1PulseRepeatCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseRepeatCounter register. |
read_led1_pulse_time_off()
#
Reads the contents of the Led1PulseTimeOff register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseTimeOff register. |
read_led1_pulse_time_on()
#
Reads the contents of the Led1PulseTimeOn register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseTimeOn register. |
read_led1_pulse_time_pulse_counter()
#
Reads the contents of the Led1PulseTimePulseCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseTimePulseCounter register. |
read_led1_pulse_time_tail()
#
Reads the contents of the Led1PulseTimeTail register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseTimeTail register. |
read_led1_pwm_duty_cycle()
#
Reads the contents of the Led1PwmDutyCycle register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led1PwmDutyCycle register. |
read_led1_pwm_frequency()
#
Reads the contents of the Led1PwmFrequency register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led1PwmFrequency register. |
read_led1_pwm_pulse_counter()
#
Reads the contents of the Led1PwmPulseCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PwmPulseCounter register. |
read_led1_pwm_real()
#
Reads the contents of the Led1PwmReal register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led1PwmReal register. |
read_led_d1_pwm_duty_cycle_real()
#
Reads the contents of the LedD1PwmDutyCycleReal register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the LedD1PwmDutyCycleReal register. |
read_pulse_mode()
#
Reads the contents of the PulseMode register.
Returns:
| Type | Description |
|---|---|
PulseModePayload
|
Value read from the PulseMode register. |
write_aux_digital_output_state(value)
#
Writes a value to the AuxDigitalOutputState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AuxDigitalOutputs
|
Value to write to the AuxDigitalOutputState register. |
required |
write_aux_led_power(value)
#
Writes a value to the AuxLedPower register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the AuxLedPower register. |
required |
write_digital_input_trigger(value)
#
Writes a value to the DigitalInputTrigger register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalInputTriggerPayload
|
Value to write to the DigitalInputTrigger 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_sync(value)
#
Writes a value to the DigitalOutputSync register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputSyncPayload
|
Value to write to the DigitalOutputSync register. |
required |
write_enable_events(value)
#
Writes a value to the EnableEvents register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LedArrayEvents
|
Value to write to the EnableEvents register. |
required |
write_enable_led(value)
#
Writes a value to the EnableLed register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LedState
|
Value to write to the EnableLed register. |
required |
write_enable_led_mode(value)
#
Writes a value to the EnableLedMode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LedState
|
Value to write to the EnableLedMode register. |
required |
write_enable_power(value)
#
Writes a value to the EnablePower register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LedState
|
Value to write to the EnablePower register. |
required |
write_led0_power(value)
#
Writes a value to the Led0Power register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0Power register. |
required |
write_led0_pulse_repeat_counter(value)
#
Writes a value to the Led0PulseRepeatCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseRepeatCounter register. |
required |
write_led0_pulse_time_off(value)
#
Writes a value to the Led0PulseTimeOff register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseTimeOff register. |
required |
write_led0_pulse_time_on(value)
#
Writes a value to the Led0PulseTimeOn register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseTimeOn register. |
required |
write_led0_pulse_time_pulse_counter(value)
#
Writes a value to the Led0PulseTimePulseCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseTimePulseCounter register. |
required |
write_led0_pulse_time_tail(value)
#
Writes a value to the Led0PulseTimeTail register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseTimeTail register. |
required |
write_led0_pwm_duty_cycle(value)
#
Writes a value to the Led0PwmDutyCycle register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
Value to write to the Led0PwmDutyCycle register. |
required |
write_led0_pwm_frequency(value)
#
Writes a value to the Led0PwmFrequency register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
Value to write to the Led0PwmFrequency register. |
required |
write_led0_pwm_pulse_counter(value)
#
Writes a value to the Led0PwmPulseCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PwmPulseCounter register. |
required |
write_led1_power(value)
#
Writes a value to the Led1Power register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1Power register. |
required |
write_led1_pulse_repeat_counter(value)
#
Writes a value to the Led1PulseRepeatCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseRepeatCounter register. |
required |
write_led1_pulse_time_off(value)
#
Writes a value to the Led1PulseTimeOff register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseTimeOff register. |
required |
write_led1_pulse_time_on(value)
#
Writes a value to the Led1PulseTimeOn register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseTimeOn register. |
required |
write_led1_pulse_time_pulse_counter(value)
#
Writes a value to the Led1PulseTimePulseCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseTimePulseCounter register. |
required |
write_led1_pulse_time_tail(value)
#
Writes a value to the Led1PulseTimeTail register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseTimeTail register. |
required |
write_led1_pwm_duty_cycle(value)
#
Writes a value to the Led1PwmDutyCycle register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
Value to write to the Led1PwmDutyCycle register. |
required |
write_led1_pwm_frequency(value)
#
Writes a value to the Led1PwmFrequency register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
Value to write to the Led1PwmFrequency register. |
required |
write_led1_pwm_pulse_counter(value)
#
Writes a value to the Led1PwmPulseCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PwmPulseCounter register. |
required |
write_pulse_mode(value)
#
Writes a value to the PulseMode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PulseModePayload
|
Value to write to the PulseMode register. |
required |
LedArrayEvents
#
Bases: IntFlag
The events that can be enabled/disabled.
Attributes:
| Name | Type | Description |
|---|---|---|
ENABLE_LED |
int
|
No description currently available |
DIGITAL_INPUT_STATE |
int
|
No description currently available |
LedArrayRegisters
#
Bases: IntEnum
Enum for all available registers in the LedArray device.
Attributes:
| Name | Type | Description |
|---|---|---|
ENABLE_POWER |
int
|
Control the enable of both LEDs' power supply. |
ENABLE_LED_MODE |
int
|
Start/stop the LEDs according to the pulse configuration. |
ENABLE_LED |
int
|
Enables/disables the LEDs. |
DIGITAL_INPUT_STATE |
int
|
State of the digital input pins. An event will be emitted when the value of any digital input pin changes. |
DIGITAL_OUTPUT_SYNC |
int
|
Configuration of the digital outputs behavior. |
DIGITAL_INPUT_TRIGGER |
int
|
Configuration of the digital inputs pins behavior. |
PULSE_MODE |
int
|
Sets the pulse mode used by the LEDs. |
LED0_POWER |
int
|
Sets the power to LED0, between 1 and 120 (arbitrary units). |
LED1_POWER |
int
|
Sets the power to LED1, between 1 and 120 (arbitrary units). |
LED0_PWM_FREQUENCY |
int
|
Sets the frequency (Hz) of LED0 when in Pwm mode, between 0.5 and 2000. |
LED0_PWM_DUTY_CYCLE |
int
|
Sets the duty cycle (%) of LED0 when in Pwm mode, between 0.1 and 99.9. |
LED0_PWM_PULSE_COUNTER |
int
|
Sets the number of pulses of LED0 when in Pwm mode, between 1 and 65535. |
LED0_PULSE_TIME_ON |
int
|
Sets the time on (milliseconds) of LED0 when in PulseTime mode, between 1 and 65535. |
LED0_PULSE_TIME_OFF |
int
|
Sets the time off (milliseconds) of LED0 when in PulseTime mode, between 1 and 65535. |
LED0_PULSE_TIME_PULSE_COUNTER |
int
|
Sets the number of pulses of LED0 when in PulseTime mode, between 1 and 65535. |
LED0_PULSE_TIME_TAIL |
int
|
Sets the wait time between pulses (milliseconds) of LED0 when in PulseTime mode, between 1 and 65535. |
LED0_PULSE_REPEAT_COUNTER |
int
|
Sets the number of repetitions of LED0 pulse protocol when in PulseTime mode, between 1 and 65535. |
LED1_PWM_FREQUENCY |
int
|
Sets the frequency (Hz) of LED1 when in Pwm mode, between 0.5 and 2000. |
LED1_PWM_DUTY_CYCLE |
int
|
Sets the duty cycle (%) of LED1 when in Pwm mode, between 0.1 and 99.9. |
LED1_PWM_PULSE_COUNTER |
int
|
Sets the number of pulses of LED1 when in Pwm mode, between 1 and 65535. |
LED1_PULSE_TIME_ON |
int
|
Sets the time on (milliseconds) of LED1 when in PulseTime mode, between 1 and 65535. |
LED1_PULSE_TIME_OFF |
int
|
Sets the time off (milliseconds) of LED1 when in PulseTime mode, between 1 and 65535. |
LED1_PULSE_TIME_PULSE_COUNTER |
int
|
Sets the number of pulses of LED1 when in PulseTime mode, between 1 and 65535. |
LED1_PULSE_TIME_TAIL |
int
|
Sets the wait time between pulses (milliseconds) of LED1 when in PulseTime mode, between 1 and 65535. |
LED1_PULSE_REPEAT_COUNTER |
int
|
Sets the number of repetitions of LED1 pulse protocol when in PulseTime mode, between 1 and 65535. |
LED0_PWM_REAL |
int
|
Get the real frequency (Hz) of LED0 when in Pwm mode. |
LED0_PWM_DUTY_CYCLE_REAL |
int
|
Get the real duty cycle (%) of LED0 when in Pwm mode. |
LED1_PWM_REAL |
int
|
Get the real frequency (Hz) of LED1 when in Pwm mode. |
LED_D1_PWM_DUTY_CYCLE_REAL |
int
|
Get the real duty cycle (%) of LED1 when in Pwm mode. |
AUX_DIGITAL_OUTPUT_STATE |
int
|
Write the state of the auxiliary digital output bit. |
AUX_LED_POWER |
int
|
Sets the power to be applied to auxiliary LED, between 1 and 120. |
DIGITAL_OUTPUT_STATE |
int
|
Write the state of digital output lines. |
ENABLE_EVENTS |
int
|
Specifies all the active events in the device. |
LedState
#
Bases: IntFlag
Specifies the LEDs state.
Attributes:
| Name | Type | Description |
|---|---|---|
LED0_ON |
int
|
No description currently available |
LED1_ON |
int
|
No description currently available |
LED0_OFF |
int
|
No description currently available |
LED1_OFF |
int
|
No description currently available |
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 |
PulseModeConfig
#
Bases: IntEnum
Available configurations modes when LED behavior is enabled.
Attributes:
| Name | Type | Description |
|---|---|---|
PWM |
int
|
No description currently available |
PULSE_TIME |
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 |
harpdevice
#
AuxDigitalOutputs
#
Bases: IntFlag
Specifies the state of the auxiliary digital output lines.
Attributes:
| Name | Type | Description |
|---|---|---|
AUX0_SET |
int
|
No description currently available |
AUX1_SET |
int
|
No description currently available |
AUX0_CLEAR |
int
|
No description currently available |
AUX1_CLEAR |
int
|
No description currently available |
DO0SyncConfig
#
Bases: IntEnum
Available configurations when using digital output pin 0 to report firmware events.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
MIMIC_LED0_ENABLE_POWER |
int
|
No description currently available |
MIMIC_LED0_ENABLE_BEHAVIOR |
int
|
No description currently available |
MIMIC_LED0_ENABLE_LED |
int
|
No description currently available |
DO1SyncConfig
#
Bases: IntEnum
Available configurations when using digital output pin 1 to report firmware events.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
No description currently available |
MIMIC_LED1_ENABLE_POWER |
int
|
No description currently available |
MIMIC_LED1_ENABLE_BEHAVIOR |
int
|
No description currently available |
MIMIC_LED1_ENABLE_LED |
int
|
No description currently available |
DigitalInputTriggerConfig
#
Bases: IntEnum
Available configurations when using digital inputs as an acquisition trigger.
Attributes:
| Name | Type | Description |
|---|---|---|
LED0_ENABLE_POWER |
int
|
No description currently available |
LED0_ENABLE_BEHAVIOR |
int
|
No description currently available |
LED0_ENABLE_LED |
int
|
No description currently available |
LED1_ENABLE_POWER |
int
|
No description currently available |
LED1_ENABLE_BEHAVIOR |
int
|
No description currently available |
LED1_ENABLE_LED |
int
|
No description currently available |
NONE |
int
|
No description currently available |
DigitalInputs
#
Bases: IntFlag
Specifies the state of port digital input lines.
Attributes:
| Name | Type | Description |
|---|---|---|
DI0 |
int
|
No description currently available |
DI1 |
int
|
No description currently available |
DigitalOutputs
#
Bases: IntFlag
Specifies the state of port digital output lines.
Attributes:
| Name | Type | Description |
|---|---|---|
DO0_SET |
int
|
No description currently available |
DO1_SET |
int
|
No description currently available |
DO0_CLEAR |
int
|
No description currently available |
DO1_CLEAR |
int
|
No description currently available |
LedArray
#
Bases: Device
LedArray class for controlling the device.
read_aux_digital_output_state()
#
Reads the contents of the AuxDigitalOutputState register.
Returns:
| Type | Description |
|---|---|
AuxDigitalOutputs
|
Value read from the AuxDigitalOutputState register. |
read_aux_led_power()
#
Reads the contents of the AuxLedPower register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the AuxLedPower register. |
read_digital_input_state()
#
Reads the contents of the DigitalInputState register.
Returns:
| Type | Description |
|---|---|
DigitalInputs
|
Value read from the DigitalInputState register. |
read_digital_input_trigger()
#
Reads the contents of the DigitalInputTrigger register.
Returns:
| Type | Description |
|---|---|
DigitalInputTriggerPayload
|
Value read from the DigitalInputTrigger 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_sync()
#
Reads the contents of the DigitalOutputSync register.
Returns:
| Type | Description |
|---|---|
DigitalOutputSyncPayload
|
Value read from the DigitalOutputSync register. |
read_enable_events()
#
Reads the contents of the EnableEvents register.
Returns:
| Type | Description |
|---|---|
LedArrayEvents
|
Value read from the EnableEvents register. |
read_enable_led()
#
Reads the contents of the EnableLed register.
Returns:
| Type | Description |
|---|---|
LedState
|
Value read from the EnableLed register. |
read_enable_led_mode()
#
Reads the contents of the EnableLedMode register.
Returns:
| Type | Description |
|---|---|
LedState
|
Value read from the EnableLedMode register. |
read_enable_power()
#
Reads the contents of the EnablePower register.
Returns:
| Type | Description |
|---|---|
LedState
|
Value read from the EnablePower register. |
read_led0_power()
#
Reads the contents of the Led0Power register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0Power register. |
read_led0_pulse_repeat_counter()
#
Reads the contents of the Led0PulseRepeatCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseRepeatCounter register. |
read_led0_pulse_time_off()
#
Reads the contents of the Led0PulseTimeOff register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseTimeOff register. |
read_led0_pulse_time_on()
#
Reads the contents of the Led0PulseTimeOn register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseTimeOn register. |
read_led0_pulse_time_pulse_counter()
#
Reads the contents of the Led0PulseTimePulseCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseTimePulseCounter register. |
read_led0_pulse_time_tail()
#
Reads the contents of the Led0PulseTimeTail register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PulseTimeTail register. |
read_led0_pwm_duty_cycle()
#
Reads the contents of the Led0PwmDutyCycle register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led0PwmDutyCycle register. |
read_led0_pwm_duty_cycle_real()
#
Reads the contents of the Led0PwmDutyCycleReal register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led0PwmDutyCycleReal register. |
read_led0_pwm_frequency()
#
Reads the contents of the Led0PwmFrequency register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led0PwmFrequency register. |
read_led0_pwm_pulse_counter()
#
Reads the contents of the Led0PwmPulseCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led0PwmPulseCounter register. |
read_led0_pwm_real()
#
Reads the contents of the Led0PwmReal register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led0PwmReal register. |
read_led1_power()
#
Reads the contents of the Led1Power register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1Power register. |
read_led1_pulse_repeat_counter()
#
Reads the contents of the Led1PulseRepeatCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseRepeatCounter register. |
read_led1_pulse_time_off()
#
Reads the contents of the Led1PulseTimeOff register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseTimeOff register. |
read_led1_pulse_time_on()
#
Reads the contents of the Led1PulseTimeOn register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseTimeOn register. |
read_led1_pulse_time_pulse_counter()
#
Reads the contents of the Led1PulseTimePulseCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseTimePulseCounter register. |
read_led1_pulse_time_tail()
#
Reads the contents of the Led1PulseTimeTail register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PulseTimeTail register. |
read_led1_pwm_duty_cycle()
#
Reads the contents of the Led1PwmDutyCycle register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led1PwmDutyCycle register. |
read_led1_pwm_frequency()
#
Reads the contents of the Led1PwmFrequency register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led1PwmFrequency register. |
read_led1_pwm_pulse_counter()
#
Reads the contents of the Led1PwmPulseCounter register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the Led1PwmPulseCounter register. |
read_led1_pwm_real()
#
Reads the contents of the Led1PwmReal register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the Led1PwmReal register. |
read_led_d1_pwm_duty_cycle_real()
#
Reads the contents of the LedD1PwmDutyCycleReal register.
Returns:
| Type | Description |
|---|---|
float
|
Value read from the LedD1PwmDutyCycleReal register. |
read_pulse_mode()
#
Reads the contents of the PulseMode register.
Returns:
| Type | Description |
|---|---|
PulseModePayload
|
Value read from the PulseMode register. |
write_aux_digital_output_state(value)
#
Writes a value to the AuxDigitalOutputState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
AuxDigitalOutputs
|
Value to write to the AuxDigitalOutputState register. |
required |
write_aux_led_power(value)
#
Writes a value to the AuxLedPower register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the AuxLedPower register. |
required |
write_digital_input_trigger(value)
#
Writes a value to the DigitalInputTrigger register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalInputTriggerPayload
|
Value to write to the DigitalInputTrigger 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_sync(value)
#
Writes a value to the DigitalOutputSync register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputSyncPayload
|
Value to write to the DigitalOutputSync register. |
required |
write_enable_events(value)
#
Writes a value to the EnableEvents register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LedArrayEvents
|
Value to write to the EnableEvents register. |
required |
write_enable_led(value)
#
Writes a value to the EnableLed register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LedState
|
Value to write to the EnableLed register. |
required |
write_enable_led_mode(value)
#
Writes a value to the EnableLedMode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LedState
|
Value to write to the EnableLedMode register. |
required |
write_enable_power(value)
#
Writes a value to the EnablePower register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LedState
|
Value to write to the EnablePower register. |
required |
write_led0_power(value)
#
Writes a value to the Led0Power register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0Power register. |
required |
write_led0_pulse_repeat_counter(value)
#
Writes a value to the Led0PulseRepeatCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseRepeatCounter register. |
required |
write_led0_pulse_time_off(value)
#
Writes a value to the Led0PulseTimeOff register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseTimeOff register. |
required |
write_led0_pulse_time_on(value)
#
Writes a value to the Led0PulseTimeOn register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseTimeOn register. |
required |
write_led0_pulse_time_pulse_counter(value)
#
Writes a value to the Led0PulseTimePulseCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseTimePulseCounter register. |
required |
write_led0_pulse_time_tail(value)
#
Writes a value to the Led0PulseTimeTail register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PulseTimeTail register. |
required |
write_led0_pwm_duty_cycle(value)
#
Writes a value to the Led0PwmDutyCycle register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
Value to write to the Led0PwmDutyCycle register. |
required |
write_led0_pwm_frequency(value)
#
Writes a value to the Led0PwmFrequency register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
Value to write to the Led0PwmFrequency register. |
required |
write_led0_pwm_pulse_counter(value)
#
Writes a value to the Led0PwmPulseCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led0PwmPulseCounter register. |
required |
write_led1_power(value)
#
Writes a value to the Led1Power register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1Power register. |
required |
write_led1_pulse_repeat_counter(value)
#
Writes a value to the Led1PulseRepeatCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseRepeatCounter register. |
required |
write_led1_pulse_time_off(value)
#
Writes a value to the Led1PulseTimeOff register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseTimeOff register. |
required |
write_led1_pulse_time_on(value)
#
Writes a value to the Led1PulseTimeOn register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseTimeOn register. |
required |
write_led1_pulse_time_pulse_counter(value)
#
Writes a value to the Led1PulseTimePulseCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseTimePulseCounter register. |
required |
write_led1_pulse_time_tail(value)
#
Writes a value to the Led1PulseTimeTail register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PulseTimeTail register. |
required |
write_led1_pwm_duty_cycle(value)
#
Writes a value to the Led1PwmDutyCycle register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
Value to write to the Led1PwmDutyCycle register. |
required |
write_led1_pwm_frequency(value)
#
Writes a value to the Led1PwmFrequency register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
Value to write to the Led1PwmFrequency register. |
required |
write_led1_pwm_pulse_counter(value)
#
Writes a value to the Led1PwmPulseCounter register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the Led1PwmPulseCounter register. |
required |
write_pulse_mode(value)
#
Writes a value to the PulseMode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PulseModePayload
|
Value to write to the PulseMode register. |
required |
LedArrayEvents
#
Bases: IntFlag
The events that can be enabled/disabled.
Attributes:
| Name | Type | Description |
|---|---|---|
ENABLE_LED |
int
|
No description currently available |
DIGITAL_INPUT_STATE |
int
|
No description currently available |
LedArrayRegisters
#
Bases: IntEnum
Enum for all available registers in the LedArray device.
Attributes:
| Name | Type | Description |
|---|---|---|
ENABLE_POWER |
int
|
Control the enable of both LEDs' power supply. |
ENABLE_LED_MODE |
int
|
Start/stop the LEDs according to the pulse configuration. |
ENABLE_LED |
int
|
Enables/disables the LEDs. |
DIGITAL_INPUT_STATE |
int
|
State of the digital input pins. An event will be emitted when the value of any digital input pin changes. |
DIGITAL_OUTPUT_SYNC |
int
|
Configuration of the digital outputs behavior. |
DIGITAL_INPUT_TRIGGER |
int
|
Configuration of the digital inputs pins behavior. |
PULSE_MODE |
int
|
Sets the pulse mode used by the LEDs. |
LED0_POWER |
int
|
Sets the power to LED0, between 1 and 120 (arbitrary units). |
LED1_POWER |
int
|
Sets the power to LED1, between 1 and 120 (arbitrary units). |
LED0_PWM_FREQUENCY |
int
|
Sets the frequency (Hz) of LED0 when in Pwm mode, between 0.5 and 2000. |
LED0_PWM_DUTY_CYCLE |
int
|
Sets the duty cycle (%) of LED0 when in Pwm mode, between 0.1 and 99.9. |
LED0_PWM_PULSE_COUNTER |
int
|
Sets the number of pulses of LED0 when in Pwm mode, between 1 and 65535. |
LED0_PULSE_TIME_ON |
int
|
Sets the time on (milliseconds) of LED0 when in PulseTime mode, between 1 and 65535. |
LED0_PULSE_TIME_OFF |
int
|
Sets the time off (milliseconds) of LED0 when in PulseTime mode, between 1 and 65535. |
LED0_PULSE_TIME_PULSE_COUNTER |
int
|
Sets the number of pulses of LED0 when in PulseTime mode, between 1 and 65535. |
LED0_PULSE_TIME_TAIL |
int
|
Sets the wait time between pulses (milliseconds) of LED0 when in PulseTime mode, between 1 and 65535. |
LED0_PULSE_REPEAT_COUNTER |
int
|
Sets the number of repetitions of LED0 pulse protocol when in PulseTime mode, between 1 and 65535. |
LED1_PWM_FREQUENCY |
int
|
Sets the frequency (Hz) of LED1 when in Pwm mode, between 0.5 and 2000. |
LED1_PWM_DUTY_CYCLE |
int
|
Sets the duty cycle (%) of LED1 when in Pwm mode, between 0.1 and 99.9. |
LED1_PWM_PULSE_COUNTER |
int
|
Sets the number of pulses of LED1 when in Pwm mode, between 1 and 65535. |
LED1_PULSE_TIME_ON |
int
|
Sets the time on (milliseconds) of LED1 when in PulseTime mode, between 1 and 65535. |
LED1_PULSE_TIME_OFF |
int
|
Sets the time off (milliseconds) of LED1 when in PulseTime mode, between 1 and 65535. |
LED1_PULSE_TIME_PULSE_COUNTER |
int
|
Sets the number of pulses of LED1 when in PulseTime mode, between 1 and 65535. |
LED1_PULSE_TIME_TAIL |
int
|
Sets the wait time between pulses (milliseconds) of LED1 when in PulseTime mode, between 1 and 65535. |
LED1_PULSE_REPEAT_COUNTER |
int
|
Sets the number of repetitions of LED1 pulse protocol when in PulseTime mode, between 1 and 65535. |
LED0_PWM_REAL |
int
|
Get the real frequency (Hz) of LED0 when in Pwm mode. |
LED0_PWM_DUTY_CYCLE_REAL |
int
|
Get the real duty cycle (%) of LED0 when in Pwm mode. |
LED1_PWM_REAL |
int
|
Get the real frequency (Hz) of LED1 when in Pwm mode. |
LED_D1_PWM_DUTY_CYCLE_REAL |
int
|
Get the real duty cycle (%) of LED1 when in Pwm mode. |
AUX_DIGITAL_OUTPUT_STATE |
int
|
Write the state of the auxiliary digital output bit. |
AUX_LED_POWER |
int
|
Sets the power to be applied to auxiliary LED, between 1 and 120. |
DIGITAL_OUTPUT_STATE |
int
|
Write the state of digital output lines. |
ENABLE_EVENTS |
int
|
Specifies all the active events in the device. |
LedState
#
Bases: IntFlag
Specifies the LEDs state.
Attributes:
| Name | Type | Description |
|---|---|---|
LED0_ON |
int
|
No description currently available |
LED1_ON |
int
|
No description currently available |
LED0_OFF |
int
|
No description currently available |
LED1_OFF |
int
|
No description currently available |
PulseModeConfig
#
Bases: IntEnum
Available configurations modes when LED behavior is enabled.
Attributes:
| Name | Type | Description |
|---|---|---|
PWM |
int
|
No description currently available |
PULSE_TIME |
int
|
No description currently available |