Merge branch 'feature/device_scheduling' into 'master'

Scheduling support

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

Author: shahpiyushv

components/esp_rainmaker/CMakeLists.txt

@@ -10,7 +10,8 @@ set(core_srcs "src/core/esp_rmaker_core.c"
         "src/core/esp_rmaker_storage.c"
         "src/core/esp_rmaker_user_mapping.pb-c.c"
         "src/core/esp_rmaker_utils.c"
-        "src/core/esp_rmaker_user_mapping.c")
+        "src/core/esp_rmaker_user_mapping.c"
+        "src/core/esp_rmaker_schedule.c")
 
 
 if(CONFIG_ESP_RMAKER_ASSISTED_CLAIM)
@@ -48,7 +49,7 @@ idf_component_register(SRCS ${core_srcs} ${mqtt_srcs} ${ota_srcs} ${standard_typ
                        INCLUDE_DIRS "include"
                        PRIV_INCLUDE_DIRS ${core_priv_includes} ${ota_priv_includes} ${console_priv_includes}
                        REQUIRES
-                       PRIV_REQUIRES protobuf-c json_parser json_generator wifi_provisioning nvs_flash esp_http_client app_update esp-tls mqtt esp_https_ota console)
+                       PRIV_REQUIRES protobuf-c json_parser json_generator wifi_provisioning nvs_flash esp_http_client app_update esp-tls mqtt esp_https_ota console esp_schedule)
 
 target_add_binary_data(${COMPONENT_TARGET} "server_certs/mqtt_server.crt" TEXT)
 target_add_binary_data(${COMPONENT_TARGET} "server_certs/claim_service_server.crt" TEXT)

components/esp_rainmaker/Kconfig.projbuild

@@ -178,4 +178,15 @@ menu "ESP RainMaker Config"
 
     endmenu
 
+    menu "ESP RainMaker Scheduling"
+
+        config ESP_RMAKER_SCHEDULING_MAX_SCHEDULES
+            int "Maximum schedules"
+            default 5
+            range 1 20
+            help
+                Maximum Number of schedules allowed. The json size for report params increases as the number of schedules increases.
+
+    endmenu
+
 endmenu

components/esp_rainmaker/include/esp_rmaker_core.h

@@ -136,6 +136,8 @@ typedef enum {
     ESP_RMAKER_REQ_SRC_INIT,
     /** Request received from cloud */
     ESP_RMAKER_REQ_SRC_CLOUD,
+    /** Request received when a schedule has triggered */
+    ESP_RMAKER_REQ_SRC_SCHEDULE,
 } esp_rmaker_req_src_t;
 
 /** Write request Context */
@@ -622,6 +624,20 @@ esp_err_t esp_rmaker_param_add_bounds(const esp_rmaker_param_t *param,
  */
 esp_err_t esp_rmaker_param_add_valid_str_list(const esp_rmaker_param_t *param, const char *strs[], uint8_t count);
 
+/** Add max count for an array parameter
+ *
+ * This can be used to put a limit on the maximum number of elements in an array.
+ *
+ * @note The RainMaker core does not check the values. It is upto the application to handle it.
+ *
+ * @param[in] param Parameter handle.
+ * @param[in] count Max number of elements allowed in the array.
+ *
+ * @return ESP_OK on success.
+ * return error in case of failure.
+ */
+esp_err_t esp_rmaker_param_add_array_max_count(const esp_rmaker_param_t *param, int count);
+
 /** Update and report a parameter
  *
  * Calling this API will update the parameter and report it to ESP RainMaker cloud.

components/esp_rainmaker/include/esp_rmaker_schedule.h

@@ -0,0 +1,36 @@
+// Copyright 2020 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
+
+/** Enable Schedules
+ *
+ * This API enables the scheduling service for the node. For more information,
+ * check [here](https://rainmaker.espressif.com/docs/scheduling.html)
+ *
+ * It is recommended to set the timezone while using schedules. Check [here](https://rainmaker.espressif.com/docs/time-service.html#time-zone) for more information on timezones
+ *
+ * @return ESP_OK on success.
+ * @return error in case of failure.
+ */
+esp_err_t esp_rmaker_schedule_enable(void);
+
+#ifdef __cplusplus
+}
+#endif

components/esp_rainmaker/include/esp_rmaker_standard_params.h

@@ -44,6 +44,7 @@ extern "C"
 #define ESP_RMAKER_DEF_OTA_URL_NAME         "URL"
 #define ESP_RMAKER_DEF_TIMEZONE_NAME        "TZ"
 #define ESP_RMAKER_DEF_TIMEZONE_POSIX_NAME  "TZ-POSIX"
+#define ESP_RMAKER_DEF_SCHEDULE_NAME        "Schedules"
 
 /**
  * Create standard name param
@@ -244,6 +245,21 @@ esp_rmaker_param_t *esp_rmaker_timezone_param_create(const char *param_name, con
  * @return NULL in case of failures.
  */
 esp_rmaker_param_t *esp_rmaker_timezone_posix_param_create(const char *param_name, const char *val);
+
+/**
+ * Create standard schedules param
+ *
+ * This will create the standard schedules parameter. Default value
+ * is set internally.
+ *
+ * @param[in] param_name Name of the parameter
+ * @param[in] max_schedules Maximum number of schedules allowed
+ *
+ * @return Parameter handle on success.
+ * @return NULL in case of failures.
+ */
+esp_rmaker_param_t *esp_rmaker_schedules_param_create(const char *param_name, int max_schedules);
+
 #ifdef __cplusplus
 }
 #endif

components/esp_rainmaker/include/esp_rmaker_standard_services.h

@@ -54,6 +54,23 @@ esp_rmaker_device_t *esp_rmaker_ota_service_create(const char *serv_name, void *
 esp_rmaker_device_t *esp_rmaker_time_service_create(const char *serv_name, const char *timezone,
         const char *timezone_posix, void *priv_data);
 
+/** Create a standard Schedule service
+ *
+ * This creates a Schedule 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_schedules Maximum number of schedules supported.
+ * @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_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);
+
 #ifdef __cplusplus
 }
 #endif

components/esp_rainmaker/include/esp_rmaker_standard_types.h

@@ -43,6 +43,8 @@ extern "C"
 #define ESP_RMAKER_PARAM_OTA_URL        "esp.param.ota_url"
 #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"
+
 
 /********** STANDARD DEVICE TYPES **********/
 
@@ -51,9 +53,11 @@ extern "C"
 #define ESP_RMAKER_DEVICE_FAN           "esp.device.fan"
 #define ESP_RMAKER_DEVICE_TEMP_SENSOR   "esp.device.temperature-sensor"
 
+
 /********** STANDARD SERVICE TYPES **********/
 #define ESP_RMAKER_SERVICE_OTA          "esp.service.ota"
 #define ESP_RMAKER_SERVICE_TIME         "esp.service.time"
+#define ESP_RMAKER_SERVICE_SCHEDULE     "esp.service.schedule"
 
 #ifdef __cplusplus
 }

components/esp_rainmaker/src/core/esp_rmaker_param.c

@@ -488,6 +488,30 @@ esp_err_t esp_rmaker_param_add_valid_str_list(const esp_rmaker_param_t *param, c
   return ESP_OK;
 }
 
+esp_err_t esp_rmaker_param_add_array_max_count(const esp_rmaker_param_t *param, int count)
+{
+    if (!param) {
+        ESP_LOGE(TAG, "Param handle cannot be NULL.");
+        return ESP_ERR_INVALID_ARG;
+    }
+    _esp_rmaker_param_t *_param = (_esp_rmaker_param_t *)param;
+    if (_param->val.type != RMAKER_VAL_TYPE_ARRAY) {
+        ESP_LOGE(TAG, "Only array params can have max count.");
+        return ESP_ERR_INVALID_ARG;
+    }
+    esp_rmaker_param_bounds_t *bounds = calloc(1, sizeof(esp_rmaker_param_bounds_t));
+    if (!bounds) {
+        ESP_LOGE(TAG, "Failed to allocate memory for parameter bounds.");
+        return ESP_ERR_NO_MEM;
+    }
+    bounds->max = esp_rmaker_int(count);
+    if (_param->bounds) {
+        free(_param->bounds);
+    }
+    _param->bounds = bounds;
+    return ESP_OK;
+}
+
 esp_err_t esp_rmaker_param_add_ui_type(const esp_rmaker_param_t *param, const char *ui_type)
 {
     if (!param || !ui_type) {