:py:mod:`secop_ophyd.SECoPDevices`
==================================

.. py:module:: secop_ophyd.SECoPDevices

.. autodoc2-docstring:: secop_ophyd.SECoPDevices
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`SECoPCMDDevice <secop_ophyd.SECoPDevices.SECoPCMDDevice>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPCMDDevice
          :summary:
   * - :py:obj:`SECoPBaseDevice <secop_ophyd.SECoPDevices.SECoPBaseDevice>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPBaseDevice
          :summary:
   * - :py:obj:`SECoPCommunicatorDevice <secop_ophyd.SECoPDevices.SECoPCommunicatorDevice>`
     -
   * - :py:obj:`SECoPReadableDevice <secop_ophyd.SECoPDevices.SECoPReadableDevice>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPReadableDevice
          :summary:
   * - :py:obj:`SECoPTriggerableDevice <secop_ophyd.SECoPDevices.SECoPTriggerableDevice>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPTriggerableDevice
          :summary:
   * - :py:obj:`SECoPWritableDevice <secop_ophyd.SECoPDevices.SECoPWritableDevice>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPWritableDevice
          :summary:
   * - :py:obj:`SECoPMoveableDevice <secop_ophyd.SECoPDevices.SECoPMoveableDevice>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPMoveableDevice
          :summary:
   * - :py:obj:`SECoPNodeDevice <secop_ophyd.SECoPDevices.SECoPNodeDevice>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPNodeDevice
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`clean_identifier <secop_ophyd.SECoPDevices.clean_identifier>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.clean_identifier
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`DISABLED <secop_ophyd.SECoPDevices.DISABLED>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.DISABLED
          :summary:
   * - :py:obj:`IDLE <secop_ophyd.SECoPDevices.IDLE>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.IDLE
          :summary:
   * - :py:obj:`STANDBY <secop_ophyd.SECoPDevices.STANDBY>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.STANDBY
          :summary:
   * - :py:obj:`PREPARED <secop_ophyd.SECoPDevices.PREPARED>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.PREPARED
          :summary:
   * - :py:obj:`WARN <secop_ophyd.SECoPDevices.WARN>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.WARN
          :summary:
   * - :py:obj:`WARN_STANDBY <secop_ophyd.SECoPDevices.WARN_STANDBY>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.WARN_STANDBY
          :summary:
   * - :py:obj:`WARN_PREPARED <secop_ophyd.SECoPDevices.WARN_PREPARED>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.WARN_PREPARED
          :summary:
   * - :py:obj:`NSTABLE <secop_ophyd.SECoPDevices.NSTABLE>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.NSTABLE
          :summary:
   * - :py:obj:`BUSY <secop_ophyd.SECoPDevices.BUSY>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.BUSY
          :summary:
   * - :py:obj:`DISABLING <secop_ophyd.SECoPDevices.DISABLING>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.DISABLING
          :summary:
   * - :py:obj:`INITIALIZING <secop_ophyd.SECoPDevices.INITIALIZING>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.INITIALIZING
          :summary:
   * - :py:obj:`PREPARING <secop_ophyd.SECoPDevices.PREPARING>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.PREPARING
          :summary:
   * - :py:obj:`STARTING <secop_ophyd.SECoPDevices.STARTING>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.STARTING
          :summary:
   * - :py:obj:`RAMPING <secop_ophyd.SECoPDevices.RAMPING>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.RAMPING
          :summary:
   * - :py:obj:`STABILIZING <secop_ophyd.SECoPDevices.STABILIZING>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.STABILIZING
          :summary:
   * - :py:obj:`FINALIZING <secop_ophyd.SECoPDevices.FINALIZING>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.FINALIZING
          :summary:
   * - :py:obj:`ERROR <secop_ophyd.SECoPDevices.ERROR>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.ERROR
          :summary:
   * - :py:obj:`ERROR_STANDBY <secop_ophyd.SECoPDevices.ERROR_STANDBY>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.ERROR_STANDBY
          :summary:
   * - :py:obj:`ERROR_PREPARED <secop_ophyd.SECoPDevices.ERROR_PREPARED>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.ERROR_PREPARED
          :summary:
   * - :py:obj:`UNKNOWN <secop_ophyd.SECoPDevices.UNKNOWN>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.UNKNOWN
          :summary:
   * - :py:obj:`IF_CLASSES <secop_ophyd.SECoPDevices.IF_CLASSES>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.IF_CLASSES
          :summary:
   * - :py:obj:`SECOP_TO_NEXUS_TYPE <secop_ophyd.SECoPDevices.SECOP_TO_NEXUS_TYPE>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECOP_TO_NEXUS_TYPE
          :summary:
   * - :py:obj:`ALL_IF_CLASSES <secop_ophyd.SECoPDevices.ALL_IF_CLASSES>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPDevices.ALL_IF_CLASSES
          :summary:

API
~~~

.. py:data:: DISABLED
   :canonical: secop_ophyd.SECoPDevices.DISABLED
   :value: 0

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.DISABLED

.. py:data:: IDLE
   :canonical: secop_ophyd.SECoPDevices.IDLE
   :value: 100

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.IDLE

.. py:data:: STANDBY
   :canonical: secop_ophyd.SECoPDevices.STANDBY
   :value: 130

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.STANDBY

.. py:data:: PREPARED
   :canonical: secop_ophyd.SECoPDevices.PREPARED
   :value: 150

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.PREPARED

.. py:data:: WARN
   :canonical: secop_ophyd.SECoPDevices.WARN
   :value: 200

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.WARN

.. py:data:: WARN_STANDBY
   :canonical: secop_ophyd.SECoPDevices.WARN_STANDBY
   :value: 230

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.WARN_STANDBY

.. py:data:: WARN_PREPARED
   :canonical: secop_ophyd.SECoPDevices.WARN_PREPARED
   :value: 250

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.WARN_PREPARED

.. py:data:: NSTABLE
   :canonical: secop_ophyd.SECoPDevices.NSTABLE
   :value: 270

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.NSTABLE

.. py:data:: BUSY
   :canonical: secop_ophyd.SECoPDevices.BUSY
   :value: 300

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.BUSY

.. py:data:: DISABLING
   :canonical: secop_ophyd.SECoPDevices.DISABLING
   :value: 310

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.DISABLING

.. py:data:: INITIALIZING
   :canonical: secop_ophyd.SECoPDevices.INITIALIZING
   :value: 320

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.INITIALIZING

.. py:data:: PREPARING
   :canonical: secop_ophyd.SECoPDevices.PREPARING
   :value: 340

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.PREPARING

.. py:data:: STARTING
   :canonical: secop_ophyd.SECoPDevices.STARTING
   :value: 360

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.STARTING

.. py:data:: RAMPING
   :canonical: secop_ophyd.SECoPDevices.RAMPING
   :value: 370

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.RAMPING

.. py:data:: STABILIZING
   :canonical: secop_ophyd.SECoPDevices.STABILIZING
   :value: 380

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.STABILIZING

.. py:data:: FINALIZING
   :canonical: secop_ophyd.SECoPDevices.FINALIZING
   :value: 390

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.FINALIZING

.. py:data:: ERROR
   :canonical: secop_ophyd.SECoPDevices.ERROR
   :value: 400

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.ERROR

.. py:data:: ERROR_STANDBY
   :canonical: secop_ophyd.SECoPDevices.ERROR_STANDBY
   :value: 430

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.ERROR_STANDBY

.. py:data:: ERROR_PREPARED
   :canonical: secop_ophyd.SECoPDevices.ERROR_PREPARED
   :value: 450

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.ERROR_PREPARED

.. py:data:: UNKNOWN
   :canonical: secop_ophyd.SECoPDevices.UNKNOWN
   :value: 401

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.UNKNOWN

.. py:function:: clean_identifier(anystring)
   :canonical: secop_ophyd.SECoPDevices.clean_identifier

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.clean_identifier

.. py:class:: SECoPCMDDevice(path: secop_ophyd.util.Path, secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient)
   :canonical: secop_ophyd.SECoPDevices.SECoPCMDDevice

   Bases: :py:obj:`ophyd_async.core.StandardReadable`, :py:obj:`bluesky.protocols.Flyable`, :py:obj:`bluesky.protocols.Triggerable`

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPCMDDevice

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPCMDDevice.__init__

   .. py:method:: trigger() -> ophyd_async.core.AsyncStatus
      :canonical: secop_ophyd.SECoPDevices.SECoPCMDDevice.trigger

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPCMDDevice.trigger

   .. py:method:: kickoff() -> ophyd_async.core.AsyncStatus
      :canonical: secop_ophyd.SECoPDevices.SECoPCMDDevice.kickoff

   .. py:method:: complete() -> ophyd_async.core.AsyncStatus
      :canonical: secop_ophyd.SECoPDevices.SECoPCMDDevice.complete

   .. py:method:: collect() -> typing.Iterator[bluesky.protocols.PartialEvent]
      :canonical: secop_ophyd.SECoPDevices.SECoPCMDDevice.collect

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPCMDDevice.collect

.. py:class:: SECoPBaseDevice(secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient, module_name: str, loglevel=logging.INFO, logdir: str | None = None)
   :canonical: secop_ophyd.SECoPDevices.SECoPBaseDevice

   Bases: :py:obj:`ophyd_async.core.StandardReadable`

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPBaseDevice

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPBaseDevice.__init__

   .. py:method:: add_signals_by_format(format, format_params: list, module_name, module_desc: dict)
      :canonical: secop_ophyd.SECoPDevices.SECoPBaseDevice.add_signals_by_format

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPBaseDevice.add_signals_by_format

   .. py:method:: generate_cmd_plan(cmd_dev: secop_ophyd.SECoPDevices.SECoPCMDDevice, argument_type: typing.Type | None = None, return_type: typing.Type | None = None)
      :canonical: secop_ophyd.SECoPDevices.SECoPBaseDevice.generate_cmd_plan

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPBaseDevice.generate_cmd_plan

.. py:class:: SECoPCommunicatorDevice(secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient, module_name: str, loglevel=logging.INFO, logdir: str | None = None)
   :canonical: secop_ophyd.SECoPDevices.SECoPCommunicatorDevice

   Bases: :py:obj:`secop_ophyd.SECoPDevices.SECoPBaseDevice`

.. py:class:: SECoPReadableDevice(secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient, module_name: str, loglevel=logging.INFO, logdir: str | None = None)
   :canonical: secop_ophyd.SECoPDevices.SECoPReadableDevice

   Bases: :py:obj:`secop_ophyd.SECoPDevices.SECoPCommunicatorDevice`, :py:obj:`bluesky.protocols.Triggerable`, :py:obj:`bluesky.protocols.Subscribable`

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPReadableDevice

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPReadableDevice.__init__

   .. py:method:: wait_for_idle()
      :canonical: secop_ophyd.SECoPDevices.SECoPReadableDevice.wait_for_idle
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPReadableDevice.wait_for_idle

   .. py:method:: observe_status_change(monitored_status_code: int)
      :canonical: secop_ophyd.SECoPDevices.SECoPReadableDevice.observe_status_change

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPReadableDevice.observe_status_change

   .. py:method:: trigger() -> ophyd_async.core.AsyncStatus
      :canonical: secop_ophyd.SECoPDevices.SECoPReadableDevice.trigger

   .. py:method:: subscribe(function: ophyd_async.core._utils.Callback[dict[str, bluesky.protocols.Reading]]) -> None
      :canonical: secop_ophyd.SECoPDevices.SECoPReadableDevice.subscribe

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPReadableDevice.subscribe

   .. py:method:: clear_sub(function: ophyd_async.core._utils.Callback) -> None
      :canonical: secop_ophyd.SECoPDevices.SECoPReadableDevice.clear_sub

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPReadableDevice.clear_sub

.. py:class:: SECoPTriggerableDevice(secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient, module_name: str, loglevel=logging.info, logdir: str | None = None)
   :canonical: secop_ophyd.SECoPDevices.SECoPTriggerableDevice

   Bases: :py:obj:`secop_ophyd.SECoPDevices.SECoPReadableDevice`, :py:obj:`bluesky.protocols.Stoppable`

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPTriggerableDevice

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPTriggerableDevice.__init__

   .. py:method:: wait_for_prepared()
      :canonical: secop_ophyd.SECoPDevices.SECoPTriggerableDevice.wait_for_prepared

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPTriggerableDevice.wait_for_prepared

   .. py:method:: trigger() -> ophyd_async.core.AsyncStatus
      :canonical: secop_ophyd.SECoPDevices.SECoPTriggerableDevice.trigger

   .. py:method:: stop(success=True)
      :canonical: secop_ophyd.SECoPDevices.SECoPTriggerableDevice.stop
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPTriggerableDevice.stop

.. py:class:: SECoPWritableDevice(secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient, module_name: str, loglevel=logging.INFO, logdir: str | None = None)
   :canonical: secop_ophyd.SECoPDevices.SECoPWritableDevice

   Bases: :py:obj:`secop_ophyd.SECoPDevices.SECoPReadableDevice`

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPWritableDevice

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPWritableDevice.__init__

.. py:class:: SECoPMoveableDevice(secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient, module_name: str, loglevel=logging.INFO, logdir: str | None = None)
   :canonical: secop_ophyd.SECoPDevices.SECoPMoveableDevice

   Bases: :py:obj:`secop_ophyd.SECoPDevices.SECoPWritableDevice`, :py:obj:`bluesky.protocols.Locatable`, :py:obj:`bluesky.protocols.Stoppable`

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPMoveableDevice

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPMoveableDevice.__init__

   .. py:method:: set(new_target, timeout: typing.Optional[float] = None) -> ophyd_async.core.AsyncStatus
      :canonical: secop_ophyd.SECoPDevices.SECoPMoveableDevice.set

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPMoveableDevice.set

   .. py:method:: stop(success=True)
      :canonical: secop_ophyd.SECoPDevices.SECoPMoveableDevice.stop
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPMoveableDevice.stop

   .. py:method:: locate() -> bluesky.protocols.Location
      :canonical: secop_ophyd.SECoPDevices.SECoPMoveableDevice.locate
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPMoveableDevice.locate

.. py:class:: SECoPNodeDevice(sec_node_uri: str, prefix: str = '', name: str = '', loglevel: str = 'INFO', logdir: str | None = None)
   :canonical: secop_ophyd.SECoPDevices.SECoPNodeDevice

   Bases: :py:obj:`ophyd_async.core.StandardReadable`

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPNodeDevice

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPNodeDevice.__init__

   .. py:attribute:: name
      :canonical: secop_ophyd.SECoPDevices.SECoPNodeDevice.name
      :type: str
      :value: <Multiline-String>

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPNodeDevice.name

   .. py:method:: connect(mock: bool | ophyd_async.core.LazyMock = False, timeout: float = DEFAULT_TIMEOUT, force_reconnect: bool = False)
      :canonical: secop_ophyd.SECoPDevices.SECoPNodeDevice.connect
      :async:

   .. py:method:: class_from_instance(path_to_module: str | None = None)
      :canonical: secop_ophyd.SECoPDevices.SECoPNodeDevice.class_from_instance

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPNodeDevice.class_from_instance

   .. py:method:: descriptiveDataChange(module, description)
      :canonical: secop_ophyd.SECoPDevices.SECoPNodeDevice.descriptiveDataChange

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPNodeDevice.descriptiveDataChange

   .. py:method:: nodeStateChange(online, state)
      :canonical: secop_ophyd.SECoPDevices.SECoPNodeDevice.nodeStateChange

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPNodeDevice.nodeStateChange

   .. py:method:: class_from_interface(mod_properties: dict)
      :canonical: secop_ophyd.SECoPDevices.SECoPNodeDevice.class_from_interface

      .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECoPNodeDevice.class_from_interface

.. py:data:: IF_CLASSES
   :canonical: secop_ophyd.SECoPDevices.IF_CLASSES
   :value: None

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.IF_CLASSES

.. py:data:: SECOP_TO_NEXUS_TYPE
   :canonical: secop_ophyd.SECoPDevices.SECOP_TO_NEXUS_TYPE
   :value: None

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.SECOP_TO_NEXUS_TYPE

.. py:data:: ALL_IF_CLASSES
   :canonical: secop_ophyd.SECoPDevices.ALL_IF_CLASSES
   :value: 'set(...)'

   .. autodoc2-docstring:: secop_ophyd.SECoPDevices.ALL_IF_CLASSES