Skip to content

Commit a788230

Browse files
committed
Adding README
1 parent 81bb736 commit a788230

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

REAME.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# ESP-32s Project with Arduino and PlatformIO
2+
3+
This project consists of an ESP-32s that uses Arduino libraries to receive data (temperature, air/soil humidity, and light intensity) through UART and send it to an MQTT server on Ubidots. PlatformIO is used as the integrated development environment (IDE).
4+
5+
## Before start...
6+
Before compiling the project, you must create a file named wifi_credentials.h with the following defined macros:
7+
8+
```c++
9+
#define WIFI_SSID_SECRETS "<Network Name>"
10+
#define WIFI_PASSWORD_SECRETS "<Password>"
11+
#define UBIDOTS_TOKEN_SECRETS "<Ubidots Token>"
12+
#define DEVICE_LABEL_SECRETS "<Device name>"
13+
```
14+
15+
| ⚠️ Make sure to replace the example values with your own data before compiling.
16+
17+
## Customization
18+
19+
Additionally, you can customize the project by overwriting the following constants:
20+
21+
```c++
22+
#define DATA_UART <UART NUMBER>
23+
#define SERIAL_RX <PIN TO RECEIVE DATA>
24+
#define SERIAL_TX <PIN TO TRANSMIT DATA>
25+
#define BAUD_RATE <BAUD RATE TO TRANSMIT DATA>
26+
#define FREQUENCY_TO_PUBLISH_IN_M <FREQUENCY TO PUBLISH IN MINUTES>
27+
#define FREQUENCY_TO_PUBLISH_IN_MS (FREQUENCY_TO_PUBLISH_IN_M * 60 * 1000)
28+
```
29+
30+
| ⚠️ Make sure that the slave device transmits at the same baud rate defined in the BAUD_RATE macro.

0 commit comments

Comments
 (0)