Class CANdleConfiguration

java.lang.Object

com.ctre.phoenix6.configs.CANdleConfiguration

All Implemented Interfaces:

ParentConfiguration, Cloneable

public class CANdleConfiguration
extends Object
implements ParentConfiguration, Cloneable

All configurations for the CANdle.

Field Summary

Fields

Modifier and Type	Field	Description
CANdleFeaturesConfigs	CANdleFeatures	Configs related to general CANdle features.
CustomParamsConfigs	CustomParams	Custom Params.
boolean	FutureProofConfigs	True if we should factory default newer unsupported configs, false to leave newer unsupported configs alone.
LEDConfigs	LED	Configs related to CANdle LED control.

Constructor Summary

Constructors

Constructor	Description
CANdleConfiguration()

Method Summary

Modifier and Type	Method	Description
CANdleConfiguration	clone()
final StatusCode	deserialize(String to_deserialize)	Take a string and deserialize it to this configuration.
final String	serialize()	Get the serialized form of this configuration.
String	toString()
final CANdleConfiguration	withCANdleFeatures(CANdleFeaturesConfigs newCANdleFeatures)	Modifies this configuration's CANdleFeatures parameter and returns itself for method-chaining and easier to use config API.
final CANdleConfiguration	withCustomParams(CustomParamsConfigs newCustomParams)	Modifies this configuration's CustomParams parameter and returns itself for method-chaining and easier to use config API.
final CANdleConfiguration	withLED(LEDConfigs newLED)	Modifies this configuration's LED parameter and returns itself for method-chaining and easier to use config API.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

FutureProofConfigs

public boolean FutureProofConfigs

True if we should factory default newer unsupported configs, false to leave newer unsupported configs alone.

This flag addresses a corner case where the device may have firmware with newer configs that didn't exist when this version of the API was built. If this occurs and this flag is true, unsupported new configs will be factory defaulted to avoid unexpected behavior.

This is also the behavior in Phoenix 5, so this flag is defaulted to true to match.

CustomParams

public CustomParamsConfigs CustomParams

Custom Params.

Custom paramaters that have no real impact on controller.

Parameter list:

• CustomParamsConfigs.CustomParam0
• CustomParamsConfigs.CustomParam1

LED

public LEDConfigs LED

Configs related to CANdle LED control.

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

Parameter list:

• LEDConfigs.StripType
• LEDConfigs.BrightnessScalar
• LEDConfigs.LossOfSignalBehavior

CANdleFeatures

public CANdleFeaturesConfigs CANdleFeatures

Configs related to general CANdle features.

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

Parameter list:

• CANdleFeaturesConfigs.Enable5VRail
• CANdleFeaturesConfigs.VBatOutputMode
• CANdleFeaturesConfigs.StatusLedWhenActive

Constructor Details

CANdleConfiguration

public CANdleConfiguration()

Method Details

withCustomParams

public final CANdleConfiguration withCustomParams(CustomParamsConfigs newCustomParams)

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

Custom Params.

Custom paramaters that have no real impact on controller.

Parameter list:

• CustomParamsConfigs.CustomParam0
• CustomParamsConfigs.CustomParam1

Parameters:

newCustomParams - Parameter to modify

Returns:

Itself

withLED

public final CANdleConfiguration withLED(LEDConfigs newLED)

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

Configs related to CANdle LED control.

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

Parameter list:

• LEDConfigs.StripType
• LEDConfigs.BrightnessScalar
• LEDConfigs.LossOfSignalBehavior

Parameters:

newLED - Parameter to modify

Returns:

Itself

withCANdleFeatures

public final CANdleConfiguration withCANdleFeatures(CANdleFeaturesConfigs newCANdleFeatures)

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

Configs related to general CANdle features.

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

Parameter list:

• CANdleFeaturesConfigs.Enable5VRail
• CANdleFeaturesConfigs.VBatOutputMode
• CANdleFeaturesConfigs.StatusLedWhenActive

Parameters:

newCANdleFeatures - Parameter to modify

Returns:

Itself

toString

public String toString()

Overrides:

toString in class Object

serialize

public final String serialize()

Get the serialized form of this configuration.

Specified by:

serialize in interface ParentConfiguration

Returns:

Serialized form of this config group

deserialize

public final StatusCode deserialize(String to_deserialize)

Take a string and deserialize it to this configuration.

Specified by:

deserialize in interface ParentConfiguration

Parameters:

to_deserialize - The serialized configuration

Returns:

Return code of the deserialize method

clone

public CANdleConfiguration clone()

Overrides:

clone in class Object