Pigeon2_StickyFaults

class phoenix5.sensors.Pigeon2_StickyFaults(*args, **kwargs)

Bases: pybind11_object

Sticky faults available to Pigeon

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.

Deprecated:

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.

Overloaded function.

  1. __init__(self: phoenix5._ctre.sensors.Pigeon2_StickyFaults, bits: int) -> None

Creates fault list with specified bit field of faults

Parameters:

bits – bit field of faults to update with

  1. __init__(self: phoenix5._ctre.sensors.Pigeon2_StickyFaults) -> None

property APIError

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

property AccelFault

The Accelerometer failed its self-test. This is likely due to hardware damage, oftentimes from exposing the Pigeon to a very large impact.

property BootIntoMotion

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.

property GyroFault

The gyro failed its self-test. This is likely due to hardware damage.

property HardwareFault

Device detects hardware failure

property MagnetometerFault

The magnetometer failed its self-test. This is likely due to hardware damage, oftentimes from exposing the Pigeon to a very large magnetic field.

property ResetDuringEn

Device was powered-on or reset while robot is enabled. Check your breakers and wiring.

property SaturatedAccel

The device saw an acceleration that exceeded its maximum. Increase the range or avoid high-g events.

property SaturatedMag

The device saw a magnetic field that exceeded its maximum. Keep the device far from strong magnetic fields.

property SaturatedRotVelocity

The device rotated at a rate that exceeded its maximum. Increase the range or slow the rate of rotation.

property UnderVoltage

Device is under 6.5V

hasAnyFault() → bool
Returns:

true if any faults are tripped

toBitfield() → int
Returns:

Current fault list as a bit field

update(bits: int) → None

Updates current fault list with specified bit field of faults

Parameters:

bits – bit field of faults to update with