Animation that randomly turns on LEDs until it reaches the maximum count, and then turns them all off. More...

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

Inheritance diagram for ctre::phoenix6::controls::TwinkleOffAnimation:

Public Member Functions
constexpr	TwinkleOffAnimation (int LEDStartIndex, int LEDEndIndex)
	Animation that randomly turns on LEDs until it reaches the maximum count, and then turns them all off.

constexpr	~TwinkleOffAnimation () override

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

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

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

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

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

constexpr TwinkleOffAnimation &	WithMaxLEDsOnProportion (units::dimensionless::scalar_t newMaxLEDsOnProportion)
	Modifies this Control Request's MaxLEDsOnProportion parameter and returns itself for method-chaining and easier to use request API.

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

units::dimensionless::scalar_t	MaxLEDsOnProportion = 1.0
	The max proportion of LEDs that can be on, in the range [0.1, 1.0].

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 randomly turns on LEDs until it reaches the maximum count, and then turns them all off.

Constructor & Destructor Documentation

◆ TwinkleOffAnimation()

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

inlineconstexpr

Animation that randomly turns on LEDs until it reaches the maximum count, and then turns them all off.

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.

◆ ~TwinkleOffAnimation()

ctre::phoenix6::controls::TwinkleOffAnimation::~TwinkleOffAnimation ( )

inlineconstexproverride

Member Function Documentation

◆ GetControlInfo()

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

overridevirtual

Returns a string representation of the object.

Returns: a string representation of the object.

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

◆ WithColor()

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

TwinkleOffAnimation & ctre::phoenix6::controls::TwinkleOffAnimation::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, turning one LED on or all LEDs off.

Units: Hz

Parameters

newFrameRate Parameter to modify

Returns: Itself

◆ WithLEDEndIndex()

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

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

◆ WithMaxLEDsOnProportion()

TwinkleOffAnimation & ctre::phoenix6::controls::TwinkleOffAnimation::WithMaxLEDsOnProportion ( units::dimensionless::scalar_t newMaxLEDsOnProportion )

inlineconstexpr

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

The max proportion of LEDs that can be on, in the range [0.1, 1.0].

Parameters

newMaxLEDsOnProportion Parameter to modify

Returns: Itself

◆ WithSlot()

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

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

◆ Color

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

The color to use in the animation.

◆ FrameRate

units::frequency::hertz_t ctre::phoenix6::controls::TwinkleOffAnimation::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, turning one LED on or all LEDs off.

Units: Hz

◆ LEDEndIndex

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

◆ MaxLEDsOnProportion

units::dimensionless::scalar_t ctre::phoenix6::controls::TwinkleOffAnimation::MaxLEDsOnProportion = 1.0

The max proportion of LEDs that can be on, in the range [0.1, 1.0].

◆ Slot

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TwinkleOffAnimation()

◆ ~TwinkleOffAnimation()

Member Function Documentation

◆ GetControlInfo()

◆ GetName()

◆ ToString()

◆ WithColor()

◆ WithFrameRate()

◆ WithLEDEndIndex()

◆ WithLEDStartIndex()

◆ WithMaxLEDsOnProportion()

◆ WithSlot()

◆ WithUpdateFreqHz()

Member Data Documentation

◆ Color

◆ FrameRate

◆ LEDEndIndex

◆ LEDStartIndex

◆ MaxLEDsOnProportion

◆ Slot

◆ UpdateFreqHz