ctre::phoenix::led Namespace Reference

Classes
class	Animation
	The base class for all animations that CANdle supports. More...
class	BaseStandardAnimation
	The base class for one generic type of animation. More...
class	BaseTwoSizeAnimation
	The base class for one generic type of animation. More...
class	CANdle
	CTRE CANdle. More...
struct	CANdleConfiguration
	Configurables available to CANdle. More...
class	CANdleConfigUtil
	Util class to help with configuring CANifier. More...
struct	CANdleFaults
	Faults available to CANdle (Currently has none) More...
struct	CANdleStickyFaults
	Faults available to CANdle (Currently has none) More...
class	ColorFlowAnimation
	Animation that gradually lights the entire LED strip one LED at a time. More...
class	FireAnimation
	Animation that looks similarly to a flame flickering. More...
class	LarsonAnimation
	Animation that sends a pocket of light across the LED strip. More...
class	RainbowAnimation
	Animation that creates a rainbow throughout all the LEDs. More...
class	RgbFadeAnimation
	Animation that fades all the LEDs of a strip simultaneously between Red, Green, and Blue. More...
class	SingleFadeAnimation
	Animation that fades into and out of a specified color. More...
class	StrobeAnimation
	Animation that strobes the LEDs a specified color. More...
class	TwinkleAnimation
	Animation that randomly turns LEDs on and off to a certain color. More...
class	TwinkleOffAnimation
	Animation that randomly turns on LEDs, until it reaches the maximum count and turns them all off. More...

Enumerations
enum	CANdleStatusFrame {   CANdleStatusFrame_Status_1_General = 0x041400 , CANdleStatusFrame_Status_2_Startup = 0x041440 , CANdleStatusFrame_Status_3_FirmwareApiStatus = 0x041480 , CANdleStatusFrame_Status_4_ControlTelem = 0x0414C0 ,   CANdleStatusFrame_Status_5_PixelPulseTrain = 0x041500 , CANdleStatusFrame_Status_6_BottomPixels = 0x041540 , CANdleStatusFrame_Status_7_TopPixels = 0x041580 }
	Enumerated type for status frame types. More...
enum	CANdleControlFrame { CANdle_Control_1_General = 0x040000 , CANdle_Control_2_ModulatedVBatOutput = 0x040040 }
	Enumerated type for status frame types. More...
enum	LEDStripType {   GRB = 0 , RGB = 1 , BRG = 2 , GRBW = 6 ,   RGBW = 7 , BRGW = 8 }
	The various LED types that the CANdle can support. More...
enum	VBatOutputMode { On = 0 , Off = 1 , Modulated = 2 }
	The various methods of managing the VBat output behavior. More...

Enumeration Type Documentation

CANdleControlFrame

enum ctre::phoenix::led::CANdleControlFrame

Enumerated type for status frame types.

Enumerator
CANdle_Control_1_General
CANdle_Control_2_ModulatedVBatOutput

CANdleStatusFrame

enum ctre::phoenix::led::CANdleStatusFrame

Enumerated type for status frame types.

Enumerator
CANdleStatusFrame_Status_1_General
CANdleStatusFrame_Status_2_Startup
CANdleStatusFrame_Status_3_FirmwareApiStatus
CANdleStatusFrame_Status_4_ControlTelem
CANdleStatusFrame_Status_5_PixelPulseTrain
CANdleStatusFrame_Status_6_BottomPixels
CANdleStatusFrame_Status_7_TopPixels

LEDStripType

enum ctre::phoenix::led::LEDStripType

The various LED types that the CANdle can support.

Enumerator
GRB	LEDs that are controlled by Green-Red-Blue values.
RGB	LEDs that are controlled by Red-Green-Blue values.
BRG	LEDs that are controlled by Blue-Red-Green values.
GRBW	LEDs that are controlled by Green-Red-Blue-White values.
RGBW	LEDs that are controlled by Red-Green-Blue-White values.
BRGW	LEDs that are controlled by Blue-Red-Green-White values.

VBatOutputMode

enum ctre::phoenix::led::VBatOutputMode

The various methods of managing the VBat output behavior.

Enumerator
On	VBat output is on at full power, no modulation.
Off	VBat output is off, no modulation.
Modulated	VBat output is on at the specified modulation.