Merge branch 'feature/scenes' into 'master'

esp_rmaker_scenes: Add scenes support.

See merge request app-frameworks/esp-rainmaker!245

Author: shahpiyushv

components/esp_rainmaker/CMakeLists.txt

@@ -9,7 +9,8 @@ set(core_srcs "src/core/esp_rmaker_core.c"
         "src/core/esp_rmaker_system_service.c"
         "src/core/esp_rmaker_user_mapping.pb-c.c"
         "src/core/esp_rmaker_user_mapping.c"
-        "src/core/esp_rmaker_schedule.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)
 

components/esp_rainmaker/Kconfig.projbuild

@@ -195,4 +195,24 @@ menu "ESP RainMaker Config"
 
     endmenu
 
+    menu "ESP RainMaker Scenes"
+
+        config ESP_RMAKER_SCENES_MAX_SCENES
+            int "Maximum scenes"
+            default 10
+            range 1 50
+            help
+                Maximum Number of scenes allowed. The json size for report params increases as the number of scenes increases.
+
+        config ESP_RMAKER_SCENES_DEACTIVATE_SUPPORT
+            bool "Enable Deactivate support"
+            default n
+            help
+                This enables the deactivate callback support. The application callback will be invoked with the source
+                set to ESP_RMAKER_REQ_SRC_SCENE_DEACTIVATE when the deactivate operation is received. However, the
+                param values would be the same as those for activate, since the RainMaker core does not know what the
+                expected values are for scene deactivation.
+
+    endmenu
+
 endmenu

components/esp_rainmaker/include/esp_rmaker_core.h

@@ -154,6 +154,10 @@ typedef enum {
     ESP_RMAKER_REQ_SRC_CLOUD,
     /** Request received when a schedule has triggered */
     ESP_RMAKER_REQ_SRC_SCHEDULE,
+    /** Request received when a scene has been activated */
+    ESP_RMAKER_REQ_SRC_SCENE_ACTIVATE,
+    /** Request received when a scene has been deactivated */
+    ESP_RMAKER_REQ_SRC_SCENE_DEACTIVATE,
     /** Request received from a local controller */
     ESP_RMAKER_REQ_SRC_LOCAL,
     /** This will always be the last value. Any value equal to or

components/esp_rainmaker/include/esp_rmaker_scenes.h

@@ -0,0 +1,38 @@
+// Copyright 2022 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+#include <esp_err.h>
+
+/** Enable Scenes
+ *
+ * This API enables the scenes service for the node. For more information,
+ * check [here](https://rainmaker.espressif.com/docs/scenes.html)
+ *
+ * @note This API should be called after esp_rmaker_node_init() but before esp_rmaker_start().
+ *
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t esp_rmaker_scenes_enable(void);
+
+#ifdef __cplusplus
+}
+#endif

components/esp_rainmaker/include/esp_rmaker_standard_params.h

@@ -45,6 +45,7 @@ extern "C"
 #define ESP_RMAKER_DEF_TIMEZONE_NAME        "TZ"
 #define ESP_RMAKER_DEF_TIMEZONE_POSIX_NAME  "TZ-POSIX"
 #define ESP_RMAKER_DEF_SCHEDULE_NAME        "Schedules"
+#define ESP_RMAKER_DEF_SCENES_NAME          "Scenes"
 #define ESP_RMAKER_DEF_REBOOT_NAME          "Reboot"
 #define ESP_RMAKER_DEF_FACTORY_RESET_NAME   "Factory-Reset"
 #define ESP_RMAKER_DEF_WIFI_RESET_NAME      "Wi-Fi-Reset"
@@ -265,6 +266,20 @@ esp_rmaker_param_t *esp_rmaker_timezone_posix_param_create(const char *param_nam
  */
 esp_rmaker_param_t *esp_rmaker_schedules_param_create(const char *param_name, int max_schedules);
 
+/**
+ * Create standard Scenes param
+ *
+ * This will create the standard scenes parameter. Default value
+ * is set internally.
+ *
+ * @param[in] param_name Name of the parameter
+ * @param[in] max_scenes Maximum number of scenes allowed
+ *
+ * @return Parameter handle on success.
+ * @return NULL in case of failures.
+ */
+esp_rmaker_param_t *esp_rmaker_scenes_param_create(const char *param_name, int max_scenes);
+
 /**
  * Create standard Reboot param
  *

components/esp_rainmaker/include/esp_rmaker_standard_services.h

@@ -71,6 +71,24 @@ esp_rmaker_device_t *esp_rmaker_time_service_create(const char *serv_name, const
  */
 esp_rmaker_device_t *esp_rmaker_create_schedule_service(const char *serv_name, esp_rmaker_device_write_cb_t write_cb, esp_rmaker_device_read_cb_t read_cb, int max_schedules, void *priv_data);
 
+/** Create a standard Scenes service
+ *
+ * This creates a Scenes service with the mandatory parameters. The default parameter names will be used.
+ * Refer \ref esp_rmaker_standard_params.h for default names.
+ *
+ * @param[in] serv_name The unique service name
+ * @param[in] write_cb Write callback.
+ * @param[in] read_cb Read callback.
+ * @param[in] max_scenes Maximum number of scenes supported.
+ * @param[in] deactivation_support Deactivation callback support.
+ * @param[in] priv_data (Optional) Private data associated with the service. This should stay
+ * allocated throughout the lifetime of the service.
+ *
+ * @return service_handle on success.
+ * @return NULL in case of any error.
+ */
+esp_rmaker_device_t *esp_rmaker_create_scenes_service(const char *serv_name, esp_rmaker_device_write_cb_t write_cb, esp_rmaker_device_read_cb_t read_cb, int max_scenes, bool deactivation_support, void *priv_data);
+
 /** Create a standard System service
  *
  * This creates an empty System service. Appropriate parameters should be added by the caller.

components/esp_rainmaker/include/esp_rmaker_standard_types.h

@@ -44,6 +44,7 @@ extern "C"
 #define ESP_RMAKER_PARAM_TIMEZONE       "esp.param.tz"
 #define ESP_RMAKER_PARAM_TIMEZONE_POSIX       "esp.param.tz_posix"
 #define ESP_RMAKER_PARAM_SCHEDULES      "esp.param.schedules"
+#define ESP_RMAKER_PARAM_SCENES         "esp.param.scenes"
 #define ESP_RMAKER_PARAM_REBOOT         "esp.param.reboot"
 #define ESP_RMAKER_PARAM_FACTORY_RESET  "esp.param.factory-reset"
 #define ESP_RMAKER_PARAM_WIFI_RESET     "esp.param.wifi-reset"
@@ -63,6 +64,7 @@ extern "C"
 #define ESP_RMAKER_SERVICE_OTA          "esp.service.ota"
 #define ESP_RMAKER_SERVICE_TIME         "esp.service.time"
 #define ESP_RMAKER_SERVICE_SCHEDULE     "esp.service.schedule"
+#define ESP_RMAKER_SERVICE_SCENES       "esp.service.scenes"
 #define ESP_RMAKER_SERVICE_SYSTEM       "esp.service.system"
 #define ESP_RMAKER_SERVICE_LOCAL_CONTROL    "esp.service.local_control"
 

components/esp_rainmaker/src/core/esp_rmaker_device.c

@@ -170,10 +170,6 @@ esp_err_t esp_rmaker_device_add_attribute(const esp_rmaker_device_t *device, con
         return ESP_ERR_INVALID_ARG;
     }
     _esp_rmaker_device_t *_device = ( _esp_rmaker_device_t *)device;
-    if (_device->is_service) {
-        ESP_LOGE(TAG, "Cannot add attribute to a service");
-        return ESP_ERR_INVALID_ARG;
-    }
     esp_rmaker_attr_t *attr = _device->attributes;
     while(attr) {
         if (strcmp(attr_name, attr->name) == 0) {

components/esp_rainmaker/src/core/esp_rmaker_param.c

@@ -52,6 +52,8 @@ static const char *cb_srcs[ESP_RMAKER_REQ_SRC_MAX] = {
     [ESP_RMAKER_REQ_SRC_INIT] = "Init",
     [ESP_RMAKER_REQ_SRC_CLOUD] = "Cloud",
     [ESP_RMAKER_REQ_SRC_SCHEDULE] = "Schedule",
+    [ESP_RMAKER_REQ_SRC_SCENE_ACTIVATE] = "Scene Activate",
+    [ESP_RMAKER_REQ_SRC_SCENE_DEACTIVATE] = "Scene Deactivate",
     [ESP_RMAKER_REQ_SRC_LOCAL] = "Local",
 };