Class CANdleFeaturesConfigs

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Configs related to general CANdle features.

This includes configs such as disabling the 5V rail and the behavior of VBat output.

public class CANdleFeaturesConfigs : IParentConfiguration, ISerializable, ICloneable

Inheritance

object

CANdleFeaturesConfigs

Implements

IParentConfiguration

ISerializable

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

Enable5VRail

Whether the 5V rail is enabled. Disabling the 5V rail will also turn off the onboard LEDs.

public Enable5VRailValue Enable5VRail

Field Value

Enable5VRailValue

StatusLedWhenActive

Whether the Status LED is enabled when the CANdle is actively being controlled.

public StatusLedWhenActiveValue StatusLedWhenActive

Field Value

StatusLedWhenActiveValue

VBatOutputMode

The behavior of the VBat output. CANdle supports modulating VBat output for single-color LED strips.

public VBatOutputModeValue VBatOutputMode

Field Value

VBatOutputModeValue

Methods

Clone()

Creates a copy of this config group.

public CANdleFeaturesConfigs Clone()

Returns

CANdleFeaturesConfigs

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

WithEnable5VRail(Enable5VRailValue)

Modifies this configuration's Enable5VRail parameter and returns itself for method-chaining and easier to use config API.

Whether the 5V rail is enabled. Disabling the 5V rail will also turn off the onboard LEDs.

public CANdleFeaturesConfigs WithEnable5VRail(Enable5VRailValue newEnable5VRail)

Parameters

newEnable5VRail Enable5VRailValue

Parameter to modify

Returns

CANdleFeaturesConfigs

Itself

WithStatusLedWhenActive(StatusLedWhenActiveValue)

Modifies this configuration's StatusLedWhenActive parameter and returns itself for method-chaining and easier to use config API.

Whether the Status LED is enabled when the CANdle is actively being controlled.

public CANdleFeaturesConfigs WithStatusLedWhenActive(StatusLedWhenActiveValue newStatusLedWhenActive)

Parameters

newStatusLedWhenActive StatusLedWhenActiveValue

Parameter to modify

Returns

CANdleFeaturesConfigs

Itself

WithVBatOutputMode(VBatOutputModeValue)

Modifies this configuration's VBatOutputMode parameter and returns itself for method-chaining and easier to use config API.

The behavior of the VBat output. CANdle supports modulating VBat output for single-color LED strips.

public CANdleFeaturesConfigs WithVBatOutputMode(VBatOutputModeValue newVBatOutputMode)

Parameters

newVBatOutputMode VBatOutputModeValue

Parameter to modify

Returns

CANdleFeaturesConfigs

Itself