Package com.ctre.phoenix.led

Enum Class CANdleControlFrame

java.lang.Object
java.lang.Enum<CANdleControlFrame>
com.ctre.phoenix.led.CANdleControlFrame
All Implemented Interfaces:
Serializable, Comparable<CANdleControlFrame>, java.lang.constant.Constable
@Deprecated(since="2026", forRemoval=true) public enum CANdleControlFrame extends Enum<CANdleControlFrame>
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.

CANdle control frame

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CANdle_Control_1_General
    Deprecated, for removal: This API element is subject to removal in a future version.
    Controls what animation or block of LEDs to set
    CANdle_Control_2_ModulatedVBatOut
    Deprecated, for removal: This API element is subject to removal in a future version.
    Controls the VBat Output Modulation

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final int
    value
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static CANdleControlFrame
    valueOf(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this class with the specified name.
    static CANdleControlFrame[]
    values()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Field Details

    • value

      public final int value
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • values

      public static CANdleControlFrame[] values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CANdleControlFrame valueOf(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null