From 69d321a07e4d9e7629a7e64016847f8073290a3d Mon Sep 17 00:00:00 2001 From: Gabe Shaughnessy Date: Wed, 28 Sep 2016 11:34:41 -0500 Subject: [PATCH] updated readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 804eb40..089309f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ +ESP8266 driven weather station with Flask webserver frontend. + +There are two main components to this project. The device source in esp8266/ and the webserver in app/. Data on device can be accessed directly via: http://deviceIP + +For debuggin purposes, the device can have firmware uploaded directly from the webpage. It's recommended that after deployment, this feature be removed for security. + +Recommend platformio for compiling and distributing the esp8266 source to devices. +![Alt text](/screenshots/WXDevice_ESP8266.png?raw=true "Device Webpage") + Flask and SocketIO frontend to weather station. It can accept multiple stations simultaneously. To setup: @@ -12,3 +21,5 @@ $python app.py Webpage will be located at and will update when packet is received from stations http://localhost:5000/ + +![Alt text](/screenshots/FlaskWXServer.png?raw=true "Flask Server Webpage")