UART Tx

The PxUartTx class implements the functionality of a UART Transmitter. It provides methods to transmit data.

PxUartTx

PxUartTx(
    exerciser: AqProtocolExerciser,
    baud_rate: int = 9600,
    stop_bits: int = 1,
    data_bits: int = 8,
    parity: PxUartParityMode = NONE,
    config: PxUartTxConfig | None = None,
    *args,
    **kwargs
)

Uart Tx Class.

METHOD	DESCRIPTION
add_event_handler	Add an event handler to the current device instance, by event class or event name.
remove_event_handler	Remove an event handler from the current device instance, by event class or event name.
get_event_handlers	Retreive handlers registerd on this device.
on_event	Add an event handler to the instance by decorator, by event class or event name.
match	Return whether a device config describes a device of this class.
update_additional_data	Atomically update additional_data with revision-aware retry.
update_config	Set the config of the controller.
set_config	Set the config of the controller.
attach_to_bus	Attach the controller to a bus.
detach_from_bus	Detach the device from the bus.
perform_operation	Send an operation.
write_data	Write a list of data to the bus.
write_bytes	Write a list of data in bytes to the bus.

ATTRIBUTE	DESCRIPTION
available_events_map	Map each available event name to its id in event topics. TYPE: dict[str, str]
is_attached	Check if the device is attached to a bus. TYPE: bool
state	Get the state of the device. TYPE: DeviceStateT | None
name	Get the name of the device. TYPE: str
cts_op_name	Get the name of CTS operation. TYPE: str | None
additional_data	Get the opaque additional data blob associated with this device. TYPE: bytes
config	Get the config of the device. TYPE: DeviceConfigT | None

available_events_map

available_events_map: dict[str, str]

Map each available event name to its id in event topics.

is_attached

is_attached: bool

Check if the device is attached to a bus.

state

state: DeviceStateT | None

Get the state of the device.

name

name: str

Get the name of the device.

cts_op_name

cts_op_name: str | None

Get the name of CTS operation.

additional_data

additional_data: bytes

Get the opaque additional data blob associated with this device.

config

config: DeviceConfigT | None

Get the config of the device.

add_event_handler

add_event_handler(event: str, handler: Callable[[Any], Any]) -> None

add_event_handler(event: type[EventT], handler: Callable[[EventT], Any]) -> None

add_event_handler(
    event: str | type[PxAbstractEvent], handler: Callable[[Any], Any]
) -> None

Add an event handler to the current device instance, by event class or event name.

remove_event_handler

remove_event_handler(
    event: str | type[PxAbstractEvent], handler: Callable[[Any], Any] | None = None
) -> None

Remove an event handler from the current device instance, by event class or event name.

get_event_handlers

get_event_handlers(
    filter_by: Callable[[str], bool] | None = None,
) -> dict[str, list[Callable[[Any], Any]]]

Retreive handlers registerd on this device.

Handlers are always scoped to this device; an optional filter_by is applied on friendly event names.

on_event

on_event(event_type: str) -> Callable[[Callable[..., Any]], Callable[..., Any]]

on_event(
    event_type: type[EventT],
) -> Callable[[Callable[[EventT], Any]], Callable[[EventT], Any]]

on_event(
    event_type: str | type[PxAbstractEvent],
) -> Callable[[Callable[..., Any]], Callable[..., Any]]

Add an event handler to the instance by decorator, by event class or event name.

match

match(config: PxAbstractDeviceConfig) -> bool

Return whether a device config describes a device of this class.

update_additional_data

update_additional_data(updater: Callable[[bytes], bytes]) -> None

Atomically update additional_data with revision-aware retry.

update_config

update_config(updater: Callable[[Any], Any]) -> None

Set the config of the controller.

set_config

set_config(config: DeviceConfigT) -> None

Set the config of the controller.

attach_to_bus

attach_to_bus(bus: PxAbstractBus) -> None

Attach the controller to a bus.

This method is used to make the device aware of the bus it is connected to. It is used to set the bus attribute of the device.

Note

This method will not automatically create an actual instance on the Protocol Exerciser until user call the attach_to_bus method.

PARAMETER	DESCRIPTION
bus	The bus to attach the device to TYPE: PxAbstractBus

RAISES	DESCRIPTION
ValueError	If the device is already attached to a bus

detach_from_bus

detach_from_bus() -> None

Detach the device from the bus.

The opposite of the attach_to_bus method.

perform_operation

perform_operation(
    operation: PxDeviceOperation, *, timeout: int | None = None
) -> PxDeviceOperation

Send an operation.

PARAMETER	DESCRIPTION
operation	Device operation to perform. TYPE: PxDeviceOperation
timeout	Optional base STOP-handshake wait in milliseconds. When omitted, the instrument uses subsystem defaults. TYPE: int | None DEFAULT: None

write_data

write_data(data: list[int], parity_error: bool = False) -> list[int]

Write a list of data to the bus.

write_bytes

write_bytes(data: bytes, parity_error: bool = False) -> list[int]

Write a list of data in bytes to the bus.