some rough instructions in a README

master
Kenneth Barbour 2020-06-12 21:49:27 -04:00
parent 863d5eff78
commit e02a6066f3
1 changed files with 19 additions and 0 deletions

19
README.markdown 100644
View File

@ -0,0 +1,19 @@
<h1>uWeather Firmware</h1>
Firmware for a small Arduino/ESP8266 + BME280 Weather Station
# Build/Install
`pio run -t upload`, then `pio run -t uploadfs` to build and upload code and filesystem for the first time, while connected over USB/Serial.
If station is connected to wifi, uploading over the air is preferred:
`pio run -t upload --upload-port 192.168.1.72` (substituting the station's IP address)
# Initial Station Setup
After installing firmware and booting for the first time:
1) Using a smartphone or laptop, connect to the station's WiFi Access Point
2) Access the setup page from 192.168.1.4/setup
3) Enter WiFi configuration and station settings
4) Optionally commit config settings to EEPROM(WiFi is automatically committed) by POST-ing to /config/commit
5) Restart the weather station
# TODO
* Responses from config api calls don't properly fill form elements after saving