Class LEDConfigs

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Configs related to CANdle LED control.

All the configs related to controlling LEDs with the CANdle, including LED strip type and brightness.

public class LEDConfigs : IParentConfiguration, ISerializable, ICloneable

Inheritance

object

LEDConfigs

Implements

IParentConfiguration

ISerializable

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

BrightnessScalar

The brightness scalar for all LEDs controlled. All LED values sent to the CANdle will be scaled by this config.

• Minimum Value0.0
• Maximum Value1.0
• Default Value1.0
• Unitsscalar

public double BrightnessScalar

Field Value

double

LossOfSignalBehavior

The behavior of the LEDs when the control signal is lost.

public LossOfSignalBehaviorValue LossOfSignalBehavior

Field Value

LossOfSignalBehaviorValue

StripType

The type of LEDs that are being controlled.

public StripTypeValue StripType

Field Value

StripTypeValue

Methods

Clone()

Creates a copy of this config group.

public LEDConfigs Clone()

Returns

LEDConfigs

Deserialize(string)

Deserialize string and put values into this object

public StatusCode Deserialize(string to_deserialize)

Parameters

to_deserialize string

String to deserialize

Returns

StatusCode

OK if deserialization is OK

Serialize()

Serialize this object into a string

public string Serialize()

Returns

string

This object's data serialized into a string

ToString()

Provides the string representation of this object

public override string ToString()

Returns

string

WithBrightnessScalar(double)

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.

• Minimum Value0.0
• Maximum Value1.0
• Default Value1.0
• Unitsscalar

public LEDConfigs WithBrightnessScalar(double newBrightnessScalar)

Parameters

newBrightnessScalar double

Parameter to modify

Returns

LEDConfigs

Itself

WithLossOfSignalBehavior(LossOfSignalBehaviorValue)

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.

public LEDConfigs WithLossOfSignalBehavior(LossOfSignalBehaviorValue newLossOfSignalBehavior)

Parameters

newLossOfSignalBehavior LossOfSignalBehaviorValue

Parameter to modify

Returns

LEDConfigs

Itself

WithStripType(StripTypeValue)

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.

public LEDConfigs WithStripType(StripTypeValue newStripType)

Parameters

newStripType StripTypeValue

Parameter to modify

Returns

LEDConfigs

Itself