Skip to content

Commit a1c5c92

Browse files
author
nik-markovic
committed
Update with new structure to better support Arduino library approach
1 parent 758dbdd commit a1c5c92

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,31 @@ ease of use, and code completion features. Arduino IDE is also supported.
1818

1919
### PlatformIO
2020

21-
* Download and extract the PlatformIO package from the [Releases](https://github.com/avnet-iotconnect/iotc-arduino-sdk/packages)
21+
* Clone this repository, or Download and extract the PlatformIO package from the [Releases](https://github.com/avnet-iotconnect/iotc-arduino-sdk/packages)
2222
page into a directory of your choosing.
2323
* Download and install Microsoft [Visual Studio Code](https://code.visualstudio.com/download) (VSCode) for your OS.
2424
* Open VSCode and in the menu navigate to **View -> Extensions**.
2525
* Search for *PlatformIO* and install the **Platform IO IDE** extension.
26-
* Open the PlatformIO plugin in the left sidebar and navigate to **PIO Home -> Open** on the left side panel.
26+
* Open the PlatformIO plugin in the lft sidebar and navigate to **PIO Home -> Open** on the left side panel.
2727
* Click the **Open Project** button and navigate to the directory containing platformio.ini, where the project is extracted.
2828
* Click the **Open <project name>** button in the dialog.
2929
* Click **Yes** when asked about trusting the authors.
3030
* Modify *include/wifi_config.h* and *include/app_config.h* per your WiFi, IoTConnect device, and account credentials.
31-
* Connect the device, open the PlatformIO extension in the sidebar and click **Genral -> esp32thing -> Upload and Monitor**
31+
* Connect the device, open the PlatformIO extension in the sidebar and click **General -> esp32thing -> Upload and Monitor**
3232
in order to upload the code to your device and see the device console messages.
3333

3434
### Arduino IDE
3535

36-
* Download and extract the Arduino ID package from the [Releases](https://github.com/avnet-iotconnect/iotc-arduino-sdk/packages)
36+
* Download and extract the Arduino IDE package from the [Releases](https://github.com/avnet-iotconnect/iotc-arduino-sdk/packages)
3737
page into a directory of your choosing.
3838
* Download and install [Arduino IDE](https://www.arduino.cc/en/software) for your OS.
39-
* Open the file explorer and open esp-sensors-demo.ino file in the directory of the extracted package.
40-
Alternatively, you can open the IDE and open a new sketch.
41-
* Using the **Sketch -> Include Library** menu item,
42-
install the PubSubClient and LibPrintf (using the zip URL) packages as listed in the dep_libs section
43-
of the [platfromio.ini](platfromio.ini) file.
39+
* Open the file explorer and open esp-sensors-demo.ino file in the examples/esp-sensors-demo directory of the extracted package.
40+
Alternatively, you can open the IDE and open this sketch by using the **File -> Open** menu option.
41+
* Select the **Sketch -> Include Library -> Add .ZIP Library** menu item,
42+
and *Open* the downloaded IoTConnectSDK.ZIP, or the directory where it is extracted. this will install the IoTConnectSDK library.
43+
* Using the **Sketch -> Include Library** menu item, install the PubSubClient library.
44+
* If not using an ESP board, install the LibPrintf library (using the zip URL).
4445
* Modify *wifi_config.h* and *app_config.h* per your WiFi, IoTConnect device, and account credentials.
4546
* Connect the device, and click the **Upload** button. If the device fails to upload,
46-
press the reset button on the board while the upload process is connecting -- while the dots and underscores are printed in the log
47+
press the reset button on the board while the upload process is connecting -- while the dots and underscores are printed in the log.
4748
* Select **Tools -> Serial Monitor** in the menu, in order to see the device console messages.

platformio.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
[common]
1212
lib_deps =
13-
IoTConnectSDK@^1.0.0
13+
IoTConnectSDK@^1.0
1414
knolleary/PubSubClient@^2.8
1515
LibPrintf=https://github.com/embeddedartistry/arduino-printf/archive/1.1.4.tar.gz
1616
WiFiClientSecure

0 commit comments

Comments
 (0)