Package com.ctre.phoenix.led

Class CANdleConfiguration

java.lang.Object
com.ctre.phoenix.CustomParamConfiguration
com.ctre.phoenix.led.CANdleConfiguration
@Deprecated(since="2026", forRemoval=true) public class CANdleConfiguration extends CustomParamConfiguration
Deprecated, for removal: This API element is subject to removal in a future version.
This device's Phoenix 5 API is deprecated for removal in the 2027 season. Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API. A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.

If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.

Configurables available to CANdle

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    double
    brightnessScalar
    Deprecated, for removal: This API element is subject to removal in a future version.
    Brightness scalar for all LEDs controlled
    boolean
    disableWhenLOS
    Deprecated, for removal: This API element is subject to removal in a future version.
    True to turn off LEDs when Loss of Signal occurrs
    boolean
    statusLedOffWhenActive
    Deprecated, for removal: This API element is subject to removal in a future version.
    True to turn off Status LED when CANdle is actively being controlled
    CANdle.LEDStripType
    stripType
    Deprecated, for removal: This API element is subject to removal in a future version.
    What type of LEDs the CANdle controls
    boolean
    v5Enabled
    Deprecated, for removal: This API element is subject to removal in a future version.
    True to turn off the 5V rail.
    CANdle.VBatOutputMode
    vBatOutputMode
    Deprecated, for removal: This API element is subject to removal in a future version.
    The behavior of VBat output

    Fields inherited from class com.ctre.phoenix.CustomParamConfiguration

    customParam0, customParam1, enableOptimizations

  • Constructor Summary

    Constructors
    Constructor
    Description
    CANdleConfiguration()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    toString(String prependString)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • stripType

      public CANdle.LEDStripType stripType
      Deprecated, for removal: This API element is subject to removal in a future version.
      What type of LEDs the CANdle controls

    • brightnessScalar

      public double brightnessScalar
      Deprecated, for removal: This API element is subject to removal in a future version.
      Brightness scalar for all LEDs controlled

    • disableWhenLOS

      public boolean disableWhenLOS
      Deprecated, for removal: This API element is subject to removal in a future version.
      True to turn off LEDs when Loss of Signal occurrs

    • statusLedOffWhenActive

      public boolean statusLedOffWhenActive
      Deprecated, for removal: This API element is subject to removal in a future version.
      True to turn off Status LED when CANdle is actively being controlled

    • vBatOutputMode

      public CANdle.VBatOutputMode vBatOutputMode
      Deprecated, for removal: This API element is subject to removal in a future version.
      The behavior of VBat output

    • v5Enabled

      public boolean v5Enabled
      Deprecated, for removal: This API element is subject to removal in a future version.
      True to turn off the 5V rail. This turns off the on-board LEDs as well.

  • Constructor Details

    • CANdleConfiguration

      public CANdleConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class CustomParamConfiguration
      Returns:
      String representation of configs

    • toString

      public String toString(String prependString)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class CustomParamConfiguration
      Parameters:
      prependString - String to prepend to configs
      Returns:
      String representation of configs