5.3.1.17.1.1. cli.com.can_com.CAN

class cli.com.can_com.CAN(name: str, parameter: CanBusConfig)

Bases: ComInterface

Communication interface for CAN bus operations. Handles initialization and interaction with CANProcess for reading and writing messages.

read(block: bool = False, timeout: float | None = None) → Message | None

Read a CAN message from the output queue.

Parameters:

• block (bool) – Whether to block if the queue is empty.

• timeout (float | None) – Maximum time to wait for a message.

Returns:

The received CAN message, or None if not available.

Return type:

Message | None

write(msg: Message | dict) → None

Send a CAN message by placing it on the input queue.

Parameters:

msg (Message) – The CAN message to send.

Raises:

RuntimeError – If the related CAN process is not running.