Release v1.0.0

Author: actions-user

LICENSE

@@ -1,22 +1,87 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
 
-The MIT License (MIT)
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Copyright (c) Blynk Technologies Inc
+1. Definitions.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications.
+
+"Object" form shall mean any form resulting from mechanical transformation.
+
+"Work" shall mean the work of authorship, whether in Source or Object form.
+
+"Derivative Works" shall mean any work based on the Work.
+
+"Contribution" shall mean any work of authorship intentionally submitted.
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor
+hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+royalty-free, irrevocable copyright license to reproduce, prepare
+Derivative Works of, publicly display, publicly perform, sublicense,
+and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable patent license
+to make, have made, use, offer to sell, sell, import, and otherwise
+transfer the Work.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works
+thereof in any medium, with or without modifications, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work a copy of this License;
+
+(b) You must cause any modified files to carry prominent notices;
+
+(c) You must retain all copyright, patent, trademark, and attribution notices;
+
+(d) If the Work includes a "NOTICE" file, you must include it.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally
+submitted shall be under the terms of this License.
+
+6. Trademarks.
+
+This License does not grant permission to use trade names, trademarks,
+or product names of the Licensor.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law, the Work is provided "AS IS",
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
+
+8. Limitation of Liability.
+
+In no event shall any Contributor be liable for any damages.
+
+9. Accepting Warranty or Additional Liability.
+
+You may choose to offer support or warranty, but only on Your own behalf.
+
+END OF TERMS AND CONDITIONS

README.md

@@ -24,7 +24,7 @@ and take advantage of all its advanced features without the need for extensive c
 Supported targets:
 ```
 ✅ ESP32, ESP32-S3, ESP32-C2, ESP32-C3, ESP32-C5, ESP32-C6
-⏳ ESP32-S2 - *(soon)*
+⏳ ESP32-S2 - soon
 ❌ ESP32-P4, ESP32-H4
 ```
 
@@ -39,7 +39,7 @@ Supported targets:
 Configure the target chip, eg `idf.py set-target esp32`.
 
 Configure component using `idf.py menuconfig`:
-```
+```txt
 (Top) → Component config → Blynk.Edgent
 ```
 
@@ -62,18 +62,17 @@ The device should appear `online` once the above steps complete successfully.
 See the device log via `idf.py monitor`:
 
 ```log
-I (326) example: app_main() started
-I (326) gpio: GPIO[9]| InputEn: 1| OutputEn: 0| OpenDrain: 0| Pullup: 1| Pulldown: 0| Intr:0 
-I (326) button: IoT Button Version: 4.1.3
-I (346) nm_eth.c: Ethernet initialized with 0 port(s)
-I (346) edgent.c: Blynk.Edgent initialized (device: Blynk Blinking LED-N945)
-I (356) edgent.c: State transition: IDLE => CONNECTING_NET
-I (356) example: Received on_state_change
-I (1506) edgent.c: State transition: CONNECTING_NET => CONNECTING_CLOUD
-I (1506) example: Received on_state_change
-I (2626) edgent.c: State transition: CONNECTING_CLOUD => RUNNING
-I (2626) example: Received on_state_change
-I (2626) example: Received on_initial_connection
+I (771) edgent.c: Blynk.Edgent initialized (device: Blynk Demo-N1A9)
+I (771) edgent.c: State: IDLE => CONNECTING_NET
+I (771) example: State change event received
+I (851) nm_wifi.c: Connecting to SSID:wifi BSSID 2c:c8:1b:xx:xx:xx CH:11
+I (851) example: Awaiting Cloud connection...
+I (1931) edgent.c: State: CONNECTING_NET => CONNECTING_CLOUD
+I (1931) example: State change event received
+I (2981) edgent.c: State: CONNECTING_CLOUD => RUNNING
+I (2981) example: State change event received
+I (2981) example: Initial connection established
+I (2991) example: [main] Cloud connected event received! Continuing...
 ```
 
 </details>
@@ -95,19 +94,18 @@ The example application also handles the on-board button:
 idf.py add-dependency "blynk/edgent^1.0.0"
 ```
 
-If your project uses **Minimal Build**, consider disabling it, or add build dependencies explicitly:
+If your project uses [`MINIMAL_BUILD`](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html#cmake-build-properties), consider disabling it, or add build dependencies explicitly:
 ```
 esp_event esp_netif esp_wifi esp_https_ota
-esp_partition efuse nvs_flash mqtt json bt
-esp_eth
+esp_partition efuse nvs_flash mqtt json bt esp_eth
 ```
 
 ## OTA configuration
 
 Minimum flash size requirement for OTA updates is `4MB`.
 
 You should select a dual-bank partition table, for example:
-```
+```txt
 (Top) → Partition Table → Partition Table → Two large size OTA partitions
 ```
 
@@ -128,6 +126,7 @@ To enable Ethernet:
 <!--
 - [Cookbook](_extra/Cookbook.md)
 -->
+
 - [Blynk.Edgent](https://docs.blynk.io/en/blynk.edgent/overview)
 - [Blynk IoT Apps][blynk-apps]
 - [Deploying Products With Dynamic AuthTokens](https://docs.blynk.io/en/commercial-use/deploying-products-with-dynamic-authtokens)

examples/basic/main/main.cpp

@@ -9,19 +9,22 @@
 #include <string.h>
 #include <esp_log.h>
 #include <esp_system.h>
-#include "nvs_flash.h"
-#include "iot_button.h"
-#include "button_gpio.h"
-#include "freertos/FreeRTOS.h"
-#include "freertos/task.h"
+#include <esp_random.h>
+#include <nvs_flash.h>
+#include <freertos/FreeRTOS.h>
+#include <freertos/task.h>
+#include <iot_button.h>
+#include <button_gpio.h>
 #include "blynk_edgent.h"
 
 static const char* TAG = "example";
 
+static EventGroupHandle_t evt_group;
+#define EVT_CONNECTED BIT0
+
 #if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32S3
 #   define BOOT_BUTTON_NUM 0
-#elif CONFIG_IDF_TARGET_ESP32C3 || CONFIG_IDF_TARGET_ESP32C6 || \
-      CONFIG_IDF_TARGET_ESP32C2 || CONFIG_IDF_TARGET_ESP32C5
+#elif CONFIG_IDF_TARGET_ESP32C3 || CONFIG_IDF_TARGET_ESP32C6 || CONFIG_IDF_TARGET_ESP32C2 || CONFIG_IDF_TARGET_ESP32C5
 #   define BOOT_BUTTON_NUM 9
 #endif
 #define BUTTON_ACTIVE_LEVEL 0
@@ -30,20 +33,18 @@ static void button_event_cb(void* arg, void* data) {
    iot_button_print_event((button_handle_t)arg);
    button_event_t event = iot_button_get_event((button_handle_t)arg);
    if (BUTTON_LONG_PRESS_START == event) {
-      edgent_reset_config();
+      edgent_config_reset();
    } else if (BUTTON_DOUBLE_CLICK == event) {
-      edgent_start_config();
+      edgent_config_start();
    }
 }
 
 static void button_init(uint32_t button_num) {
    button_config_t btn_cfg = {.long_press_time = 5000, .short_press_time = 200};
-   button_gpio_config_t gpio_cfg = {
-      .gpio_num = (int32_t)button_num,
-      .active_level = BUTTON_ACTIVE_LEVEL,
-      .enable_power_save = true,
-      .disable_pull = true
-   };
+   button_gpio_config_t gpio_cfg = {.gpio_num = (int32_t)button_num,
+                                    .active_level = BUTTON_ACTIVE_LEVEL,
+                                    .enable_power_save = true,
+                                    .disable_pull = true};
 
    button_handle_t btn;
    esp_err_t ret = iot_button_new_gpio_device(&btn_cfg, &gpio_cfg, &btn);
@@ -56,11 +57,6 @@ static void button_init(uint32_t button_num) {
    ESP_ERROR_CHECK(ret);
 }
 
-void edgent_on_reboot_request(void) {
-   ESP_LOGI(TAG, "Blynk.Edgent initiated reboot");
-   esp_restart();
-}
-
 static void on_downlink_datastream_callback(const char* topic, int topic_len, const char* data, int data_len) {
    ESP_LOGI(TAG, "Datastream received — topic: %s, data: %s", topic, data);
 }
@@ -75,20 +71,28 @@ static void on_state_change(void) {
 
 static void on_initial_connection(void) {
    ESP_LOGI(TAG, "Initial connection established");
+   edgent_get_ds_all();
+   edgent_get_utc();
+   edgent_get_location();
 }
 
 static void on_config_change(void) {
    ESP_LOGI(TAG, "Configuration change detected");
 }
 
+void on_reboot_request(void) {
+   ESP_LOGI(TAG, "Blynk.Edgent initiated reboot");
+   esp_restart();
+}
+
 // Event handler
 static void blynk_edgent_event_handler(void* handler_arg, esp_event_base_t base, int32_t id, void* event_data) {
    if (id == EDGENT_EVENT_STATE_CHANGED && event_data) {
       edgent_state_evt_t* evt = (edgent_state_evt_t*)event_data;
-      ESP_LOGI(TAG, "Blynk Edgent state changed: %d -> %d", evt->prev, evt->curr);
+      ESP_LOGD(TAG, "Blynk.Edgent state changed: %d -> %d", evt->prev, evt->curr);
       switch (evt->curr) {
       case EDGENT_STATE_CONNECTED:
-         ESP_LOGI(TAG, "Device is now connected to cloud.");
+         xEventGroupSetBits(evt_group, EVT_CONNECTED);
          break;
       case EDGENT_STATE_ERROR:
          ESP_LOGW(TAG, "Device entered ERROR state, take action!");
@@ -99,6 +103,20 @@ static void blynk_edgent_event_handler(void* handler_arg, esp_event_base_t base,
    }
 }
 
+void other_task(void* arg) {
+   EventBits_t bits = xEventGroupWaitBits(evt_group, EVT_CONNECTED, pdFALSE, pdFALSE, portMAX_DELAY);
+   if (bits & EVT_CONNECTED) {
+      ESP_LOGI(TAG, "[%s] Cloud connected event received! Continuing...", pcTaskGetName(NULL));
+   }
+
+   while (true) {
+      double rnd = 10.0 + (esp_random() % 2501) / 100.0;
+      edgent_publish_ds_float("Set Temperature", rnd, 2);
+      edgent_publish_ds_int("Status", rand() % 5);
+      vTaskDelay(pdMS_TO_TICKS(10000));
+   }
+}
+
 extern "C" void app_main(void) {
    ESP_LOGI(TAG, "app_main() entered");
 
@@ -126,29 +144,59 @@ extern "C" void app_main(void) {
    ESP_ERROR_CHECK(esp_event_handler_instance_register(
       EDGENT_EVENT_BASE, EDGENT_EVENT_STATE_CHANGED, blynk_edgent_event_handler, NULL, NULL));
 
+   // Create the event group
+   evt_group = xEventGroupCreate();
+   assert(evt_group);
+
    // initialize button
    button_init(BOOT_BUTTON_NUM);
 
    // initialize Edgent
-   edgent_init();
-
-   // setup Edgent callbacks
-   edgent_set_downlink_callback(on_downlink_callback);
-   edgent_set_downlink_datastream_callback(on_downlink_datastream_callback);
-   edgent_set_on_state_change(on_state_change);
-   edgent_set_on_initial_connection(on_initial_connection);
-   edgent_set_on_config_change(on_config_change);
+   edgent_config_t config = {};
+   config.downlink_ds_callback = on_downlink_datastream_callback;
+   config.downlink_callback = on_downlink_callback;
+   config.state_change_callback = on_state_change;
+   config.config_change_callback = on_config_change;
+   config.initial_connection_callback = on_initial_connection;
+   config.reboot_request_callback = on_reboot_request;
+   edgent_init(&config);
 
    // start Edgent
    edgent_start();
 
-   bool bON = false;
-   char data[32];
+   // create parallel task
+   xTaskCreate(other_task,
+               "other_task",
+               2048,
+               NULL,
+               tskIDLE_PRIORITY + 1, // default normal priority
+               NULL);
+
+   ESP_LOGI(TAG, "Awaiting Cloud connection...");
+   EventBits_t bits = xEventGroupWaitBits(evt_group, EVT_CONNECTED, pdFALSE, pdFALSE, portMAX_DELAY);
+   if (bits & EVT_CONNECTED) {
+      ESP_LOGI(TAG, "[%s] Cloud connected event received! Continuing...", pcTaskGetName(NULL));
+   }
+
+   static bool bON = false;
    while (true) {
-      int count = snprintf(data, sizeof(data) - 1, "%d", bON);
-      // https://docs.blynk.io/en/blynk.cloud-mqtt-api/device-mqtt-api/datastreams#send-data-to-blynk
-      edgent_publish("ds/Power", data, count, 0);
-      edgent_publish("get/meta", "Serial,Time Zone", 16, 0);
+      // Publish Power state
+      edgent_publish_ds_int("Power", (int64_t)bON);
+
+      // Publish random Current Temperature
+      double rnd = 10.0 + (esp_random() % 2501) / 100.0;
+      edgent_publish_ds_float("Current Temperature", rnd, 2);
+
+      // Publish uptime
+      uint32_t uptime_sec = xTaskGetTickCount();
+      edgent_publish_ds_int("uptime", uptime_sec);
+
+      // Request metadata
+      edgent_get_metadata("Device Name");
+
+      // Toggle widget state
+      edgent_set_property("uptime", "isDisabled", bON ? "false" : "true");
+
       bON = !bON;
       vTaskDelay(pdMS_TO_TICKS(15000));
    }

idf_component.yml

@@ -1,7 +1,7 @@
-version: "0.9.0-beta.4"
+version: "1.0.0"
 description: "Blynk Edgent for ESP-IDF"
 url: "https://www.blynk.io"
-license: "MIT"
+license: "Apache-2.0"
 dependencies:
   idf:
     version: ">=5.4,<=5.5.2"