Skip to main content

Asyncio wrapper for pyserial

Project description

============================
Asyncio wrapper for pyserial
============================

.. image:: https://badge.fury.io/py/asyncserial.svg
:target: https://badge.fury.io/py/asyncserial
:alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/asyncserial.svg
:target: https://pypi.org/project/asyncserial/
:alt: Python Versions

.. image:: https://readthedocs.org/projects/asyncserial/badge/?version=latest
:target: http://asyncserial.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status


`asyncserial` is a a wrapper for the `pyserial` library providing an async interface based on `async def` and `await`.


Installation
============

.. code-block:: sh
pip install asyncserial


Documentation
=============
https://asyncserial.readthedocs.io


Examples
========
.. code-block:: python

import asyncio
from asyncserial import Serial

loop = asyncio.get_event_loop()

test_serial = Serial(loop, "/dev/ttyACM0", baudrate=115200)

async def test():
await test_serial.read() # Drop anything that was already received
while True:
line = await test_serial.readline() # Read a line
print("[+] Serial read: {}".format(line))
await asyncio.sleep(0) # Let's be a bit greedy, should be adjust to your needs


asyncio.ensure_future(test())

print("[+] Starting eventloop")
loop.run_forever()


Project details


Download files

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

Source Distribution

asyncserial-0.1.0.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

asyncserial-0.1.0-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page