phoenix6.canbus#
Module Contents#
- class phoenix6.canbus.CANBusStatus#
Contains status information about a CAN bus.
- status: phoenix6.status_code.StatusCode#
Status code response of getting the data
- bus_utilization: float = 0#
CAN bus utilization, from 0.0 to 1.0
- bus_off_count: int = 0#
Bus off count
- tx_full_count: int = 0#
Transmit buffer full count
- rec: int = 0#
Receive Error Counter (REC)
- tec: int = 0#
Transmit Error Counter (TEC)
- class phoenix6.canbus.CANBus#
Static class for getting information about available CAN buses.
- static is_network_fd(canbus: str) bool#
Gets whether the CAN bus is a CAN FD network.
- Parameters:
canbus (str) – Name of the CAN bus
- Returns:
True if the CAN bus is CAN FD
- Return type:
bool
- static get_status(canbus: str) CANBusStatus#
Gets the status of the CAN bus, including the bus utilization and the error counters.
- Parameters:
canbus (str) – Name of the CAN bus
- Returns:
Status of the CAN bus
- Return type: