Class SolidColor

Namespace

CTRE.Phoenix6.Controls

Assembly

Phoenix6.Hardware.dll

Sets LEDs to a solid color.

public sealed class SolidColor : ControlRequest, ICloneable

Inheritance

object

SolidColor

Implements

ControlRequest

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SolidColor(int, int)

Sets LEDs to a solid color.

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 SolidColor(int LEDStartIndex, int LEDEndIndex)

Parameters

LEDStartIndex int

LEDEndIndex int

Fields

Color

The color to apply to the LEDs.

public RGBWColor Color

Field Value

RGBWColor

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

Properties

Name

Name of this control request.

public string Name { get; }

Property Value

string

Methods

Clone()

Creates a copy of this control request.

public SolidColor Clone()

Returns

SolidColor

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

WithColor(RGBWColor)

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

The color to apply to the LEDs.

public SolidColor WithColor(RGBWColor newColor)

Parameters

newColor RGBWColor

Parameter to modify

Returns

SolidColor

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 SolidColor WithLEDEndIndex(int newLEDEndIndex)

Parameters

newLEDEndIndex int

Parameter to modify

Returns

SolidColor

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 SolidColor WithLEDStartIndex(int newLEDStartIndex)

Parameters

newLEDStartIndex int

Parameter to modify

Returns

SolidColor

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 SolidColor WithUpdateFreqHz(double newUpdateFreqHz)

Parameters

newUpdateFreqHz double

Parameter to modify

Returns

SolidColor

Itself