API
===

This page contains the auto-generated documentation for the socs package.

socs.agents
-----------

socs.agents.scpi_psu.drivers
````````````````````````````

.. automodule:: socs.agents.scpi_psu.drivers
    :members:
    :undoc-members:
    :show-inheritance:

socs.agents.tektronix3021c.drivers
``````````````````````````````````

.. automodule:: socs.agents.tektronix3021c.drivers
    :members:
    :undoc-members:
    :show-inheritance:

socs.agents.vantagepro2.drivers
```````````````````````````````

.. automodule:: socs.agents.vantagepro2.drivers
    :members:
    :undoc-members:
    :show-inheritance:

socs.common
-----------

The ``common/`` directory contains driver code that is used by multiple socs
Agents.

socs.common.moxa_serial
```````````````````````

.. automodule:: socs.common.moxa_serial
    :members:
    :undoc-members:
    :show-inheritance:

socs.common.pmx
```````````````

.. automodule:: socs.common.pmx
    :members:
    :undoc-members:
    :show-inheritance:

socs.common.prologix_interface
``````````````````````````````

.. automodule:: socs.common.prologix_interface
    :members:
    :undoc-members:
    :show-inheritance:

socs.db
-------

The ``db/`` directory contains code that supports databases used within socs.

socs.db.suprsync
````````````````

.. automodule:: socs.db.suprsync
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

socs.Lakeshore
--------------

The ``Lakeshore/`` directory contains code that supports the various Lakeshore
devices used in socs. For details, see the "Supporting APIs" section of the
relevant Agent page.

socs.smurf
----------

socs.smurf.MultiSlotController
``````````````````````````````

.. automodule:: socs.smurf.MultiSlotController
    :members:
    :undoc-members:
    :show-inheritance:

socs.snmp
---------

.. automodule:: socs.snmp
    :members:
    :undoc-members:
    :show-inheritance:

socs.tcp
---------

.. automodule:: socs.tcp
    :members:
    :undoc-members:
    :show-inheritance:
    :noindex:

socs.testing
------------

The ``testing/`` directory contains code that supports testing Agents.

socs.testing.device_emulator
````````````````````````````

.. automodule:: socs.testing.device_emulator
    :members:
    :undoc-members:
    :show-inheritance:

socs.util
---------

.. automodule:: socs.util
    :members:
    :undoc-members:
    :show-inheritance: