@@ -4,11 +4,42 @@ This repository contains the IoTConnect Arduino SDK and code samples that make u
4
4
5
5
## Supported Boards
6
6
7
- The code has been developed and tested With [ SparkFun ESP32 Thing] ( https://www.sparkfun.com/products/13907 )
8
- and [ ESP32-S2-Saola-1] ( https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-saola-1-v1.2.html )
7
+ The code has been developed and tested with [ SparkFun ESP32 Thing] ( https://www.sparkfun.com/products/13907 )
9
8
10
9
The SDK depends on the WiFiSecure library and will require a WiFi capable board or a WiFi shield.
11
10
12
11
The sample provided with the code makes use of the GPIO #2 for LED and #10 for the button example,
13
- and is based on ESP32 boards .
12
+ and it requires an ESP32 board with .
14
13
14
+ ## Project Setup
15
+
16
+ The recommended development environment for this project is PlatformIO, due to improved project structure,
17
+ ease of use, and code completion features. Arduino IDE is also supported.
18
+
19
+ ### PlatformIO
20
+
21
+ * Download and extract the PlatformIO package from the Releases page into a directory of your choosing.
22
+ * Download and install Microsoft VSCode for your OS.
23
+ * Open VSCode and in the menu navigate to ** View -> Extensions** .
24
+ * Search for * PlatformIO* and install the ** Platform IO IDE** extension.
25
+ * Open the PlatformIO plugin in the left sidebar and navigate to ** PIO Home -> Open** on the left side panel.
26
+ * Click the ** Open Project** button and navigate to the directory containing platformio.ini, where the project is extracted.
27
+ * Click the ** Open <project name >** button in the dialog.
28
+ * Click ** Yes** when asked about trusting the authors.
29
+ * Modify * include/wifi_config.h* and * include/app_config.h* per your WiFi, IoTConnect device, and account credentials.
30
+ * Connect the device, open the PlatformIO extension in the sidebar and click ** Genral -> esp32thing -> Upload and Monitor**
31
+ in order to upload the code to your device and see the device console messages.
32
+
33
+ ### Arduino IDE
34
+
35
+ * Download and extract the Arduino ID package from the Releases page into a directory of your choosing.
36
+ * Download and install Arduino IDE for your OS.
37
+ * Open the file explorer and open esp-sensors-demo.ino file in the directory of the extracted package.
38
+ Alternatively, you can open the IDE and open a new sketch.
39
+ * Using the ** Sketch -> Include Library** menu item,
40
+ install the PubSubClient and LibPrintf (using the zip URL) packages as listed in the dep_libs section
41
+ of the [ platfromio.ini] ( platfromio.ini ) file.
42
+ * Modify * wifi_config.h* and * app_config.h* per your WiFi, IoTConnect device, and account credentials.
43
+ * Connect the device, and click the ** Upload** button. If the device fails to upload,
44
+ press the reset button on the board while the upload process is connecting -- while the dots and underscores are printed in the log
45
+ * Select ** Tools -> Serial Monitor** in the menu, in order to see the device console messages.
0 commit comments