| Name | plugwise-usb JSON |
| Version |
0.31.3
JSON |
| download |
| home_page | https://github.com/plugwise/python-plugwise-usb |
| Summary | Plugwise USB (Stick) module for Python 3. |
| upload_time | 2024-01-28 10:16:47 |
| maintainer | bouwew, brefra, CoMPaTech |
| docs_url | None |
| author | Plugwise device owners |
| requires_python | >=3.9.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
usb
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Plugwise USB python module
This module is the USB backend for the upcoming [`plugwise_usb` component](https://github.com/home-assistant/core/tree/dev/homeassistant/components/plugwise_usb) which we will maintain as co-code owners Home Assistant Core.
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://pypi.python.org/pypi/plugwise_usb/)
[](https://github.com/plugwise/python-plugwise-usb/actions)
[](https://github.com/plugwise/python-plugwise-usb/actions)
[](https://results.pre-commit.ci/latest/github/plugwise/python-plugwise-usb/main)
[](https://github.com/plugwise/python-plugwise-usb/issues/2)
[](https://www.codefactor.io/repository/github/plugwise/python-plugwise-usb)
[](https://codecov.io/gh/plugwise/python-plugwise-usb)
[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise-usb)
[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise-usb)
[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise-usb)
## Integration
### Home-Assistant Integration
(maintained through Home-Assistant)
[](https://github.com/home-assistant/core/tree/dev/homeassistant/components/plugwise_usb)
### 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_usb-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_usb-beta)
See the [`plugwise_usb-beta`](https://github.com/plugwise/plugwise_usb-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 make sure 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-usb/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:
### USB
- [x] Stick
- [x] Circle+ / Stealth+
- [x] Circle / Stealth
- [x] Scan
The devices listed below have **NOT** been tested and are therefore unknown for their correct operation
- [x] Sense
- [x] Switch
- [x] [Home-Assistant](https://home-assistant.io) via
- [ ] Native support for USB Plugwise products in HA Core (in progress)
- [x] [HACS](https://hacs.xyz) and `custom_component` [Plugwise USB Beta](https://github.com/plugwise/plugwise_usb-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):
- USB module and integration is supported by @brefra (Frank), ssupported and helped by @bouwew (Bouwe) and @CoMPaTech (Tom) where possible.
- '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 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-usb",
"name": "plugwise-usb",
"maintainer": "bouwew, brefra, CoMPaTech",
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": "",
"keywords": "home,automation,plugwise,module,usb",
"author": "Plugwise device owners",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/57/16/0b7a6d10b88e7c82077f47fc7846c1c7894c6419e5054c69e308cc1445fc/plugwise_usb-0.31.3.tar.gz",
"platform": "any",
"description": "# Plugwise USB python module\n\nThis module is the USB backend for the upcoming [`plugwise_usb` component](https://github.com/home-assistant/core/tree/dev/homeassistant/components/plugwise_usb) which we will maintain as co-code owners Home Assistant Core.\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://pypi.python.org/pypi/plugwise_usb/)\n\n[](https://github.com/plugwise/python-plugwise-usb/actions)\n[](https://github.com/plugwise/python-plugwise-usb/actions)\n[](https://results.pre-commit.ci/latest/github/plugwise/python-plugwise-usb/main)\n[](https://github.com/plugwise/python-plugwise-usb/issues/2)\n\n[](https://www.codefactor.io/repository/github/plugwise/python-plugwise-usb)\n[](https://codecov.io/gh/plugwise/python-plugwise-usb)\n[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise-usb)\n[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise-usb)\n[](https://sonarcloud.io/summary/new_code?id=plugwise_python-plugwise-usb)\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_usb)\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_usb-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_usb-beta)\n\nSee the [`plugwise_usb-beta`](https://github.com/plugwise/plugwise_usb-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 make sure 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-usb/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### USB\n\n- [x] Stick\n - [x] Circle+ / Stealth+\n - [x] Circle / Stealth\n - [x] Scan\n The devices listed below have **NOT** been tested and are therefore unknown for their correct operation\n - [x] Sense\n - [x] Switch\n\n- [x] [Home-Assistant](https://home-assistant.io) via\n - [ ] Native support for USB Plugwise products in HA Core (in progress)\n - [x] [HACS](https://hacs.xyz) and `custom_component` [Plugwise USB Beta](https://github.com/plugwise/plugwise_usb-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- USB module and integration is supported by @brefra (Frank), ssupported and helped by @bouwew (Bouwe) and @CoMPaTech (Tom) where possible.\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 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 USB (Stick) module for Python 3.",
"version": "0.31.3",
"project_urls": {
"Bug Reports": "https://github.com/plugwise/python-plugwise-usb/issues",
"Homepage": "https://github.com/plugwise/python-plugwise-usb",
"Source Code": "https://github.com/plugwise/python-plugwise-usb"
},
"split_keywords": [
"home",
"automation",
"plugwise",
"module",
"usb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7e8edfa1e31bded779d466c444de78ba731ee5da8221081b0d259514838b71d4",
"md5": "a1b6cf92722d4b2f99ab2bf5b3805a41",
"sha256": "b4d08310c78829253e1aa3432025128453a0749ffc231e9749d2bc5b677a5107"
},
"downloads": -1,
"filename": "plugwise_usb-0.31.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1b6cf92722d4b2f99ab2bf5b3805a41",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 49405,
"upload_time": "2024-01-28T10:16:46",
"upload_time_iso_8601": "2024-01-28T10:16:46.109451Z",
"url": "https://files.pythonhosted.org/packages/7e/8e/dfa1e31bded779d466c444de78ba731ee5da8221081b0d259514838b71d4/plugwise_usb-0.31.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "57160b7a6d10b88e7c82077f47fc7846c1c7894c6419e5054c69e308cc1445fc",
"md5": "b8d9e4e2f62f572009863c6a976d0a6d",
"sha256": "275d6166febe6be929b27f977b3eb8550a6b70285e95e050a8bb9b662f627cd5"
},
"downloads": -1,
"filename": "plugwise_usb-0.31.3.tar.gz",
"has_sig": false,
"md5_digest": "b8d9e4e2f62f572009863c6a976d0a6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 47421,
"upload_time": "2024-01-28T10:16:47",
"upload_time_iso_8601": "2024-01-28T10:16:47.250409Z",
"url": "https://files.pythonhosted.org/packages/57/16/0b7a6d10b88e7c82077f47fc7846c1c7894c6419e5054c69e308cc1445fc/plugwise_usb-0.31.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-28 10:16:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plugwise",
"github_project": "python-plugwise-usb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "plugwise-usb"
}
