ctre::phoenix::led::CANdleConfiguration Struct Reference
Configurables available to CANdle. More...
#include <ctre/phoenix/led/CANdleConfiguration.h>
Inheritance diagram for ctre::phoenix::led::CANdleConfiguration:
Public Member Functions | |
| CANdleConfiguration () | |
| std::string | toString (std::string prependString="") |
 Public Member Functions inherited from ctre::phoenix::CustomParamConfiguration | |
| CustomParamConfiguration () | |
| std::string | toString () |
| std::string | toString (std::string prependString) |
Public Attributes | |
| LEDStripType | stripType {LEDStripType::RGB} |
| What type of LEDs the CANdle controls. More... | |
| double | brightnessScalar {1.0} |
| Brightness scalar for all LEDs controlled. More... | |
| bool | disableWhenLOS {false} |
| True to turn off LEDs when Loss of Signal occurrs. More... | |
| bool | statusLedOffWhenActive {false} |
| True to turn off Status LED when CANdle is actively being controlled. More... | |
| VBatOutputMode | vBatOutputMode {VBatOutputMode::On} |
| The behavior of VBat output. More... | |
| bool | v5Enabled {false} |
| True to turn off the 5V rail. More... | |
| Public Attributes inherited from ctre::phoenix::CustomParamConfiguration | |
| int | customParam0 |
| Custom Param 0. More... | |
| int | customParam1 |
| Custom Param 1. More... | |
| bool | enableOptimizations |
| Enable optimizations for ConfigAll (defaults true) More... | |
Detailed Description
Configurables available to CANdle.
Constructor & Destructor Documentation
◆ CANdleConfiguration()
| ctre::phoenix::led::CANdleConfiguration::CANdleConfiguration | ( | ) |
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.
◆ v5Enabled
| bool ctre::phoenix::led::CANdleConfiguration::v5Enabled {false} |
True to turn off the 5V rail.
This turns off the on-board LEDs as well.
◆ 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:
- ctre/phoenix/led/CANdleConfiguration.h
