| Name | homeconnect-webthing JSON |
| Version |
1.0.6
JSON |
| download |
| home_page | None |
| Summary | Homeconnect WebThing adapter |
| upload_time | 2024-05-01 07:41:54 |
| maintainer | None |
| docs_url | None |
| author | Gregor Roth |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# homeconnect_webthing
A webthing adapter for HomeConnect smart home devices.
This project provides a [webthing API](https://iot.mozilla.org/wot/) for accessing [HomeConnect devices](https://api-docs.home-connect.com/).
Currently, only the ***dishwasher***, ***washing machine*** and ***dryer*** device types are supported.
The homeconnect_webthing package provides an http webthing endpoint for each detected and supported smart home device. E.g.
```
# webthing has been started on host 192.168.0.23
curl http://192.168.0.23:8744/0/properties
{
"device_name":"Geschirrspüler",
"device_type":"Dishwasher",
"device_haid":"BOSCH-SMV68TX06E-70C62F17C8E4",
"device_brand":"Bosch",
"device_vib":"SMV68TX06E",
"device_enumber":"SMV68TX06E/74",
"power":"Off",
"door":"Open",
"operation":"Inactive",
"remote_start_allowed":false,
"program_selected":"Eco50",
"program_vario_speed_plus":false,
"program_hygiene_plus":false,
"program_extra_try":false,
"program_start_date":"",
"program_progress":0
}
```
To install this software, you can use the [PIP](https://realpython.com/what-is-pip/) package manager as shown below
**PIP approach**
```
sudo pip3 install homeconnect_webthing
```
After this installation, you can use the Webthing http endpoint in your Python code or from the command line with
```
sudo homeconnect --command listen --port 8744 --refresh_token 9yJ4LXJlZyI6IfVVIiwi...2YXRlIn0= --client_secret FEAE...522BD0
```
Here the webthing API is bound to the local port 8744. Also, refresh_token and client_secret must be set.
Please refer to [HomeConnect Authorization](https://api-docs.home-connect.com/quickstart?#authorization) to obtain your refresh_token and client_secret
As an alternative to the *list* command, you can also use the *register* command to register and start the webthing service as a systemd entity.
This way, the webthing service is started automatically at boot time. Starting the server manually with the *listen* command is no longer necessary.
```
sudo homeconnect --command register --port 8744 --refresh_token 9yJ4LXJlZyI6IfVVIiwi...2YXRlIn0= --client_secret FEAE...522BD0
```
Raw data
{
"_id": null,
"home_page": null,
"name": "homeconnect-webthing",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Gregor Roth",
"author_email": "gregor.roth@web.de",
"download_url": "https://files.pythonhosted.org/packages/93/74/3e314bfaccd50ae40f03b7ccb4be08b6cdb93ca0e921a6eb55208da8f700/homeconnect_webthing-1.0.6.tar.gz",
"platform": null,
"description": "# homeconnect_webthing\nA webthing adapter for HomeConnect smart home devices.\n\nThis project provides a [webthing API](https://iot.mozilla.org/wot/) for accessing [HomeConnect devices](https://api-docs.home-connect.com/).\nCurrently, only the ***dishwasher***, ***washing machine*** and ***dryer*** device types are supported.\n\nThe homeconnect_webthing package provides an http webthing endpoint for each detected and supported smart home device. E.g.\n```\n# webthing has been started on host 192.168.0.23\ncurl http://192.168.0.23:8744/0/properties \n\n{\n \"device_name\":\"Geschirrsp\u00fcler\",\n \"device_type\":\"Dishwasher\",\n \"device_haid\":\"BOSCH-SMV68TX06E-70C62F17C8E4\",\n \"device_brand\":\"Bosch\",\n \"device_vib\":\"SMV68TX06E\",\n \"device_enumber\":\"SMV68TX06E/74\",\n \"power\":\"Off\",\n \"door\":\"Open\",\n \"operation\":\"Inactive\",\n \"remote_start_allowed\":false,\n \"program_selected\":\"Eco50\",\n \"program_vario_speed_plus\":false,\n \"program_hygiene_plus\":false,\n \"program_extra_try\":false,\n \"program_start_date\":\"\",\n \"program_progress\":0\n}\n```\n\nTo install this software, you can use the [PIP](https://realpython.com/what-is-pip/) package manager as shown below\n\n**PIP approach**\n```\nsudo pip3 install homeconnect_webthing\n```\n\nAfter this installation, you can use the Webthing http endpoint in your Python code or from the command line with\n```\nsudo homeconnect --command listen --port 8744 --refresh_token 9yJ4LXJlZyI6IfVVIiwi...2YXRlIn0= --client_secret FEAE...522BD0 \n```\nHere the webthing API is bound to the local port 8744. Also, refresh_token and client_secret must be set.\nPlease refer to [HomeConnect Authorization](https://api-docs.home-connect.com/quickstart?#authorization) to obtain your refresh_token and client_secret\n\nAs an alternative to the *list* command, you can also use the *register* command to register and start the webthing service as a systemd entity.\nThis way, the webthing service is started automatically at boot time. Starting the server manually with the *listen* command is no longer necessary.\n```\nsudo homeconnect --command register --port 8744 --refresh_token 9yJ4LXJlZyI6IfVVIiwi...2YXRlIn0= --client_secret FEAE...522BD0\n``` \n",
"bugtrack_url": null,
"license": null,
"summary": "Homeconnect WebThing adapter",
"version": "1.0.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e8628104f9b022dc10e131ab1b8671035de0dcb18aac3b2efc029f471799462a",
"md5": "7ca3e91d232b094bcf764ef19fbfd604",
"sha256": "35c1666c9a9773a33727fa86c2d2ed00c582beb6f13a6de340747ac002dad560"
},
"downloads": -1,
"filename": "homeconnect_webthing-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ca3e91d232b094bcf764ef19fbfd604",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 25880,
"upload_time": "2024-05-01T07:41:51",
"upload_time_iso_8601": "2024-05-01T07:41:51.380496Z",
"url": "https://files.pythonhosted.org/packages/e8/62/8104f9b022dc10e131ab1b8671035de0dcb18aac3b2efc029f471799462a/homeconnect_webthing-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93743e314bfaccd50ae40f03b7ccb4be08b6cdb93ca0e921a6eb55208da8f700",
"md5": "b1e6abb8ca23ea304e7b9701e6acf4ad",
"sha256": "a2fd1930cb5ad4128bc57773e5f18e69a44fbf76d831f28a56772866746a9c1d"
},
"downloads": -1,
"filename": "homeconnect_webthing-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "b1e6abb8ca23ea304e7b9701e6acf4ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 23542,
"upload_time": "2024-05-01T07:41:54",
"upload_time_iso_8601": "2024-05-01T07:41:54.015459Z",
"url": "https://files.pythonhosted.org/packages/93/74/3e314bfaccd50ae40f03b7ccb4be08b6cdb93ca0e921a6eb55208da8f700/homeconnect_webthing-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 07:41:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "homeconnect-webthing"
}
