UART Rx¶

The PxUartRx class implements the functionality of a UART Receiver. It provides methods to receive data.

PxUartRx ¶

PxUartRx(
    exerciser: AqProtocolExerciser,
    baud_rate: int = 9600,
    stop_bits: int = 1,
    data_bits: int = 8,
    parity: PxUartParityMode = PARITY_MODE_NONE,
    config: PxUartConfig | None = None,
    *args,
    **kwargs
)

Uart Rx Class.

METHOD	DESCRIPTION
`add_event_handler`	Add an event handler to the current device instance.
`attach_to_bus`	Attach the target to a bus.
`config`	Set the config of the target.
`detach_from_bus`	Detach the device from the bus.
`get_event_handlers`	Retreive handlers registerd on this device.
`on_event`	Add an event handler to the instance by decorator.
`perform_operation`	Send an operation.
`remove_event_handler`	Remove an event handler.

ATTRIBUTE	DESCRIPTION
`available_events_map`	A reverse mapping of `field_name_by_number`, which uses field name as key. TYPE: `dict[str, str]`
`is_attached`	Check if the device is attached to a bus. TYPE: `bool`
`name`	Get the name of the device. TYPE: `str`
`state`	Get the state of the device. TYPE: `Message \| None`

available_events_map ¶

available_events_map: dict[str, str]

A reverse mapping of field_name_by_number, which uses field name as key.

is_attached ¶

is_attached: bool

Check if the device is attached to a bus.

name ¶

name: str

Get the name of the device.

state ¶

state: Message | None

Get the state of the device.

add_event_handler ¶

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

Add an event handler to the current device instance.

attach_to_bus ¶

attach_to_bus(bus: PxAbstractBus) -> None

Attach the target 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

config ¶

config(config: Message) -> None

Set the config of the target.

detach_from_bus ¶

detach_from_bus() -> None

Detach the device from the bus.

The opposite of the attach_to_bus method.

get_event_handlers ¶

get_event_handlers() -> dict[str, Callable]

Retreive handlers registerd on this device.

on_event ¶

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

Add an event handler to the instance by decorator.

perform_operation ¶

perform_operation(operation: PxDeviceOperation) -> PxDeviceOperation

Send an operation.

remove_event_handler ¶

remove_event_handler(event: str) -> None

Remove an event handler.