alex/ESP-Nodes
1
1
Fork 0
mirror of https://github.com/alexandrebobkov/ESP-Nodes.git synced 2024-10-05 20:47:50 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update rainmaker.md

Browse Source
This commit is contained in:
Alexander 2024-08-11 01:17:36 -04:00 committed by GitHub
parent 09028d3135
commit 27ddccfa3b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 84 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
rainmaker.md
View File

@ -3,3 +3,87 @@ layout: tutorial
---
# Tutorial: Creating Rainmaker Device
# ESP RAINMAKER TUTORIAL
This tutorial walks you through the most important steps neccessary to provision ESP32-WROOM device.
> [!TIP]
> _WHAT'S REQUIRED:_
>
> ESP32-WROOM, either a Module or DevKit</br>
> Wi-Fi Access Point, preferrably with dedicated vLAN for IoT devices</br>
> Smart phone with RainMaker installed
### ESP-IDF: Create a New Project
Launch ESP-IDF extention on VS Code
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_001.png" width="70%"/>
Specify project name, directory path and ESP32 module (ESP32-WROOM or ESP32-C3). In addition, you may state the Serial port where ESP32 Module is connected to; this setting can be changed latter, if neccessary.
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_002.png" width="70%"/>
On the next screen, specify ESP Rainmaker extention and select example code to start with. For this tutorial, an example code for _ _Switch_ _ was selected. Click "Create project using template switch".
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_003.png" width="70%"/>
### Modify Template Code
Make the following changes to app_main.cpp source file.
Change the TAG variable as follows:
```C++
static const char *TAG = "ESP32-Nodes app main";
```
```C++
esp_rmaker_node_t *node = esp_rmaker_node_init(&rainmaker_cfg, "ESP RainMaker Device", "Switch");
```
```C++
switch_device = esp_rmaker_device_create("ESP32-Nodes Switch", ESP_RMAKER_DEVICE_SWITCH, NULL);
```
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_004.png" width="70%"/>
### Modify Configuration
Navigate to the ESP-IDF: SDK Configuration Editor (menuconfig). Some of the default values provided by RainMaker Switch template need to be changed in order to match GPIO used to turn LED Lights on or off.
Click on Example Configuration section, and change **Output GPIO** value to _4_, which corresponds to the GPIO connected to the LED lights control pin.
Set **Claiming Type** to _Assisted_, and **Provisioning Transport Method** to _BLE_.
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_005.png" width="70%"/>
Click _Save_ and then build the project by running the command _ESP-IDF: Build Project_.
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_006.png" width="70%"/>
Building the project can take some time.
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_007.png" width="70%"/>
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_008.png" width="70%"/>
### Adding RainMaker Device
Once project is successfully built, and ESP32-WROOM module is flashed, reboot your device and open Serial Monitor in order to access provisioning QR code. At this point you can start adding your device to your RainMaker dashboard. On your smartphone, launch the _ESP RainMaker_ app and click _Add device_. You'll be asked to scan the QR code. If provisioning is successful, _ESP RainMaker_ app will take you to the nest steps.
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_009.png" width="70%"/>
<img alt="ESP-IDF. Create a New Project" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Espressif-Rainmaker_010.png" width="70%"/>
<img alt="Alexa Account Linking to RainMaker" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Screenshot_20240716-213521~2.png" width="70%"/>
<img alt="RainMaker Provisioning. Adding Wi-Fi" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Screenshot_20240716-223344~2.png" width="70%"/>
<img alt="RainMaker Provisioning" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Screenshot_20240716-223358~2.png" width="70%"/>
<img alt="RainMaker. ESP32 Node Switch Setting" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Screenshot_20240716-230310~2.png" width="70%"/>
<img alt="RainMaker. ESP32 Node Switch" src="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/assets/Screenshot_20240716-230318~2.png" width="70%"/>