phoenix6.controls.fire_animation

Module Contents

class phoenix6.controls.fire_animation.FireAnimation(led_start_index: int, led_end_index: int, slot: int = 0, brightness: float = 1.0, direction: AnimationDirectionValue = AnimationDirectionValue.FORWARD, sparking: float = 0.6, cooling: float = 0.3, frame_rate: phoenix6.units.hertz = 60)

Animation that looks similar to a flame flickering.

Parameters:

  • led_start_index (int) –

    The index of the first LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip

    If the start index is greater than the end index, the direction will be reversed. The direction can also be changed using the Direction parameter.

  • led_end_index (int) –

    The index of the last LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.

    If the end index is less than the start index, the direction will be reversed. The direction can also be changed using the Direction parameter.

  • slot (int) – The slot of this animation, within [0, 7]. Each slot on the CANdle can store and run one animation.

  • brightness (float) – The brightness of the animation, as a scalar from 0.0 to 1.0.

  • direction (AnimationDirectionValue) – The direction of the animation.

  • sparking (float) – The proportion of time in which sparks reignite the fire, as a scalar from 0.0 to 1.0.

  • cooling (float) – The rate at which the fire cools along the travel, as a scalar from 0.0 to 1.0.

  • frame_rate (hertz) –

    The frame rate of the animation, from [2, 1000] Hz. This determines the speed of the animation.

    A frame is defined as a transition in the state of the LEDs, advancing the animation of the fire.

property name: str

Gets the name of this control request.

Returns:

Name of the control request

Return type:

str

property control_info: dict

Gets information about this control request.

Returns:

Dictonary of control parameter names and corresponding applied values

Return type:

dict

update_freq_hz: phoenix6.units.hertz = 20

The period at which this control will update at. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

led_start_index

The index of the first LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip

If the start index is greater than the end index, the direction will be reversed. The direction can also be changed using the Direction parameter.

led_end_index

The index of the last LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.

If the end index is less than the start index, the direction will be reversed. The direction can also be changed using the Direction parameter.

slot

The slot of this animation, within [0, 7]. Each slot on the CANdle can store and run one animation.

brightness

The brightness of the animation, as a scalar from 0.0 to 1.0.

direction

The direction of the animation.

sparking

The proportion of time in which sparks reignite the fire, as a scalar from 0.0 to 1.0.

cooling

The rate at which the fire cools along the travel, as a scalar from 0.0 to 1.0.

frame_rate

The frame rate of the animation, from [2, 1000] Hz. This determines the speed of the animation.

A frame is defined as a transition in the state of the LEDs, advancing the animation of the fire.

  • Units: Hz

with_led_start_index(new_led_start_index: int) → FireAnimation

Modifies this Control Request’s led_start_index parameter and returns itself for method-chaining and easier to use request API.

The index of the first LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip

If the start index is greater than the end index, the direction will be reversed. The direction can also be changed using the Direction parameter.

Parameters:

new_led_start_index (int) – Parameter to modify

Returns:

Itself

Return type:

FireAnimation

with_led_end_index(new_led_end_index: int) → FireAnimation

Modifies this Control Request’s led_end_index parameter and returns itself for method-chaining and easier to use request API.

The index of the last LED this animation controls (inclusive). Indices 0-7 control the onboard LEDs, and 8-399 control an attached LED strip.

If the end index is less than the start index, the direction will be reversed. The direction can also be changed using the Direction parameter.

Parameters:

new_led_end_index (int) – Parameter to modify

Returns:

Itself

Return type:

FireAnimation

with_slot(new_slot: int) → FireAnimation

Modifies this Control Request’s slot parameter and returns itself for method-chaining and easier to use request API.

The slot of this animation, within [0, 7]. Each slot on the CANdle can store and run one animation.

Parameters:

new_slot (int) – Parameter to modify

Returns:

Itself

Return type:

FireAnimation

with_brightness(new_brightness: float) → FireAnimation

Modifies this Control Request’s brightness parameter and returns itself for method-chaining and easier to use request API.

The brightness of the animation, as a scalar from 0.0 to 1.0.

Parameters:

new_brightness (float) – Parameter to modify

Returns:

Itself

Return type:

FireAnimation

with_direction(new_direction: AnimationDirectionValue) → FireAnimation

Modifies this Control Request’s direction parameter and returns itself for method-chaining and easier to use request API.

The direction of the animation.

Parameters:

new_direction (AnimationDirectionValue) – Parameter to modify

Returns:

Itself

Return type:

FireAnimation

with_sparking(new_sparking: float) → FireAnimation

Modifies this Control Request’s sparking parameter and returns itself for method-chaining and easier to use request API.

The proportion of time in which sparks reignite the fire, as a scalar from 0.0 to 1.0.

Parameters:

new_sparking (float) – Parameter to modify

Returns:

Itself

Return type:

FireAnimation

with_cooling(new_cooling: float) → FireAnimation

Modifies this Control Request’s cooling parameter and returns itself for method-chaining and easier to use request API.

The rate at which the fire cools along the travel, as a scalar from 0.0 to 1.0.

Parameters:

new_cooling (float) – Parameter to modify

Returns:

Itself

Return type:

FireAnimation

with_frame_rate(new_frame_rate: phoenix6.units.hertz) → FireAnimation

Modifies this Control Request’s frame_rate parameter and returns itself for method-chaining and easier to use request API.

The frame rate of the animation, from [2, 1000] Hz. This determines the speed of the animation.

A frame is defined as a transition in the state of the LEDs, advancing the animation of the fire.

  • Units: Hz

Parameters:

new_frame_rate (hertz) – Parameter to modify

Returns:

Itself

Return type:

FireAnimation

with_update_freq_hz(new_update_freq_hz: phoenix6.units.hertz) → FireAnimation

Sets the period at which this control will update at. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

Parameters:

new_update_freq_hz (hertz) – Parameter to modify

Returns:

Itself

Return type:

FireAnimation