ctre::phoenix6::unmanaged Namespace Reference

Functions
void	FeedEnable (wpi::units::second_t timeoutSeconds)
	Feeds the enable signal with a timeout specified in seconds.
bool	GetEnableState ()
void	SetTransmitEnable (bool enable)
	Sets whether to transmit the enable frame.
bool	GetTransmitEnable ()
	Gets whether the enable frame is being transmitted.
int	GetPhoenixVersion ()
int	GetApiCompliancy ()
	Gets this API's compliancy version.
void	LoadPhoenix ()
	Load and start the Phoenix background tasks.
void	SetPhoenixDiagnosticsStartTime (wpi::units::second_t startTimeSeconds)
	Sets the duration of the delay before starting the Phoenix diagnostics server.

Function Documentation

FeedEnable()

void ctre::phoenix6::unmanaged::FeedEnable

(

wpi::units::second_t

timeoutSeconds

)

Feeds the enable signal with a timeout specified in seconds.

This function does nothing on a Systemcore during FRC use.

A timeout of 0 disables actuators.

Parameters

timeoutSeconds

Time to remain enabled in seconds

GetApiCompliancy()

int ctre::phoenix6::unmanaged::GetApiCompliancy

(

)

Gets this API's compliancy version.

This is purely used to check the compliancy of API against firmware, and report if there is a mismatch to the user.

Returns

The current API compliancy

GetEnableState()

bool ctre::phoenix6::unmanaged::GetEnableState

(

)

Returns

true if non-FRC enabled

GetPhoenixVersion()

int ctre::phoenix6::unmanaged::GetPhoenixVersion

(

)

Returns

The current version of Phoenix

GetTransmitEnable()

bool ctre::phoenix6::unmanaged::GetTransmitEnable

(

)

Gets whether the enable frame is being transmitted.

This function returns true on a Systemcore during FRC use.

Returns

true if the enable frame is being transmitted

LoadPhoenix()

void ctre::phoenix6::unmanaged::LoadPhoenix

(

)

Load and start the Phoenix background tasks.

This can be useful if you need the Enable/Disable functionality for CAN devices but aren't using any of the CAN device classes.

This function does NOT need to be called if you are using any of the Phoenix CAN device classes.

SetPhoenixDiagnosticsStartTime()

void ctre::phoenix6::unmanaged::SetPhoenixDiagnosticsStartTime

(

wpi::units::second_t

startTimeSeconds

)

Sets the duration of the delay before starting the Phoenix diagnostics server.

Parameters

startTimeSeconds

The delay (in seconds) before starting the server. A value of 0 will start the server immediately. A negative value will signal the server to shutdown or never start.

SetTransmitEnable()

void ctre::phoenix6::unmanaged::SetTransmitEnable

(

bool

enable

)

Sets whether to transmit the enable frame.

This function does nothing on a Systemcore during FRC use.

Parameters

enable

true to transmit the enable frame