id4_common.devices.softgluezynq_vortex
======================================

.. py:module:: id4_common.devices.softgluezynq_vortex

.. autoapi-nested-parse::

   SoftGlue Zynq device for histogram-mode Vortex detector triggering.





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

.. py:class:: SGZVortex(*args, reset_sleep_time=0.1, reference_clock=10000000.0, **kwargs)

   Bases: :py:obj:`ophyd.Device`


   SoftGlue Zynq device that sequences histogram-mode Vortex detector
   acquisitions.


   .. py:attribute:: preset_monitor


   .. py:attribute:: buffers


   .. py:attribute:: io


   .. py:attribute:: up_counter_status


   .. py:attribute:: down_counter_pulse


   .. py:attribute:: div_by_n


   .. py:attribute:: gate_sync


   .. py:attribute:: gate_trigger


   .. py:attribute:: and_1


   .. py:attribute:: and_3


   .. py:attribute:: or_1


   .. py:attribute:: dff_2


   .. py:attribute:: dff_3


   .. py:attribute:: histscal


   .. py:attribute:: histdma


   .. py:attribute:: clocks


   .. py:attribute:: clock_freq


   .. py:property:: frequency

      Return the configured detector trigger frequency in Hz.


   .. py:method:: start_softglue()

      Bluesky plan stub to assert the enable buffer (in1 = '1').



   .. py:method:: stop_softglue()

      Bluesky plan stub to de-assert the enable buffer (in1 = '0').



   .. py:method:: reset()

      Bluesky plan stub to pulse the reset buffer and clear the histogram
      scaler.



   .. py:method:: stage()

      Stop and reset the SGZ, then subscribe the acquire callback before
      staging.



   .. py:method:: unstage()

      Stop, reset the SGZ, and unsubscribe the acquire callback after
      unstaging.



   .. py:method:: trigger()

      Assert the enable buffer to start one histogram acquisition and return
      its status.



   .. py:method:: default_settings(timeout=10)

      Apply default SGZ Vortex settings (currently a no-op placeholder).