# pi_eltakows_webthing
A web connected Eltako windsensor measuring wind speed on Raspberry Pi
This project provides a [webthing API](https://iot.mozilla.org/wot/) to a [Eltako windsensor](https://www.eltako.com/fileadmin/downloads/en/_datasheets/Datasheet_WS.pdf)
running on a Raspberry Pi. As a webthing, the Eltako windsensor can be discovered and used by
*home automation systems* or custom solutions supporting the webthing API.
The pi_eltakows_webthing package exposes an http webthing endpoint which supports reading the wind speed via http. E.g.
```
# webthing has been started on host 192.168.0.23
curl http://192.168.0.23:7050/properties
{
"windspeed": 2.6
}
```
Regarding the RaspberryPi/Eltako windsensor hardware setup and wiring please refer tutorials such as [Measure Wind Speed with Eltako Windsensor and Win10 IoT Core](https://www.hackster.io/daniel-kreuzhofer/measure-wind-speed-with-eltako-windsensor-and-win10-iot-core-e1e42a)
To install this software you may use [Docker](https://phoenixnap.com/kb/docker-on-raspberry-pi) or [PIP](https://realpython.com/what-is-pip/) package manager such as shown below
**Docker approach**
```
sudo docker run --privileged -p 7050:7050 -e gpio=25 grro/pi_eltakows_webthing:0.2.0
```
**PIP approach**
requires python 3.x
```
sudo pip install pi_eltakows_webthing
```
After this installation you may start the webthing http endpoint inside your python code or via command line using
```
sudo eltakows --command listen --port 7050 --gpio 25
```
Here, the webthing API will be bind ton port 7050 and be connected to the Eltako windsensor reed switch
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 eltakows --command register --port 7050 --gpio 25
```
Raw data
{
"_id": null,
"home_page": "https://github.com/grro/pi_eltakows_webthing",
"name": "pi-eltakows-webthing",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "webthings, home automation, Eltako, windsensor, windspeed, WS, raspberry, pi",
"author": "Gregor Roth",
"author_email": "gregor.roth@web.de",
"download_url": "https://files.pythonhosted.org/packages/7d/af/0f18facd1888d8d3153b172afa64f50d5846428eff3e2996e9c1ed2f63b0/pi_eltakows_webthing-1.1.7.tar.gz",
"platform": null,
"description": "# pi_eltakows_webthing\nA web connected Eltako windsensor measuring wind speed on Raspberry Pi\n\nThis project provides a [webthing API](https://iot.mozilla.org/wot/) to a [Eltako windsensor](https://www.eltako.com/fileadmin/downloads/en/_datasheets/Datasheet_WS.pdf) \nrunning on a Raspberry Pi. As a webthing, the Eltako windsensor can be discovered and used by \n*home automation systems* or custom solutions supporting the webthing API. \n\nThe pi_eltakows_webthing package exposes an http webthing endpoint which supports reading the wind speed via http. E.g. \n```\n# webthing has been started on host 192.168.0.23\n\ncurl http://192.168.0.23:7050/properties \n{\n \"windspeed\": 2.6\n}\n```\n\nRegarding the RaspberryPi/Eltako windsensor hardware setup and wiring please refer tutorials such as [Measure Wind Speed with Eltako Windsensor and Win10 IoT Core](https://www.hackster.io/daniel-kreuzhofer/measure-wind-speed-with-eltako-windsensor-and-win10-iot-core-e1e42a)\n\nTo install this software you may use [Docker](https://phoenixnap.com/kb/docker-on-raspberry-pi) or [PIP](https://realpython.com/what-is-pip/) package manager such as shown below\n\n**Docker approach**\n```\nsudo docker run --privileged -p 7050:7050 -e gpio=25 grro/pi_eltakows_webthing:0.2.0\n```\n\n**PIP approach**\n\nrequires python 3.x\n\n```\nsudo pip install pi_eltakows_webthing\n```\n\nAfter this installation you may start the webthing http endpoint inside your python code or via command line using\n```\nsudo eltakows --command listen --port 7050 --gpio 25\n```\nHere, the webthing API will be bind ton port 7050 and be connected to the Eltako windsensor reed switch\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 eltakows --command register --port 7050 --gpio 25\n``` \n\n\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A web connected Eltako windsensor measuring wind speed on Raspberry Pi",
"version": "1.1.7",
"project_urls": {
"Homepage": "https://github.com/grro/pi_eltakows_webthing"
},
"split_keywords": [
"webthings",
" home automation",
" eltako",
" windsensor",
" windspeed",
" ws",
" raspberry",
" pi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6119b96b27d83bf3fd3d00f84693f73fa02e6e41515b80e097cd78500209f61",
"md5": "7fade38d358e0d691c9b06d3e5995541",
"sha256": "6bdbdce67d4aa369bb6733cb99a501813f03f3b87e0a1de53f7375c53d8808a8"
},
"downloads": -1,
"filename": "pi_eltakows_webthing-1.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7fade38d358e0d691c9b06d3e5995541",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11736,
"upload_time": "2024-08-27T14:47:22",
"upload_time_iso_8601": "2024-08-27T14:47:22.777294Z",
"url": "https://files.pythonhosted.org/packages/b6/11/9b96b27d83bf3fd3d00f84693f73fa02e6e41515b80e097cd78500209f61/pi_eltakows_webthing-1.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7daf0f18facd1888d8d3153b172afa64f50d5846428eff3e2996e9c1ed2f63b0",
"md5": "57e55d4d69b493d9dce0efcebafa16ef",
"sha256": "ef013816627f749f187d8573421c52fcc452471dd156d9632ef6146a5e2b49b8"
},
"downloads": -1,
"filename": "pi_eltakows_webthing-1.1.7.tar.gz",
"has_sig": false,
"md5_digest": "57e55d4d69b493d9dce0efcebafa16ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6138,
"upload_time": "2024-08-27T14:47:24",
"upload_time_iso_8601": "2024-08-27T14:47:24.206895Z",
"url": "https://files.pythonhosted.org/packages/7d/af/0f18facd1888d8d3153b172afa64f50d5846428eff3e2996e9c1ed2f63b0/pi_eltakows_webthing-1.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-27 14:47:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grro",
"github_project": "pi_eltakows_webthing",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pi-eltakows-webthing"
}
JSON
