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
	TwinkleOffAnimation (int LEDStartIndex, int LEDEndIndex)
	Animation that randomly turns on LEDs until it reaches the maximum count, and then turns them all off.

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

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

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

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

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.

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.

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

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

inline

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.

Member Function Documentation

◆ GetControlInfo()

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

inlineoverridevirtual

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 )

inline

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 )

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

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

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

◆ WithMaxLEDsOnProportion()

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

inline

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 )

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

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

◆ 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 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/TwinkleOffAnimation.hpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TwinkleOffAnimation()

Member Function Documentation

◆ GetControlInfo()

◆ ToString()

◆ WithColor()

◆ WithFrameRate()

◆ WithLEDEndIndex()

◆ WithLEDStartIndex()

◆ WithMaxLEDsOnProportion()

◆ WithSlot()

◆ WithUpdateFreqHz()

Member Data Documentation

◆ Color

◆ FrameRate

◆ LEDEndIndex

◆ LEDStartIndex

◆ MaxLEDsOnProportion

◆ Slot

◆ UpdateFreqHz