ctre::phoenix::sensors::Pigeon2_StickyFaults Struct Reference

#include <Pigeon2_StickyFaults.h>

Public Member Functions
bool	HasAnyFault () const
uint64_t	ToBitfield () const
void	Update (uint64_t bits)
	Pigeon2_StickyFaults (uint64_t bits)

Public Attributes
bool	HardwareFault
bool	APIError
bool	UnderVoltage
bool	ResetDuringEn
bool	SaturatedRotVelocity
bool	SaturatedAccel
bool	SaturatedMag
bool	MotionDriverTookTooLong
bool	DataAcquiredLate
bool	BootIntoMotion
bool	MagnetometerFault
bool	GyroFault
bool	AccelFault

Detailed Description

Sticky faults available to Pigeon

Constructor & Destructor Documentation

Pigeon2_StickyFaults()

ctre::phoenix::sensors::Pigeon2_StickyFaults::Pigeon2_StickyFaults ( uint64_t  bits )

inline

Creates fault list with specified bit field of faults

Parameters

bits	bit field of faults to update with

Member Function Documentation

HasAnyFault()

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::HasAnyFault ( ) const

inline

Returns

true if any faults are tripped

ToBitfield()

uint64_t ctre::phoenix::sensors::Pigeon2_StickyFaults::ToBitfield ( ) const

inline

Returns

Current fault list as a bit field

Update()

void ctre::phoenix::sensors::Pigeon2_StickyFaults::Update ( uint64_t  bits )

inline

Updates current fault list with specified bit field of faults

Parameters

bits	bit field of faults to update with

Member Data Documentation

AccelFault

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::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

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::APIError

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

BootIntoMotion

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::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

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::DataAcquiredLate

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

GyroFault

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::GyroFault

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

HardwareFault

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::HardwareFault

Device detects hardware failure

MagnetometerFault

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::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

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::MotionDriverTookTooLong

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

ResetDuringEn

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::ResetDuringEn

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

SaturatedAccel

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::SaturatedAccel

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

SaturatedMag

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::SaturatedMag

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

SaturatedRotVelocity

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::SaturatedRotVelocity

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

UnderVoltage

bool ctre::phoenix::sensors::Pigeon2_StickyFaults::UnderVoltage

Device is under 6.5V

---

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

• Phoenix-cci/src/main/native/include/ctre/phoenix/sensors/Pigeon2_StickyFaults.h