Merge branch 'espressif:master' into master

Author: sivar2311

.github/workflows/upload_components.yml

@@ -79,3 +79,7 @@ docs/docusaurus/website/node_modules
 
 # cli logs
 **/logs
+
+# IDF package manager
+**/managed_components/
+*.lock

.gitignore

@@ -5,7 +5,6 @@ stages:
 variables:
   V: "0"
   MAKEFLAGS: "-j8 --no-keep-going"
-  IDF_PATH: "$CI_PROJECT_DIR/esp-idf"
   APP_BUILD: "all"
   GIT_SUBMODULE_STRATEGY: recursive
 
@@ -20,173 +19,77 @@ before_script:
     # Create esp-rainmaker-bins-${CI_JOB_ID}/ dir (to copy binaries into for artifacts)
     - mkdir -p $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}
 
-.setup_idf: &setup_idf
-# Checking git version
-- echo Checking git version
-- git --version
-# Cloning esp-idf - Started
-- echo Cloning esp-idf - Started
-- git clone --recursive --branch ${IDF_GIT_BRANCH} --depth 1 ${IDF_GIT_PATH}/esp-idf.git
-- cd esp-idf
-- echo Cloning esp-idf - Done
-# Cloning esp-idf - Done
-# Running install.sh - Started
-- echo Running install.sh - Started
-- ./install.sh
-- echo Running install.sh - Done
-# Running install.sh - Done
-# Running export.sh - Started
-- echo Running export.sh - Started
-- . export.sh
-- echo Running export.sh - Done
-# Running export.sh - Done
-
-.build_switch: &build_switch
-# Building switch app - Started
-- echo Building switch app - Started
-- ls
-- cd $CI_PROJECT_DIR/examples/switch
-- echo Building for esp32
-- idf.py set-target esp32
-- idf.py build
-- rm -rf build/ sdkconfig
-- echo Building for esp32s2
-- idf.py set-target esp32s2
-- idf.py build
-- rm -rf build/ sdkconfig
-- echo Building for esp32c3
-- idf.py set-target esp32c3
-- idf.py build
-- rm -rf build/ sdkconfig
-- echo Building for esp32s3
-- idf.py set-target esp32s3
-- idf.py build
-- echo Building switch app - Done
-# Building switch app - Done
-# Copying switch.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- echo Copy switch.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- cp $CI_PROJECT_DIR/examples/switch/build/switch.bin $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}/
-
-.build_led_light: &build_led_light
-# Building led_light app - Started
-- echo Building led_light app - Started
-- echo Running idf.py
-- cd $CI_PROJECT_DIR/examples/led_light
-- idf.py build
-- echo Building led_light app - Done
-# Building led_light app - Done
-# Copying led_light.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- echo Copy led_light.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- cp $CI_PROJECT_DIR/examples/led_light/build/led_light.bin $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}/
-
-.build_fan: &build_fan
-# Building fan app - Started
-- echo Building fan app - Started
-- echo Running idf.py
-- cd $CI_PROJECT_DIR/examples/fan
-- idf.py build
-- echo Building fan app - Done
-# Building fan app - Done
-# Copying fan.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- echo Copy fan.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- cp $CI_PROJECT_DIR/examples/fan/build/fan.bin $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}/
-
-.build_temperature_sensor: &build_temperature_sensor
-# Building temperature_sensor app - Started
-- echo Building temperature_sensor app - Started
-- echo Running idf.py
-- cd $CI_PROJECT_DIR/examples/temperature_sensor
-- idf.py build
-- echo Building temperature_sensor app - Done
-# Building temperature_sensor app - Done
-# Copying temperature_sensor.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- echo Copy temperature_sensor.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- cp $CI_PROJECT_DIR/examples/temperature_sensor/build/temperature_sensor.bin $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}/
-
-.build_multi_device: &build_multi_device
-# Building multi_device app - Started
-- echo Building multi_device app - Started
-- echo Running idf.py
-- cd $CI_PROJECT_DIR/examples/multi_device
-- idf.py build
-- echo Building multi_device app - Done
-# Building multi_device app - Done
-# Copying multi_device.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- echo Copy multi_device.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- cp $CI_PROJECT_DIR/examples/multi_device/build/multi_device.bin $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}/
-
-.build_gpio: &build_gpio
-# Building gpio app - Started
-- echo Building gpio app - Started
-- echo Running idf.py
-- cd $CI_PROJECT_DIR/examples/gpio
-- idf.py build
-- echo Building gpio app - Done
-# Building gpio app - Done
-# Copying gpio.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- echo Copy gpio.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- cp $CI_PROJECT_DIR/examples/gpio/build/gpio.bin $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}/
-
-.build_homekit_switch: &build_homekit_switch
-# Building homekit_switch app - Started
-- cd $CI_PROJECT_DIR/examples/homekit_switch
+.build_all_examples: &build_all_examples
+- pip install --upgrade idf-component-manager
+- for EXAMPLE in $EXAMPLES; do
+- cd $CI_PROJECT_DIR/examples/$EXAMPLE
+- echo Building $EXAMPLE
+- if [[ "$EXAMPLE" == "homekit_switch" ]]; then
 - cd components
 - echo Cloning esp-homekit-sdk
 - git clone --recursive --branch master --depth 1 https://github.com/espressif/esp-homekit-sdk.git
 - cd ..
 - export HOMEKIT_PATH=$PWD/components/esp-homekit-sdk
-- echo Building homekit_switch app - Started
-- echo Running idf.py
+- fi
+- for TARGET in $EXAMPLE_TARGETS; do
+- echo Building for $TARGET
+- idf.py set-target $TARGET
 - idf.py build
-- echo Building homekit_switch app - Done
-# Building homekit_switch app - Done
-# Copying homekit_switch.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- echo Copy homekit_switch.bin to esp-rainmaker-bins-${CI_JOB_ID}/
-- cp $CI_PROJECT_DIR/examples/homekit_switch/build/homekit_switch.bin $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}/
+- mkdir -p $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}/$EXAMPLE/$TARGET/
+- cp $CI_PROJECT_DIR/examples/$EXAMPLE/build/*.bin $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}/$EXAMPLE/$TARGET/
+- done
+- echo Build Complete for $EXAMPLE
+- done
+# Generating zip file for binaries generated
+- cd $CI_PROJECT_DIR
+- echo Generating zip file for binaries generated
+- tar -zcvf esp-rainmaker-bins-${CI_JOB_ID}.zip esp-rainmaker-bins-${CI_JOB_ID}/
 
-build_app:
+.build_template:
   stage: build
-  image: $CI_DOCKER_REGISTRY/esp32-ci-env:rainmaker
+  image: espressif/idf:latest
   tags:
     - build
-  artifacts:
-    paths:
-      - $CI_PROJECT_DIR/esp-rainmaker-bins-${CI_JOB_ID}.zip
-    expire_in: 6 mos
+  variables:
+    PEDANTIC_FLAGS: "-Werror -Werror=deprecated-declarations -Wno-error=cpp -Werror=unused-variable -Werror=unused-but-set-variable -Werror=unused-function"
+    EXTRA_CFLAGS: "${PEDANTIC_FLAGS}"
+    EXTRA_CXXFLAGS: "${PEDANTIC_FLAGS}"
+    EXAMPLE_TARGETS: "esp32"
+    EXAMPLES: "switch led_light fan temperature_sensor multi_device gpio homekit_switch"
   script:
-    - *setup_idf
-    - for APP in $APP_BUILD; do
-    - if [[ "$APP_BUILD" == "all" || "$APP" == "switch" ]]; then
-    - *build_switch
-    - fi
-    - if [[ "$APP_BUILD" == "all" || "$APP" == "led_light" ]]; then
-    - *build_led_light
-    - fi
-    - if [[ "$APP_BUILD" == "all" || "$APP" == "fan" ]]; then
-    - *build_fan
-    - fi
-    - if [[ "$APP_BUILD" == "all" || "$APP" == "temperature_sensor" ]]; then
-    - *build_temperature_sensor
-    - fi
-    - if [[ "$APP_BUILD" == "all" || "$APP" == "multi_device" ]]; then
-    - *build_multi_device
-    - fi
-    - if [[ "$APP_BUILD" == "all" || "$APP" == "gpio" ]]; then
-    - *build_gpio
-    - fi
-    - if [[ "$APP_BUILD" == "all" || "$APP" == "homekit_switch" ]]; then
-    - *build_homekit_switch
-    - fi
-    - done
-    - echo Build Complete for $APP_BUILD
-    # Generating zip file for binaries generated
-    - cd $CI_PROJECT_DIR
-    - echo Generating zip file for binaries generated
-    - tar -zcvf esp-rainmaker-bins-${CI_JOB_ID}.zip esp-rainmaker-bins-${CI_JOB_ID}/
-  
+    - *build_all_examples
+
+build_idf_v4.1:
+  extends: .build_template
+  image: espressif/idf:release-v4.1
+
+build_idf_v4.2:
+  extends: .build_template
+  image: espressif/idf:release-v4.2
+  variables:
+    EXAMPLE_TARGETS: "esp32 esp32s2"
+
+build_idf_v4.3:
+  extends: .build_template
+  image: espressif/idf:release-v4.3
+  variables:
+    EXAMPLE_TARGETS: "esp32 esp32s2 esp32c3"
+
+build_idf_v4.4:
+  extends: .build_template
+  image: espressif/idf:release-v4.4
+  variables:
+    EXAMPLE_TARGETS: "esp32 esp32s2 esp32c3 esp32s3"
+
+build_idf_master:
+  extends: .build_template
+  image: espressif/idf:latest
+  variables:
+    EXAMPLE_TARGETS: "esp32 esp32s2 esp32c3 esp32s3"
+
 build_docs:
     stage: build
-    image: $CI_DOCKER_REGISTRY/esp32-ci-env:rainmaker
+    image: $CI_DOCKER_REGISTRY/esp32-ci-env
     tags:
       - build
     artifacts:
@@ -213,7 +116,7 @@ build_docs:
 
 push_master_to_github:
   stage: deploy
-  image: $CI_DOCKER_REGISTRY/esp32-ci-env:rainmaker
+  image: espressif/idf:latest
   tags:
     - build
   when: on_success

.gitlab-ci.yml

@@ -1,5 +1,32 @@
 # Changes
 
+## 26-May-2022 (claiming and ota)
+
+- claiming: Make self claiming as the default for esp32s3 and esp32c3
+- ota: Make "OTA using Topics" as default and provide a simplified API for that
+
+Self claiming is much more convenient and fast since the node directly gets the
+credentials from the claiming service over HTTPS, instead of using the slower BLE based
+Assisted claiming, wherein the phone app acts as a proxy between the node and the
+claiming service. However, with self claiming, there was no concept of
+[Admin Role](https://rainmaker.espressif.com/docs/user-roles.html#admin-users) and so, it was
+not possible to access the node via the RainMaker or Insights dashboards. This was one
+reason why Assisted Claiming was kept as a default for esp32c3 and esp32s3 even though
+they support self claiming.
+
+With recent changes in the Public RainMaker backend, the primary user (the user who performs the [user-node
+mapping](https://rainmaker.espressif.com/docs/user-node-mapping.html)) for a self claimed
+node is now made as the admin. This gives the primary user the access to the node for OTA and Insights.
+So, self claiming has now been made as the default for all chips (except esp32) and the OTA Using Topics
+has also been made as the default, since it is convenient and also the correct option for
+production devices. A simpler API `esp_rmaker_ota_enable_default()` as also been added in esp_rmaker_core.h.
+
+Note: Nodes that are already claimed via Assisted/Host Claiming will not have any effect, even if the
+new firmware is enabled with self claiming. The self claiming will take effect only if the flash is
+erased. **This will result in a change of node_id, since mac address is the node_id for self claimed nodes.**
+If you want to contine using Assisted Claiming (probably because there is quite some data associated
+with the node_id), please set is explicitly in your sdkconfig.
+
 ## 25-Jan-2022 (app_wifi: Minor feature additions to provisioning workflow)
 
 Added a 30 minute timeout for Wi-Fi provisioning as a security measure. A device reboot will be

CHANGES.md

@@ -12,8 +12,7 @@ set(core_srcs "src/core/esp_rmaker_core.c"
         "src/core/esp_rmaker_schedule.c"
         "src/core/esp_rmaker_scenes.c")
 
-set(priv_req protobuf-c json_parser json_generator wifi_provisioning nvs_flash esp_http_client app_update esp-tls mbedtls esp_https_ota console esp_local_ctrl esp_https_server mdns esp_schedule)
-
+set(priv_req protobuf-c json_parser json_generator wifi_provisioning nvs_flash esp_http_client app_update esp-tls mbedtls esp_https_ota console esp_local_ctrl esp_https_server mdns esp_schedule efuse)
 
 if(CONFIG_ESP_RMAKER_ASSISTED_CLAIM)
     list(APPEND core_srcs

components/esp-insights

@@ -2,8 +2,8 @@ menu "ESP RainMaker Config"
 
     choice ESP_RMAKER_CLAIM_TYPE
         bool "Claiming Type"
-        default ESP_RMAKER_SELF_CLAIM if IDF_TARGET_ESP32S2
-        default ESP_RMAKER_ASSISTED_CLAIM if !IDF_TARGET_ESP32S2
+        default ESP_RMAKER_SELF_CLAIM
+        default ESP_RMAKER_ASSISTED_CLAIM if IDF_TARGET_ESP32
         help
             Claiming type to be used.
 
@@ -79,6 +79,14 @@ menu "ESP RainMaker Config"
             can take appropriate action w.r.t user permissions. It is recommended to enable this option
             for security reasons.
 
+    config RMAKER_NAME_PARAM_CB
+        bool "Call device callback for Name param"
+        default n
+        help
+            By default, the "Name" parameter (esp.param.name) changes are handled internally. If Applications
+            want to handle this themselves, this config option can be enabled. Please ensure that you update
+            and report the name parameter in your callback so that it reflects correctly everywhere.
+            If no device callback is registered, the name paramater will be handled internally.
 
     config ESP_RMAKER_LOCAL_CTRL_ENABLE
         bool "ESP RainMaker Local Control"

components/esp_rainmaker/CMakeLists.txt

@@ -917,6 +917,20 @@ esp_err_t esp_rmaker_system_service_enable(esp_rmaker_system_serv_config_t *conf
  */
 bool esp_rmaker_local_ctrl_service_started(void);
 
+/**
+ * Enable Default RainMaker OTA Firmware Upgrade
+ *
+ * This enables the default recommended RainMaker OTA Firmware Upgrade, which is
+ * "Using the Topics", which allows performing OTA from Dashboard.
+ * This OTA can be triggered by Admin Users only.
+ * On Public RainMaker deployment, for nodes using "Self Claiming", since there
+ * is no associated admin user, the Primary user will automatically become the admin
+ * and can perform OTA from dashboard.
+ *
+ * @return ESP_OK on success
+ * @return error on failure
+ */
+esp_err_t esp_rmaker_ota_enable_default(void);
 #ifdef __cplusplus
 }
 #endif

components/esp_rainmaker/Kconfig.projbuild

@@ -38,7 +38,7 @@ static esp_err_t esp_rmaker_report_info(json_gen_str_t *jptr)
     }
     json_gen_obj_set_string(jptr, "model",  info->model);
     const esp_app_desc_t *app_desc = esp_ota_get_app_description();
-    json_gen_obj_set_string(jptr, "project_name", app_desc->project_name);
+    json_gen_obj_set_string(jptr, "project_name", (char *)app_desc->project_name);
     json_gen_obj_set_string(jptr, "platform", CONFIG_IDF_TARGET);
     json_gen_pop_object(jptr);
     return ESP_OK;