WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
frc::RobotController Class Reference

Static Public Member Functions

static int GetFPGAVersion ()
 Return the FPGA Version number. More...
 
static int64_t GetFPGARevision ()
 Return the FPGA Revision number. More...
 
static uint64_t GetFPGATime ()
 Read the microsecond-resolution timer on the FPGA. More...
 
static bool GetUserButton ()
 Get the state of the "USER" button on the roboRIO. More...
 
static bool IsSysActive ()
 Check if the FPGA outputs are enabled. More...
 
static bool IsBrownedOut ()
 Check if the system is browned out. More...
 
static double GetInputVoltage ()
 Get the input voltage to the robot controller. More...
 
static double GetInputCurrent ()
 Get the input current to the robot controller. More...
 
static double GetVoltage3V3 ()
 Get the voltage of the 3.3V rail. More...
 
static double GetCurrent3V3 ()
 Get the current output of the 3.3V rail. More...
 
static bool GetEnabled3V3 ()
 Get the enabled state of the 3.3V rail. More...
 
static int GetFaultCount3V3 ()
 Get the count of the total current faults on the 3.3V rail since the controller has booted. More...
 
static double GetVoltage5V ()
 Get the voltage of the 5V rail. More...
 
static double GetCurrent5V ()
 Get the current output of the 5V rail. More...
 
static bool GetEnabled5V ()
 Get the enabled state of the 5V rail. More...
 
static int GetFaultCount5V ()
 Get the count of the total current faults on the 5V rail since the controller has booted. More...
 
static double GetVoltage6V ()
 Get the voltage of the 6V rail. More...
 
static double GetCurrent6V ()
 Get the current output of the 6V rail. More...
 
static bool GetEnabled6V ()
 Get the enabled state of the 6V rail. More...
 
static int GetFaultCount6V ()
 Get the count of the total current faults on the 6V rail since the controller has booted. More...
 
static CANStatus GetCANStatus ()
 

Member Function Documentation

static double frc::RobotController::GetCurrent3V3 ( )
static

Get the current output of the 3.3V rail.

Returns
The controller 3.3V rail output current value in Amps
static double frc::RobotController::GetCurrent5V ( )
static

Get the current output of the 5V rail.

Returns
The controller 5V rail output current value in Amps
static double frc::RobotController::GetCurrent6V ( )
static

Get the current output of the 6V rail.

Returns
The controller 6V rail output current value in Amps
static bool frc::RobotController::GetEnabled3V3 ( )
static

Get the enabled state of the 3.3V rail.

The rail may be disabled due to a controller brownout, a short circuit on the rail, or controller over-voltage.

Returns
The controller 3.3V rail enabled value. True for enabled.
static bool frc::RobotController::GetEnabled5V ( )
static

Get the enabled state of the 5V rail.

The rail may be disabled due to a controller brownout, a short circuit on the rail, or controller over-voltage.

Returns
The controller 5V rail enabled value. True for enabled.
static bool frc::RobotController::GetEnabled6V ( )
static

Get the enabled state of the 6V rail.

The rail may be disabled due to a controller brownout, a short circuit on the rail, or controller over-voltage.

Returns
The controller 6V rail enabled value. True for enabled.
static int frc::RobotController::GetFaultCount3V3 ( )
static

Get the count of the total current faults on the 3.3V rail since the controller has booted.

Returns
The number of faults
static int frc::RobotController::GetFaultCount5V ( )
static

Get the count of the total current faults on the 5V rail since the controller has booted.

Returns
The number of faults
static int frc::RobotController::GetFaultCount6V ( )
static

Get the count of the total current faults on the 6V rail since the controller has booted.

Returns
The number of faults.
static int64_t frc::RobotController::GetFPGARevision ( )
static

Return the FPGA Revision number.

The format of the revision is 3 numbers. The 12 most significant bits are the Major Revision. The next 8 bits are the Minor Revision. The 12 least significant bits are the Build Number.

Returns
FPGA Revision number.
static uint64_t frc::RobotController::GetFPGATime ( )
static

Read the microsecond-resolution timer on the FPGA.

Returns
The current time in microseconds according to the FPGA (since FPGA reset).
static int frc::RobotController::GetFPGAVersion ( )
static

Return the FPGA Version number.

For now, expect this to be competition year.

Returns
FPGA Version number.
static double frc::RobotController::GetInputCurrent ( )
static

Get the input current to the robot controller.

Returns
The controller input current value in Amps
static double frc::RobotController::GetInputVoltage ( )
static

Get the input voltage to the robot controller.

Returns
The controller input voltage value in Volts
static bool frc::RobotController::GetUserButton ( )
static

Get the state of the "USER" button on the roboRIO.

Returns
True if the button is currently pressed down
static double frc::RobotController::GetVoltage3V3 ( )
static

Get the voltage of the 3.3V rail.

Returns
The controller 3.3V rail voltage value in Volts
static double frc::RobotController::GetVoltage5V ( )
static

Get the voltage of the 5V rail.

Returns
The controller 5V rail voltage value in Volts
static double frc::RobotController::GetVoltage6V ( )
static

Get the voltage of the 6V rail.

Returns
The controller 6V rail voltage value in Volts
static bool frc::RobotController::IsBrownedOut ( )
static

Check if the system is browned out.

Returns
True if the system is browned out
static bool frc::RobotController::IsSysActive ( )
static

Check if the FPGA outputs are enabled.

The outputs may be disabled if the robot is disabled or e-stopped, the watchdog has expired, or if the roboRIO browns out.

Returns
True if the FPGA outputs are enabled.

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