Package com.ctre.phoenix6.controls

Class TwinkleAnimation

java.lang.Object
com.ctre.phoenix6.controls.ControlRequest
com.ctre.phoenix6.controls.TwinkleAnimation
All Implemented Interfaces:
Cloneable
public class TwinkleAnimation extends ControlRequest implements Cloneable
Animation that randomly turns LEDs on and off to a certain color.

  • Field Details

    • LEDStartIndex

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

    • LEDEndIndex

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

    • Slot

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

    • Color

      public RGBWColor Color
      The color to use in the animation.

    • MaxLEDsOnProportion

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

    • FrameRate

      public double 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, turning one on or off.

      • Units: Hz

    • UpdateFreqHz

      public double UpdateFreqHz
      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.

  • Constructor Details

    • TwinkleAnimation

      public TwinkleAnimation(int LEDStartIndex, int LEDEndIndex)
      Animation that randomly turns LEDs on and off to a certain color.

      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.

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • sendRequest

      public StatusCode sendRequest(String network, int deviceHash)
      Specified by:
      sendRequest in class ControlRequest

    • getControlInfo

      public Map<String,String> getControlInfo()
      Gets information about this control request.
      Specified by:
      getControlInfo in class ControlRequest
      Returns:
      Map of control parameter names and corresponding applied values

    • withLEDStartIndex

      public TwinkleAnimation withLEDStartIndex(int newLEDStartIndex)
      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

    • withLEDEndIndex

      public TwinkleAnimation withLEDEndIndex(int newLEDEndIndex)
      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

    • withSlot

      public TwinkleAnimation withSlot(int newSlot)
      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

    • withColor

      public TwinkleAnimation withColor(RGBWColor newColor)
      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

    • withMaxLEDsOnProportion

      public TwinkleAnimation withMaxLEDsOnProportion(double newMaxLEDsOnProportion)
      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

    • withFrameRate

      public TwinkleAnimation withFrameRate(double newFrameRate)
      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 on or off.

      • Units: Hz
      Parameters:
      newFrameRate - Parameter to modify
      Returns:
      Itself

    • withFrameRate

      public TwinkleAnimation withFrameRate(Frequency newFrameRate)
      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 on or off.

      • Units: Hz
      Parameters:
      newFrameRate - Parameter to modify
      Returns:
      Itself

    • getFrameRateMeasure

      public Frequency getFrameRateMeasure()
      Helper method to get this Control Request's FrameRate parameter converted to a unit type. If not using the Java units library, FrameRate can be accessed directly instead.

      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 on or off.

      • Units: Hz
      Returns:
      FrameRate

    • withUpdateFreqHz

      public TwinkleAnimation withUpdateFreqHz(double newUpdateFreqHz)
      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.

      Specified by:
      withUpdateFreqHz in class ControlRequest
      Parameters:
      newUpdateFreqHz - Parameter to modify
      Returns:
      Itself

    • withUpdateFreqHz

      public TwinkleAnimation withUpdateFreqHz(Frequency newUpdateFreqHz)
      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.

      Specified by:
      withUpdateFreqHz in class ControlRequest
      Parameters:
      newUpdateFreqHz - Parameter to modify
      Returns:
      Itself

    • clone

      public TwinkleAnimation clone()
      Overrides:
      clone in class Object