Package com.ctre.phoenix.led

Enum Class CANdleStatusFrame

java.lang.Object

java.lang.Enum<CANdleStatusFrame>

com.ctre.phoenix.led.CANdleStatusFrame

All Implemented Interfaces:

Serializable, Comparable<CANdleStatusFrame>, java.lang.constant.Constable

@Deprecated(since="2026",
            forRemoval=true)
public enum CANdleStatusFrame
extends Enum<CANdleStatusFrame>

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.

The various status frames from CANdle

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
CANdleStatusFrame_Status_1_General	Deprecated, for removal: This API element is subject to removal in a future version. General status frame Includes: - Battery Voltage - Current Measurement - Temperature - Faults - Sticky Faults
CANdleStatusFrame_Status_2_Startup	Deprecated, for removal: This API element is subject to removal in a future version. Startup frame, this is only sent out once
CANdleStatusFrame_Status_3_FirmwareApiStatus	Deprecated, for removal: This API element is subject to removal in a future version. Firmware status, this is sent until API gets it, then no longer sends again.
CANdleStatusFrame_Status_4_ControlTelem	Deprecated, for removal: This API element is subject to removal in a future version. Status frame regarding LED control.
CANdleStatusFrame_Status_5_PixelPulseTrain	Deprecated, for removal: This API element is subject to removal in a future version. Status frame regarding Neopixel generation.
CANdleStatusFrame_Status_6_BottomPixels	Deprecated, for removal: This API element is subject to removal in a future version. The bottom 4 pixels' state.
CANdleStatusFrame_Status_7_TopPixels	Deprecated, for removal: This API element is subject to removal in a future version. The top 4 pixels' state.

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 CANdleStatusFrame	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 CANdleStatusFrame[]	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

CANdleStatusFrame_Status_1_General

public static final CANdleStatusFrame CANdleStatusFrame_Status_1_General

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

General status frame Includes: - Battery Voltage - Current Measurement - Temperature - Faults - Sticky Faults

CANdleStatusFrame_Status_2_Startup

public static final CANdleStatusFrame CANdleStatusFrame_Status_2_Startup

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

Startup frame, this is only sent out once

CANdleStatusFrame_Status_3_FirmwareApiStatus

public static final CANdleStatusFrame CANdleStatusFrame_Status_3_FirmwareApiStatus

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

Firmware status, this is sent until API gets it, then no longer sends again.

CANdleStatusFrame_Status_4_ControlTelem

public static final CANdleStatusFrame CANdleStatusFrame_Status_4_ControlTelem

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

Status frame regarding LED control. Is not used in API.

CANdleStatusFrame_Status_5_PixelPulseTrain

public static final CANdleStatusFrame CANdleStatusFrame_Status_5_PixelPulseTrain

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

Status frame regarding Neopixel generation. Is not used in API.

CANdleStatusFrame_Status_6_BottomPixels

public static final CANdleStatusFrame CANdleStatusFrame_Status_6_BottomPixels

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

The bottom 4 pixels' state. Is not used in API.

CANdleStatusFrame_Status_7_TopPixels

public static final CANdleStatusFrame CANdleStatusFrame_Status_7_TopPixels

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

The top 4 pixels' state. Is not used in API.

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 CANdleStatusFrame[] 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 CANdleStatusFrame 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