:py:mod:`phoenix6.controls.empty_animation`
===========================================

.. py:module:: phoenix6.controls.empty_animation

Module Contents
---------------


.. py:class:: EmptyAnimation(slot: int)


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



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

   .. py:property:: name
      :type: str

      Gets the name of this control request.

      :returns: Name of the control request
      :rtype: str


   .. py:property:: control_info
      :type: dict

      Gets information about this control request.

      :returns: Dictonary of control parameter names and corresponding applied values
      :rtype: dict


   .. py:attribute:: update_freq_hz
      :type: phoenix6.units.hertz
      :value: '0'

      The frequency at which this control will update.
      This is designated in Hertz, with a minimum of 20 Hz
      (every 50 ms) and a maximum of 1000 Hz (every 1 ms).
      Some update frequencies are not supported and will be
      promoted up to the next highest supported frequency.

      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.


   .. py:attribute:: slot

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


   .. py:method:: 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.

      :param new_slot: Parameter to modify
      :type new_slot: int
      :returns: Itself
      :rtype: EmptyAnimation


   .. py:method:: with_update_freq_hz(new_update_freq_hz: phoenix6.units.hertz) -> EmptyAnimation

      Sets the frequency at which this control will update.
      This is designated in Hertz, with a minimum of 20 Hz
      (every 50 ms) and a maximum of 1000 Hz (every 1 ms).
      Some update frequencies are not supported and will be
      promoted up to the next highest supported frequency.

      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.

      :param new_update_freq_hz: Parameter to modify
      :type new_update_freq_hz: hertz
      :returns: Itself
      :rtype: EmptyAnimation