Loading [MathJax]/extensions/tex2jax.js
CTRE Phoenix 6 C++ 25.4.0
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
ctre::phoenix6::controls::StrobeAnimation Class Reference

Animation that strobes the LEDs a specified color. More...

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

Inheritance diagram for ctre::phoenix6::controls::StrobeAnimation:
ctre::phoenix6::controls::ControlRequest

Public Member Functions

 StrobeAnimation (int LEDStartIndex, int LEDEndIndex)
 Animation that strobes the LEDs a specified color.
 
StrobeAnimation & WithLEDStartIndex (int newLEDStartIndex)
 Modifies this Control Request's LEDStartIndex parameter and returns itself for method-chaining and easier to use request API.
 
StrobeAnimation & WithLEDEndIndex (int newLEDEndIndex)
 Modifies this Control Request's LEDEndIndex parameter and returns itself for method-chaining and easier to use request API.
 
StrobeAnimation & WithSlot (int newSlot)
 Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.
 
StrobeAnimation & WithColor (signals::RGBWColor newColor)
 Modifies this Control Request's Color parameter and returns itself for method-chaining and easier to use request API.
 
StrobeAnimation & 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.
 
StrobeAnimation & 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::frequency::hertz_t FrameRate = 4_Hz
 The frame rate of the animation, from [1, 500] 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 strobes the LEDs a specified color.

Constructor & Destructor Documentation

◆ StrobeAnimation()

ctre::phoenix6::controls::StrobeAnimation::StrobeAnimation ( int LEDStartIndex,
int LEDEndIndex )
inline

Animation that strobes the LEDs a specified color.

Parameters
LEDStartIndexThe index of the first LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.
LEDEndIndexThe 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::StrobeAnimation::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::StrobeAnimation::ToString ( ) const
inlineoverridevirtual

Returns a string representation of the object.

Returns
a string representation of the object.

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

◆ WithColor()

StrobeAnimation & ctre::phoenix6::controls::StrobeAnimation::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
newColorParameter to modify
Returns
Itself

◆ WithFrameRate()

StrobeAnimation & ctre::phoenix6::controls::StrobeAnimation::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 [1, 500] Hz. This determines the speed of the animation.

A frame is defined as a transition in the state of the LEDs, turning all LEDs on or off.

  • Units: Hz
Parameters
newFrameRateParameter to modify
Returns
Itself

◆ WithLEDEndIndex()

StrobeAnimation & ctre::phoenix6::controls::StrobeAnimation::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
newLEDEndIndexParameter to modify
Returns
Itself

◆ WithLEDStartIndex()

StrobeAnimation & ctre::phoenix6::controls::StrobeAnimation::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
newLEDStartIndexParameter to modify
Returns
Itself

◆ WithSlot()

StrobeAnimation & ctre::phoenix6::controls::StrobeAnimation::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
newSlotParameter to modify
Returns
Itself

◆ WithUpdateFreqHz()

StrobeAnimation & ctre::phoenix6::controls::StrobeAnimation::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
newUpdateFreqHzParameter to modify
Returns
Itself

Member Data Documentation

◆ Color

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

The color to use in the animation.

◆ FrameRate

units::frequency::hertz_t ctre::phoenix6::controls::StrobeAnimation::FrameRate = 4_Hz

The frame rate of the animation, from [1, 500] Hz.

This determines the speed of the animation.

A frame is defined as a transition in the state of the LEDs, turning all LEDs on or off.

  • Units: Hz

◆ LEDEndIndex

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