counterfit-shims-serial 0.1.0.dev1

Shims for the PySerial library for the CounterFit virtual IoT device app

CounterFit Shims - PySerial

Shims for the PySerial to read sensors that use a virtual serial port

See the PySerial Docs for the API documentation.

Getting started

To use these shims, you will need to install CounterFit and have it running, with the appropriate hardware created.

• Install this package from pip:

  pip install counterfit-shims-serial
  

• Import PySerial using the counterfit_shims_serial package instead of the serial package, as well as importing the CounterFitConnection from the counterfit_shims_grove.counterfit_connection module:

  from counterfit_connection import CounterFitConnection
  import counterfit_shims_serial
  

• Configure the connection to the CounterFit app. Change the hostname and port to where you are running it:

  CounterFitConnection.init('127.0.0.1', 5000)
  

• Write your PySerial code as usual, setting the port to match the one you set in the CounterFit app.

  For example, create a UART sensor on port /dev/ttyAMA0:

  serial = counterfit_shims_serial.Serial('/dev/ttyAMA0', 9600, timeout=1)
  

  The baud and timeout settings are ignored.