Added image of altimeter webinterface and updated text authored by Tobias Stein's avatar Tobias Stein
...@@ -9,6 +9,10 @@ during the ascent of the rocket. The display from the original project is gone a ...@@ -9,6 +9,10 @@ during the ascent of the rocket. The display from the original project is gone a
replaced with a webinterface which can be accessed over a WiFi connection. replaced with a webinterface which can be accessed over a WiFi connection.
# Usage # Usage
This section describes how to use the altimeter.
**Image of the webinterface (as of 03.03.2024)**
![Webinterface as of 03.03.2024](./2023-Altimeter-WLAN-resources/webinterface-example-view.png)
## WiFi Credential setup ## WiFi Credential setup
One set of WiFi credentials can be embedded into the firmware during flashing. One set of WiFi credentials can be embedded into the firmware during flashing.
On startup, the microcontroller will attempt to connect to the WiFi network On startup, the microcontroller will attempt to connect to the WiFi network
...@@ -31,7 +35,9 @@ The contents of the file should look like the following ...@@ -31,7 +35,9 @@ The contents of the file should look like the following
Before starting the sampling process, ensure that the measured reference values Before starting the sampling process, ensure that the measured reference values
are sensible by checking the webinterface, as the height calculation is relative are sensible by checking the webinterface, as the height calculation is relative
to those values. If they do not make sense, a recalibration can be triggered to those values. If they do not make sense, a recalibration can be triggered
from the webinterface. from the webinterface. In general you should open the webinterface once before
launching the altimeter as this will set the clock of the microcontroller to the
current time.
The sampling process can be started by pressing the user button The sampling process can be started by pressing the user button
connected to pin D8 on the controller or by using the start button in the connected to pin D8 on the controller or by using the start button in the
...@@ -41,10 +47,14 @@ When the statemachine is in the sampling state, pressing the user button or ...@@ -41,10 +47,14 @@ When the statemachine is in the sampling state, pressing the user button or
the start button in the webinterface again will restart the measurements and the start button in the webinterface again will restart the measurements and
discard existing samples. discard existing samples.
The sampling process stops either when the current measured height falls a There are 3 ways for the sampling process to end:
configurable distance below the maximum height or when the stop button in the 1. The current measured height falls a configurable distance below the maximum
webinterface is pressed. Afterwards the statemachine enters the idle stop state height measured during this sampling cycle.
and can be restarted by pressing the start buttons again. This will however 2. The stop button in the webinterface is pressed.
3. The maximum configured time for sampling has been reached.
After the statemachine enters the idle stop state the sampling process can
be restarted by pressing the start buttons again. This will however
discard the previous measurement results. discard the previous measurement results.
## Downloading results ## Downloading results
...@@ -270,7 +280,6 @@ will return a chunk of measured sensor values instead of a current sensor value. ...@@ -270,7 +280,6 @@ will return a chunk of measured sensor values instead of a current sensor value.
sensor issue has to be resolved. sensor issue has to be resolved.
- Improve webinterface design - Improve webinterface design
# Additional resources/guides # Additional resources/guides
## General information ## General information
- [Getting Started with Seeed Studio XIAO ESP32C3](https://wiki.seeedstudio.com/XIAO_ESP32C3_Getting_Started/): Getting started guide for MCU. Includes pinout and general information. - [Getting Started with Seeed Studio XIAO ESP32C3](https://wiki.seeedstudio.com/XIAO_ESP32C3_Getting_Started/): Getting started guide for MCU. Includes pinout and general information.
... ...
......