:py:mod:`expliot.plugins.serial.baudscan`
=========================================

.. py:module:: expliot.plugins.serial.baudscan

.. autoapi-nested-parse::

   Support for detecting the baud rate of a device.



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

Classes
~~~~~~~

.. autoapisummary::

   expliot.plugins.serial.baudscan.BaudScan




.. py:class:: BaudScan

   Bases: :py:obj:`expliot.core.tests.test.Test`

   Test the available baud rate of a device.

   Output Format:
   [
       {
           "baud": 9600,
           "ascii_percent": 70.0,
           "received_data": "ð0bar
",
           "ascii_data": "0bar",
           "status": "Data received", # or "No data received" if nothing is received
           "exception": None, # or "Error message" in case an exception occurred during
                              # serial communication, in which case the other information
                              # may be empty or incomplete
       },
       # ... More than one entry based on no. of baud rates scanned.

   ]

   .. py:method:: check_baud(baud)

      Scan a serial connection for ASCII data with a given baud rate.

      :param baud: The baud rate to use for the serial connection
      :return: Percentage of ASCII characters present in the received data


   .. py:method:: execute()

      Execute the test.