.. currentmodule:: pymoku

Moku:Lab Device Class
=====================

All interaction with pymoku starts with the creation of a :any:`Moku` object. This can be done directly
if one already knows the IP address of the target, or by using one of the *get_by_* functions to look
up a Moku by Name or Serial Number.

.. note:: If you are running on a Linux OS, use of the *get_by_* functions require that your platform has access to *libdnssd*. This
	is provided by the Avahi libdnssd compatibility library. For example, on Ubuntu::

		sudo apt-get install libavahi-compat-libdnssd1

A :any:`Moku` object is useful only for flashing lights until an instrument is deployed to it. The deployment process
defines the functionality of the Moku:Lab. For examples on how to deploy an instrument, see demo scripts on each of the `Instruments`_ pages below.

Example Usage
-------------

For more details on searching for your Moku:Lab and retrieving device configuration information, see the `Bonjour Moku guide <https://liquidinstruments.atlassian.net/wiki/x/foME>`_. The following example code and a wide range of other pymoku demo scripts can be found at the `pymoku Github repository <https://github.com/liquidinstruments/pymoku>`_.

--------------
The Moku Class
--------------

.. autoclass:: pymoku.Moku
	:members:

-----------
Instruments
-----------

.. toctree::

   oscilloscope
   datalogger
   wavegen
   arbwave
   specan
   phasemeter
   fra
   pid
   lockin
   iirfilterbox

----------
Exceptions
----------

.. autoexception:: MokuException
.. autoexception:: MokuNotFound
.. autoexception:: NetworkError
.. autoexception:: DeployException
.. autoexception:: InvalidOperationException
.. autoexception:: InvalidParameterException
.. autoexception:: ValueOutOfRangeException
.. autoexception:: NotDeployedException
.. autoexception:: FrameTimeout
.. autoexception:: NoDataException
.. autoexception:: InvalidConfigurationException
.. autoexception:: StreamException
.. autoexception:: FileNotFound
.. autoexception:: InsufficientSpace
.. autoexception:: MPNotMounted
.. autoexception:: MPReadOnly
.. autoexception:: UnknownAction
.. autoexception:: MokuBusy
.. autoexception:: UncommittedSettings