Animation

class phoenix5.led.Animation(idx: int, speed: float, numLed: int, ledOffset: int)

Bases: pybind11_object

The base class for all animations that CANdle supports.

Constructor for an Animation class

Parameters:

• idx – The animation-specific ID

• speed – The rate at which the animation runs at. Higher is generally faster

• numLed – The number of LEDs to run the animation on

• ledOffset – Where to start the animation

getAnimationIdx() → int

getBaseStandardAnimation() → phoenix5._ctre.led.BaseStandardAnimation

getBaseTwoSizeAnimation() → phoenix5._ctre.led.BaseTwoSizeAnimation

getLedOffset() → int

getNumLed() → int

getSpeed() → float

setLedOffset(ledOffset: int) → None

Sets where the animation starts along the strip

Parameters:

ledOffset – Where to start the animation along the strip

setNumLed(numLed: int) → None

Sets the number of LEDs the animation will run on

Parameters:

numLed – The number of LEDs to run the animation on

setSpeed(speed: float) → None

Sets the speed of the animation

Parameters:

speed – The rate at which the animation runs at. Higher is generally faster