This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:iot:examples:quickstart [2022/05/10 08:50] – raivo.sell | en:iot:examples:quickstart [Unknown date] (current) – external edit (Unknown date) 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Quickstart guide ====== | ====== Quickstart guide ====== | ||
- | - [[en: | + | ====== Configuring the development environment ====== |
- | - [[en: | + | |
- | - [[en: | + | Download and install VS Code from [[https:// |
+ | |||
+ | =====Install Python on Windows===== | ||
+ | |||
+ | Download Python from [[https:// | ||
+ | |||
+ | Before installing check the **Add Python to PATH** | ||
+ | |||
+ | {{:en: | ||
+ | |||
+ | =====Install Python on Linux===== | ||
+ | |||
+ | Open terminal and check if you have Python 3 installed. | ||
+ | |||
+ | < | ||
+ | $ python3 --version | ||
+ | </ | ||
+ | |||
+ | If you don't have Python 3 installed then run the following command. | ||
+ | < | ||
+ | $ sudo apt install python3 | ||
+ | </ | ||
+ | |||
+ | Wether you already had Python installed or not, you need to run the following command. | ||
+ | < | ||
+ | $ sudo apt install python3-distutils | ||
+ | </ | ||
+ | |||
+ | =====Installing PlatformIO IDE on VS Code===== | ||
+ | |||
+ | - Click on the **Extensions** icon or press **Ctrl+Shift+X** to open the extensions tab | ||
+ | - Search for " | ||
+ | - Select the first option | ||
+ | - Click the **Install** button | ||
+ | |||
+ | {{: | ||
+ | |||
+ | After installing make sure the extension is enabled. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | After that, the PlatformIO icon should appear on the left sidebar and a **Home** icon redirects you to PlatformIO home. If not, restart Visual Studio Code. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ====== Creating your first project ====== | ||
+ | |||
+ | =====Using PlatformIO IDE===== | ||
+ | |||
+ | On VS Code, click on the PlartfomIO **Home** icon. Click on **+ New Project** to start a new project. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Give your project a name, select the board **WeMos D1 MINI ESP32 (WEMOS)** and the framework as **Arduino Framework** | ||
+ | |||
+ | {{:en: | ||
+ | |||
+ | After finishing the setup the project should be accessible from the explorer tab. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ====platformio.ini file==== | ||
+ | |||
+ | The **platformio.ini** file is the PlatformIO Configuration File for your project. It shows the platform, board, and framework for your project. You can also add other configurations like libraries to be included, upload options, changing the Serial Monitor baud rate and other configurations. | ||
+ | |||
+ | Add the following line to include the ITTIoT Library and other parameters (check correct port instead of example COM3): | ||
+ | |||
+ | < | ||
+ | upload_speed = 921600 | ||
+ | upload_port = COM3 | ||
+ | // | ||
+ | monitor_speed = 115200 | ||
+ | lib_deps = ITTIoT | ||
+ | </ | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ====src folder==== | ||
+ | |||
+ | The **src** folder is your working folder. Under the src folder, there’s a main.cpp file. That’s where you write your code. Click on that file. The structure of an Arduino program should open with the setup() and loop() functions. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Paste the following example code to main.cpp | ||
+ | |||
+ | <code c> | ||
+ | #include < | ||
+ | #include < | ||
+ | |||
+ | void iot_received(String topic, String msg){ | ||
+ | Serial.print(" | ||
+ | Serial.print(topic); | ||
+ | Serial.print(" | ||
+ | Serial.println(msg); | ||
+ | } | ||
+ | |||
+ | void iot_connected(){ | ||
+ | Serial.println(" | ||
+ | iot.subscribe(" | ||
+ | iot.log(" | ||
+ | } | ||
+ | |||
+ | void setup() { | ||
+ | Serial.begin(115200); | ||
+ | iot.setConfig(" | ||
+ | iot.setConfig(" | ||
+ | iot.setConfig(" | ||
+ | iot.setConfig(" | ||
+ | iot.setConfig(" | ||
+ | iot.setConfig(" | ||
+ | iot.printConfig(); | ||
+ | iot.setBootPin(5); | ||
+ | iot.setup(); | ||
+ | } | ||
+ | |||
+ | void loop() { | ||
+ | iot.handle(); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | Make sure to replace the connection information with yours. | ||
+ | |||
+ | =====Uploading code using PlatformIO IDE===== | ||
+ | |||
+ | To test and upload your code, first save your code and then click on the **Build** icon at the bottom of the editor to verify that your code can be run. After a successful build, press the **Upload** icon. Alternatively, | ||
+ | |||
+ | {{: | ||
+ | |||
+ | |||
+ | ====== Verifying the connection ====== | ||
+ | |||
+ | |||
+ | If the code is compiled and uploaded successfully, | ||
+ | |||
+ | {{:en: | ||
+ | |||
+ | If the serial monitor does not open automatically, | ||
+ | |||
+ | {{: | ||
+ | |||
+ | This means the code was successfully uploaded, and the board was connected to the MQTT server. | ||
+ | |||
+ | Install the [[https:// | ||
+ | |||
+ | Configure the connection with your details and publish a message to the topic that your board is listening to (// | ||
+ | |||
+ | The board should receive the message and print it out on the serial monitor: | ||
+ | |||
+ | {{: |