CTRE_Phoenix 5.20.2
Public Member Functions | Public Attributes | List of all members
com.ctre.phoenix.sensors.Pigeon2_Faults Class Reference

Public Member Functions

boolean hasAnyFault ()
 
int toBitfield ()
 
void update (int bits)
 
 Pigeon2_Faults (int bits)
 

Public Attributes

boolean HardwareFault
 
boolean APIError
 
boolean UnderVoltage
 
boolean ResetDuringEn
 
boolean SaturatedRotVelocity
 
boolean SaturatedAccel
 
boolean SaturatedMag
 
boolean MotionDriverTookTooLong
 
boolean DataAcquiredLate
 
boolean BootIntoMotion
 
boolean MagnetometerFault
 
boolean GyroFault
 
boolean AccelFault
 

Detailed Description

Faults available to Pigeon (Currently has none)

Member Function Documentation

◆ hasAnyFault()

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.hasAnyFault ( )
inline
Returns
true if any faults are tripped

◆ toBitfield()

int com.ctre.phoenix.sensors.Pigeon2_Faults.toBitfield ( )
inline
Returns
Current fault list as a bit field

◆ update()

void com.ctre.phoenix.sensors.Pigeon2_Faults.update ( int  bits)
inline

Updates current fault list with specified bit field of faults

Parameters
bitsbit field of faults to update with

Member Data Documentation

◆ AccelFault

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.AccelFault

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

◆ APIError

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.APIError

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

◆ BootIntoMotion

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.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.

◆ DataAcquiredLate

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.DataAcquiredLate

The Pigeon missed an opportunity to acquire data. This is typical when calibrating.

◆ GyroFault

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.GyroFault

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

◆ HardwareFault

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.HardwareFault

Device detects hardware failure

◆ MagnetometerFault

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.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.

◆ MotionDriverTookTooLong

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.MotionDriverTookTooLong

The Motion Driver Software took too long to complete. This is typical when calibrating.

◆ ResetDuringEn

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.ResetDuringEn

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

◆ SaturatedAccel

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.SaturatedAccel

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

◆ SaturatedMag

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.SaturatedMag

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

◆ SaturatedRotVelocity

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.SaturatedRotVelocity

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

◆ UnderVoltage

boolean com.ctre.phoenix.sensors.Pigeon2_Faults.UnderVoltage

Device is under 6.5V

The documentation for this class was generated from the following file: