Package com.ctre.phoenix.led

Class CANdleConfiguration

java.lang.Object

com.ctre.phoenix.CustomParamConfiguration

com.ctre.phoenix.led.CANdleConfiguration

public class CANdleConfiguration
extends CustomParamConfiguration

Configurables available to CANdle

Field Summary

Fields

Modifier and Type	Field	Description
double	brightnessScalar	Brightness scalar for all LEDs controlled
boolean	disableWhenLOS	True to turn off LEDs when Loss of Signal occurrs
boolean	statusLedOffWhenActive	True to turn off Status LED when CANdle is actively being controlled
CANdle.LEDStripType	stripType	What type of LEDs the CANdle controls
boolean	v5Enabled	True to turn off the 5V rail.
CANdle.VBatOutputMode	vBatOutputMode	The behavior of VBat output

Fields inherited from class com.ctre.phoenix.CustomParamConfiguration

customParam0, customParam1, enableOptimizations

Constructor Summary

Constructors

Constructor	Description
CANdleConfiguration()

Method Summary

Modifier and Type	Method	Description
String	toString()
String	toString(String prependString)

Methods inherited from class java.lang.Object

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

Field Details

stripType

public CANdle.LEDStripType stripType

What type of LEDs the CANdle controls

brightnessScalar

public double brightnessScalar

Brightness scalar for all LEDs controlled

disableWhenLOS

public boolean disableWhenLOS

True to turn off LEDs when Loss of Signal occurrs

statusLedOffWhenActive

public boolean statusLedOffWhenActive

True to turn off Status LED when CANdle is actively being controlled

vBatOutputMode

public CANdle.VBatOutputMode vBatOutputMode

The behavior of VBat output

v5Enabled

public boolean v5Enabled

True to turn off the 5V rail. This turns off the on-board LEDs as well.

Constructor Details

CANdleConfiguration

public CANdleConfiguration()

Method Details

toString

public String toString()

Overrides:

toString in class CustomParamConfiguration

Returns:

String representation of configs

toString

public String toString(String prependString)

Overrides:

toString in class CustomParamConfiguration

Parameters:

prependString - String to prepend to configs

Returns:

String representation of configs