CTRE Phoenix C++ 5.33.1
ctre::phoenix::platform::can::PlatformCAN Class Reference

Configures the can interface for API. More...

#include <ctre/phoenix/platform/can/PlatformCAN.h>

Static Public Member Functions

static int32_t SetCANInterface (const char *canInterface)
 Set CAN interface. More...
 
static int32_t RegisterCANbus (char const *canbus)
 Registers a non-compliant CANbus. More...
 
static int32_t StartAll ()
 Starts all items in interface. More...
 
static int32_t DestroyAll ()
 Destroys all items in interface. More...
 
static void SetAutocacheLevel (ctre::phoenix::AutocacheState state)
 Set Autocache state. More...
 

Detailed Description

Configures the can interface for API.

Member Function Documentation

◆ DestroyAll()

static int32_t ctre::phoenix::platform::can::PlatformCAN::DestroyAll ( )
static

Destroys all items in interface.

◆ RegisterCANbus()

static int32_t ctre::phoenix::platform::can::PlatformCAN::RegisterCANbus ( char const *  canbus)
static

Registers a non-compliant CANbus.

Parameters
canbusCANbus to register. Linux example: "can0".
Returns
ErrorCode generated by function

◆ SetAutocacheLevel()

static void ctre::phoenix::platform::can::PlatformCAN::SetAutocacheLevel ( ctre::phoenix::AutocacheState  state)
static

Set Autocache state.

Parameters
statestate of autocache

◆ SetCANInterface()

static int32_t ctre::phoenix::platform::can::PlatformCAN::SetCANInterface ( const char *  canInterface)
static

Set CAN interface.

Parameters
canInterfaceCan interface to set. Linux example: "can0".
Returns
ErrorCode generated by function
Deprecated:
pass the CAN interface to device constructors instead, or call RegisterCANbus

◆ StartAll()

static int32_t ctre::phoenix::platform::can::PlatformCAN::StartAll ( )
static

Starts all items in interface.


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