Configs related to CANdle LED control. More...
#include <ctre/phoenix6/configs/Configs.hpp>
Public Member Functions | |
constexpr | LEDConfigs ()=default |
constexpr LEDConfigs & | WithStripType (signals::StripTypeValue newStripType) |
Modifies this configuration's StripType parameter and returns itself for method-chaining and easier to use config API. | |
constexpr LEDConfigs & | WithBrightnessScalar (units::dimensionless::scalar_t newBrightnessScalar) |
Modifies this configuration's BrightnessScalar parameter and returns itself for method-chaining and easier to use config API. | |
constexpr LEDConfigs & | WithLossOfSignalBehavior (signals::LossOfSignalBehaviorValue newLossOfSignalBehavior) |
Modifies this configuration's LossOfSignalBehavior parameter and returns itself for method-chaining and easier to use config API. | |
std::string | ToString () const override |
std::string | Serialize () const override |
ctre::phoenix::StatusCode | Deserialize (const std::string &to_deserialize) override |
![]() | |
![]() |
Public Attributes | |
signals::StripTypeValue | StripType = signals::StripTypeValue::GRB |
The type of LEDs that are being controlled. | |
units::dimensionless::scalar_t | BrightnessScalar = 1.0 |
The brightness scalar for all LEDs controlled. | |
signals::LossOfSignalBehaviorValue | LossOfSignalBehavior = signals::LossOfSignalBehaviorValue::KeepRunning |
The behavior of the LEDs when the control signal is lost. | |
Configs related to CANdle LED control.
All the configs related to controlling LEDs with the CANdle, including LED strip type and brightness.
|
constexprdefault |
|
inlineoverridevirtual |
Implements ctre::phoenix6::configs::ParentConfiguration.
|
inlineoverridevirtual |
Implements ctre::phoenix6::ISerializable.
|
inlineoverridevirtual |
Implements ctre::phoenix6::configs::ParentConfiguration.
|
inlineconstexpr |
Modifies this configuration's BrightnessScalar parameter and returns itself for method-chaining and easier to use config API.
The brightness scalar for all LEDs controlled. All LED values sent to the CANdle will be scaled by this config.
newBrightnessScalar | Parameter to modify |
|
inlineconstexpr |
Modifies this configuration's LossOfSignalBehavior parameter and returns itself for method-chaining and easier to use config API.
The behavior of the LEDs when the control signal is lost.
newLossOfSignalBehavior | Parameter to modify |
|
inlineconstexpr |
Modifies this configuration's StripType parameter and returns itself for method-chaining and easier to use config API.
The type of LEDs that are being controlled.
newStripType | Parameter to modify |
units::dimensionless::scalar_t ctre::phoenix6::configs::LEDConfigs::BrightnessScalar = 1.0 |
The brightness scalar for all LEDs controlled.
All LED values sent to the CANdle will be scaled by this config.
signals::LossOfSignalBehaviorValue ctre::phoenix6::configs::LEDConfigs::LossOfSignalBehavior = signals::LossOfSignalBehaviorValue::KeepRunning |
The behavior of the LEDs when the control signal is lost.
signals::StripTypeValue ctre::phoenix6::configs::LEDConfigs::StripType = signals::StripTypeValue::GRB |
The type of LEDs that are being controlled.