Animation that fades all the LEDs of a strip simultaneously between Red, Green, and Blue. More...

#include <ctre/phoenix6/controls/RgbFadeAnimation.hpp>

Inheritance diagram for ctre::phoenix6::controls::RgbFadeAnimation:

Public Member Functions
	RgbFadeAnimation (int LEDStartIndex, int LEDEndIndex)
	Animation that fades all the LEDs of a strip simultaneously between Red, Green, and Blue.

RgbFadeAnimation &	WithLEDStartIndex (int newLEDStartIndex)
	Modifies this Control Request's LEDStartIndex parameter and returns itself for method-chaining and easier to use request API.

RgbFadeAnimation &	WithLEDEndIndex (int newLEDEndIndex)
	Modifies this Control Request's LEDEndIndex parameter and returns itself for method-chaining and easier to use request API.

RgbFadeAnimation &	WithSlot (int newSlot)
	Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.

RgbFadeAnimation &	WithBrightness (units::dimensionless::scalar_t newBrightness)
	Modifies this Control Request's Brightness parameter and returns itself for method-chaining and easier to use request API.

RgbFadeAnimation &	WithFrameRate (units::frequency::hertz_t newFrameRate)
	Modifies this Control Request's FrameRate parameter and returns itself for method-chaining and easier to use request API.

RgbFadeAnimation &	WithUpdateFreqHz (units::frequency::hertz_t newUpdateFreqHz)
	Sets the period at which this control will update at.

std::string	ToString () const override
	Returns a string representation of the object.

std::map< std::string, std::string >	GetControlInfo () const override
	Gets information about this control request.

Public Member Functions inherited from ctre::phoenix6::controls::ControlRequest
	ControlRequest (std::string name)
	Constructs a new Control Request with the given name.

std::string const &	GetName () const

virtual	~ControlRequest ()=default

Public Attributes
int	LEDStartIndex
	The index of the first LED this animation controls (inclusive).

int	LEDEndIndex
	The index of the last LED this animation controls (inclusive).

int	Slot = 0
	The slot of this animation, within [0, 7].

units::dimensionless::scalar_t	Brightness = 1.0
	The brightness of the animation, as a scalar from 0.0 to 1.0.

units::frequency::hertz_t	FrameRate = 100_Hz
	The frame rate of the animation, from [2, 1000] Hz.

units::frequency::hertz_t	UpdateFreqHz {20_Hz}
	The period at which this control will update at.

Additional Inherited Members
Protected Member Functions inherited from ctre::phoenix6::controls::ControlRequest
	ControlRequest (ControlRequest const &)=default

	ControlRequest (ControlRequest &&)=default

ControlRequest &	operator= (ControlRequest const &)=default

ControlRequest &	operator= (ControlRequest &&)=default

Protected Attributes inherited from ctre::phoenix6::controls::ControlRequest
std::string	name

Detailed Description

Animation that fades all the LEDs of a strip simultaneously between Red, Green, and Blue.

Constructor & Destructor Documentation

◆ RgbFadeAnimation()

ctre::phoenix6::controls::RgbFadeAnimation::RgbFadeAnimation	(	int	LEDStartIndex,
		int	LEDEndIndex )

inline

Animation that fades all the LEDs of a strip simultaneously between Red, Green, and Blue.

Parameters

LEDStartIndex	The index of the first LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.
LEDEndIndex	The index of the last LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.

Member Function Documentation

◆ GetControlInfo()

std::map< std::string, std::string > ctre::phoenix6::controls::RgbFadeAnimation::GetControlInfo ( ) const

inlineoverridevirtual

Gets information about this control request.

Returns: Map of control parameter names and corresponding applied values

Implements ctre::phoenix6::controls::ControlRequest.

◆ ToString()

std::string ctre::phoenix6::controls::RgbFadeAnimation::ToString ( ) const

inlineoverridevirtual

Returns a string representation of the object.

Returns: a string representation of the object.

Implements ctre::phoenix6::controls::ControlRequest.

◆ WithBrightness()

RgbFadeAnimation & ctre::phoenix6::controls::RgbFadeAnimation::WithBrightness ( units::dimensionless::scalar_t newBrightness )

inline

Modifies this Control Request's Brightness parameter and returns itself for method-chaining and easier to use request API.

The brightness of the animation, as a scalar from 0.0 to 1.0.

Parameters

newBrightness Parameter to modify

Returns: Itself

◆ WithFrameRate()

RgbFadeAnimation & ctre::phoenix6::controls::RgbFadeAnimation::WithFrameRate ( units::frequency::hertz_t newFrameRate )

inline

Modifies this Control Request's FrameRate parameter and returns itself for method-chaining and easier to use request API.

The frame rate of the animation, from [2, 1000] Hz. This determines the speed of the animation.

A frame is defined as a transition in the state of the LEDs, adjusting the brightness of the LEDs by 1%.

Units: Hz

Parameters

newFrameRate Parameter to modify

Returns: Itself

◆ WithLEDEndIndex()

RgbFadeAnimation & ctre::phoenix6::controls::RgbFadeAnimation::WithLEDEndIndex ( int newLEDEndIndex )

inline

Modifies this Control Request's LEDEndIndex parameter and returns itself for method-chaining and easier to use request API.

The index of the last LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.

Parameters

newLEDEndIndex Parameter to modify

Returns: Itself

◆ WithLEDStartIndex()

RgbFadeAnimation & ctre::phoenix6::controls::RgbFadeAnimation::WithLEDStartIndex ( int newLEDStartIndex )

inline

Modifies this Control Request's LEDStartIndex parameter and returns itself for method-chaining and easier to use request API.

The index of the first LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.

Parameters

newLEDStartIndex Parameter to modify

Returns: Itself

◆ WithSlot()

RgbFadeAnimation & ctre::phoenix6::controls::RgbFadeAnimation::WithSlot ( int newSlot )

inline

Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.

The slot of this animation, within [0, 7]. Each slot on the CANdle can store and run one animation.

Parameters

newSlot Parameter to modify

Returns: Itself

◆ WithUpdateFreqHz()

RgbFadeAnimation & ctre::phoenix6::controls::RgbFadeAnimation::WithUpdateFreqHz ( units::frequency::hertz_t newUpdateFreqHz )

inline

Sets the period at which this control will update at.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

Parameters

newUpdateFreqHz Parameter to modify

Returns: Itself

Member Data Documentation

◆ Brightness

units::dimensionless::scalar_t ctre::phoenix6::controls::RgbFadeAnimation::Brightness = 1.0

The brightness of the animation, as a scalar from 0.0 to 1.0.

◆ FrameRate

units::frequency::hertz_t ctre::phoenix6::controls::RgbFadeAnimation::FrameRate = 100_Hz

The frame rate of the animation, from [2, 1000] Hz.

This determines the speed of the animation.

A frame is defined as a transition in the state of the LEDs, adjusting the brightness of the LEDs by 1%.

Units: Hz

◆ LEDEndIndex

int ctre::phoenix6::controls::RgbFadeAnimation::LEDEndIndex

The index of the last LED this animation controls (inclusive).

Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.

◆ LEDStartIndex

int ctre::phoenix6::controls::RgbFadeAnimation::LEDStartIndex

The index of the first LED this animation controls (inclusive).

Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.

◆ Slot

int ctre::phoenix6::controls::RgbFadeAnimation::Slot = 0

The slot of this animation, within [0, 7].

Each slot on the CANdle can store and run one animation.

◆ UpdateFreqHz

units::frequency::hertz_t ctre::phoenix6::controls::RgbFadeAnimation::UpdateFreqHz {20_Hz}

The period at which this control will update at.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

The documentation for this class was generated from the following file:

ctre/phoenix6/controls/RgbFadeAnimation.hpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RgbFadeAnimation()

Member Function Documentation

◆ GetControlInfo()

◆ ToString()

◆ WithBrightness()

◆ WithFrameRate()

◆ WithLEDEndIndex()

◆ WithLEDStartIndex()

◆ WithSlot()

◆ WithUpdateFreqHz()

Member Data Documentation

◆ Brightness

◆ FrameRate

◆ LEDEndIndex

◆ LEDStartIndex

◆ Slot

◆ UpdateFreqHz