phoenix6.controls.twinkle_off_animation

Module Contents

class phoenix6.controls.twinkle_off_animation.TwinkleOffAnimation(led_start_index: int, led_end_index: int, slot: int = 0, color: RGBWColor = RGBWColor(), max_leds_on_proportion: float = 1.0, frame_rate: phoenix6.units.hertz = 25)

Animation that randomly turns on LEDs until it reaches the maximum count, and then turns them all off.

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.

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

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

  • color (RGBWColor) – The color to use in the animation.

  • max_leds_on_proportion (float) – The max proportion of LEDs that can be on, in the range [0.1, 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, turning one LED on or all LEDs off.

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.

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.

slot

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

color

The color to use in the animation.

max_leds_on_proportion

The max proportion of LEDs that can be on, in the range [0.1, 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, turning one LED on or all LEDs off.

  • Units: Hz

with_led_start_index(new_led_start_index: int) → TwinkleOffAnimation

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.

Parameters:

new_led_start_index (int) – Parameter to modify

Returns:

Itself

Return type:

TwinkleOffAnimation

with_led_end_index(new_led_end_index: int) → TwinkleOffAnimation

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.

Parameters:

new_led_end_index (int) – Parameter to modify

Returns:

Itself

Return type:

TwinkleOffAnimation

with_slot(new_slot: int) → TwinkleOffAnimation

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:

TwinkleOffAnimation

with_color(new_color: RGBWColor) → TwinkleOffAnimation

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

The color to use in the animation.

Parameters:

new_color (RGBWColor) – Parameter to modify

Returns:

Itself

Return type:

TwinkleOffAnimation

with_max_leds_on_proportion(new_max_leds_on_proportion: float) → TwinkleOffAnimation

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

The max proportion of LEDs that can be on, in the range [0.1, 1.0].

Parameters:

new_max_leds_on_proportion (float) – Parameter to modify

Returns:

Itself

Return type:

TwinkleOffAnimation

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

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, turning one LED on or all LEDs off.

  • Units: Hz

Parameters:

new_frame_rate (hertz) – Parameter to modify

Returns:

Itself

Return type:

TwinkleOffAnimation

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

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:

TwinkleOffAnimation