Package com.ctre.phoenix.led

Class FireAnimation

java.lang.Object
com.ctre.phoenix.led.Animation
com.ctre.phoenix.led.FireAnimation
@Deprecated(since="2026", forRemoval=true) public class FireAnimation 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 looks similarly to a flame flickering

  • Constructor Summary

    Constructors
    Constructor
    Description
    FireAnimation()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor for a FireAnimation.
    FireAnimation(double brightness, double speed, int numLed, double sparking, double cooling)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor for a FireAnimation
    FireAnimation(double brightness, double speed, int numLed, double sparking, double cooling, boolean reverseDirection, int ledOffset)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor for a FireAnimation

  • 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
    setBrightness(double brightness)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the brightness of this animation
    void
    setCooling(double cooling)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the cooling value of the FireAnimation
    void
    setSparking(double sparking)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the sparking value of the FireAnimation

    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

    • FireAnimation

      public FireAnimation(double brightness, double speed, int numLed, double sparking, double cooling, boolean reverseDirection, int ledOffset)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor for a FireAnimation
      Parameters:
      brightness - How bright should the animation be [0, 1]
      speed - How fast will the flame be processed at [0, 1]
      numLed - How many LEDs is the CANdle controlling
      sparking - The rate at which the Fire "Sparks" [0, 1]
      cooling - The rate at which the Fire "Cools" along the travel [0, 1]
      reverseDirection - True to reverse the animation direction, so instead of fire going "away" from the CANdle, it will go "toward" the CANdle.
      ledOffset - Where to start the animation

    • FireAnimation

      public FireAnimation(double brightness, double speed, int numLed, double sparking, double cooling)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor for a FireAnimation
      Parameters:
      brightness - How bright should the animation be [0, 1]
      speed - How fast will the flame be processed at [0, 1]
      numLed - How many LEDs is the CANdle controlling
      sparking - The rate at which the Fire "Sparks" [0, 1]
      cooling - The rate at which the Fire "Cools" along the travel [0, 1]

    • FireAnimation

      public FireAnimation()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor for a FireAnimation. Call individual setters to tune the parameters further

  • Method Details

    • setSparking

      public void setSparking(double sparking)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the sparking value of the FireAnimation
      Parameters:
      sparking - The rate at which the Fire "Sparks" [0, 1]

    • setCooling

      public void setCooling(double cooling)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the cooling value of the FireAnimation
      Parameters:
      cooling - The rate at which the Fire "Cools" [0, 1]

    • setBrightness

      public void setBrightness(double brightness)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the brightness of this animation
      Parameters:
      brightness - The brightness to run the animation at. This is a scalar from [0, 1]

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