Concurrency agnostic serialio API
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).
Besides local serial line, serialio also supports serial line over RFC2217 protocol, raw TCP socket and tango.
As far as RFC2217 is concerned, it should be compatible with:
- ser2net bridge with telnet(RFC2217) and raw configurations
- gserial[ser2tcp] bridge (RFC2217)
As far as tango is concerned, it should be compatible with the tango classes:
Base implementation written in asyncio with support for different concurrency models:
- classic blocking API
- future based API
Here is a summary of what is forseen and what is implemented
From within your favourite python environment:
pip install serialio
import asyncio import serialio.aio.tcp async def main(): sl = serialio.serial_for_url("serial-tcp://lab1.acme.org:5000") # or the equivalent: # sl = serialio.aio.tcp.Serial("lab1.acme.org", 5000) await sl.open() # Assuming a SCPI complient on the other end we can ask for: reply = await sl.write_readline(b"*IDN?\n") print(reply) await sl.close() asyncio.run(main())
local serial line
import serialio.aio.posix sl = serialio.aio.posix.Serial("/dev/ttyS0") # or the equivalent sl = serialio.serial_for_url("serial:///dev/ttyS0")
raw TCP socket
import serialio.aio.tcp sl = serialio.aio.tcp.Serial("lab1.acme.org:5000") # or the equivalent sl = serialio.serial_for_url("serial+tcp://lab1.acme.org:5000")
import serialio.aio.rfc2217 sl = serialio.aio.rfc2217.Serial("lab1.acme.org:5000") # or the equivalent sl = serialio.serial_for_url("rfc2217://lab1.acme.org:5000")
pip install serialio[tango] installation)
import serialio.aio.tango sl = serialio.aio.tango.Serial("lab/01/serial-01") # or the equivalent sl = serialio.serial_for_url("serial+tango://lab/01/serial-01")
from serialio.aio.tcp import Serial sl = Serial("lab1.acme.org", 5000) reply = sl.write_readline(b"*IDN?\n") print(reply)
from serialio.sio.tcp import Serial sl = Serial("lab1.acme.org", 5000, resolve_futures=False) reply = sl.write_readline(b"*IDN?\n").result() print(reply)
API differences with serial
- coroutine based API
open()coroutine must be called explicitly before using the serial line
- setting of parameters done through functions instead of properties (ie:
await ser_line.set_XXX(value)instead of
ser_line.XXX = value(ex:
eolcharacter (serial is fixed to
- included REQ/REP atomic functions (
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.
Many instruments out there have a Request-Reply protocol. A serialio Serial
write_read family of methods which simplify communication
with these instruments.
In line based protocols, sometimes people decide
\n is not a good EOL character.
A serialio can be customized with a different EOL character.
For example, the XIA-PFCU always
;\r\n, so we could configure it using the following snippet:
sl = serialio.serial_for_url("serial:///dev/ttyS0", eol=b";\r\n") await sl.open()
The initial EOL character can be overwritten in any of the
await sl.write_readline(b"*IDN?\n", eol=b"\r")
TODO: Write this chapter
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.