CTRE Phoenix C++ 5.33.1
ctre::phoenix::unmanaged::Unmanaged Class Reference

Handles enabling when used in a non-FRC manner. More...

#include <ctre/phoenix/unmanaged/Unmanaged.h>

Static Public Member Functions

static void FeedEnable (int timeoutMs)
 Feed the enable frame. More...
 
static bool GetEnableState ()
 
static int GetPhoenixVersion ()
 
static void LoadPhoenix ()
 Calling this function will load and start the Phoenix background tasks. More...
 
static void SetPhoenixDiagnosticsStartTime (int startTimeSeconds)
 Sets the duration of the delay before starting the Phoenix diagnostics server. More...
 

Detailed Description

Handles enabling when used in a non-FRC manner.

Member Function Documentation

◆ FeedEnable()

static void ctre::phoenix::unmanaged::Unmanaged::FeedEnable ( int  timeoutMs)
static

Feed the enable frame.

This function does nothing on a roborio during FRC use.

If running an application in simulation, creating a WPI_* object automatically enables actuators. Otherwise, call this to enable actuators.

Parameters
timeoutMsTimeout before disabling

◆ GetEnableState()

static bool ctre::phoenix::unmanaged::Unmanaged::GetEnableState ( )
static
Returns
true if enabled

◆ GetPhoenixVersion()

static int ctre::phoenix::unmanaged::Unmanaged::GetPhoenixVersion ( )
static
Returns
Phoenix version

◆ LoadPhoenix()

static void ctre::phoenix::unmanaged::Unmanaged::LoadPhoenix ( )
static

Calling this function will 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()

static void ctre::phoenix::unmanaged::Unmanaged::SetPhoenixDiagnosticsStartTime ( int  startTimeSeconds)
static

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

Parameters
startTimeMagnitude of 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.

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