ctre::phoenix::led::CANdleConfiguration Struct Reference

#include <CANdleConfiguration.h>

Inherits ctre::phoenix::CustomParamConfiguration.

Public Member Functions
std::string	toString (std::string prependString="")
Public Member Functions inherited from ctre::phoenix::CustomParamConfiguration
std::string	toString ()
std::string	toString (std::string prependString)

Public Attributes
LEDStripType	stripType {LEDStripType::RGB}
double	brightnessScalar {1.0}
bool	disableWhenLOS {false}
bool	statusLedOffWhenActive {false}
VBatOutputMode	vBatOutputMode {VBatOutputMode::On}
Public Attributes inherited from ctre::phoenix::CustomParamConfiguration
int	customParam0
int	customParam1
bool	enableOptimizations

Detailed Description

Configurables available to CANifier

Member Function Documentation

toString()

std::string ctre::phoenix::led::CANdleConfiguration::toString

(

std::string

prependString = ""

)

Parameters

prependString

String to prepend to configs

Returns

String representation of configs

Member Data Documentation

brightnessScalar

double ctre::phoenix::led::CANdleConfiguration::brightnessScalar {1.0}

Brightness scalar for all LEDs controlled

disableWhenLOS

bool ctre::phoenix::led::CANdleConfiguration::disableWhenLOS {false}

True to turn off LEDs when Loss of Signal occurrs

statusLedOffWhenActive

bool ctre::phoenix::led::CANdleConfiguration::statusLedOffWhenActive {false}

True to turn off Status LED when CANdle is actively being controlled

stripType

LEDStripType ctre::phoenix::led::CANdleConfiguration::stripType {LEDStripType::RGB}

What type of LEDs the CANdle controls

vBatOutputMode

VBatOutputMode ctre::phoenix::led::CANdleConfiguration::vBatOutputMode {VBatOutputMode::On}

The behavior of VBat output

---

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

• Phoenix-api/cpp/src/main/native/include/ctre/phoenix/led/CANdleConfiguration.h