Package com.ctre.phoenix.led

Class CANdleFaults

java.lang.Object
com.ctre.phoenix.led.CANdleFaults
@Deprecated(since="2026", forRemoval=true) public class CANdleFaults extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
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.

Faults the CANdle can have

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    CANdleFaults()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    CANdleFaults(int bits)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Updates current fault list with specified bit field of faults

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    hasAnyFault()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    long
    toBitfield()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    update(long bits)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • HardwareFault

      public boolean HardwareFault
      Deprecated, for removal: This API element is subject to removal in a future version.
      Device detects hardware failure

    • APIError

      public boolean APIError
      Deprecated, for removal: This API element is subject to removal in a future version.
      API error detected. Make sure API and firmware versions are compatible.

    • BootDuringEnable

      public boolean BootDuringEnable
      Deprecated, for removal: This API element is subject to removal in a future version.
      Boot while receiving an enable frame

    • VBatTooLow

      public boolean VBatTooLow
      Deprecated, for removal: This API element is subject to removal in a future version.
      VBat is under 5V

    • VBatTooHigh

      public boolean VBatTooHigh
      Deprecated, for removal: This API element is subject to removal in a future version.
      VBat is over 30V

    • V5TooLow

      public boolean V5TooLow
      Deprecated, for removal: This API element is subject to removal in a future version.
      5V Line is under 4 V

    • V5TooHigh

      public boolean V5TooHigh
      Deprecated, for removal: This API element is subject to removal in a future version.
      5V Line is over 6V

    • SoftwareFuse

      public boolean SoftwareFuse
      Deprecated, for removal: This API element is subject to removal in a future version.
      Exceeded output current of 6 amps

    • ThermalFault

      public boolean ThermalFault
      Deprecated, for removal: This API element is subject to removal in a future version.
      Device is over temperature

    • ShortCircuit

      public boolean ShortCircuit
      Deprecated, for removal: This API element is subject to removal in a future version.
      Output pin is shorted to something

  • Constructor Details

    • CANdleFaults

      public CANdleFaults(int bits)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Updates current fault list with specified bit field of faults
      Parameters:
      bits - bit field of faults to update with

    • CANdleFaults

      public CANdleFaults()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • hasAnyFault

      public boolean hasAnyFault()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      true if any faults are tripped

    • toBitfield

      public long toBitfield()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      Current fault list as a bit field

    • update

      public void update(long bits)
      Deprecated, for removal: This API element is subject to removal in a future version.