A utility class to control a simulated RoboRIO. More...

#include <frc/simulation/RoboRioSim.h>

Static Public Member Functions
static std::unique_ptr< CallbackStore >	RegisterFPGAButtonCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run when the FPGA button state changes. More...

static bool	GetFPGAButton ()
	Query the state of the FPGA button. More...

static void	SetFPGAButton (bool fPGAButton)
	Define the state of the FPGA button. More...

static std::unique_ptr< CallbackStore >	RegisterVInVoltageCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the Vin voltage changes. More...

static units::volt_t	GetVInVoltage ()
	Measure the Vin voltage. More...

static void	SetVInVoltage (units::volt_t vInVoltage)
	Define the Vin voltage. More...

static std::unique_ptr< CallbackStore >	RegisterVInCurrentCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the Vin current changes. More...

static units::ampere_t	GetVInCurrent ()
	Measure the Vin current. More...

static void	SetVInCurrent (units::ampere_t vInCurrent)
	Define the Vin current. More...

static std::unique_ptr< CallbackStore >	RegisterUserVoltage6VCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 6V rail voltage changes. More...

static units::volt_t	GetUserVoltage6V ()
	Measure the 6V rail voltage. More...

static void	SetUserVoltage6V (units::volt_t userVoltage6V)
	Define the 6V rail voltage. More...

static std::unique_ptr< CallbackStore >	RegisterUserCurrent6VCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 6V rail current changes. More...

static units::ampere_t	GetUserCurrent6V ()
	Measure the 6V rail current. More...

static void	SetUserCurrent6V (units::ampere_t userCurrent6V)
	Define the 6V rail current. More...

static std::unique_ptr< CallbackStore >	RegisterUserActive6VCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 6V rail active state changes. More...

static bool	GetUserActive6V ()
	Get the 6V rail active state. More...

static void	SetUserActive6V (bool userActive6V)
	Set the 6V rail active state. More...

static std::unique_ptr< CallbackStore >	RegisterUserVoltage5VCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 5V rail voltage changes. More...

static units::volt_t	GetUserVoltage5V ()
	Measure the 5V rail voltage. More...

static void	SetUserVoltage5V (units::volt_t userVoltage5V)
	Define the 5V rail voltage. More...

static std::unique_ptr< CallbackStore >	RegisterUserCurrent5VCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 5V rail current changes. More...

static units::ampere_t	GetUserCurrent5V ()
	Measure the 5V rail current. More...

static void	SetUserCurrent5V (units::ampere_t userCurrent5V)
	Define the 5V rail current. More...

static std::unique_ptr< CallbackStore >	RegisterUserActive5VCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 5V rail active state changes. More...

static bool	GetUserActive5V ()
	Get the 5V rail active state. More...

static void	SetUserActive5V (bool userActive5V)
	Set the 5V rail active state. More...

static std::unique_ptr< CallbackStore >	RegisterUserVoltage3V3Callback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 3.3V rail voltage changes. More...

static units::volt_t	GetUserVoltage3V3 ()
	Measure the 3.3V rail voltage. More...

static void	SetUserVoltage3V3 (units::volt_t userVoltage3V3)
	Define the 3.3V rail voltage. More...

static std::unique_ptr< CallbackStore >	RegisterUserCurrent3V3Callback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 3.3V rail current changes. More...

static units::ampere_t	GetUserCurrent3V3 ()
	Measure the 3.3V rail current. More...

static void	SetUserCurrent3V3 (units::ampere_t userCurrent3V3)
	Define the 3.3V rail current. More...

static std::unique_ptr< CallbackStore >	RegisterUserActive3V3Callback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 3.3V rail active state changes. More...

static bool	GetUserActive3V3 ()
	Get the 3.3V rail active state. More...

static void	SetUserActive3V3 (bool userActive3V3)
	Set the 3.3V rail active state. More...

static std::unique_ptr< CallbackStore >	RegisterUserFaults6VCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 6V rail number of faults changes. More...

static int	GetUserFaults6V ()
	Get the 6V rail number of faults. More...

static void	SetUserFaults6V (int userFaults6V)
	Set the 6V rail number of faults. More...

static std::unique_ptr< CallbackStore >	RegisterUserFaults5VCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 5V rail number of faults changes. More...

static int	GetUserFaults5V ()
	Get the 5V rail number of faults. More...

static void	SetUserFaults5V (int userFaults5V)
	Set the 5V rail number of faults. More...

static std::unique_ptr< CallbackStore >	RegisterUserFaults3V3Callback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the 3.3V rail number of faults changes. More...

static int	GetUserFaults3V3 ()
	Get the 3.3V rail number of faults. More...

static void	SetUserFaults3V3 (int userFaults3V3)
	Set the 3.3V rail number of faults. More...

static std::unique_ptr< CallbackStore >	RegisterBrownoutVoltageCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the brownout voltage changes. More...

static units::volt_t	GetBrownoutVoltage ()
	Measure the brownout voltage. More...

static void	SetBrownoutVoltage (units::volt_t brownoutVoltage)
	Define the brownout voltage. More...

static std::string	GetSerialNumber ()
	Get the serial number. More...

static void	SetSerialNumber (std::string_view serialNumber)
	Set the serial number. More...

static std::string	GetComments ()
	Get the comments. More...

static void	SetComments (std::string_view comments)
	Set the comments. More...

static void	ResetData ()
	Reset all simulation data. More...

Detailed Description

A utility class to control a simulated RoboRIO.

Member Function Documentation

◆ GetBrownoutVoltage()

static units::volt_t frc::sim::RoboRioSim::GetBrownoutVoltage ( )

static

Measure the brownout voltage.

Returns: the brownout voltage

◆ GetComments()

static std::string frc::sim::RoboRioSim::GetComments ( )

static

Get the comments.

Returns: The comments.

◆ GetFPGAButton()

static bool frc::sim::RoboRioSim::GetFPGAButton ( )

static

Query the state of the FPGA button.

Returns: the FPGA button state

◆ GetSerialNumber()

static std::string frc::sim::RoboRioSim::GetSerialNumber ( )

static

Get the serial number.

Returns: The serial number.

◆ GetUserActive3V3()

static bool frc::sim::RoboRioSim::GetUserActive3V3 ( )

static

Get the 3.3V rail active state.

Returns: true if the 3.3V rail is active

◆ GetUserActive5V()

static bool frc::sim::RoboRioSim::GetUserActive5V ( )

static

Get the 5V rail active state.

Returns: true if the 5V rail is active

◆ GetUserActive6V()

static bool frc::sim::RoboRioSim::GetUserActive6V ( )

static

Get the 6V rail active state.

Returns: true if the 6V rail is active

◆ GetUserCurrent3V3()

static units::ampere_t frc::sim::RoboRioSim::GetUserCurrent3V3 ( )

static

Measure the 3.3V rail current.

Returns: the 3.3V rail current

◆ GetUserCurrent5V()

static units::ampere_t frc::sim::RoboRioSim::GetUserCurrent5V ( )

static

Measure the 5V rail current.

Returns: the 5V rail current

◆ GetUserCurrent6V()

static units::ampere_t frc::sim::RoboRioSim::GetUserCurrent6V ( )

static

Measure the 6V rail current.

Returns: the 6V rail current

◆ GetUserFaults3V3()

static int frc::sim::RoboRioSim::GetUserFaults3V3 ( )

static

Get the 3.3V rail number of faults.

Returns: number of faults

◆ GetUserFaults5V()

static int frc::sim::RoboRioSim::GetUserFaults5V ( )

static

Get the 5V rail number of faults.

Returns: number of faults

◆ GetUserFaults6V()

static int frc::sim::RoboRioSim::GetUserFaults6V ( )

static

Get the 6V rail number of faults.

Returns: number of faults

◆ GetUserVoltage3V3()

static units::volt_t frc::sim::RoboRioSim::GetUserVoltage3V3 ( )

static

Measure the 3.3V rail voltage.

Returns: the 3.3V rail voltage

◆ GetUserVoltage5V()

static units::volt_t frc::sim::RoboRioSim::GetUserVoltage5V ( )

static

Measure the 5V rail voltage.

Returns: the 5V rail voltage

◆ GetUserVoltage6V()

static units::volt_t frc::sim::RoboRioSim::GetUserVoltage6V ( )

static

Measure the 6V rail voltage.

Returns: the 6V rail voltage

◆ GetVInCurrent()

static units::ampere_t frc::sim::RoboRioSim::GetVInCurrent ( )

static

Measure the Vin current.

Returns: the Vin current

◆ GetVInVoltage()

static units::volt_t frc::sim::RoboRioSim::GetVInVoltage ( )

static

Measure the Vin voltage.

Returns: the Vin voltage

◆ RegisterBrownoutVoltageCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterBrownoutVoltageCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the brownout voltage changes.

Parameters

callback	the callback
initialNotify	whether to call the callback with the initial state

Returns: the CallbackStore object associated with this callback

◆ RegisterFPGAButtonCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterFPGAButtonCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run when the FPGA button state changes.

Parameters

callback	the callback
initialNotify	whether to run the callback with the initial state

Returns: the CallbackStore object associated with this callback

◆ RegisterUserActive3V3Callback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserActive3V3Callback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 3.3V rail active state changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial state

Returns: the CallbackStore object associated with this callback

◆ RegisterUserActive5VCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserActive5VCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 5V rail active state changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial state

Returns: the CallbackStore object associated with this callback

◆ RegisterUserActive6VCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserActive6VCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 6V rail active state changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial state

Returns: the CallbackStore object associated with this callback

◆ RegisterUserCurrent3V3Callback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserCurrent3V3Callback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 3.3V rail current changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterUserCurrent5VCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserCurrent5VCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 5V rail current changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterUserCurrent6VCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserCurrent6VCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 6V rail current changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterUserFaults3V3Callback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserFaults3V3Callback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 3.3V rail number of faults changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterUserFaults5VCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserFaults5VCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 5V rail number of faults changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterUserFaults6VCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserFaults6VCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 6V rail number of faults changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterUserVoltage3V3Callback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserVoltage3V3Callback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 3.3V rail voltage changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterUserVoltage5VCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserVoltage5VCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 5V rail voltage changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterUserVoltage6VCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterUserVoltage6VCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the 6V rail voltage changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterVInCurrentCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterVInCurrentCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the Vin current changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns: the CallbackStore object associated with this callback

◆ RegisterVInVoltageCallback()

static std::unique_ptr< CallbackStore > frc::sim::RoboRioSim::RegisterVInVoltageCallback	(	NotifyCallback	callback,
		bool	initialNotify
	)

static

Register a callback to be run whenever the Vin voltage changes.

Parameters

callback	the callback
initialNotify	whether to call the callback with the initial state

Returns: the CallbackStore object associated with this callback

◆ ResetData()

static void frc::sim::RoboRioSim::ResetData ( )

static

Reset all simulation data.

◆ SetBrownoutVoltage()

static void frc::sim::RoboRioSim::SetBrownoutVoltage ( units::volt_t brownoutVoltage )

static

Define the brownout voltage.

Parameters

brownoutVoltage the new voltage

◆ SetComments()

static void frc::sim::RoboRioSim::SetComments ( std::string_view comments )

static

Set the comments.

Parameters

comments The comments.

◆ SetFPGAButton()

static void frc::sim::RoboRioSim::SetFPGAButton ( bool fPGAButton )

static

Define the state of the FPGA button.

Parameters

fPGAButton the new state

◆ SetSerialNumber()

static void frc::sim::RoboRioSim::SetSerialNumber ( std::string_view serialNumber )

static

Set the serial number.

Parameters

serialNumber The serial number.

◆ SetUserActive3V3()

static void frc::sim::RoboRioSim::SetUserActive3V3 ( bool userActive3V3 )

static

Set the 3.3V rail active state.

Parameters

userActive3V3 true to make rail active

◆ SetUserActive5V()

static void frc::sim::RoboRioSim::SetUserActive5V ( bool userActive5V )

static

Set the 5V rail active state.

Parameters

userActive5V true to make rail active

◆ SetUserActive6V()

static void frc::sim::RoboRioSim::SetUserActive6V ( bool userActive6V )

static

Set the 6V rail active state.

Parameters

userActive6V true to make rail active

◆ SetUserCurrent3V3()

static void frc::sim::RoboRioSim::SetUserCurrent3V3 ( units::ampere_t userCurrent3V3 )

static

Define the 3.3V rail current.

Parameters

userCurrent3V3 the new current

◆ SetUserCurrent5V()

static void frc::sim::RoboRioSim::SetUserCurrent5V ( units::ampere_t userCurrent5V )

static

Define the 5V rail current.

Parameters

userCurrent5V the new current

◆ SetUserCurrent6V()

static void frc::sim::RoboRioSim::SetUserCurrent6V ( units::ampere_t userCurrent6V )

static

Define the 6V rail current.

Parameters

userCurrent6V the new current

◆ SetUserFaults3V3()

static void frc::sim::RoboRioSim::SetUserFaults3V3 ( int userFaults3V3 )

static

Set the 3.3V rail number of faults.

Parameters

userFaults3V3 number of faults

◆ SetUserFaults5V()

static void frc::sim::RoboRioSim::SetUserFaults5V ( int userFaults5V )

static

Set the 5V rail number of faults.

Parameters

userFaults5V number of faults

◆ SetUserFaults6V()

static void frc::sim::RoboRioSim::SetUserFaults6V ( int userFaults6V )

static

Set the 6V rail number of faults.

Parameters

userFaults6V number of faults

◆ SetUserVoltage3V3()

static void frc::sim::RoboRioSim::SetUserVoltage3V3 ( units::volt_t userVoltage3V3 )

static

Define the 3.3V rail voltage.

Parameters

userVoltage3V3 the new voltage

◆ SetUserVoltage5V()

static void frc::sim::RoboRioSim::SetUserVoltage5V ( units::volt_t userVoltage5V )

static

Define the 5V rail voltage.

Parameters

userVoltage5V the new voltage

◆ SetUserVoltage6V()

static void frc::sim::RoboRioSim::SetUserVoltage6V ( units::volt_t userVoltage6V )

static

Define the 6V rail voltage.

Parameters

userVoltage6V the new voltage

◆ SetVInCurrent()

static void frc::sim::RoboRioSim::SetVInCurrent ( units::ampere_t vInCurrent )

static

Define the Vin current.

Parameters

vInCurrent the new current

◆ SetVInVoltage()

static void frc::sim::RoboRioSim::SetVInVoltage ( units::volt_t vInVoltage )

static

Define the Vin voltage.

Parameters

vInVoltage the new voltage

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

frc/simulation/RoboRioSim.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBrownoutVoltage()

◆ GetComments()

◆ GetFPGAButton()

◆ GetSerialNumber()

◆ GetUserActive3V3()

◆ GetUserActive5V()

◆ GetUserActive6V()

◆ GetUserCurrent3V3()

◆ GetUserCurrent5V()

◆ GetUserCurrent6V()

◆ GetUserFaults3V3()

◆ GetUserFaults5V()

◆ GetUserFaults6V()

◆ GetUserVoltage3V3()

◆ GetUserVoltage5V()

◆ GetUserVoltage6V()

◆ GetVInCurrent()

◆ GetVInVoltage()

◆ RegisterBrownoutVoltageCallback()

◆ RegisterFPGAButtonCallback()

◆ RegisterUserActive3V3Callback()

◆ RegisterUserActive5VCallback()

◆ RegisterUserActive6VCallback()

◆ RegisterUserCurrent3V3Callback()

◆ RegisterUserCurrent5VCallback()

◆ RegisterUserCurrent6VCallback()

◆ RegisterUserFaults3V3Callback()

◆ RegisterUserFaults5VCallback()

◆ RegisterUserFaults6VCallback()

◆ RegisterUserVoltage3V3Callback()

◆ RegisterUserVoltage5VCallback()

◆ RegisterUserVoltage6VCallback()

◆ RegisterVInCurrentCallback()

◆ RegisterVInVoltageCallback()

◆ ResetData()

◆ SetBrownoutVoltage()

◆ SetComments()

◆ SetFPGAButton()

◆ SetSerialNumber()

◆ SetUserActive3V3()

◆ SetUserActive5V()

◆ SetUserActive6V()

◆ SetUserCurrent3V3()

◆ SetUserCurrent5V()

◆ SetUserCurrent6V()

◆ SetUserFaults3V3()

◆ SetUserFaults5V()

◆ SetUserFaults6V()

◆ SetUserVoltage3V3()

◆ SetUserVoltage5V()

◆ SetUserVoltage6V()

◆ SetVInCurrent()

◆ SetVInVoltage()