# homewizard-climate-websocket
API/Websocket to control Homewizard Climate devices
---
This library allows you to control your Homewizard Climate devices. There are a multitude of brands that use Homewizard apps for their smart controls.
This was developed in order to be used in a [Home Assistant](https://www.home-assistant.io/) integration. It has not been thoroughly tested or worked with as a standalone code.
### Supported Devices
This library is in an early stage of development and only works for the following device types returned from the Homewizard Climate API:
- `heaterfan`
- `infraredheater`
- `heater`
It has been tested on the following devices (even though it might work on others too):
- [Princess Smart Heating and Cooling Tower (01.347000.01.001)](https://www.princesshome.eu/en-gb/princess-01-347000-01-001-smart-heating-and-01.347000.01.001)
- [Princess Smart Infrared Panel Heater 350 (01.343350.02.001)](https://www.princesshome.eu/en-gb/princess-01-343350-02-001-smart-infrared-panel-01.343350.02.001)
- [Princess Smart Glass Panel Heater (01.342001.09.001)](https://www.princesshome.eu/en-gb/princess-01-342001-09-001-smart-glass-panel-heater-01.342001.09.001)
## Quick start
There's no separate `requirements.txt` file, the dependencies can be found and installed in `setup.py`
```
username = os.environ["HW_CLIMATE_USERNAME"]
password = os.environ["HW_CLIMATE_PASSWORD"]
api = HomeWizardClimateApi(username, password)
api.login()
devices = api.get_devices()
ws = HomeWizardClimateWebSocket(api, devices[0])
ws.connect_in_thread() # There's also a blocking `connect`
time.sleep(5)
```
## Installation
**Stable Release (PyPi):** `pip install homewizard_climate_websocket`<br>
**Local Development:** `pip install .`
## Development
Any help to increase the number of supported devices is much appreciated as I only had access to the one mentioned above.
See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.
Raw data
{
"_id": null,
"home_page": "https://github.com/dennis1804/homewizard-climate-websocket",
"name": "homewizard-climate-ws",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "homewizard_climate_ws",
"author": "Dennis1804",
"author_email": "dennis@de-jong.frl",
"download_url": "https://files.pythonhosted.org/packages/30/f7/55c4cbe62425b63a10e4fdfad4831c7e5cb2ee97cd6d7413e22ecb4c721b/homewizard_climate_ws-0.0.27.tar.gz",
"platform": null,
"description": "# homewizard-climate-websocket\n\nAPI/Websocket to control Homewizard Climate devices\n\n---\n\nThis library allows you to control your Homewizard Climate devices. There are a multitude of brands that use Homewizard apps for their smart controls.\n\nThis was developed in order to be used in a [Home Assistant](https://www.home-assistant.io/) integration. It has not been thoroughly tested or worked with as a standalone code.\n\n### Supported Devices\nThis library is in an early stage of development and only works for the following device types returned from the Homewizard Climate API:\n\n- `heaterfan`\n- `infraredheater`\n- `heater`\n\nIt has been tested on the following devices (even though it might work on others too):\n- [Princess Smart Heating and Cooling Tower (01.347000.01.001)](https://www.princesshome.eu/en-gb/princess-01-347000-01-001-smart-heating-and-01.347000.01.001)\n- [Princess Smart Infrared Panel Heater 350 (01.343350.02.001)](https://www.princesshome.eu/en-gb/princess-01-343350-02-001-smart-infrared-panel-01.343350.02.001)\n- [Princess Smart Glass Panel Heater (01.342001.09.001)](https://www.princesshome.eu/en-gb/princess-01-342001-09-001-smart-glass-panel-heater-01.342001.09.001)\n\n## Quick start\nThere's no separate `requirements.txt` file, the dependencies can be found and installed in `setup.py`\n\n```\nusername = os.environ[\"HW_CLIMATE_USERNAME\"]\npassword = os.environ[\"HW_CLIMATE_PASSWORD\"]\napi = HomeWizardClimateApi(username, password)\napi.login()\ndevices = api.get_devices()\nws = HomeWizardClimateWebSocket(api, devices[0])\nws.connect_in_thread() # There's also a blocking `connect`\ntime.sleep(5)\n```\n\n## Installation\n\n**Stable Release (PyPi):** `pip install homewizard_climate_websocket`<br>\n**Local Development:** `pip install .`\n\n## Development\nAny help to increase the number of supported devices is much appreciated as I only had access to the one mentioned above.\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "API/Websocket to control Homewizard Climate devices",
"version": "0.0.27",
"project_urls": {
"Homepage": "https://github.com/dennis1804/homewizard-climate-websocket"
},
"split_keywords": [
"homewizard_climate_ws"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30f755c4cbe62425b63a10e4fdfad4831c7e5cb2ee97cd6d7413e22ecb4c721b",
"md5": "a979ebdc33608b175238d699180c30a9",
"sha256": "f1b2b1d0659b40d6574c7b58e9b29c7b7b5156f4daece3414da8b6b4e7e3d247"
},
"downloads": -1,
"filename": "homewizard_climate_ws-0.0.27.tar.gz",
"has_sig": false,
"md5_digest": "a979ebdc33608b175238d699180c30a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 16926,
"upload_time": "2024-03-30T15:18:35",
"upload_time_iso_8601": "2024-03-30T15:18:35.997811Z",
"url": "https://files.pythonhosted.org/packages/30/f7/55c4cbe62425b63a10e4fdfad4831c7e5cb2ee97cd6d7413e22ecb4c721b/homewizard_climate_ws-0.0.27.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-30 15:18:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dennis1804",
"github_project": "homewizard-climate-websocket",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "homewizard-climate-ws"
}
JSON
