Metadata-Version: 2.1
Name: pi-eltakows-webthing
Version: 1.0.0
Summary: A web connected Eltako windsensor measuring wind speed on Raspberry Pi
Home-page: https://github.com/grro/pi_eltakows_webthing
Author: Gregor Roth
Author-email: gregor.roth@web.de
License: MIT
Description: # 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
        ```  
        
        
        
        
        
        
Keywords: webthings,home automation,Eltako,windsensor,windspeed,WS,raspberry,pi
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Description-Content-Type: text/markdown
