:py:mod:`secop_ophyd.SECoPSignal`
=================================

.. py:module:: secop_ophyd.SECoPSignal

.. autodoc2-docstring:: secop_ophyd.SECoPSignal
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`LocalBackend <secop_ophyd.SECoPSignal.LocalBackend>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPSignal.LocalBackend
          :summary:
   * - :py:obj:`SECoPXBackend <secop_ophyd.SECoPSignal.SECoPXBackend>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPXBackend
          :summary:
   * - :py:obj:`SECoPParamBackend <secop_ophyd.SECoPSignal.SECoPParamBackend>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPParamBackend
          :summary:
   * - :py:obj:`PropertyBackend <secop_ophyd.SECoPSignal.PropertyBackend>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPSignal.PropertyBackend
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`secop_dtype_obj_from_json <secop_ophyd.SECoPSignal.secop_dtype_obj_from_json>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPSignal.secop_dtype_obj_from_json
          :summary:
   * - :py:obj:`describedict_to_datakey <secop_ophyd.SECoPSignal.describedict_to_datakey>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPSignal.describedict_to_datakey
          :summary:

Data
~~~~

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

   * - :py:obj:`atomic_dtypes <secop_ophyd.SECoPSignal.atomic_dtypes>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPSignal.atomic_dtypes
          :summary:
   * - :py:obj:`MAX_DEPTH <secop_ophyd.SECoPSignal.MAX_DEPTH>`
     - .. autodoc2-docstring:: secop_ophyd.SECoPSignal.MAX_DEPTH
          :summary:

API
~~~

.. py:data:: atomic_dtypes
   :canonical: secop_ophyd.SECoPSignal.atomic_dtypes
   :value: ()

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.atomic_dtypes

.. py:data:: MAX_DEPTH
   :canonical: secop_ophyd.SECoPSignal.MAX_DEPTH
   :value: 1

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.MAX_DEPTH

.. py:class:: LocalBackend(path: secop_ophyd.util.Path, secop_dtype_obj: frappy.datatypes.DataType, sig_datainfo: dict)
   :canonical: secop_ophyd.SECoPSignal.LocalBackend

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

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.LocalBackend

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.LocalBackend.__init__

   .. py:method:: source(name: str, read: bool) -> str
      :canonical: secop_ophyd.SECoPSignal.LocalBackend.source

   .. py:method:: connect(timeout: float)
      :canonical: secop_ophyd.SECoPSignal.LocalBackend.connect
      :async:

   .. py:method:: put(value: typing.Any | None, wait=True)
      :canonical: secop_ophyd.SECoPSignal.LocalBackend.put
      :async:

   .. py:method:: get_datakey(source: str) -> bluesky.protocols.DataKey
      :canonical: secop_ophyd.SECoPSignal.LocalBackend.get_datakey
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.LocalBackend.get_datakey

   .. py:method:: get_reading() -> bluesky.protocols.Reading[ophyd_async.core.SignalDatatypeT]
      :canonical: secop_ophyd.SECoPSignal.LocalBackend.get_reading
      :async:

   .. py:method:: get_value() -> ophyd_async.core.SignalDatatypeT
      :canonical: secop_ophyd.SECoPSignal.LocalBackend.get_value
      :async:

   .. py:method:: get_setpoint() -> ophyd_async.core.SignalDatatypeT
      :canonical: secop_ophyd.SECoPSignal.LocalBackend.get_setpoint
      :async:

   .. py:method:: set_callback(callback: ophyd_async.core.Callback[bluesky.protocols.Reading[ophyd_async.core.SignalDatatypeT]] | None) -> None
      :canonical: secop_ophyd.SECoPSignal.LocalBackend.set_callback

.. py:class:: SECoPXBackend(path: secop_ophyd.util.Path, secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient, argument: secop_ophyd.SECoPSignal.LocalBackend | None, result: secop_ophyd.SECoPSignal.LocalBackend | None)
   :canonical: secop_ophyd.SECoPSignal.SECoPXBackend

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

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPXBackend

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPXBackend.__init__

   .. py:method:: source(name: str, read: bool) -> str
      :canonical: secop_ophyd.SECoPSignal.SECoPXBackend.source

   .. py:method:: connect(timeout: float)
      :canonical: secop_ophyd.SECoPSignal.SECoPXBackend.connect
      :async:

   .. py:method:: put(value: typing.Any | None, wait=True)
      :canonical: secop_ophyd.SECoPSignal.SECoPXBackend.put
      :async:

   .. py:method:: get_datakey(source: str) -> bluesky.protocols.DataKey
      :canonical: secop_ophyd.SECoPSignal.SECoPXBackend.get_datakey
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPXBackend.get_datakey

   .. py:method:: get_reading() -> bluesky.protocols.Reading[ophyd_async.core.SignalDatatypeT]
      :canonical: secop_ophyd.SECoPSignal.SECoPXBackend.get_reading
      :async:

   .. py:method:: get_value() -> ophyd_async.core.SignalDatatypeT
      :canonical: secop_ophyd.SECoPSignal.SECoPXBackend.get_value
      :async:

   .. py:method:: set_callback(callback: ophyd_async.core.Callback[bluesky.protocols.Reading[ophyd_async.core.SignalDatatypeT]] | None) -> None
      :canonical: secop_ophyd.SECoPSignal.SECoPXBackend.set_callback

   .. py:method:: get_setpoint() -> ophyd_async.core.SignalDatatypeT
      :canonical: secop_ophyd.SECoPSignal.SECoPXBackend.get_setpoint
      :async:

.. py:class:: SECoPParamBackend(path: secop_ophyd.util.Path, secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient)
   :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend

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

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPParamBackend

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPParamBackend.__init__

   .. py:method:: source(name: str, read: bool) -> str
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.source

   .. py:method:: connect(timeout: float)
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.connect
      :async:

   .. py:method:: put(value: typing.Any | None, wait=True)
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.put
      :async:

   .. py:method:: get_datakey(source: str) -> bluesky.protocols.DataKey
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.get_datakey
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPParamBackend.get_datakey

   .. py:method:: get_reading() -> bluesky.protocols.Reading[ophyd_async.core.SignalDatatypeT]
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.get_reading
      :async:

   .. py:method:: get_value() -> ophyd_async.core.SignalDatatypeT
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.get_value
      :async:

   .. py:method:: get_setpoint() -> ophyd_async.core.SignalDatatypeT
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.get_setpoint
      :async:

   .. py:method:: set_callback(callback: ophyd_async.core.Callback[bluesky.protocols.Reading[ophyd_async.core.SignalDatatypeT]] | None) -> None
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.set_callback

   .. py:method:: get_param_path()
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.get_param_path

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPParamBackend.get_param_path

   .. py:method:: get_path_tuple()
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.get_path_tuple

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPParamBackend.get_path_tuple

   .. py:method:: get_unit()
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.get_unit

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPParamBackend.get_unit

   .. py:method:: is_number() -> bool
      :canonical: secop_ophyd.SECoPSignal.SECoPParamBackend.is_number

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.SECoPParamBackend.is_number

.. py:class:: PropertyBackend(prop_key: str, property_dict: typing.Dict[str, typing.Any], secclient: secop_ophyd.AsyncFrappyClient.AsyncFrappyClient)
   :canonical: secop_ophyd.SECoPSignal.PropertyBackend

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

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.PropertyBackend

   .. rubric:: Initialization

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.PropertyBackend.__init__

   .. py:method:: source(name: str, read: bool) -> str
      :canonical: secop_ophyd.SECoPSignal.PropertyBackend.source

   .. py:method:: connect(timeout: float)
      :canonical: secop_ophyd.SECoPSignal.PropertyBackend.connect
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.PropertyBackend.connect

   .. py:method:: put(value: ophyd_async.core.SignalDatatypeT | None, wait=True)
      :canonical: secop_ophyd.SECoPSignal.PropertyBackend.put
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.PropertyBackend.put

   .. py:method:: get_datakey(source: str) -> bluesky.protocols.DataKey
      :canonical: secop_ophyd.SECoPSignal.PropertyBackend.get_datakey
      :async:

      .. autodoc2-docstring:: secop_ophyd.SECoPSignal.PropertyBackend.get_datakey

   .. py:method:: get_reading() -> bluesky.protocols.Reading[ophyd_async.core.SignalDatatypeT]
      :canonical: secop_ophyd.SECoPSignal.PropertyBackend.get_reading
      :async:

   .. py:method:: get_value() -> ophyd_async.core.SignalDatatypeT
      :canonical: secop_ophyd.SECoPSignal.PropertyBackend.get_value
      :async:

   .. py:method:: get_setpoint() -> ophyd_async.core.SignalDatatypeT
      :canonical: secop_ophyd.SECoPSignal.PropertyBackend.get_setpoint
      :async:

   .. py:method:: set_callback(callback: ophyd_async.core.Callback[bluesky.protocols.Reading[ophyd_async.core.SignalDatatypeT]] | None) -> None
      :canonical: secop_ophyd.SECoPSignal.PropertyBackend.set_callback

.. py:function:: secop_dtype_obj_from_json(prop_val)
   :canonical: secop_ophyd.SECoPSignal.secop_dtype_obj_from_json

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.secop_dtype_obj_from_json

.. py:function:: describedict_to_datakey(describe_dict: dict) -> secop_ophyd.util.SECoPDataKey
   :canonical: secop_ophyd.SECoPSignal.describedict_to_datakey

   .. autodoc2-docstring:: secop_ophyd.SECoPSignal.describedict_to_datakey