aioserial 1.1.4

An asynchronous serial port library of Python

aioserial

• Quick start
  • A simple serial port reader
• API
  • AioSerial
    • Constructor
    • Methods
      • read_async
      • read_until_async
      • readinto_async
      • readline_async
      • readlines_async
      • write_async
      • writelines_async
  • Other APIs
• Why aioserial?

A Python package that combines asyncio and pySerial.

Quick start

A simple serial port reader

import aioserial
import asyncio


async def read_and_print(aioserial_instance: aioserial.AioSerial):
    while True:
        print((await aioserial_instance.read_async()).decode(errors='ignore'), end='', flush=True)

asyncio.run(read_and_print(aioserial.AioSerial(port='COM1')))

API

AioSerial

>>> import aioserial
>>> import serial

>>> isinstance(aioserial.AioSerial(), serial.Serial)
True

>>> issubclass(aioserial.AioSerial, serial.Serial)
True

>>> aioserial.Serial is serial.Serial
True

Constructor

aioserial_instance: aioserial.AioSerial = aioserial.AioSerial(
    # ... same with what can be passed to serial.Serial ...,
    loop: Optional[asyncio.AbstractEventLoop] = None)

Methods

read_async

bytes_read: bytes = \
    await aioserial_instance.read_async(size: int = 1)

read_until_async

at_most_certain_size_of_bytes_read: bytes = \
    await aioserial_instance.read_until_async(
        expected: bytes = aioserial.LF, size: Optional[int] = None)

readinto_async

number_of_byte_read: int = \
    await aioserial_instance.readinto_async(b: Union[array.array, bytearray])

readline_async

a_line_of_at_most_certain_size_of_bytes_read: bytes = \
    await aioserial_instance.readline_async(size: int = -1)

readlines_async

lines_of_at_most_certain_size_of_bytes_read: bytes = \
    await aioserial_instance.readlines_async(hint: int = -1)

write_async

number_of_byte_like_data_written: int = \
    await aioserial_instance.write_async(bytes_like_data)

writelines_async

number_of_byte_like_data_in_the_given_list_written: int = \
    await aioserial_instance.writelines_async(list_of_bytes_like_data)

Other APIs

All the other APIs in package pySerial are supported in aioserial as original.

Why aioserial?

• Want to use an asyncio-based but not a (self-built) thread-based serial library.
• pySerial-asyncio does not support Windows.
• APIs in all the other packages (pySerial-asyncio, asyncserial) that target the same goal are not designed in high level.