[](../../actions/workflows/pylint.yml)
[](https://pypi.org/project/labnode_async/)
[](LICENSE)
[](https://github.com/psf/black)
# LabNode
This is the Python3 asyncio API library for the [Labnode](https://github.com/TU-Darmstadt-APQ/Labnode_PID) system.
The library is fully type-hinted.
## Documentation
The full documentation can be found on GitHub Pages:
[https://patrickbaus.github.io/labnode_async/](https://patrickbaus.github.io/labnode_async/). I use the
[Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) style for documentation and
[Sphinx](https://www.sphinx-doc.org/en/master/index.html) for compiling it.
## Setup
To install the library in a virtual environment (always use venvs with every project):
```bash
python3 -m venv env # virtual environment, optional
source env/bin/activate
pip install labnode-async
```
## Usage
This library makes use of asynchronous context managers to hide all connection related stuff and
also handle cleanup. By the way: Context managers are great!
Connect to the remote endpoint, and it will automatically enumerate the Labnode and create the correct device.
```python
from labnode_async import IPConnection
# Create a device and start coding
async with IPConnection("192.1680.0.2") as device:
# Add your code here
...
```
See [examples/](/examples/) for more working examples.
## Versioning
I use [SemVer](http://semver.org/) for versioning. For the versions available, see the
[tags of this repository](../../tags).
## Authors
* **Patrick Baus** - *Initial work* - [PatrickBaus](https://github.com/PatrickBaus)
## License
This project is licensed under the GPL v3 license - see the
[LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "labnode-async",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "IoT, PID, PID controller, API",
"author": null,
"author_email": "Patrick Baus <patrick.baus@physik.tu-darmstadt.de>",
"download_url": "https://files.pythonhosted.org/packages/96/3f/084f7d48143f1c15e42a48880cebca976befb063360339ba476f20f37074/labnode_async-0.16.4.tar.gz",
"platform": null,
"description": "[](../../actions/workflows/pylint.yml)\n[](https://pypi.org/project/labnode_async/)\n\n\n[](LICENSE)\n[](https://github.com/psf/black)\n# LabNode\nThis is the Python3 asyncio API library for the [Labnode](https://github.com/TU-Darmstadt-APQ/Labnode_PID) system.\n\nThe library is fully type-hinted.\n\n## Documentation\nThe full documentation can be found on GitHub Pages:\n[https://patrickbaus.github.io/labnode_async/](https://patrickbaus.github.io/labnode_async/). I use the\n[Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) style for documentation and\n[Sphinx](https://www.sphinx-doc.org/en/master/index.html) for compiling it.\n\n## Setup\nTo install the library in a virtual environment (always use venvs with every project):\n\n```bash\npython3 -m venv env # virtual environment, optional\nsource env/bin/activate\npip install labnode-async\n```\n\n## Usage\nThis library makes use of asynchronous context managers to hide all connection related stuff and\nalso handle cleanup. By the way: Context managers are great!\n\nConnect to the remote endpoint, and it will automatically enumerate the Labnode and create the correct device.\n```python\nfrom labnode_async import IPConnection\n\n# Create a device and start coding\nasync with IPConnection(\"192.1680.0.2\") as device:\n # Add your code here\n ...\n```\n\nSee [examples/](/examples/) for more working examples.\n\n## Versioning\nI use [SemVer](http://semver.org/) for versioning. For the versions available, see the\n[tags of this repository](../../tags).\n\n## Authors\n* **Patrick Baus** - *Initial work* - [PatrickBaus](https://github.com/PatrickBaus)\n\n## License\nThis project is licensed under the GPL v3 license - see the\n[LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "Python3 AsyncIO Labnode driver",
"version": "0.16.4",
"project_urls": {
"Bug Tracker": "https://github.com/PatrickBaus/labnode_async/issues",
"Documentation": "https://patrickbaus.github.io/labnode_async/",
"Download": "https://github.com/PatrickBaus/labnode_async/releases",
"Homepage": "https://github.com/PatrickBaus/labnode_async"
},
"split_keywords": [
"iot",
" pid",
" pid controller",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "367982d5458d44eac49d551a11ea39602a49e44e0f713bc891ddd21d46588faf",
"md5": "c5de965dceca3aad816178c99bd4afeb",
"sha256": "286f9f99e4797c95a7bf2926ddf1a05c4ff2e0d86bdf214d5722d826c11d3ecd"
},
"downloads": -1,
"filename": "labnode_async-0.16.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5de965dceca3aad816178c99bd4afeb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 35329,
"upload_time": "2024-06-22T12:05:23",
"upload_time_iso_8601": "2024-06-22T12:05:23.209991Z",
"url": "https://files.pythonhosted.org/packages/36/79/82d5458d44eac49d551a11ea39602a49e44e0f713bc891ddd21d46588faf/labnode_async-0.16.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "963f084f7d48143f1c15e42a48880cebca976befb063360339ba476f20f37074",
"md5": "0f964af1181c4b20cdd10ce32e19ecc0",
"sha256": "e3e6b83f3b9a470ab1c13ca1891bd974449a44d2b6d7eb299207492aac0640d4"
},
"downloads": -1,
"filename": "labnode_async-0.16.4.tar.gz",
"has_sig": false,
"md5_digest": "0f964af1181c4b20cdd10ce32e19ecc0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 30793,
"upload_time": "2024-06-22T12:05:24",
"upload_time_iso_8601": "2024-06-22T12:05:24.942919Z",
"url": "https://files.pythonhosted.org/packages/96/3f/084f7d48143f1c15e42a48880cebca976befb063360339ba476f20f37074/labnode_async-0.16.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-22 12:05:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PatrickBaus",
"github_project": "labnode_async",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "labnode-async"
}
JSON
