Animation that bounces a pocket of light across the LED strip. More...

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

Inheritance diagram for ctre::phoenix6::controls::LarsonAnimation:

Public Member Functions
constexpr	LarsonAnimation (int LEDStartIndex, int LEDEndIndex)
	Animation that bounces a pocket of light across the LED strip.

constexpr	~LarsonAnimation () override

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

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

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

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

constexpr LarsonAnimation &	WithColor (signals::RGBWColor newColor)
	Modifies this Control Request's Color parameter and returns itself for method-chaining and easier to use request API.

constexpr LarsonAnimation &	WithSize (int newSize)
	Modifies this Control Request's Size parameter and returns itself for method-chaining and easier to use request API.

constexpr LarsonAnimation &	WithBounceMode (signals::LarsonBounceValue newBounceMode)
	Modifies this Control Request's BounceMode parameter and returns itself for method-chaining and easier to use request API.

constexpr LarsonAnimation &	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 LarsonAnimation &	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].

signals::RGBWColor	Color = signals::RGBWColor{}
	The color to use in the animation.

int	Size = 3
	The number of LEDs in the pocket of light, up to 15.

signals::LarsonBounceValue	BounceMode = signals::LarsonBounceValue::Front
	The behavior of the pocket of light when it reaches the end of the strip.

units::frequency::hertz_t	FrameRate = 25_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 bounces a pocket of light across the LED strip.

Constructor & Destructor Documentation

◆ LarsonAnimation()

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

inlineconstexpr

Animation that bounces a pocket of light across the LED strip.

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.

◆ ~LarsonAnimation()

ctre::phoenix6::controls::LarsonAnimation::~LarsonAnimation ( )

inlineconstexproverride

Member Function Documentation

◆ GetControlInfo()

std::map< std::string, std::string > ctre::phoenix6::controls::LarsonAnimation::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::LarsonAnimation::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::LarsonAnimation::ToString ( ) const

overridevirtual

Returns a string representation of the object.

Returns: a string representation of the object.

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

◆ WithBounceMode()

LarsonAnimation & ctre::phoenix6::controls::LarsonAnimation::WithBounceMode ( signals::LarsonBounceValue newBounceMode )

inlineconstexpr

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

The behavior of the pocket of light when it reaches the end of the strip.

Parameters

newBounceMode Parameter to modify

Returns: Itself

◆ WithColor()

LarsonAnimation & ctre::phoenix6::controls::LarsonAnimation::WithColor ( signals::RGBWColor newColor )

inlineconstexpr

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

The color to use in the animation.

Parameters

newColor Parameter to modify

Returns: Itself

◆ WithFrameRate()

LarsonAnimation & ctre::phoenix6::controls::LarsonAnimation::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 pocket of light by one LED.

Units: Hz

Parameters

newFrameRate Parameter to modify

Returns: Itself

◆ WithLEDEndIndex()

LarsonAnimation & ctre::phoenix6::controls::LarsonAnimation::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.

Parameters

newLEDEndIndex Parameter to modify

Returns: Itself

◆ WithLEDStartIndex()

LarsonAnimation & ctre::phoenix6::controls::LarsonAnimation::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.

Parameters

newLEDStartIndex Parameter to modify

Returns: Itself

◆ WithSize()

LarsonAnimation & ctre::phoenix6::controls::LarsonAnimation::WithSize ( int newSize )

inlineconstexpr

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

The number of LEDs in the pocket of light, up to 15.

Parameters

newSize Parameter to modify

Returns: Itself

◆ WithSlot()

LarsonAnimation & ctre::phoenix6::controls::LarsonAnimation::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()

LarsonAnimation & ctre::phoenix6::controls::LarsonAnimation::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

◆ BounceMode

signals::LarsonBounceValue ctre::phoenix6::controls::LarsonAnimation::BounceMode = signals::LarsonBounceValue::Front

The behavior of the pocket of light when it reaches the end of the strip.

◆ Color

signals::RGBWColor ctre::phoenix6::controls::LarsonAnimation::Color = signals::RGBWColor{}

The color to use in the animation.

◆ FrameRate

units::frequency::hertz_t ctre::phoenix6::controls::LarsonAnimation::FrameRate = 25_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 pocket of light by one LED.

Units: Hz

◆ LEDEndIndex

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

◆ Size

int ctre::phoenix6::controls::LarsonAnimation::Size = 3

The number of LEDs in the pocket of light, up to 15.

◆ Slot

int ctre::phoenix6::controls::LarsonAnimation::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::LarsonAnimation::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/LarsonAnimation.hpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LarsonAnimation()

◆ ~LarsonAnimation()

Member Function Documentation

◆ GetControlInfo()

◆ GetName()

◆ ToString()

◆ WithBounceMode()

◆ WithColor()

◆ WithFrameRate()

◆ WithLEDEndIndex()

◆ WithLEDStartIndex()

◆ WithSize()

◆ WithSlot()

◆ WithUpdateFreqHz()

Member Data Documentation

◆ BounceMode

◆ Color

◆ FrameRate

◆ LEDEndIndex

◆ LEDStartIndex

◆ Size

◆ Slot

◆ UpdateFreqHz