Class LarsonAnimation

Namespace

CTRE.Phoenix6.Controls

Assembly

Phoenix6.Hardware.dll

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

public sealed class LarsonAnimation : ControlRequest, ICloneable

Inheritance

object

LarsonAnimation

Implements

ControlRequest

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

LarsonAnimation(int, int)

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

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

public LarsonAnimation(int LEDStartIndex, int LEDEndIndex)

Parameters

LEDStartIndex int

LEDEndIndex int

Fields

BounceMode

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

public LarsonBounceValue BounceMode

Field Value

LarsonBounceValue

Color

The color to use in the animation.

public RGBWColor Color

Field Value

RGBWColor

FrameRate

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

public double FrameRate

Field Value

double

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.

public int LEDEndIndex

Field Value

int

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.

public int LEDStartIndex

Field Value

int

Size

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

public int Size

Field Value

int

Slot

The slot of this animation, within [0, 7]. Each slot on the CANdle can store and run one animation.

public int Slot

Field Value

int

UpdateFreqHz

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.

public double UpdateFreqHz

Field Value

double

Properties

Name

Name of this control request.

public string Name { get; }

Property Value

string

Methods

Clone()

Creates a copy of this control request.

public LarsonAnimation Clone()

Returns

LarsonAnimation

GetControlInfo()

Gets information about this control request.

public Dictionary<string, string> GetControlInfo()

Returns

Dictionary<string, string>

Dictionary of control parameter names and corresponding applied values

SendRequest(string, uint)

Sends this request out over CAN bus to the device for the device to apply.

public StatusCode SendRequest(string network, uint deviceHash)

Parameters

network string

Network to send request over

deviceHash uint

Device to send request to

Returns

StatusCode

Status of the send operation

ToString()

Provides the string representation of this object.

public override string ToString()

Returns

string

WithBounceMode(LarsonBounceValue)

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.

public LarsonAnimation WithBounceMode(LarsonBounceValue newBounceMode)

Parameters

newBounceMode LarsonBounceValue

Parameter to modify

Returns

LarsonAnimation

Itself

WithColor(RGBWColor)

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.

public LarsonAnimation WithColor(RGBWColor newColor)

Parameters

newColor RGBWColor

Parameter to modify

Returns

LarsonAnimation

Itself

WithFrameRate(double)

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

public LarsonAnimation WithFrameRate(double newFrameRate)

Parameters

newFrameRate double

Parameter to modify

Returns

LarsonAnimation

Itself

WithLEDEndIndex(int)

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.

public LarsonAnimation WithLEDEndIndex(int newLEDEndIndex)

Parameters

newLEDEndIndex int

Parameter to modify

Returns

LarsonAnimation

Itself

WithLEDStartIndex(int)

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.

public LarsonAnimation WithLEDStartIndex(int newLEDStartIndex)

Parameters

newLEDStartIndex int

Parameter to modify

Returns

LarsonAnimation

Itself

WithSize(int)

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.

public LarsonAnimation WithSize(int newSize)

Parameters

newSize int

Parameter to modify

Returns

LarsonAnimation

Itself

WithSlot(int)

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.

public LarsonAnimation WithSlot(int newSlot)

Parameters

newSlot int

Parameter to modify

Returns

LarsonAnimation

Itself

WithUpdateFreqHz(double)

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.

public LarsonAnimation WithUpdateFreqHz(double newUpdateFreqHz)

Parameters

newUpdateFreqHz double

Parameter to modify

Returns

LarsonAnimation

Itself