`phoenix6.controls.empty_animation`¶

Module Contents¶

class phoenix6.controls.empty_animation.EmptyAnimation(slot: int)¶

An empty animation, clearing any animation in the specified slot.

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

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 = 0¶

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.

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

with_slot(new_slot: int) → EmptyAnimation¶

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:: EmptyAnimation

with_update_freq_hz(new_update_freq_hz: phoenix6.units.hertz) → EmptyAnimation¶

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

Parameters:: new_update_freq_hz (hertz) – Parameter to modify
Returns:: Itself
Return type:: EmptyAnimation

phoenix6.controls.empty_animation¶

Module Contents¶

`phoenix6.controls.empty_animation`¶