# Python: Asynchronous client for the Fumis WiRCU API
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE.md)
[![Build Status][build-shield]][build]
[![Code Coverage][codecov-shield]][codecov]
Asynchronous Python client for the Fumis WiRCU API.
## About
This package allows you to control and monitor Fumis WiRCU devices programmatically.
It is mainly created to allow third-party programs to automate the behavior of a Fumis WiRCU device.
An excellent example of this might be Home Assistant, which allows you to write automations, to turn on your pallet stove on or off and set
a target temperature.
## Usage
```python
import asyncio
from fumis_wircu import Fumis
async def main(loop):
"""Show example on controlling your Fumis WiRCU device."""
async with Fumis(mac="AABBCCDDEEFF", password="1234", loop=loop) as fumis:
info = await fumis.update_info()
print(info)
await fumis.set_target_temperature(23.0)
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run_until_complete(main(loop))
```
## Contributing
This is an active open-source project.
We are always open to people who want to use the code or contribute to it.
We've set up a separate document for our [contribution guidelines](CONTRIBUTING.md).
Thank you for being involved! :heart_eyes:
## Setting up development environment
In case you'd like to contribute, a `Makefile` has been included to ensure a quick start.
```bash
make venv
source ./venv/bin/activate
make dev
```
Now you can start developing, run `make` without arguments to get an overview of all make goals that are available (including description):
```
$ make
Asynchronous Python client for the Fumis WiRCU API.
Usage:
make help Shows this message.
make dev Set up a development environment.
make lint Run all linters.
make lint-black Run linting using black & blacken-docs.
make lint-flake8 Run linting using flake8 (pycodestyle/pydocstyle).
make lint-pylint Run linting using PyLint.
make lint-mypy Run linting using MyPy.
make test Run tests quickly with the default Python.
make coverage Check code coverage quickly with the default Python.
make install Install the package to the active Python's site-packages.
make clean Removes build, test, coverage and Python artifacts.
make clean-all Removes all venv, build, test, coverage and Python artifacts.
make clean-build Removes build artifacts.
make clean-pyc Removes Python file artifacts.
make clean-test Removes test and coverage artifacts.
make clean-venv Removes Python virtual environment artifacts.
make dist Builds source and wheel package.
make release Release build on PyP
make tox Run tests on every Python version with tox.
make venv Create Python venv environment.
```
## Authors & contributors
The original setup of this repository is by [Franck Nijhof][frenck].
For a full list of all authors and contributors, check [the contributor's page][contributors].
[build-shield]: https://github.com/aaronmunsters/fumis_wircu/workflows/Continuous%20Integration/badge.svg
[build]: https://github.com/aaronmunsters/fumis_wircu/actions
[codecov-shield]: https://codecov.io/gh/aaronmunsters/fumis_wircu/branch/main/graph/badge.svg
[codecov]: https://codecov.io/gh/aaronmunsters/fumis_wircu
[contributors]: https://github.com/aaronmunsters/fumis_wircu/graphs/contributors
[frenck]: https://github.com/frenck
[license-shield]: https://img.shields.io/github/license/aaronmunsters/fumis_wircu.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[semver]: http://semver.org/spec/v2.0.0.html
Raw data
{
"_id": null,
"home_page": null,
"name": "fumis-wircu",
"maintainer": "A\u00e4ron Munsters",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "api, async, client, fumis, wircu",
"author": "A\u00e4ron Munsters",
"author_email": "Franck Nijhof <frenck@frenck.dev>",
"download_url": "https://files.pythonhosted.org/packages/1c/b1/ff9c3c04a47180141b78193eb2d8b29731c5ea063a2ee31198230f80f721/fumis_wircu-0.1.1.tar.gz",
"platform": null,
"description": "# Python: Asynchronous client for the Fumis WiRCU API\n\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE.md)\n\n[![Build Status][build-shield]][build]\n[![Code Coverage][codecov-shield]][codecov]\n\nAsynchronous Python client for the Fumis WiRCU API.\n\n## About\n\nThis package allows you to control and monitor Fumis WiRCU devices programmatically.\nIt is mainly created to allow third-party programs to automate the behavior of a Fumis WiRCU device.\n\nAn excellent example of this might be Home Assistant, which allows you to write automations, to turn on your pallet stove on or off and set\na target temperature.\n\n## Usage\n\n```python\nimport asyncio\n\nfrom fumis_wircu import Fumis\n\n\nasync def main(loop):\n \"\"\"Show example on controlling your Fumis WiRCU device.\"\"\"\n async with Fumis(mac=\"AABBCCDDEEFF\", password=\"1234\", loop=loop) as fumis:\n info = await fumis.update_info()\n print(info)\n\n await fumis.set_target_temperature(23.0)\n\n\nif __name__ == \"__main__\":\n loop = asyncio.get_event_loop()\n loop.run_until_complete(main(loop))\n```\n\n## Contributing\n\nThis is an active open-source project.\nWe are always open to people who want to use the code or contribute to it.\n\nWe've set up a separate document for our [contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nIn case you'd like to contribute, a `Makefile` has been included to ensure a quick start.\n\n```bash\nmake venv\nsource ./venv/bin/activate\nmake dev\n```\n\nNow you can start developing, run `make` without arguments to get an overview of all make goals that are available (including description):\n\n```\n$ make\nAsynchronous Python client for the Fumis WiRCU API.\n\nUsage:\n make help Shows this message.\n make dev Set up a development environment.\n make lint Run all linters.\n make lint-black Run linting using black & blacken-docs.\n make lint-flake8 Run linting using flake8 (pycodestyle/pydocstyle).\n make lint-pylint Run linting using PyLint.\n make lint-mypy Run linting using MyPy.\n make test Run tests quickly with the default Python.\n make coverage Check code coverage quickly with the default Python.\n make install Install the package to the active Python's site-packages.\n make clean Removes build, test, coverage and Python artifacts.\n make clean-all Removes all venv, build, test, coverage and Python artifacts.\n make clean-build Removes build artifacts.\n make clean-pyc Removes Python file artifacts.\n make clean-test Removes test and coverage artifacts.\n make clean-venv Removes Python virtual environment artifacts.\n make dist Builds source and wheel package.\n make release Release build on PyP\n make tox Run tests on every Python version with tox.\n make venv Create Python venv environment.\n```\n\n## Authors & contributors\n\nThe original setup of this repository is by [Franck Nijhof][frenck].\n\nFor a full list of all authors and contributors, check [the contributor's page][contributors].\n\n[build-shield]: https://github.com/aaronmunsters/fumis_wircu/workflows/Continuous%20Integration/badge.svg\n[build]: https://github.com/aaronmunsters/fumis_wircu/actions\n[codecov-shield]: https://codecov.io/gh/aaronmunsters/fumis_wircu/branch/main/graph/badge.svg\n[codecov]: https://codecov.io/gh/aaronmunsters/fumis_wircu\n[contributors]: https://github.com/aaronmunsters/fumis_wircu/graphs/contributors\n[frenck]: https://github.com/frenck\n[license-shield]: https://img.shields.io/github/license/aaronmunsters/fumis_wircu.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2024\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg\n[semver]: http://semver.org/spec/v2.0.0.html\n",
"bugtrack_url": null,
"license": null,
"summary": "Asynchronous Python client for the Fumis WiRCU API.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/aaronmunsters/fumis_wircu",
"Issues": "https://github.com/aaronmunsters/fumis_wircu/issues"
},
"split_keywords": [
"api",
" async",
" client",
" fumis",
" wircu"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ef13b601f30bf75d2261f84686badf8bcabe25fb4a2c99a81b14041ce1068fb",
"md5": "c9bf8c4e00f0dedf0a566077d406c721",
"sha256": "fdabcf14cfb900695d1ad1e66127ab6eaee3bab858f637172b3b30ae60c15eeb"
},
"downloads": -1,
"filename": "fumis_wircu-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c9bf8c4e00f0dedf0a566077d406c721",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7340,
"upload_time": "2024-05-27T10:51:01",
"upload_time_iso_8601": "2024-05-27T10:51:01.162630Z",
"url": "https://files.pythonhosted.org/packages/3e/f1/3b601f30bf75d2261f84686badf8bcabe25fb4a2c99a81b14041ce1068fb/fumis_wircu-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1cb1ff9c3c04a47180141b78193eb2d8b29731c5ea063a2ee31198230f80f721",
"md5": "0bdaece80b67a5c0d1929b03330b92bc",
"sha256": "14abe705a2fd727100ce65f2f8140e68db7821414f6c737bb288ff97e4fbe9f6"
},
"downloads": -1,
"filename": "fumis_wircu-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "0bdaece80b67a5c0d1929b03330b92bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19208,
"upload_time": "2024-05-27T10:51:05",
"upload_time_iso_8601": "2024-05-27T10:51:05.366213Z",
"url": "https://files.pythonhosted.org/packages/1c/b1/ff9c3c04a47180141b78193eb2d8b29731c5ea063a2ee31198230f80f721/fumis_wircu-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-27 10:51:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aaronmunsters",
"github_project": "fumis_wircu",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aiohttp",
"specs": [
[
"==",
"3.9.5"
]
]
},
{
"name": "async-timeout",
"specs": [
[
"==",
"4.0.3"
]
]
},
{
"name": "yarl",
"specs": [
[
"==",
"1.9.4"
]
]
}
],
"tox": true,
"lcname": "fumis-wircu"
}
JSON
