Skip to content

sdwilsh/aiobrultech-serial

Repository files navigation

Lint Build PyPI Supported Python Versions

What is aiobrultech-serial?

This library talks to devices from Brultech Research over their serial port, using siobrultech-protocols to decode the data.

Installation

pip install aiobrultech-serial

Usage

from aiobrultech_serial import connect


async with connect("/dev/ttyUSB0") as connection:
    async for packet in connection.packets():
        print(f"{packet}")

Look at scripts/dump.py for a fuller example.

API Calls

This library also supports getting and setting information on the attached device. It supports all of the API calls available in siobrultech-protocols.

Development

Setup

python3.11 -m venv .venv
source .venv/bin/activate

# Install Requirements
pip install -r requirements.txt

# Install Dev Requirements
pip install -r requirements-dev.txt

# One-Time Install of Commit Hooks
pre-commit install

Testing

Tests are run with pytest.