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

Public Member Functions

boolean hasAnyFault ()
 
int toBitfield ()
 
void update (int bits)
 
String toString ()
 

Public Attributes

boolean UnderVoltage
 
boolean ForwardLimitSwitch
 
boolean ReverseLimitSwitch
 
boolean ForwardSoftLimit
 
boolean ReverseSoftLimit
 
boolean HardwareFailure
 
boolean ResetDuringEn
 
boolean SensorOverflow
 
boolean SensorOutOfPhase
 
boolean HardwareESDReset
 
boolean RemoteLossOfSignal
 
boolean APIError
 
boolean SupplyOverV
 
boolean SupplyUnstable
 

Detailed Description

All the faults available to motor controllers

Member Function Documentation

◆ hasAnyFault()

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

◆ toBitfield()

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

◆ toString()

String com.ctre.phoenix.motorcontrol.Faults.toString ( )
inline
Returns
string representation of current faults tripped

◆ update()

void com.ctre.phoenix.motorcontrol.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

◆ APIError

boolean com.ctre.phoenix.motorcontrol.Faults.APIError

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

◆ ForwardLimitSwitch

boolean com.ctre.phoenix.motorcontrol.Faults.ForwardLimitSwitch

Forward limit switch is tripped and device is trying to go forward Only trips when the device is limited

◆ ForwardSoftLimit

boolean com.ctre.phoenix.motorcontrol.Faults.ForwardSoftLimit

Sensor is beyond forward soft limit and device is trying to go forward Only trips when the device is limited

◆ HardwareESDReset

boolean com.ctre.phoenix.motorcontrol.Faults.HardwareESDReset

Not used,

See also
ResetDuringEn

◆ HardwareFailure

boolean com.ctre.phoenix.motorcontrol.Faults.HardwareFailure

Device detects hardware failure

◆ RemoteLossOfSignal

boolean com.ctre.phoenix.motorcontrol.Faults.RemoteLossOfSignal

Remote Sensor is no longer detected on bus

◆ ResetDuringEn

boolean com.ctre.phoenix.motorcontrol.Faults.ResetDuringEn

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

◆ ReverseLimitSwitch

boolean com.ctre.phoenix.motorcontrol.Faults.ReverseLimitSwitch

Reverse limit switch is tripped and device is trying to go reverse Only trips when the device is limited

◆ ReverseSoftLimit

boolean com.ctre.phoenix.motorcontrol.Faults.ReverseSoftLimit

Sensor is beyond reverse soft limit and device is trying to go reverse Only trips when the device is limited

◆ SensorOutOfPhase

boolean com.ctre.phoenix.motorcontrol.Faults.SensorOutOfPhase

Device detects its sensor is out of phase

◆ SensorOverflow

boolean com.ctre.phoenix.motorcontrol.Faults.SensorOverflow

Device's sensor overflowed

◆ SupplyOverV

boolean com.ctre.phoenix.motorcontrol.Faults.SupplyOverV

Supply is well above the rated voltage of the hardware. This fault is specific to Brushless.

◆ SupplyUnstable

boolean com.ctre.phoenix.motorcontrol.Faults.SupplyUnstable

Supply is rapidly fluctuating and unstable. This fault is specific to Brushless.

◆ UnderVoltage

boolean com.ctre.phoenix.motorcontrol.Faults.UnderVoltage

Motor Controller is under 6.5V

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