From aef3c902c4ecd0cc9e04a72441eb4180533e851f Mon Sep 17 00:00:00 2001 From: Gabe Shaughnessy Date: Wed, 28 Sep 2016 12:09:14 -0500 Subject: [PATCH] README update --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 089309f..5ccad5b 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ -ESP8266 driven weather station with Flask webserver frontend. +# 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 +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. +For debugging 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: +To setup:\ pip -r requirements To run: -Run station receiver that pushes socketIO packets to flask webserver: +Run station receiver that pushes socketIO packets to flask webserver:\ $python stationServer.py -Run flask webserver that listens for SocketIO packets: +Run flask webserver that listens for SocketIO packets:\ $python app.py Webpage will be located at and will update when packet is received from stations