homewizard-climate-websocket


Namehomewizard-climate-websocket JSON
Version 0.0.12 PyPI version JSON
download
home_pagehttps://github.com/mepla/homewizard_climate_websocket
SummaryAPI/Websocket to control Homewizard Climate devices
upload_time2024-07-04 07:14:28
maintainerNone
docs_urlNone
authorMepla
requires_python>=3.7
licenseMIT license
keywords homewizard_climate_websocket
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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 oder 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`

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)

![](https://www.princesshome.eu/product/image/large/01.347000.01.001_3.jpg)

## 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/mepla/homewizard_climate_websocket",
    "name": "homewizard-climate-websocket",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "homewizard_climate_websocket",
    "author": "Mepla",
    "author_email": "soheil.nasirian@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9b/15/3ccfc4fec41855680acbec8093e528687163878fb02d3876d682db10a550/homewizard_climate_websocket-0.0.12.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 oder 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\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\n![](https://www.princesshome.eu/product/image/large/01.347000.01.001_3.jpg)\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\n\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "API/Websocket to control Homewizard Climate devices",
    "version": "0.0.12",
    "project_urls": {
        "Homepage": "https://github.com/mepla/homewizard_climate_websocket"
    },
    "split_keywords": [
        "homewizard_climate_websocket"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eedd4dda6ff3bb02f4da6cf8091f1773f235dbb1a3b610309eae7c0f3bfcdf68",
                "md5": "65d50fd5a3a06babe84d5072edf863f7",
                "sha256": "74d06df533b1690be0b216f05f6d4a94670c2716c5a03a8a5a801de4a8c0ab90"
            },
            "downloads": -1,
            "filename": "homewizard_climate_websocket-0.0.12-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "65d50fd5a3a06babe84d5072edf863f7",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 10955,
            "upload_time": "2024-07-04T07:14:09",
            "upload_time_iso_8601": "2024-07-04T07:14:09.153435Z",
            "url": "https://files.pythonhosted.org/packages/ee/dd/4dda6ff3bb02f4da6cf8091f1773f235dbb1a3b610309eae7c0f3bfcdf68/homewizard_climate_websocket-0.0.12-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9b153ccfc4fec41855680acbec8093e528687163878fb02d3876d682db10a550",
                "md5": "aca1df1387d6a82bf99abd3fd9d595a0",
                "sha256": "3bfe47833fd080082111e388608d503e0bc799e9e0e255aad1cb7944826779b2"
            },
            "downloads": -1,
            "filename": "homewizard_climate_websocket-0.0.12.tar.gz",
            "has_sig": false,
            "md5_digest": "aca1df1387d6a82bf99abd3fd9d595a0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 14952,
            "upload_time": "2024-07-04T07:14:28",
            "upload_time_iso_8601": "2024-07-04T07:14:28.242279Z",
            "url": "https://files.pythonhosted.org/packages/9b/15/3ccfc4fec41855680acbec8093e528687163878fb02d3876d682db10a550/homewizard_climate_websocket-0.0.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-04 07:14:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mepla",
    "github_project": "homewizard_climate_websocket",
    "github_not_found": true,
    "lcname": "homewizard-climate-websocket"
}
        
Elapsed time: 0.34267s