BaseStandardAnimation

class phoenix5.led.BaseStandardAnimation(idx: int, brightness: float, speed: float, numLed: int, param4: float, param5: float, reverseDirection: bool, ledOffset: int)

Bases: Animation

The base class for one generic type of animation. These animations do not allow the user to specify a color.

Constructor for the BaseStandardAnimation object

Parameters:

  • idx – The animation-specific ID

  • brightness – The brightness to run the animation at. This is a scalar from [0, 1]

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

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

  • param4 – Animation-specific parameter

  • param5 – Animation-specific parameter

  • reverseDirection – True to reverse the animation direction, so instead of going “away” from the CANdle, it will go “toward” the CANdle.

  • ledOffset – Where to start the animation

getBaseStandardAnimation() → phoenix5._ctre.led.BaseStandardAnimation
getBaseTwoSizeAnimation() → phoenix5._ctre.led.BaseTwoSizeAnimation
getBrightness() → float
getParam4() → float
getParam5() → float
getReverseDirection() → bool
setBrightness(brightness: float) → None

Sets the brightness of this animation

Parameters:

brightness – The brightness to run the animation at. This is a scalar from [0, 1]

setParam4(param4: float) → None
setParam5(param5: float) → None
setReverseDirection(reverseDirection: bool) → None

Set the Direction of the animation

Parameters:

reverseDirection – True to reverse the animation direction, so instead of fire going “away” from the CANdle, it will go “toward” the CANdle.