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

.. py:module:: phoenix6.controls.empty_control

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


.. py:class:: EmptyControl


   Generic Empty Control class used to do nothing.

   .. 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:method:: with_update_freq_hz(new_update_freq_hz: phoenix6.units.hertz) -> EmptyControl

      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.

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