ctre::phoenix6::networking::Wrappers Class Reference

#include <ctre/phoenix6/networking/Wrappers.hpp>

Static Public Member Functions
static uint32_t	CompileDeviceHash (int deviceID, char const *model, char const *canbus)
	Creates the device hash from provided parameters.
static ctre::phoenix::StatusCode	Device_SetConfigValues (char const *network, int deviceHash, double timeoutSeconds, std::string_view serializedString, bool futureProofConfigs, bool overrideIfDuplicate)
	Sets the config value of the device.
static ctre::phoenix::StatusCode	Device_GetConfigValues (char const *network, int deviceHash, double timeoutSeconds, std::string &serializedString)
	Gets the config value of the device.
static void	ReportError (bool isError, int32_t errorCode, char const *details, char const *location, bool getStackTrace=true)
	Reports an error.
static void	ReportStatusCode (ctre::phoenix::StatusCode statusCode, char const *location, bool getStackTrace=true)
	Reports a status code.

Member Function Documentation

CompileDeviceHash()

uint32_t ctre::phoenix6::networking::Wrappers::CompileDeviceHash ( int deviceID, char const * model, char const * canbus )

static

Creates the device hash from provided parameters.

Parameters

deviceID	Device ID
model	Device Model
canbus	CAN bus name

Returns

Hash of the device

Device_GetConfigValues()

ctre::phoenix::StatusCode ctre::phoenix6::networking::Wrappers::Device_GetConfigValues ( char const * network, int deviceHash, double timeoutSeconds, std::string & serializedString )

static

Gets the config value of the device.

Parameters

network	What network the device is on
deviceHash	The hash of the device
timeoutSeconds	How long to wait for the device to acknowledge in seconds
serializedString	Serialized configs to get

Returns

Status of the config set

Device_SetConfigValues()

ctre::phoenix::StatusCode ctre::phoenix6::networking::Wrappers::Device_SetConfigValues ( char const * network, int deviceHash, double timeoutSeconds, std::string_view serializedString, bool futureProofConfigs, bool overrideIfDuplicate )

static

Sets the config value of the device.

Parameters

network	What network the device is on
deviceHash	The hash of the device
timeoutSeconds	How long to wait for the device to acknowledge in seconds
serializedString	Serialized configs to set
futureProofConfigs	True to factory default the configs before setting
overrideIfDuplicate	True to always configure this parameter, even if we detect it's unnecessary

Returns

Status of the config set

ReportError()

void ctre::phoenix6::networking::Wrappers::ReportError ( bool isError, int32_t errorCode, char const * details, char const * location, bool getStackTrace = true )

static

Reports an error.

Parameters

isError	Whether this is an error (1) or warning (0)
errorCode	Error code
details	Error details
location	Error location
getStackTrace	Whether to include the stack trace

ReportStatusCode()

void ctre::phoenix6::networking::Wrappers::ReportStatusCode ( ctre::phoenix::StatusCode statusCode, char const * location, bool getStackTrace = true )

static

Reports a status code.

Parameters

statusCode	Status code
location	Location of the status
getStackTrace	Whether to include the stack trace

---

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

• ctre/phoenix6/networking/Wrappers.hpp