# enocean_webthing
A web connected enocean gateway. This project provides a [webthing API](https://iot.mozilla.org/wot/) to an enocean gateway such as the [EnOcean USB 300 USB-Gateway](https://www.enocean.com/de/produkt/usb-300-500u-400j/)
The enocean_webthing package exposes a http webthing endpoint supporting enocean devices.
E.g.
```
# webthing has been started on host 192.168.0.23
curl http://192.168.1.198:9090/0/properties
{
"eep_id":"F6:10:00",
"enocean_id":"81:00:F0:4E",
"state":3
}
```
Currently, the [devices](https://www.enocean-alliance.org/wp-content/uploads/2017/05/EnOcean_Equipment_Profiles_EEP_v2.6.7_public.pdf) listed below are supported
* Window Handle such as [HOPPE Window Handle ConnectHome](https://www.hoppe.com/in-en/window-handles/hoppe-innovations-window-handles/ehandle-connecthome-for-windows/) (EEP ID: F6:10:00)
To install this software you may use the [PIP](https://realpython.com/what-is-pip/) package manager such as shown below
**PIP approach**
```
sudo pip install enocean_webthing
```
After this installation you may start the webthing http endpoint inside your python code or via command line using
```
sudo enocean --command listen --port 9090 --path /dev/ttyUSB-enocean --devices 'Office/F6:10:00/81:00:F0:4E, Patiodoor/F6:10:00/01:9A:CC:06'
```
Here, the webthing API will be bound to the local port 9090 by using the USB-Gateway /dev/ttyUSB-enocean.
To list the devices to be supported a comma-separated list is used with the syntax {Device name}/{EEP ID}/{ENOCEAN ID}
Alternatively to the *listen* command, you can use the *register* command to register and start the webthing service as systemd unit.
By doing this the webthing service will be started automatically on boot. Starting the server manually using the *listen* command is no longer necessary.
```
sudo enocean --command register --port 9090 --path /dev/ttyUSB-enocean --devices 'Office/F6:10:00/81:00:F0:4E, Patiodoor/F6:10:00/01:9A:CC:06'
```
Raw data
{
"_id": null,
"home_page": "https://github.com/grro/enocean_webthing",
"name": "enocean-webthing",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "webthings,home automation,enocean,gateway",
"author": "Gregor Roth",
"author_email": "gregor.roth@web.de",
"download_url": "https://files.pythonhosted.org/packages/d2/3c/2b32ed05dfd44b951e8380679e0c6820b76cf3909046121a220a0902dac8/enocean_webthing-1.0.1.tar.gz",
"platform": null,
"description": "# enocean_webthing\nA web connected enocean gateway. This project provides a [webthing API](https://iot.mozilla.org/wot/) to an enocean gateway such as the [EnOcean USB 300 USB-Gateway](https://www.enocean.com/de/produkt/usb-300-500u-400j/)\n\nThe enocean_webthing package exposes a http webthing endpoint supporting enocean devices. \n\nE.g.\n```\n# webthing has been started on host 192.168.0.23\n\ncurl http://192.168.1.198:9090/0/properties\n\n{\n \"eep_id\":\"F6:10:00\",\n \"enocean_id\":\"81:00:F0:4E\",\n \"state\":3\n}\n```\nCurrently, the [devices](https://www.enocean-alliance.org/wp-content/uploads/2017/05/EnOcean_Equipment_Profiles_EEP_v2.6.7_public.pdf) listed below are supported\n* Window Handle such as [HOPPE Window Handle ConnectHome](https://www.hoppe.com/in-en/window-handles/hoppe-innovations-window-handles/ehandle-connecthome-for-windows/) (EEP ID: F6:10:00)\n\nTo install this software you may use the [PIP](https://realpython.com/what-is-pip/) package manager such as shown below\n\n**PIP approach**\n```\nsudo pip install enocean_webthing\n```\n\nAfter this installation you may start the webthing http endpoint inside your python code or via command line using\n```\nsudo enocean --command listen --port 9090 --path /dev/ttyUSB-enocean --devices 'Office/F6:10:00/81:00:F0:4E, Patiodoor/F6:10:00/01:9A:CC:06'\n```\nHere, the webthing API will be bound to the local port 9090 by using the USB-Gateway /dev/ttyUSB-enocean. \nTo list the devices to be supported a comma-separated list is used with the syntax {Device name}/{EEP ID}/{ENOCEAN ID} \n\nAlternatively to the *listen* command, you can use the *register* command to register and start the webthing service as systemd unit.\nBy doing this the webthing service will be started automatically on boot. Starting the server manually using the *listen* command is no longer necessary.\n```\nsudo enocean --command register --port 9090 --path /dev/ttyUSB-enocean --devices 'Office/F6:10:00/81:00:F0:4E, Patiodoor/F6:10:00/01:9A:CC:06'\n``` \n\n",
"bugtrack_url": null,
"license": "",
"summary": "A web connected enocean gateway",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/grro/enocean_webthing"
},
"split_keywords": [
"webthings",
"home automation",
"enocean",
"gateway"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20123ae575002623d738340ca5d87197b187ada681f4376870078a612895017b",
"md5": "06fdc24e5efe7b3618c9c9cdad97d176",
"sha256": "3574f98a0e9b8164212558dc813cded79d99863fe09e9e6a48020face0e46206"
},
"downloads": -1,
"filename": "enocean_webthing-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "06fdc24e5efe7b3618c9c9cdad97d176",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12512,
"upload_time": "2023-07-19T06:41:49",
"upload_time_iso_8601": "2023-07-19T06:41:49.142839Z",
"url": "https://files.pythonhosted.org/packages/20/12/3ae575002623d738340ca5d87197b187ada681f4376870078a612895017b/enocean_webthing-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d23c2b32ed05dfd44b951e8380679e0c6820b76cf3909046121a220a0902dac8",
"md5": "2d0935ea2b1652ceb2ae3540f8eb65bf",
"sha256": "354b215fe834f84c46b7c570bd223bfc85a68ede6e7dd2df920089dbf94e9e76"
},
"downloads": -1,
"filename": "enocean_webthing-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2d0935ea2b1652ceb2ae3540f8eb65bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6728,
"upload_time": "2023-07-19T06:41:51",
"upload_time_iso_8601": "2023-07-19T06:41:51.221664Z",
"url": "https://files.pythonhosted.org/packages/d2/3c/2b32ed05dfd44b951e8380679e0c6820b76cf3909046121a220a0902dac8/enocean_webthing-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-19 06:41:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grro",
"github_project": "enocean_webthing",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "enocean-webthing"
}
JSON
