Skip to content

Commit 92ea806

Browse files
committed
Update documentation of macros and fix typos
1 parent 6962152 commit 92ea806

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,12 @@ temperature and pressure sensor **BMP180**. It uses the ESP-IDF framework.
2727
[Project Configuration](#project-configuration) for the steps to enter
2828
the _ssid_ and the _password_.
2929
3. Communicate with the ESP32 via **UDP**. Both sending and receiving are
30-
done over the same port. The port is set in `main.c`.
30+
done over the same port. The port and the timer periods for heartbeat
31+
and measurements are set in `main.c`.
3132
```c
3233
#define UDP_PORT 50000
34+
#define MEASUREMENT_RATE 600
35+
#define HEARTBEAT_RATE 300
3336
```
3437
4. The **UDP** communication consists of **JSON** objects that are send as
3538
strings. The following listing shows all the current options.
@@ -57,7 +60,7 @@ temperature and pressure sensor **BMP180**. It uses the ESP-IDF framework.
5760
}]
5861
}
5962
```
60-
Respone from a periodic `measurement` which holds a list of measured
63+
Response from a periodic `measurement` which holds a list of measured
6164
quantities in `quantity`.
6265
```json
6366
{
@@ -99,7 +102,7 @@ found on GitHub and has an extensive documentation.
99102

100103
This project uses **version 4.2** of the ESP-IDF.
101104
```bash
102-
git clone --recurisve --branch v4.2 https://github.com/espressif/esp-idf.git
105+
git clone --recursive --branch v4.2 https://github.com/espressif/esp-idf.git
103106
```
104107

105108
### Toolchain Troubleshooting (Ubuntu)
@@ -153,7 +156,7 @@ Further documentation for `monitor`.
153156

154157
### WiFi
155158
The WiFi bundle uses the **LwIP stack** with `esp_netif` and **BSD Sockets**
156-
for UDP/TCP communication. Time syncronization is done via `sntp`.
159+
for UDP/TCP communication. Time synchronization is done via `sntp`.
157160

158161
=> https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-guides/wifi.html
159162
=> https://docs.espressif.com/projects/esp-idf/en/v4.2/esp32/api-reference/network/esp_netif.html

0 commit comments

Comments
 (0)