CANdleFaults (CTRE Phoenix Java 5.33.1)

java.lang.Object

com.ctre.phoenix.led.CANdleFaults

public class CANdleFaults
extends Object

Faults the CANdle can have

Field Summary

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

Constructor Summary

Constructors

Constructor Description

CANdleFaults()

CANdleFaults(int bits)
Updates current fault list with specified bit field of faults
Method Summary

Modifier and Type Method Description

boolean hasAnyFault()

long toBitfield()

void update(long bits)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- HardwareFault
  
  public boolean HardwareFault
  
  Device detects hardware failure
- APIError
  
  public boolean APIError
  
  API error detected. Make sure API and firmware versions are compatible.
- BootDuringEnable
  
  public boolean BootDuringEnable
  
  Boot while receiving an enable frame
- VBatTooLow
  
  public boolean VBatTooLow
  
  VBat is under 5V
- VBatTooHigh
  
  public boolean VBatTooHigh
  
  VBat is over 30V
- V5TooLow
  
  public boolean V5TooLow
  
  5V Line is under 4 V
- V5TooHigh
  
  public boolean V5TooHigh
  
  5V Line is over 6V
- SoftwareFuse
  
  public boolean SoftwareFuse
  
  Exceeded output current of 6 amps
- ThermalFault
  
  public boolean ThermalFault
  
  Device is over temperature
- ShortCircuit
  
  public boolean ShortCircuit
  
  Output pin is shorted to something
Constructor Details
- CANdleFaults
  
  public CANdleFaults(int bits)
  
  Updates current fault list with specified bit field of faults
  
  Parameters:
  
  bits - bit field of faults to update with
- CANdleFaults
  
  public CANdleFaults()
Method Details
- hasAnyFault
  
  public boolean hasAnyFault()
  
  Returns:
  
  true if any faults are tripped
- toBitfield
  
  public long toBitfield()
  
  Returns:
  
  Current fault list as a bit field
- update
  
  public void update(long bits)