Animation that creates a rainbow throughout all the LEDs. More...

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

Inheritance diagram for ctre::phoenix6::controls::RainbowAnimation:

Public Member Functions
constexpr	RainbowAnimation (int LEDStartIndex, int LEDEndIndex)
	Animation that creates a rainbow throughout all the LEDs.

constexpr	~RainbowAnimation () override

constexpr std::string_view	GetName () const override
	Gets the name of this control request.

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

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

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

constexpr RainbowAnimation &	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.

constexpr RainbowAnimation &	WithDirection (signals::AnimationDirectionValue newDirection)
	Modifies this Control Request's Direction parameter and returns itself for method-chaining and easier to use request API.

constexpr RainbowAnimation &	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.

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

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
constexpr	ControlRequest ()=default
	Constructs a new Control Request.

virtual constexpr	~ControlRequest ()

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.

signals::AnimationDirectionValue	Direction = signals::AnimationDirectionValue::Forward
	The direction of the animation.

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 frequency at which this control will update.

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

constexpr	ControlRequest (ControlRequest &&)=default

constexpr ControlRequest &	operator= (ControlRequest const &)=default

constexpr ControlRequest &	operator= (ControlRequest &&)=default

Detailed Description

Animation that creates a rainbow throughout all the LEDs.

Constructor & Destructor Documentation

◆ RainbowAnimation()

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

inlineconstexpr

Animation that creates a rainbow throughout all the LEDs.

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

If the start index is greater than the end index, the direction will be reversed. The direction can also be changed using the Direction parameter.

Parameters

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.

If the end index is less than the start index, the direction will be reversed. The direction can also be changed using the Direction parameter.

◆ ~RainbowAnimation()

ctre::phoenix6::controls::RainbowAnimation::~RainbowAnimation ( )

inlineconstexproverride

Member Function Documentation

◆ GetControlInfo()

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

overridevirtual

Gets information about this control request.

Returns: Map of control parameter names and corresponding applied values

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

◆ GetName()

std::string_view ctre::phoenix6::controls::RainbowAnimation::GetName ( ) const

inlineconstexproverridevirtual

Gets the name of this control request.

Returns: Name of the control request

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

◆ ToString()

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

overridevirtual

Returns a string representation of the object.

Returns: a string representation of the object.

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

◆ WithBrightness()

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

inlineconstexpr

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

◆ WithDirection()

RainbowAnimation & ctre::phoenix6::controls::RainbowAnimation::WithDirection ( signals::AnimationDirectionValue newDirection )

inlineconstexpr

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

The direction of the animation.

Parameters

newDirection Parameter to modify

Returns: Itself

◆ WithFrameRate()

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

inlineconstexpr

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, advancing the rainbow by about 3 degrees of hue (out of 360 degrees).

Units: Hz

Parameters

newFrameRate Parameter to modify

Returns: Itself

◆ WithLEDEndIndex()

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

inlineconstexpr

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.

If the end index is less than the start index, the direction will be reversed. The direction can also be changed using the Direction parameter.

Parameters

newLEDEndIndex Parameter to modify

Returns: Itself

◆ WithLEDStartIndex()

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

inlineconstexpr

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

If the start index is greater than the end index, the direction will be reversed. The direction can also be changed using the Direction parameter.

Parameters

newLEDStartIndex Parameter to modify

Returns: Itself

◆ WithSlot()

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

inlineconstexpr

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()

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

inlineconstexpr

Sets the frequency at which this control will update.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

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::RainbowAnimation::Brightness = 1.0

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

◆ Direction

signals::AnimationDirectionValue ctre::phoenix6::controls::RainbowAnimation::Direction = signals::AnimationDirectionValue::Forward

The direction of the animation.

◆ FrameRate

units::frequency::hertz_t ctre::phoenix6::controls::RainbowAnimation::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, advancing the rainbow by about 3 degrees of hue (out of 360 degrees).

Units: Hz

◆ LEDEndIndex

int ctre::phoenix6::controls::RainbowAnimation::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.

If the end index is less than the start index, the direction will be reversed. The direction can also be changed using the Direction parameter.

◆ LEDStartIndex

int ctre::phoenix6::controls::RainbowAnimation::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

If the start index is greater than the end index, the direction will be reversed. The direction can also be changed using the Direction parameter.

◆ Slot

int ctre::phoenix6::controls::RainbowAnimation::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::RainbowAnimation::UpdateFreqHz {20_Hz}

The frequency at which this control will update.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

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/RainbowAnimation.hpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RainbowAnimation()

◆ ~RainbowAnimation()

Member Function Documentation

◆ GetControlInfo()

◆ GetName()

◆ ToString()

◆ WithBrightness()

◆ WithDirection()

◆ WithFrameRate()

◆ WithLEDEndIndex()

◆ WithLEDStartIndex()

◆ WithSlot()

◆ WithUpdateFreqHz()

Member Data Documentation

◆ Brightness

◆ Direction

◆ FrameRate

◆ LEDEndIndex

◆ LEDStartIndex

◆ Slot

◆ UpdateFreqHz