Merge branch 'feature/valid_vals' into 'master'

esp_rmaker_core: Add a facility to add a valid set of string values

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

Author: shahpiyushv

components/esp_rainmaker/include/esp_rmaker_core.h

@@ -578,7 +578,9 @@ esp_err_t esp_rmaker_param_add_ui_type(const esp_rmaker_param_t *param, const ch
  *
  * This can be used to add bounds (min/max values) for a given integer parameter. Eg. brightness
  * will have bounds as 0 and 100 if it is a percentage.
- * Eg. esp_rmaker_param_add_bounds("Light", "brightness", esp_rmaker_int(0), esp_rmaker_int(100), esp_rmaker_int(5));
+ * Eg. esp_rmaker_param_add_bounds(brightness_param, esp_rmaker_int(0), esp_rmaker_int(100), esp_rmaker_int(5));
+ *
+ * @note The RainMaker core does not check the bounds. It is upto the application to handle it.
  *
  * @param[in] param Parameter handle.
  * @param[in] min Minimum allowed value.
@@ -591,6 +593,27 @@ esp_err_t esp_rmaker_param_add_ui_type(const esp_rmaker_param_t *param, const ch
 esp_err_t esp_rmaker_param_add_bounds(const esp_rmaker_param_t *param,
     esp_rmaker_param_val_t min, esp_rmaker_param_val_t max, esp_rmaker_param_val_t step);
 
+/**
+ * Add a list of valid strings for a string parameter
+ *
+ * This can be used to add a list of valid strings for a given string parameter.
+ *
+ * Eg.
+ * static const char *valid_strs[] = {"None","Yes","No","Can't Say"};
+ * esp_rmaker_param_add_valid_str_list(param, valid_strs, 4);
+ *
+ * @note The RainMaker core does not check the values. It is upto the application to handle it.
+ *
+ * @param[in] param Parameter handle.
+ * @param[in] strs Pointer to an array of strings. Note that this memory should stay allocated
+ * throughout the lifetime of this parameter.
+ * @param[in] count Number of strings in the above array.
+ *
+ * @return ESP_OK on success.
+ * return error in case of failure.
+ */
+esp_err_t esp_rmaker_param_add_valid_str_list(const esp_rmaker_param_t *param, const char *strs[], uint8_t count);
+
 /** Update and report a parameter
  *
  * Calling this API will update the parameter and report it to ESP RainMaker cloud.

components/esp_rainmaker/src/core/esp_rmaker_internal.h

@@ -18,16 +18,26 @@
 #include <json_generator.h>
 #include <esp_rmaker_core.h>
 #define RMAKER_PARAM_FLAG_VALUE_CHANGE   0x01
+typedef struct {
+    esp_rmaker_param_val_t min;
+    esp_rmaker_param_val_t max;
+    esp_rmaker_param_val_t step;
+} esp_rmaker_param_bounds_t;
+
+typedef struct {
+    uint8_t str_list_cnt;
+    const char **str_list;
+} esp_rmaker_param_valid_str_list_t;
+
 struct esp_rmaker_param {
     char *name;
     char *type;
     uint8_t flags;
     uint8_t prop_flags;
     char *ui_type;
     esp_rmaker_param_val_t val;
-    esp_rmaker_param_val_t min;
-    esp_rmaker_param_val_t max;
-    esp_rmaker_param_val_t step;
+    esp_rmaker_param_bounds_t *bounds;
+    esp_rmaker_param_valid_str_list_t *valid_str_list;
     struct esp_rmaker_device *parent;
     struct esp_rmaker_param * next;
 };

components/esp_rainmaker/src/core/esp_rmaker_node_config.c

@@ -144,15 +144,21 @@ static esp_err_t esp_rmaker_report_param_config(_esp_rmaker_param_t *param, json
         json_gen_arr_set_string(jptr, "time_series");
     }
     json_gen_pop_array(jptr);
-    if ((param->min.type != RMAKER_VAL_TYPE_INVALID) || (param->max.type != RMAKER_VAL_TYPE_INVALID)) {
+    if (param->bounds) {
         json_gen_push_object(jptr, "bounds");
-        esp_rmaker_report_value(&param->min, "min", jptr);
-        esp_rmaker_report_value(&param->max, "max", jptr);
-        if (param->step.val.i) {
-            esp_rmaker_report_value(&param->step, "step", jptr);
+        esp_rmaker_report_value(&param->bounds->min, "min", jptr);
+        esp_rmaker_report_value(&param->bounds->max, "max", jptr);
+        if (param->bounds->step.val.i) {
+            esp_rmaker_report_value(&param->bounds->step, "step", jptr);
         }
         json_gen_pop_object(jptr);
-
+    }
+    if (param->valid_str_list) {
+        json_gen_push_array(jptr, "valid_strs");
+        for (int i = 0; i < param->valid_str_list->str_list_cnt; i++) {
+            json_gen_arr_set_string(jptr, param->valid_str_list->str_list[i]);
+        }
+        json_gen_pop_array(jptr);
     }
     if (param->ui_type) {
         json_gen_obj_set_string(jptr, "ui_type", param->ui_type);

components/esp_rainmaker/src/core/esp_rmaker_param.c

@@ -411,12 +411,46 @@ esp_err_t esp_rmaker_param_add_bounds(const esp_rmaker_param_t *param,
         ESP_LOGE(TAG, "Cannot set bounds for %s because of value type mismatch.", _param->name);
         return ESP_ERR_INVALID_ARG;
     }
-    _param->min = min;
-    _param->max = max;
-    _param->step = step;
+    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->min = min;
+    bounds->max = max;
+    bounds->step = step;
+    if (_param->bounds) {
+        free(_param->bounds);
+    }
+    _param->bounds = bounds;
     return ESP_OK;
 }
 
+esp_err_t esp_rmaker_param_add_valid_str_list(const esp_rmaker_param_t *param, const char *strs[], uint8_t 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_STRING) {
+        ESP_LOGE(TAG, "Only string params can have valid strings array.");
+        return ESP_ERR_INVALID_ARG;
+    }
+    esp_rmaker_param_valid_str_list_t *valid_str_list = calloc(1, sizeof(esp_rmaker_param_valid_str_list_t));
+    if (!valid_str_list) {
+        ESP_LOGE(TAG, "Failed to allocate memory for valid strings array.");
+        return ESP_ERR_NO_MEM;
+    }
+    valid_str_list->str_list = strs;
+    valid_str_list->str_list_cnt = count;
+    if (_param->valid_str_list) {
+        free(_param->valid_str_list);
+    }
+    _param->valid_str_list = valid_str_list;
+  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) {