Package com.ctre.phoenix.led

Class LarsonAnimation

java.lang.Object
com.ctre.phoenix.led.Animation
com.ctre.phoenix.led.LarsonAnimation
@Deprecated(since="2026", forRemoval=true) public class LarsonAnimation extends Animation
Deprecated, for removal: This API element is subject to removal in a future version.
This device's Phoenix 5 API is deprecated for removal in the 2027 season. Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API. A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.

If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    LarsonAnimation.BounceMode
    Deprecated, for removal: This API element is subject to removal in a future version.
    How the pocket of light behaves when it reaches the end of the strip

  • Constructor Summary

    Constructors
    Constructor
    Description
    LarsonAnimation(int r, int g, int b)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor for a LarsonAnimation
    LarsonAnimation(int r, int g, int b, int w, double speed, int numLed, LarsonAnimation.BounceMode mode, int size)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor for a LarsonAnimation
    LarsonAnimation(int r, int g, int b, int w, double speed, int numLed, LarsonAnimation.BounceMode mode, int size, int ledOffset)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor for a LarsonAnimation

  • Method Summary

    Modifier and Type
    Method
    Description
    com.ctre.phoenix.led.BaseStandardAnimation
    getBaseStandardAnimation()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    com.ctre.phoenix.led.BaseTwoSizeAnimation
    getBaseTwoSizeAnimation()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setB(int b)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the B value of the LEDs
    void
    setBounceMode(LarsonAnimation.BounceMode mode)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the bounce mode of the animation.
    void
    setG(int g)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the G value of the LEDs
    void
    setR(int r)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the R value of the LEDs
    void
    setSize(int size)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the size of the pocket of LEDs
    void
    setW(int w)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the W value of the LEDs

    Methods inherited from class com.ctre.phoenix.led.Animation

    setLedOffset, setNumLed, setSpeed

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • LarsonAnimation

      public LarsonAnimation(int r, int g, int b, int w, double speed, int numLed, LarsonAnimation.BounceMode mode, int size, int ledOffset)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor for a LarsonAnimation
      Parameters:
      r - How much red should the color have [0, 255]
      g - How much green should the color have [0, 255]
      b - How much blue should the color have [0, 255]
      w - How much white should the color have [0, 255]
      speed - How fast should the color travel the strip [0, 1]
      numLed - The number of LEDs the CANdle will control
      mode - How the pocket of LEDs will behave once it reaches the end of the strip
      size - How large the pocket of LEDs are [0, 7]
      ledOffset - Where to start the animation

    • LarsonAnimation

      public LarsonAnimation(int r, int g, int b, int w, double speed, int numLed, LarsonAnimation.BounceMode mode, int size)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor for a LarsonAnimation
      Parameters:
      r - How much red should the color have [0, 255]
      g - How much green should the color have [0, 255]
      b - How much blue should the color have [0, 255]
      w - How much white should the color have [0, 255]
      speed - How fast should the color travel the strip [0, 1]
      numLed - The number of LEDs the CANdle will control
      mode - How the pocket of LEDs will behave once it reaches the end of the strip
      size - How large the pocket of LEDs are [0, 7]

    • LarsonAnimation

      public LarsonAnimation(int r, int g, int b)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor for a LarsonAnimation
      Parameters:
      r - How much red should the color have [0, 255]
      g - How much green should the color have [0, 255]
      b - How much blue should the color have [0, 255]

  • Method Details

    • setBounceMode

      public void setBounceMode(LarsonAnimation.BounceMode mode)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the bounce mode of the animation.
      Parameters:
      mode - How the pocket of LEDs will behave once it reaches the end of the strip

    • setSize

      public void setSize(int size)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the size of the pocket of LEDs
      Parameters:
      size - The size of the pocket [0, 7]

    • setR

      public void setR(int r)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the R value of the LEDs
      Parameters:
      r - The amount of red to set, a value between [0, 255]

    • setG

      public void setG(int g)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the G value of the LEDs
      Parameters:
      g - The amount of green to set, a value between [0, 255]

    • setB

      public void setB(int b)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the B value of the LEDs
      Parameters:
      b - The amount of blue to set, a value between [0, 255]

    • setW

      public void setW(int w)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the W value of the LEDs
      Parameters:
      w - The amount of white to set, a value between [0, 255]

    • getBaseStandardAnimation

      public com.ctre.phoenix.led.BaseStandardAnimation getBaseStandardAnimation()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getBaseTwoSizeAnimation

      public com.ctre.phoenix.led.BaseTwoSizeAnimation getBaseTwoSizeAnimation()
      Deprecated, for removal: This API element is subject to removal in a future version.