ctre::phoenix::led::CANdleFaults Struct Reference

Faults available to CANdle. More...

#include <ctre/phoenix/led/CANdleFaults.h>

Public Member Functions
bool	HasAnyFault () const
int	ToBitfield () const
void	Update (uint64_t bits)
	CANdleFaults (int bits)
	Updates current fault list with specified bit field of faults.
	CANdleFaults ()

Public Attributes
bool	HardwareFault
	Device detects hardware failure.
bool	APIError
	API error detected.
bool	BootDuringEnable
	Boot while receiving an enable frame.
bool	VBatTooLow
	VBat is under 5V.
bool	VBatTooHigh
	VBat is over 30V.
bool	V5TooLow
	5V Line is under 4 V
bool	V5TooHigh
	5V Line is over 6V
bool	SoftwareFuse
	Exceeded output current of 6 amps.
bool	ThermalFault
	Device is over temperature.
bool	ShortCircuit
	Output pin is shorted to something.

Detailed Description

Faults available to CANdle.

Deprecated

This device's Phoenix 5 API is deprecated for removal in the 2027 season. Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API. A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.

If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.

Constructor & Destructor Documentation

CANdleFaults() [1/2]

ctre::phoenix::led::CANdleFaults::CANdleFaults ( int bits )

inline

Updates current fault list with specified bit field of faults.

Parameters

bits	bit field of faults to update with

CANdleFaults() [2/2]

ctre::phoenix::led::CANdleFaults::CANdleFaults ( )

inline

Member Function Documentation

HasAnyFault()

bool ctre::phoenix::led::CANdleFaults::HasAnyFault ( ) const

inline

Returns

true if any faults are tripped

ToBitfield()

int ctre::phoenix::led::CANdleFaults::ToBitfield ( ) const

inline

Returns

Current fault list as a bit field

Update()

void ctre::phoenix::led::CANdleFaults::Update ( uint64_t bits )

inline

Member Data Documentation

APIError

bool ctre::phoenix::led::CANdleFaults::APIError

API error detected.

Make sure API and firmware versions are compatible.

BootDuringEnable

bool ctre::phoenix::led::CANdleFaults::BootDuringEnable

Boot while receiving an enable frame.

HardwareFault

bool ctre::phoenix::led::CANdleFaults::HardwareFault

Device detects hardware failure.

ShortCircuit

bool ctre::phoenix::led::CANdleFaults::ShortCircuit

Output pin is shorted to something.

SoftwareFuse

bool ctre::phoenix::led::CANdleFaults::SoftwareFuse

Exceeded output current of 6 amps.

ThermalFault

bool ctre::phoenix::led::CANdleFaults::ThermalFault

Device is over temperature.

V5TooHigh

bool ctre::phoenix::led::CANdleFaults::V5TooHigh

5V Line is over 6V

V5TooLow

bool ctre::phoenix::led::CANdleFaults::V5TooLow

5V Line is under 4 V

VBatTooHigh

bool ctre::phoenix::led::CANdleFaults::VBatTooHigh

VBat is over 30V.

VBatTooLow

bool ctre::phoenix::led::CANdleFaults::VBatTooLow

VBat is under 5V.

---

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

• ctre/phoenix/led/CANdleFaults.h