| Name | plugwise JSON |
| Version |
1.5.2
JSON |
| download |
| home_page | https://github.com/plugwise/python-plugwise |
| Summary | Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3. |
| upload_time | 2024-11-16 11:35:25 |
| maintainer | bouwew, CoMPaTech |
| docs_url | None |
| author | Plugwise device owners |
| requires_python | >=3.11.0 |
| license | MIT License Copyright (c) 2019 @laetificat, 2019-2020 @CoMPaTech & @bouwew, 2020-current @CoMPaTech, @bouwew & @brefra Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
home
automation
plugwise
module
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Plugwise python module
This module is the backend for the [`plugwise` component](https://github.com/home-assistant/core/tree/dev/homeassistant/components/plugwise) in Home Assistant Core (which we maintain as co-code owners).
This module supports `Smile`s (and `Stretch`), i.e. the networked plugwise devices. For the USB (or Stick-standalone version) please refer to upcoming [`plugwise-usb` component](https://github.com/plugwise/plugwise_usb-beta).
Our main usage for this module is supporting [Home Assistant](https://www.home-assistant.io) / [home-assistant](http://github.com/home-assistant/core/)
[](https://github.com/plugwise)
[](https://coderabbit.ai)
[](https://github.com/plugwise/python-plugwise/issues/291)
[](https://pypi.python.org/pypi/plugwise/)
[](https://github.com/plugwise/python-plugwise/actions)
[](https://github.com/plugwise/python-plugwise/actions)
[](https://results.pre-commit.ci/latest/github/plugwise/python-plugwise/main)
[](https://www.codefactor.io/repository/github/plugwise/python-plugwise)
[](https://codecov.io/gh/plugwise/python-plugwise)
[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise)
[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise)
[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise)
## Integration
### Home-Assistant Integration
(maintained through Home-Assistant)
[](https://github.com/home-assistant/core/tree/dev/homeassistant/components/plugwise)
Works out of the box with every Home Assistant installation, use the button below to install
[](https://my.home-assistant.io/redirect/integrations/)
### Home-Assistant custom_component (beta)
We do (also) maintain a `custom_component`, please note this is **only** intended for users helping us test new features (use at your own risk)
[](https://github.com/plugwise/plugwise-beta)
You can add our `custom_component` repository to HACS, do note that we do not intent for our `beta` `custom_component` to be included in the HACS repository.
[](https://github.com/plugwise/plugwise-beta)
See the [`plugwise-beta`](https://github.com/plugwise/plugwise-beta) repository for more info.
## Development/patches
Like Home Assistant Core, we use `pre-commit` and additionally run [pre-commit.ci](http://pre-commit.ci) to automatically validate your commits and PRs.
If you want to create a PR, please ensure you at least run `scripts/setup.sh`. This will ensure your environment is set up correctly before attempting to `git commit`. We sincerely and highly recommended also setting up local testing, see [`tests/README.md`](https://github.com/plugwise/python-plugwise/blob/main/tests/README.md) for more information and run `scripts/setup_test.sh` to prepare your environment.
## Project support status
**Notice** at this time we are refactoring the module code to move towards a supporting way for the integration to become multiple components under an umbrella `plugwise` integration featuring multiple components.
Module providing interfacing with the Plugwise devices:
### Smile
- [x] Adam
- [x] Lisa
- [x] Jip
- [x] Floor
- [x] Tom
- [x] Koen (a Koen always comes with a Plug, the Plug is the active part)
- [x] Plug
- [x] Aqara Plug
- [x] Anna
- [x] Smile P1
- [x] Stretch
- [ ] Some of the equipment mentioned in USB when in use via Stretch or Adam
- [x] [Home-Assistant](https://home-assistant.io) via
- [x] Native supporting networked Plugwise products
- [x] [HACS](https://hacs.xyz) and `custom_component` [Plugwise Beta](https://github.com/plugwise/plugwise-beta/) (supporting all devices above)
## License, origins and contributors
As per the origins, we have retained the appropriate licensing and including the MIT-license for this project.
Origins (from newest to oldest):
- Networked (Smile/Stretch) Plugwise support by @bouwew (Bouwe) and @CoMPaTech (Tom). We both support and help out @brefra (Frank) where possible, he's supporting the USB module and integration.
- 'All' available Plugwise support by @bouwew (Bouwe), @brefra (Frank) and @CoMPaTech (Tom)
- Upstreamed haanna/HA-core Anna, including all later products - 'Plugwise-Smile/Plugwise-HA/plugwise-beta' by @bouwew (Bouwe) & @CoMPaTech (Tom)
- Networked Plugwise Anna module with custom_module - `haanna/anna-ha` via <https://github.com/laetificat> (Kevin)
- USB-based stick module with custom_module - `plugwise-stick/plugwise` by @brefra (Frank)
- USB-plugwise module - `plugwise` by <https://github.com/cyberjunky/python-plugwise> (Ron) originally by <https://github.com/aequitas/python-plugwise> (Johan) (with reference only in license to Sven)
- Sensor for Plugwise Smile P1 integration - `home-assistant-sensor-plugwise-smile-p1` by <https://bitbucket.org/jvdschoot/home-assistant-sensor-plugwise-smile-p1> (Jeroen van der Schoot)
## Thanks
On behalf of all of us, big thanks to Plugwise and community members @riemers and @tane from [HAshop](https://hashop.nl) for their support and obviously all our users and testers who dealt with our typos and challenges. Disclaimer, while we are communicating with Plugwise and they expressed their gratitude through their newsletter, we are not part of Plugwise as a company. We are just a bunch of guys anxious to get our (and your) Plugwise products working with Home Assistant.
Raw data
{
"_id": null,
"home_page": "https://github.com/plugwise/python-plugwise",
"name": "plugwise",
"maintainer": "bouwew, CoMPaTech",
"docs_url": null,
"requires_python": ">=3.11.0",
"maintainer_email": null,
"keywords": "home, automation, plugwise, module",
"author": "Plugwise device owners",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/bb/9a/1b2afc5e28acfbf613b2653dd349c2fc83144c6e446bf552d5e067ce63b0/plugwise-1.5.2.tar.gz",
"platform": "any",
"description": "# Plugwise python module\n\nThis module is the backend for the [`plugwise` component](https://github.com/home-assistant/core/tree/dev/homeassistant/components/plugwise) in Home Assistant Core (which we maintain as co-code owners).\n\nThis module supports `Smile`s (and `Stretch`), i.e. the networked plugwise devices. For the USB (or Stick-standalone version) please refer to upcoming [`plugwise-usb` component](https://github.com/plugwise/plugwise_usb-beta).\n\nOur main usage for this module is supporting [Home Assistant](https://www.home-assistant.io) / [home-assistant](http://github.com/home-assistant/core/)\n\n[](https://github.com/plugwise)\n[](https://coderabbit.ai)\n[](https://github.com/plugwise/python-plugwise/issues/291)\n\n[](https://pypi.python.org/pypi/plugwise/)\n[](https://github.com/plugwise/python-plugwise/actions)\n[](https://github.com/plugwise/python-plugwise/actions)\n[](https://results.pre-commit.ci/latest/github/plugwise/python-plugwise/main)\n\n[](https://www.codefactor.io/repository/github/plugwise/python-plugwise)\n[](https://codecov.io/gh/plugwise/python-plugwise)\n\n[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise)\n[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise)\n[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise)\n\n## Integration\n\n### Home-Assistant Integration\n\n(maintained through Home-Assistant)\n\n[](https://github.com/home-assistant/core/tree/dev/homeassistant/components/plugwise)\n\nWorks out of the box with every Home Assistant installation, use the button below to install\n\n[](https://my.home-assistant.io/redirect/integrations/)\n\n### Home-Assistant custom_component (beta)\n\nWe do (also) maintain a `custom_component`, please note this is **only** intended for users helping us test new features (use at your own risk)\n\n[](https://github.com/plugwise/plugwise-beta)\n\nYou can add our `custom_component` repository to HACS, do note that we do not intent for our `beta` `custom_component` to be included in the HACS repository.\n\n[](https://github.com/plugwise/plugwise-beta)\n\nSee the [`plugwise-beta`](https://github.com/plugwise/plugwise-beta) repository for more info.\n\n## Development/patches\n\nLike Home Assistant Core, we use `pre-commit` and additionally run [pre-commit.ci](http://pre-commit.ci) to automatically validate your commits and PRs.\n\nIf you want to create a PR, please ensure you at least run `scripts/setup.sh`. This will ensure your environment is set up correctly before attempting to `git commit`. We sincerely and highly recommended also setting up local testing, see [`tests/README.md`](https://github.com/plugwise/python-plugwise/blob/main/tests/README.md) for more information and run `scripts/setup_test.sh` to prepare your environment.\n\n## Project support status\n\n**Notice** at this time we are refactoring the module code to move towards a supporting way for the integration to become multiple components under an umbrella `plugwise` integration featuring multiple components.\n\nModule providing interfacing with the Plugwise devices:\n\n### Smile\n\n- [x] Adam\n - [x] Lisa\n - [x] Jip\n - [x] Floor\n - [x] Tom\n - [x] Koen (a Koen always comes with a Plug, the Plug is the active part)\n - [x] Plug\n - [x] Aqara Plug\n- [x] Anna\n- [x] Smile P1\n- [x] Stretch\n- [ ] Some of the equipment mentioned in USB when in use via Stretch or Adam\n\n- [x] [Home-Assistant](https://home-assistant.io) via\n - [x] Native supporting networked Plugwise products\n - [x] [HACS](https://hacs.xyz) and `custom_component` [Plugwise Beta](https://github.com/plugwise/plugwise-beta/) (supporting all devices above)\n\n## License, origins and contributors\n\nAs per the origins, we have retained the appropriate licensing and including the MIT-license for this project.\n\nOrigins (from newest to oldest):\n\n- Networked (Smile/Stretch) Plugwise support by @bouwew (Bouwe) and @CoMPaTech (Tom). We both support and help out @brefra (Frank) where possible, he's supporting the USB module and integration.\n- 'All' available Plugwise support by @bouwew (Bouwe), @brefra (Frank) and @CoMPaTech (Tom)\n- Upstreamed haanna/HA-core Anna, including all later products - 'Plugwise-Smile/Plugwise-HA/plugwise-beta' by @bouwew (Bouwe) & @CoMPaTech (Tom)\n- Networked Plugwise Anna module with custom_module - `haanna/anna-ha` via <https://github.com/laetificat> (Kevin)\n- USB-based stick module with custom_module - `plugwise-stick/plugwise` by @brefra (Frank)\n- USB-plugwise module - `plugwise` by <https://github.com/cyberjunky/python-plugwise> (Ron) originally by <https://github.com/aequitas/python-plugwise> (Johan) (with reference only in license to Sven)\n- Sensor for Plugwise Smile P1 integration - `home-assistant-sensor-plugwise-smile-p1` by <https://bitbucket.org/jvdschoot/home-assistant-sensor-plugwise-smile-p1> (Jeroen van der Schoot)\n\n## Thanks\n\nOn behalf of all of us, big thanks to Plugwise and community members @riemers and @tane from [HAshop](https://hashop.nl) for their support and obviously all our users and testers who dealt with our typos and challenges. Disclaimer, while we are communicating with Plugwise and they expressed their gratitude through their newsletter, we are not part of Plugwise as a company. We are just a bunch of guys anxious to get our (and your) Plugwise products working with Home Assistant.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2019 @laetificat, 2019-2020 @CoMPaTech & @bouwew, 2020-current @CoMPaTech, @bouwew & @brefra Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3.",
"version": "1.5.2",
"project_urls": {
"Bug Reports": "https://github.com/plugwise/python-plugwise/issues",
"Homepage": "https://github.com/plugwise/python-plugwise",
"Source Code": "https://github.com/plugwise/python-plugwise"
},
"split_keywords": [
"home",
" automation",
" plugwise",
" module"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da1d9c403c33ebbd8012aee1752c493f0251151fdfd6e798924ef164ecdb7086",
"md5": "66749471746a07ec4a93cc9087465969",
"sha256": "3ddea17e9ca51f3cea23a0d49933b448e3413ac7eacb42cb2903cbce0a68aac0"
},
"downloads": -1,
"filename": "plugwise-1.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66749471746a07ec4a93cc9087465969",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11.0",
"size": 47883,
"upload_time": "2024-11-16T11:35:24",
"upload_time_iso_8601": "2024-11-16T11:35:24.150606Z",
"url": "https://files.pythonhosted.org/packages/da/1d/9c403c33ebbd8012aee1752c493f0251151fdfd6e798924ef164ecdb7086/plugwise-1.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb9a1b2afc5e28acfbf613b2653dd349c2fc83144c6e446bf552d5e067ce63b0",
"md5": "e159aa24ad76cf25816baa62ebe88e51",
"sha256": "3e0310fd45d9148a36d0487c4a9fb6b19186350f1df854cdf6e105186b109975"
},
"downloads": -1,
"filename": "plugwise-1.5.2.tar.gz",
"has_sig": false,
"md5_digest": "e159aa24ad76cf25816baa62ebe88e51",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11.0",
"size": 60165,
"upload_time": "2024-11-16T11:35:25",
"upload_time_iso_8601": "2024-11-16T11:35:25.863485Z",
"url": "https://files.pythonhosted.org/packages/bb/9a/1b2afc5e28acfbf613b2653dd349c2fc83144c6e446bf552d5e067ce63b0/plugwise-1.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-16 11:35:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plugwise",
"github_project": "python-plugwise",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "plugwise"
}
