| Name | aiobrultech-serial JSON |
| Version |
0.9.0
JSON |
| download |
| home_page | |
| Summary | A Python client library to talk with Brultech Devices over a serial connection |
| upload_time | 2023-12-08 05:24:40 |
| maintainer | |
| docs_url | None |
| author | Shawn Wilsher |
| requires_python | <4,>=3.8 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# What is aiobrultech-serial?
This library talks to devices from [Brultech Research](https://www.brultech.com/)
over their serial port, using
[siobrultech-protocols](https://github.com/sdwilsh/siobrultech-protocols) to
decode the data.
## Installation
```
pip install aiobrultech-serial
```
## Usage
```python
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`](https://github.com/sdwilsh/aiobrultech-serial/blob/main/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](https://github.com/sdwilsh/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`.
Raw data
{
"_id": null,
"home_page": "",
"name": "aiobrultech-serial",
"maintainer": "",
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Shawn Wilsher",
"author_email": "me@shawnwilsher.com",
"download_url": "https://files.pythonhosted.org/packages/85/14/afbd6526f5d649e7ebc0e4da5f30a847ed94cfe70fde2fe0c1d3c493cc95/aiobrultech-serial-0.9.0.tar.gz",
"platform": null,
"description": "\n\n\n\n\n# What is aiobrultech-serial?\n\nThis library talks to devices from [Brultech Research](https://www.brultech.com/)\nover their serial port, using\n[siobrultech-protocols](https://github.com/sdwilsh/siobrultech-protocols) to\ndecode the data.\n\n## Installation\n\n```\npip install aiobrultech-serial\n```\n\n## Usage\n\n```python\nfrom aiobrultech_serial import connect\n\n\nasync with connect(\"/dev/ttyUSB0\") as connection:\n async for packet in connection.packets():\n print(f\"{packet}\")\n```\n\nLook at [`scripts/dump.py`](https://github.com/sdwilsh/aiobrultech-serial/blob/main/scripts/dump.py)\nfor a fuller example.\n\n### API Calls\n\nThis library also supports getting and setting information on the attached\ndevice. It supports all of the API calls available in\n[siobrultech-protocols](https://github.com/sdwilsh/siobrultech-protocols).\n\n## Development\n\n### Setup\n\n```\npython3.11 -m venv .venv\nsource .venv/bin/activate\n\n# Install Requirements\npip install -r requirements.txt\n\n# Install Dev Requirements\npip install -r requirements-dev.txt\n\n# One-Time Install of Commit Hooks\npre-commit install\n```\n\n### Testing\n\nTests are run with `pytest`.\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python client library to talk with Brultech Devices over a serial connection",
"version": "0.9.0",
"project_urls": {
"Bug Reports": "https://github.com/sdwilsh/aiobrultech-serial/issues",
"Release Notes": "https://github.com/sdwilsh/aiobrultech-serial/releases/",
"Source": "https://github.com/sdwilsh/aiobrultech-serial"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cfb89058281d65336d2c19c4d92cc4b3e9e5812320b869abbc3ca73d89af0f93",
"md5": "0ac23e9d19595c6fa0766d33cb98653d",
"sha256": "71c555c0f162d9a97f7f9b6275ce5871e6919d1c2bc1aa0445f416743ddac5fc"
},
"downloads": -1,
"filename": "aiobrultech_serial-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ac23e9d19595c6fa0766d33cb98653d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 4815,
"upload_time": "2023-12-08T05:24:39",
"upload_time_iso_8601": "2023-12-08T05:24:39.234833Z",
"url": "https://files.pythonhosted.org/packages/cf/b8/9058281d65336d2c19c4d92cc4b3e9e5812320b869abbc3ca73d89af0f93/aiobrultech_serial-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8514afbd6526f5d649e7ebc0e4da5f30a847ed94cfe70fde2fe0c1d3c493cc95",
"md5": "2df5d4f13041f90abd7deb873c7bf648",
"sha256": "35ee8894c4071cbbd0f6b776dcd37811dab8eb3ff6045c649cd2373d4e6b167c"
},
"downloads": -1,
"filename": "aiobrultech-serial-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "2df5d4f13041f90abd7deb873c7bf648",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 5859,
"upload_time": "2023-12-08T05:24:40",
"upload_time_iso_8601": "2023-12-08T05:24:40.701605Z",
"url": "https://files.pythonhosted.org/packages/85/14/afbd6526f5d649e7ebc0e4da5f30a847ed94cfe70fde2fe0c1d3c493cc95/aiobrultech-serial-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 05:24:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sdwilsh",
"github_project": "aiobrultech-serial",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "aiobrultech-serial"
}
