FUTEK Device Communication
==========================

This module provides communication interfaces for FUTEK serial devices.

Custom Exceptions
-----------------

.. autoclass:: futek_device_communication.FutekDeviceError
   :members:
   :show-inheritance:

.. autoclass:: futek_device_communication.FutekConnectionError
   :members:
   :show-inheritance:

.. autoclass:: futek_device_communication.FutekCommunicationError
   :members:
   :show-inheritance:

.. autoclass:: futek_device_communication.FutekTimeoutError
   :members:
   :show-inheritance:

.. autoclass:: futek_device_communication.FutekProtocolError
   :members:
   :show-inheritance:

.. autoclass:: futek_device_communication.FutekInvalidParameterError
   :members:
   :show-inheritance:

.. autoclass:: futek_device_communication.FutekDeviceNotFoundError
   :members:
   :show-inheritance:

.. autoclass:: futek_device_communication.FutekCalibrationError
   :members:
   :show-inheritance:

FUTEK Serial Scanner
--------------------

.. autoclass:: futek_device_communication.FutekSerialScanner
   :members:
   :special-members: __init__

FUTEK Device
------------

.. autoclass:: futek_device_communication.FutekDevice
   :members:
   :special-members: __init__, __enter__, __exit__

ADC Converter
-------------

.. autoclass:: futek_device_communication.ADCConverter

Stream Data Converter
---------------------

.. autoclass:: futek_device_communication.StreamReading
   :members:

.. autoclass:: futek_device_communication.StreamConversionResult
   :members:

.. autoclass:: futek_device_communication.StreamDataConverter
   :members:

Unit of Measure Enum
--------------------

.. autoclass:: futek_device_communication.UnitOfMeasureEnum

Sampling Rate Enums
-------------------

USB225 Sampling Rates
~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: futek_device_communication.USB225SamplingRateEnum

**Example Usage:**

.. code-block:: python

   from futek_device_communication import USB225SamplingRateEnum

   # Set sampling rate to 100 SPS
   device.set_sampling_rate(USB225SamplingRateEnum.SPS_100)

   # Set sampling rate to 2400 SPS
   device.set_sampling_rate(USB225SamplingRateEnum.SPS_2400)

QIA128 Sampling Rates
~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: futek_device_communication.QIA128SamplingRateEnum

**Example Usage:**

.. code-block:: python

   from futek_device_communication import QIA128SamplingRateEnum

   # Set sampling rate to 100 SPS
   device.set_sampling_rate(QIA128SamplingRateEnum.SPS_100)

   # Set sampling rate to 500 SPS
   device.set_sampling_rate(QIA128SamplingRateEnum.SPS_500)

IDC150 Sampling Rates
~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: futek_device_communication.IDC150SamplingRateEnum

**Example Usage:**

.. code-block:: python

   from futek_device_communication import IDC150SamplingRateEnum

   # Set sampling rate to 100 SPS
   device.set_sampling_rate(IDC150SamplingRateEnum.SPS_100)

   # Set sampling rate to 850 SPS
   device.set_sampling_rate(IDC150SamplingRateEnum.SPS_850)