CTRE Phoenix 6 C++ 24.3.0
ctre::phoenix6::networking::Wrappers Class Reference

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

Static Public Member Functions

static uint32_t CompileDeviceHash (int deviceID, const char *model, const char *canbus)
 Creates the device hash from provided parameters. More...
 
static ctre::phoenix::StatusCode Device_SetConfigValues (const char *network, int deviceHash, double timeoutSeconds, const std::string &serializedString, bool futureProofConfigs, bool overrideIfDuplicate)
 Sets the config value of the device. More...
 
static ctre::phoenix::StatusCode Device_GetConfigValues (const char *network, int deviceHash, double timeoutSeconds, std::string &serializedString)
 Gets the config value of the device. More...
 

Member Function Documentation

◆ CompileDeviceHash()

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

Creates the device hash from provided parameters.

Parameters
deviceIDDevice ID
modelDevice Model
canbusCAN bus name
Returns
Hash of the device

◆ Device_GetConfigValues()

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

Gets the config value of the device.

Parameters
networkWhat network the device is on
deviceHashThe hash of the device
timeoutSecondsHow long to wait for the device to acknowledge in seconds
serializedStringSerialized configs to get
Returns
Status of the config set

◆ Device_SetConfigValues()

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

Sets the config value of the device.

Parameters
networkWhat network the device is on
deviceHashThe hash of the device
timeoutSecondsHow long to wait for the device to acknowledge in seconds
serializedStringSerialized configs to set
futureProofConfigsTrue to factory default the configs before setting
overrideIfDuplicateTrue to always configure this parameter, even if we detect it's unnecessary
Returns
Status of the config set

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