Package com.ctre.phoenix.sensors

Class CANCoderFaults

java.lang.Object
com.ctre.phoenix.sensors.CANCoderFaults
@Deprecated(since="2024", forRemoval=true) public class CANCoderFaults 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 2025 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 available to CANCoder (Currently has none)

  • 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
    HardwareFault
    Deprecated, for removal: This API element is subject to removal in a future version.
    Device detects hardware failure
    boolean
    MagnetTooWeak
    Deprecated, for removal: This API element is subject to removal in a future version.
    Magnet strength is too weak to provide reliable results Make sure CANCoder is close to the magnet being used
    boolean
    ResetDuringEn
    Deprecated, for removal: This API element is subject to removal in a future version.
    Device was powered-on or reset while robot is enabled.
    boolean
    UnderVoltage
    Deprecated, for removal: This API element is subject to removal in a future version.
    Device is under 6.5V

  • Constructor Summary

    Constructors
    Constructor
    Description
    CANCoderFaults()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    hasAnyFault()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    toBitfield()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    update(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

    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.

    • UnderVoltage

      public boolean UnderVoltage
      Deprecated, for removal: This API element is subject to removal in a future version.
      Device is under 6.5V

    • ResetDuringEn

      public boolean ResetDuringEn
      Deprecated, for removal: This API element is subject to removal in a future version.
      Device was powered-on or reset while robot is enabled. Check your breakers and wiring.

    • MagnetTooWeak

      public boolean MagnetTooWeak
      Deprecated, for removal: This API element is subject to removal in a future version.
      Magnet strength is too weak to provide reliable results Make sure CANCoder is close to the magnet being used

  • Constructor Details

    • CANCoderFaults

      public CANCoderFaults()
      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 int 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(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