com.ctre.phoenix.led.CANdleFaults Class Reference

Public Member Functions
boolean	hasAnyFault ()
long	toBitfield ()
void	update (long bits)
	CANdleFaults (int bits)

Public Attributes
boolean	HardwareFault
boolean	APIError
boolean	BootDuringEnable
boolean	VBatTooLow
boolean	VBatTooHigh
boolean	V5TooLow
boolean	V5TooHigh
boolean	SoftwareFuse
boolean	ThermalFault
boolean	ShortCircuit

Detailed Description

Faults the CANdle can have

Constructor & Destructor Documentation

CANdleFaults()

com.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

Member Function Documentation

hasAnyFault()

boolean com.ctre.phoenix.led.CANdleFaults.hasAnyFault ( )

inline

Returns

true if any faults are tripped

toBitfield()

long com.ctre.phoenix.led.CANdleFaults.toBitfield ( )

inline

Returns

Current fault list as a bit field

Member Data Documentation

APIError

boolean com.ctre.phoenix.led.CANdleFaults.APIError

API error detected. Make sure API and firmware versions are compatible.

BootDuringEnable

boolean com.ctre.phoenix.led.CANdleFaults.BootDuringEnable

Boot while receiving an enable frame

HardwareFault

boolean com.ctre.phoenix.led.CANdleFaults.HardwareFault

Device detects hardware failure

ShortCircuit

boolean com.ctre.phoenix.led.CANdleFaults.ShortCircuit

Output pin is shorted to something

SoftwareFuse

boolean com.ctre.phoenix.led.CANdleFaults.SoftwareFuse

Exceeded output current of 6 amps

ThermalFault

boolean com.ctre.phoenix.led.CANdleFaults.ThermalFault

Device is over temperature

V5TooHigh

boolean com.ctre.phoenix.led.CANdleFaults.V5TooHigh

5V Line is over 6V

V5TooLow

boolean com.ctre.phoenix.led.CANdleFaults.V5TooLow

5V Line is under 4 V

VBatTooHigh

boolean com.ctre.phoenix.led.CANdleFaults.VBatTooHigh

VBat is over 30V

VBatTooLow

boolean com.ctre.phoenix.led.CANdleFaults.VBatTooLow

VBat is under 5V

---

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

• Phoenix-api/java/src/main/java/com/ctre/phoenix/led/CANdleFaults.java