diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..2b106b98cb00b2de467793a9101311e94d01a204 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Rust Weather Station + +## Description + +A minimal weather station available through HTTP on WLAN, providing pressure [kPa], (uncalibrated) température [°C], and luminosity (abstract unit). + +## How it works + +It connects to the RustWeatherStation WLAN on startup. +Then we can access it through from a device on same network via web browser (the ip needs to be found externally). + +A webpage, is delivered on GET request. This page contains a script that will send a POST request every 3s to query the data to populate the fields. + +## Running the program + +### Requirements + +- Visual Studio Code (for easy debugging) +- openocd +- arm-none-eabi-gdb (or a symlink to gdb-multiarch) +- RustWeatherStationBox™ + + +### Instructions + +- Open project in VSCode +- Press F5 \ No newline at end of file