Skip to main content

Concurrency agnostic serialio API

Project description


![Pypi version][pypi]

A python concurrency agnostic serial line library.

Helpful when handling with instrumentation which work over serial line and implement simple REQ-REP communication protocols (example: SCPI).

So far, only serial line over RFC2217 protocol and raw socket are available. It should be compatible with:

  • ser2net bridge with telnet and raw configurations
  • gserial[ser2tcp] bridge (RFC2217)

Base implementation written in asyncio with support for different concurrency models:

  • asyncio
  • classic blocking API (TODO)
  • future based API (TODO)

Here is a summary of what is forseen and what is implemented

Concurrency Local RFC2217 Raw TCP
asyncio N Y Y
classic sync N N N
conc. futures N N N


From within your favourite python environment:

pip install serialio



import asyncio
from serialio.aio.tcp import Serial

async def main():
    sl = Serial('', 5000)
    # Assuming a SCPI complient on the other end we can ask for:
    reply = await sl.write_readline(b'*IDN?\n')

classic (TODO)

from serialio.sio.tcp import Serial

sl = Serial('', 5000)
reply = sl.write_readline(b'*IDN?\n')

concurrent.futures (TODO)

from serialio.sio.tcp import Serial

sl = Serial('', 5000, resolve_futures=False)
reply = sl.write_readline(b'*IDN?\n').result()


The main goal of a serialio Serial object is to facilitate communication with instruments connected to a serial line.

The most frequent cases include instruments which expect a REQ/REP semantics with ASCII protocols like SCPI. In these cases most commands translate in small packets being exchanged between the host and the instrument. When a raw TCP or RFC2217 bridge is used to access the serial line, serialio uses the sockio library.

REQ-REP semantics

Many instruments out there have a Request-Reply protocol. A serialio Serial provides helpfull write_read family of methods which simplify communication with these instruments.


TODO: Write this chapter

Custom EOL

In line based protocols, sometimes people decide \n is not a good EOL character. A serialio can be customized with a different EOL character. Example:

sl = Serial('', 5000, eol=b'\r')

The EOL character can be overwritten in any of the readline methods. Example:

await sl.write_readline(b'*IDN?\n', eol=b'\r')


TODO: Write this chapter

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for serialio, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size serialio-0.1.1.tar.gz (17.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page