Contains status information about a CAN bus. More...

#include <ctre/phoenix6/CANBus.hpp>

Public Member Functions
std::string	ToString () const

Public Attributes
ctre::phoenix::StatusCode	Status
	Status code response of getting the data.
wpi::units::unit_t< wpi::units::scalar, float >	BusUtilization
	CAN bus utilization, from 0.0 to 1.0.
uint32_t	BusErrorCount
	Bus error count.
uint32_t	ArbitrationLostCount
	Arbitration lost count.
uint32_t	RestartCount
	Restart count.
uint32_t	BusOffCount
	Bus off count.
uint32_t	TxFullCount
	Transmit buffer full count.
uint16_t	REC
	Receive Error Counter (REC).
uint16_t	TEC
	Transmit Error Counter (TEC).
CANState	State
	CAN state.

Friends
std::ostream &	operator<< (std::ostream &os, CANBusStatus const &status)

Detailed Description

Contains status information about a CAN bus.

Member Function Documentation

◆ ToString()

std::string ctre::phoenix6::CANBusStatus::ToString ( ) const

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		CANBusStatus const &	status )

friend

Member Data Documentation

◆ ArbitrationLostCount

uint32_t ctre::phoenix6::CANBusStatus::ArbitrationLostCount

Arbitration lost count.

◆ BusErrorCount

uint32_t ctre::phoenix6::CANBusStatus::BusErrorCount

Bus error count.

◆ BusOffCount

uint32_t ctre::phoenix6::CANBusStatus::BusOffCount

Bus off count.

◆ BusUtilization

wpi::units::unit_t<wpi::units::scalar, float> ctre::phoenix6::CANBusStatus::BusUtilization

CAN bus utilization, from 0.0 to 1.0.

◆ REC

uint16_t ctre::phoenix6::CANBusStatus::REC

Receive Error Counter (REC).

◆ RestartCount

uint32_t ctre::phoenix6::CANBusStatus::RestartCount

Restart count.

◆ State

CANState ctre::phoenix6::CANBusStatus::State

CAN state.

◆ Status

ctre::phoenix::StatusCode ctre::phoenix6::CANBusStatus::Status

Status code response of getting the data.

◆ TEC

uint16_t ctre::phoenix6::CANBusStatus::TEC

Transmit Error Counter (TEC).

◆ TxFullCount

uint32_t ctre::phoenix6::CANBusStatus::TxFullCount

Transmit buffer full count.

The documentation for this struct was generated from the following file:

ctre/phoenix6/CANBus.hpp

Public Member Functions

Public Attributes

Friends