Add project details to README
This commit is contained in:
38
README.md
38
README.md
@@ -1,3 +1,39 @@
|
||||
# Weather-Panel-Display
|
||||
|
||||
A weather display, based on an ESP32 and a 16x32 RGB led panel taken from a very pink electronic toy purse.
|
||||
A weather display, based on an ESP32 and a 16x32 RGB led panel taken from a very pink electronic toy purse.
|
||||
|
||||
The panel is updated every 10 minutes with an icon of the current weather and the current temperature outside. Data is fetched using the DarkSky API.
|
||||
|
||||
One boot, the unit will create a WiFi network with the name `ESP-XXXXXX`. When a user connects to that site, a capture portal will have a form requesting which WiFi network to use, and the DarkSky API key. After that, it will periodically update on its own.
|
||||
|
||||
## Building
|
||||
|
||||
This code compiles with the standard Arduino toolchain, and was tested with Arduino version 1.8.9.
|
||||
|
||||
### Dependencies
|
||||
|
||||
* ESP-32 SmartMatrix [Source](https://github.com/pixelmatix/SmartMatrix/tree/teensylc)
|
||||
* ArduinoJson [Homepage](https://arduinojson.org/), [Source](https://github.com/bblanchon/ArduinoJson)
|
||||
* ESP-32 WifiManager [Source](https://github.com/zhouhan0126/WIFIMANAGER-ESP32)
|
||||
|
||||
|
||||
## TODO
|
||||
|
||||
No really, this has to be done before this code can be shared.
|
||||
|
||||
- Add "Powered by DarkSky" text somewhere, per their [Terms of Service](https://darksky.net/dev/docs/terms#tos-attribution).
|
||||
|
||||
## Future Work
|
||||
This was a hacky toy project, so I'll likely never implement the below, but there are is some low-hanging fruit without too much "scope creep".
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
- Add daily high/low temperatures
|
||||
- Add alternative icons with color
|
||||
- Add an option to persist the networking information
|
||||
|
||||
### Usability
|
||||
|
||||
- Show the WiFi network name on the LED display while waiting for configuration
|
||||
- Show an error on the LED display if the networking configuration is
|
||||
|
||||
Reference in New Issue
Block a user