Modules
harp.devices.rgbarray
#
DI0ModeConfig
#
Bases: IntEnum
Specifies the operation mode of the DI0 pin.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
The DI0 pin functions as a passive digital input. |
UPDATE_ON_RISING_EDGE |
int
|
Update the LED colors when the DI0 pin transitions from low to high. |
UPDATE_ON_HIGH |
int
|
Able to update RGBs when the pin is HIGH. Turn LEDs off when rising edge is detected. |
DOModeConfig
#
Bases: IntEnum
Specifies the operation mode of a Digital Output pin.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
The pin will function as a pure digital output. |
PULSE_ON_UPDATE |
int
|
A 1ms pulse will be triggered each time an RGB is updated. |
PULSE_ON_LOAD |
int
|
A 1ms pulse will be triggered each time an new array is loaded RGB. |
TOGGLE_ON_UPDATE |
int
|
The output pin will toggle each time an RGB is updated. |
TOGGLE_ON_LOAD |
int
|
The output pin will toggle each time an new array is loaded RGB. |
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
Attributes:
| Name | Type | Description |
|---|---|---|
DI0 |
int
|
No description currently available |
DigitalOutputs
#
Bases: IntFlag
Attributes:
| Name | Type | Description |
|---|---|---|
DO0 |
int
|
Digital Output 0 |
DO1 |
int
|
Digital Output 1 |
DO2 |
int
|
Digital Output 2 |
DO3 |
int
|
Digital Output 3 |
DO4 |
int
|
Digital Output 4 |
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 |
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 |
RgbArray
#
Bases: Device
RgbArray class for controlling the device.
read_di0_mode()
#
Reads the contents of the DI0Mode register.
Returns:
| Type | Description |
|---|---|
DI0ModeConfig
|
Value read from the DI0Mode 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_pulse_count()
#
Reads the contents of the DigitalOutputPulseCount register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DigitalOutputPulseCount register. |
read_digital_output_pulse_period()
#
Reads the contents of the DigitalOutputPulsePeriod register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DigitalOutputPulsePeriod register. |
read_do0_mode()
#
Reads the contents of the DO0Mode register.
Returns:
| Type | Description |
|---|---|
DOModeConfig
|
Value read from the DO0Mode register. |
read_do1_mode()
#
Reads the contents of the DO1Mode register.
Returns:
| Type | Description |
|---|---|
DOModeConfig
|
Value read from the DO1Mode register. |
read_event_enable()
#
Reads the contents of the EventEnable register.
Returns:
| Type | Description |
|---|---|
RgbArrayEvents
|
Value read from the EventEnable register. |
read_latch_on_next_update()
#
Reads the contents of the LatchOnNextUpdate register.
Returns:
| Type | Description |
|---|---|
bool
|
Value read from the LatchOnNextUpdate register. |
read_led_count()
#
Reads the contents of the LedCount register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the LedCount register. |
read_led_status()
#
Reads the contents of the LedStatus register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the LedStatus register. |
read_output_clear()
#
Reads the contents of the OutputClear register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the OutputClear register. |
read_output_set()
#
Reads the contents of the OutputSet register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the OutputSet register. |
read_output_state()
#
Reads the contents of the OutputState register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the OutputState register. |
read_output_toggle()
#
Reads the contents of the OutputToggle register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the OutputToggle register. |
read_rgb_bus0_state()
#
Reads the contents of the RgbBus0State register.
Returns:
| Type | Description |
|---|---|
bytes
|
Value read from the RgbBus0State register. |
read_rgb_bus1_state()
#
Reads the contents of the RgbBus1State register.
Returns:
| Type | Description |
|---|---|
bytes
|
Value read from the RgbBus1State register. |
read_rgb_off_state()
#
Reads the contents of the RgbOffState register.
Returns:
| Type | Description |
|---|---|
bytes
|
Value read from the RgbOffState register. |
read_rgb_state()
#
Reads the contents of the RgbState register.
Returns:
| Type | Description |
|---|---|
bytes
|
Value read from the RgbState register. |
write_di0_mode(value)
#
Writes a value to the DI0Mode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DI0ModeConfig
|
Value to write to the DI0Mode register. |
required |
write_digital_output_pulse_count(value)
#
Writes a value to the DigitalOutputPulseCount register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DigitalOutputPulseCount register. |
required |
write_digital_output_pulse_period(value)
#
Writes a value to the DigitalOutputPulsePeriod register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DigitalOutputPulsePeriod register. |
required |
write_do0_mode(value)
#
Writes a value to the DO0Mode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DOModeConfig
|
Value to write to the DO0Mode register. |
required |
write_do1_mode(value)
#
Writes a value to the DO1Mode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DOModeConfig
|
Value to write to the DO1Mode register. |
required |
write_event_enable(value)
#
Writes a value to the EventEnable register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
RgbArrayEvents
|
Value to write to the EventEnable register. |
required |
write_latch_on_next_update(value)
#
Writes a value to the LatchOnNextUpdate register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool
|
Value to write to the LatchOnNextUpdate register. |
required |
write_led_count(value)
#
Writes a value to the LedCount register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the LedCount register. |
required |
write_led_status(value)
#
Writes a value to the LedStatus register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the LedStatus register. |
required |
write_output_clear(value)
#
Writes a value to the OutputClear register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the OutputClear register. |
required |
write_output_set(value)
#
Writes a value to the OutputSet register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the OutputSet register. |
required |
write_output_state(value)
#
Writes a value to the OutputState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the OutputState register. |
required |
write_output_toggle(value)
#
Writes a value to the OutputToggle register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the OutputToggle register. |
required |
write_rgb_bus0_state(value)
#
Writes a value to the RgbBus0State register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bytes
|
Value to write to the RgbBus0State register. |
required |
write_rgb_bus1_state(value)
#
Writes a value to the RgbBus1State register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bytes
|
Value to write to the RgbBus1State register. |
required |
write_rgb_off_state(value)
#
Writes a value to the RgbOffState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bytes
|
Value to write to the RgbOffState register. |
required |
write_rgb_state(value)
#
Writes a value to the RgbState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bytes
|
Value to write to the RgbState register. |
required |
RgbArrayEvents
#
Bases: IntEnum
Available events to be enable in the board.
Attributes:
| Name | Type | Description |
|---|---|---|
LED_STATUS |
int
|
No description currently available |
DIGITAL_INPUTS |
int
|
No description currently available |
RgbArrayRegisters
#
Bases: IntEnum
Enum for all available registers in the RgbArray device.
Attributes:
| Name | Type | Description |
|---|---|---|
LED_STATUS |
int
|
|
LED_COUNT |
int
|
The number of LEDs connected on each bus of the device. |
RGB_STATE |
int
|
The RGB color of each LED. [R0 G0 B0 R1 G1 B1 ...]. |
RGB_BUS0_STATE |
int
|
The RGB color of each LED. [R0 G0 B0 R1 G1 B1 ...]. |
RGB_BUS1_STATE |
int
|
The RGB color of each LED. [R0 G0 B0 R1 G1 B1 ...]. |
RGB_OFF_STATE |
int
|
The RGB color of the LEDs when they are off. |
DI0_MODE |
int
|
|
DO0_MODE |
int
|
|
DO1_MODE |
int
|
|
LATCH_ON_NEXT_UPDATE |
int
|
Updates the settings of the RGBs, but will queue the instruction until a valid LedStatus command. |
DIGITAL_INPUT_STATE |
int
|
Reflects the state of DI digital lines of each Port |
OUTPUT_SET |
int
|
Set the specified digital output lines. |
OUTPUT_CLEAR |
int
|
Clear the specified digital output lines |
OUTPUT_TOGGLE |
int
|
Toggle the specified digital output lines |
OUTPUT_STATE |
int
|
Write the state of all digital output lines |
DIGITAL_OUTPUT_PULSE_PERIOD |
int
|
The pulse period in milliseconds for digital outputs. |
DIGITAL_OUTPUT_PULSE_COUNT |
int
|
Triggers the specified number of pulses on the digital output lines. |
EVENT_ENABLE |
int
|
Specifies the active events in the device. |
harpdevice
#
DI0ModeConfig
#
Bases: IntEnum
Specifies the operation mode of the DI0 pin.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
The DI0 pin functions as a passive digital input. |
UPDATE_ON_RISING_EDGE |
int
|
Update the LED colors when the DI0 pin transitions from low to high. |
UPDATE_ON_HIGH |
int
|
Able to update RGBs when the pin is HIGH. Turn LEDs off when rising edge is detected. |
DOModeConfig
#
Bases: IntEnum
Specifies the operation mode of a Digital Output pin.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
int
|
The pin will function as a pure digital output. |
PULSE_ON_UPDATE |
int
|
A 1ms pulse will be triggered each time an RGB is updated. |
PULSE_ON_LOAD |
int
|
A 1ms pulse will be triggered each time an new array is loaded RGB. |
TOGGLE_ON_UPDATE |
int
|
The output pin will toggle each time an RGB is updated. |
TOGGLE_ON_LOAD |
int
|
The output pin will toggle each time an new array is loaded RGB. |
DigitalInputs
#
Bases: IntFlag
Attributes:
| Name | Type | Description |
|---|---|---|
DI0 |
int
|
No description currently available |
DigitalOutputs
#
Bases: IntFlag
Attributes:
| Name | Type | Description |
|---|---|---|
DO0 |
int
|
Digital Output 0 |
DO1 |
int
|
Digital Output 1 |
DO2 |
int
|
Digital Output 2 |
DO3 |
int
|
Digital Output 3 |
DO4 |
int
|
Digital Output 4 |
RgbArray
#
Bases: Device
RgbArray class for controlling the device.
read_di0_mode()
#
Reads the contents of the DI0Mode register.
Returns:
| Type | Description |
|---|---|
DI0ModeConfig
|
Value read from the DI0Mode 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_pulse_count()
#
Reads the contents of the DigitalOutputPulseCount register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DigitalOutputPulseCount register. |
read_digital_output_pulse_period()
#
Reads the contents of the DigitalOutputPulsePeriod register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the DigitalOutputPulsePeriod register. |
read_do0_mode()
#
Reads the contents of the DO0Mode register.
Returns:
| Type | Description |
|---|---|
DOModeConfig
|
Value read from the DO0Mode register. |
read_do1_mode()
#
Reads the contents of the DO1Mode register.
Returns:
| Type | Description |
|---|---|
DOModeConfig
|
Value read from the DO1Mode register. |
read_event_enable()
#
Reads the contents of the EventEnable register.
Returns:
| Type | Description |
|---|---|
RgbArrayEvents
|
Value read from the EventEnable register. |
read_latch_on_next_update()
#
Reads the contents of the LatchOnNextUpdate register.
Returns:
| Type | Description |
|---|---|
bool
|
Value read from the LatchOnNextUpdate register. |
read_led_count()
#
Reads the contents of the LedCount register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the LedCount register. |
read_led_status()
#
Reads the contents of the LedStatus register.
Returns:
| Type | Description |
|---|---|
int
|
Value read from the LedStatus register. |
read_output_clear()
#
Reads the contents of the OutputClear register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the OutputClear register. |
read_output_set()
#
Reads the contents of the OutputSet register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the OutputSet register. |
read_output_state()
#
Reads the contents of the OutputState register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the OutputState register. |
read_output_toggle()
#
Reads the contents of the OutputToggle register.
Returns:
| Type | Description |
|---|---|
DigitalOutputs
|
Value read from the OutputToggle register. |
read_rgb_bus0_state()
#
Reads the contents of the RgbBus0State register.
Returns:
| Type | Description |
|---|---|
bytes
|
Value read from the RgbBus0State register. |
read_rgb_bus1_state()
#
Reads the contents of the RgbBus1State register.
Returns:
| Type | Description |
|---|---|
bytes
|
Value read from the RgbBus1State register. |
read_rgb_off_state()
#
Reads the contents of the RgbOffState register.
Returns:
| Type | Description |
|---|---|
bytes
|
Value read from the RgbOffState register. |
read_rgb_state()
#
Reads the contents of the RgbState register.
Returns:
| Type | Description |
|---|---|
bytes
|
Value read from the RgbState register. |
write_di0_mode(value)
#
Writes a value to the DI0Mode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DI0ModeConfig
|
Value to write to the DI0Mode register. |
required |
write_digital_output_pulse_count(value)
#
Writes a value to the DigitalOutputPulseCount register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DigitalOutputPulseCount register. |
required |
write_digital_output_pulse_period(value)
#
Writes a value to the DigitalOutputPulsePeriod register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the DigitalOutputPulsePeriod register. |
required |
write_do0_mode(value)
#
Writes a value to the DO0Mode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DOModeConfig
|
Value to write to the DO0Mode register. |
required |
write_do1_mode(value)
#
Writes a value to the DO1Mode register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DOModeConfig
|
Value to write to the DO1Mode register. |
required |
write_event_enable(value)
#
Writes a value to the EventEnable register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
RgbArrayEvents
|
Value to write to the EventEnable register. |
required |
write_latch_on_next_update(value)
#
Writes a value to the LatchOnNextUpdate register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bool
|
Value to write to the LatchOnNextUpdate register. |
required |
write_led_count(value)
#
Writes a value to the LedCount register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the LedCount register. |
required |
write_led_status(value)
#
Writes a value to the LedStatus register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Value to write to the LedStatus register. |
required |
write_output_clear(value)
#
Writes a value to the OutputClear register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the OutputClear register. |
required |
write_output_set(value)
#
Writes a value to the OutputSet register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the OutputSet register. |
required |
write_output_state(value)
#
Writes a value to the OutputState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the OutputState register. |
required |
write_output_toggle(value)
#
Writes a value to the OutputToggle register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
DigitalOutputs
|
Value to write to the OutputToggle register. |
required |
write_rgb_bus0_state(value)
#
Writes a value to the RgbBus0State register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bytes
|
Value to write to the RgbBus0State register. |
required |
write_rgb_bus1_state(value)
#
Writes a value to the RgbBus1State register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bytes
|
Value to write to the RgbBus1State register. |
required |
write_rgb_off_state(value)
#
Writes a value to the RgbOffState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bytes
|
Value to write to the RgbOffState register. |
required |
write_rgb_state(value)
#
Writes a value to the RgbState register.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
bytes
|
Value to write to the RgbState register. |
required |
RgbArrayEvents
#
Bases: IntEnum
Available events to be enable in the board.
Attributes:
| Name | Type | Description |
|---|---|---|
LED_STATUS |
int
|
No description currently available |
DIGITAL_INPUTS |
int
|
No description currently available |
RgbArrayRegisters
#
Bases: IntEnum
Enum for all available registers in the RgbArray device.
Attributes:
| Name | Type | Description |
|---|---|---|
LED_STATUS |
int
|
|
LED_COUNT |
int
|
The number of LEDs connected on each bus of the device. |
RGB_STATE |
int
|
The RGB color of each LED. [R0 G0 B0 R1 G1 B1 ...]. |
RGB_BUS0_STATE |
int
|
The RGB color of each LED. [R0 G0 B0 R1 G1 B1 ...]. |
RGB_BUS1_STATE |
int
|
The RGB color of each LED. [R0 G0 B0 R1 G1 B1 ...]. |
RGB_OFF_STATE |
int
|
The RGB color of the LEDs when they are off. |
DI0_MODE |
int
|
|
DO0_MODE |
int
|
|
DO1_MODE |
int
|
|
LATCH_ON_NEXT_UPDATE |
int
|
Updates the settings of the RGBs, but will queue the instruction until a valid LedStatus command. |
DIGITAL_INPUT_STATE |
int
|
Reflects the state of DI digital lines of each Port |
OUTPUT_SET |
int
|
Set the specified digital output lines. |
OUTPUT_CLEAR |
int
|
Clear the specified digital output lines |
OUTPUT_TOGGLE |
int
|
Toggle the specified digital output lines |
OUTPUT_STATE |
int
|
Write the state of all digital output lines |
DIGITAL_OUTPUT_PULSE_PERIOD |
int
|
The pulse period in milliseconds for digital outputs. |
DIGITAL_OUTPUT_PULSE_COUNT |
int
|
Triggers the specified number of pulses on the digital output lines. |
EVENT_ENABLE |
int
|
Specifies the active events in the device. |