CTRE_Phoenix 5.20.2
ctre::phoenix::led::CANdleFaults Struct Reference

#include <CANdleFaults.h>

Public Member Functions

bool HasAnyFault () const
 
int ToBitfield () const
 
void Update (uint64_t bits)
 
 CANdleFaults (int bits)
 

Public Attributes

bool HardwareFault
 
bool APIError
 
bool BootDuringEnable
 
bool VBatTooLow
 
bool VBatTooHigh
 
bool V5TooLow
 
bool V5TooHigh
 
bool SoftwareFuse
 
bool ThermalFault
 
bool ShortCircuit
 

Detailed Description

Faults available to CANdle (Currently has none)

Constructor & Destructor Documentation

◆ CANdleFaults()

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

Updates current fault list with specified bit field of faults

Parameters
bitsbit field of faults to update with

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

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: