id4_common.devices.energy_device
================================

.. py:module:: id4_common.devices.energy_device

.. autoapi-nested-parse::

   Beamline energy







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

.. py:data:: logger

.. py:class:: EnergySignal(*args, mono_name='mono', feedback_name='mono_feedback', feedback_tolerance=0.1, **kwargs)

   Bases: :py:obj:`ophyd.Signal`


   Beamline energy.
   The monochromator defines the beamline energy.


   .. py:property:: mono

      Return the monochromator device, resolving from registry on first
      access.


   .. py:property:: trackable_devices

      Return all track_energy-labelled devices plus any manually added extra
      devices.


   .. py:property:: extra_devices

      Return the list of manually added trackable devices.


   .. py:property:: tracking

      Print a table of all trackable devices and their current tracking state.


   .. py:method:: tracking_setup(devices_names: collections.abc.Iterable = [])

      Enable tracking for the named devices, or prompt interactively if names
      are empty.



   .. py:property:: position

      Return the current monochromator energy position.


   .. py:property:: limits

      Return the monochromator energy soft limits.


   .. py:property:: feedback_device

      Return the monochromator feedback device from the registry, or None if
      absent.


   .. py:method:: get(**kwargs)

      Uses the mono as the standard beamline energy.



   .. py:method:: set(position, *, wait=False, timeout=None, settle_time=None, moved_cb=None)

      Move mono and all tracking devices to position (keV); disable feedback
      during the move.



   .. py:method:: stop(*, success=False)

      Stops only energy devices that are tracking.



   .. py:method:: default_settings()

      Resolve and cache the monochromator device from the registry.