Package com.ctre.phoenix.sensors

Class Pigeon2_Faults

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

  • Field Summary

    Fields 
    Modifier and Type Field Description
    boolean AccelFault
    Deprecated, for removal: This API element is subject to removal in a future version.
    The Accelerometer failed its self-test.
    boolean APIError
    Deprecated, for removal: This API element is subject to removal in a future version.
    API error detected.
    boolean BootIntoMotion
    Deprecated, for removal: This API element is subject to removal in a future version.
    /** The Pigeon saw motion as soon as it booted, and didn't attempt to self-test its features.
    boolean GyroFault
    Deprecated, for removal: This API element is subject to removal in a future version.
    The gyro failed its self-test.
    boolean HardwareFault
    Deprecated, for removal: This API element is subject to removal in a future version.
    Device detects hardware failure
    boolean MagnetometerFault
    Deprecated, for removal: This API element is subject to removal in a future version.
    The magnetometer failed its self-test.
    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 SaturatedAccel
    Deprecated, for removal: This API element is subject to removal in a future version.
    The device saw an acceleration that exceeded its maximum.
    boolean SaturatedMag
    Deprecated, for removal: This API element is subject to removal in a future version.
    The device saw a magnetic field that exceeded its maximum.
    boolean SaturatedRotVelocity
    Deprecated, for removal: This API element is subject to removal in a future version.
    The device rotated at a rate that exceeded its maximum.
    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
    Pigeon2_Faults()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Pigeon2_Faults​(int bits)
    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.

    • SaturatedRotVelocity

      public boolean SaturatedRotVelocity
      Deprecated, for removal: This API element is subject to removal in a future version.
      The device rotated at a rate that exceeded its maximum. Increase the range or slow the rate of rotation.

    • SaturatedAccel

      public boolean SaturatedAccel
      Deprecated, for removal: This API element is subject to removal in a future version.
      The device saw an acceleration that exceeded its maximum. Increase the range or avoid high-g events.

    • SaturatedMag

      public boolean SaturatedMag
      Deprecated, for removal: This API element is subject to removal in a future version.
      The device saw a magnetic field that exceeded its maximum. Keep the device far from strong magnetic fields.

    • BootIntoMotion

      public boolean BootIntoMotion
      Deprecated, for removal: This API element is subject to removal in a future version.
      /** The Pigeon saw motion as soon as it booted, and didn't attempt to self-test its features. This isn't an issue, but to prevent this don't turn the robot on while moving it.

    • MagnetometerFault

      public boolean MagnetometerFault
      Deprecated, for removal: This API element is subject to removal in a future version.
      The magnetometer failed its self-test. This is likely due to hardware damage, oftentimes from exposing the Pigeon to a very large magnetic field.

    • GyroFault

      public boolean GyroFault
      Deprecated, for removal: This API element is subject to removal in a future version.
      The gyro failed its self-test. This is likely due to hardware damage.

    • AccelFault

      public boolean AccelFault
      Deprecated, for removal: This API element is subject to removal in a future version.
      The Accelerometer failed its self-test. This is likely due to hardware damage, oftentimes from exposing the Pigeon to a very large impact.

  • Constructor Details

  • 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