FireAnimation

class phoenix5.led.FireAnimation(brightness: float = 1, speed: float = 1, numLed: int = -1, sparking: float = 1, cooling: float = 1, reverseDirection: bool = False, ledOffset: int = 0)

Bases: BaseStandardAnimation

Animation that looks similarly to a flame flickering

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

setCooling(cooling: float) None

Sets the cooling value of the FireAnimation

Parameters:

cooling – The rate at which the Fire “Cools” [0, 1]

setSparking(sparking: float) None

Sets the sparking value of the FireAnimation

Parameters:

sparking – The rate at which the Fire “Sparks” [0, 1]