esp_rmaker_standard_types: Start default names of all standard params with capital letter

Default parameter names like name, power, etc. have been changed to Name, Power, etc.
respectively, so that they look better in the phone app UIs.

Note that, with this change, any user configured device name (the name set from phone apps),
or any other persistent parameter for which a default name was used (Eg. power)
will be affected, as the values will no more be found in the NVS storage. Please edit your
application code accordingly if you want to stick with the old names.

Please check CHANGES.md for guidelines.

Author: shahpiyushv

CHANGES.md

@@ -1,5 +1,28 @@
 # Changes
 
+## 29-Sep-2020 (esp_rmaker_standard_types: Start default names of all standard params with capital letter)
+
+Default parameter names like name, power, etc. have been changed to Name, Power, etc. respectively, so that they look better in the phone app UIs.
+
+With this change, any user configured device name (the name set from phone apps), or any other persistent parameter for which a
+default name was used (Eg. power) will be affected, as the values will no more be found in the NVS storage.
+Please edit your application code accordingly if you want to stick with the old names.
+
+Eg. If you were using the standard lightbulb device API which internally creates power and name parameters
+```
+light_device = esp_rmaker_lightbulb_device_create("Light", NULL, DEFAULT_POWER);
+```
+
+Please change to below, if you want to stick with old parameter names "name" and "power".
+
+```
+light_device = esp_rmaker_device_create("Light", ESP_RMAKER_DEVICE_LIGHTBULB, NULL);
+esp_rmaker_device_add_param(light_device, esp_rmaker_name_param_create("name", "Light"));
+esp_rmaker_param_t *power_param = esp_rmaker_power_param_create("power", DEFAULT_POWER);
+esp_rmaker_device_add_param(light_device, power_param);
+esp_rmaker_device_assign_primary_param(light_device, power_param);
+```
+
 ## 5-Aug-2020 (wifi_provisioning: Use a random pop instead of creating it from MAC address)
 
 Till date, the last 4 bytes of the MAC address were being used to generate the 8 character Proof of Possession (PoP) PIN for Wi-Fi provisioning. This is not secure enough because MAC address is a public information and can also be sniffed easily by devices in vicinity. A minor risk in this is that somebody else in the vicinity can provision your device, but a major risk is a man in the middle attack, wherein someone in vicinity can read the data being exchanged between a phone and the device and get the Wi-Fi credentials.

components/esp_rainmaker/include/esp_rmaker_standard_params.h

@@ -28,21 +28,22 @@ extern "C"
  * @note These names are not mandatory. You can use the ESP RainMaker Core APIs
  * to create your own parameters with custom names, if required.
  */
-#define ESP_RMAKER_DEF_NAME_PARAM           "name"
-#define ESP_RMAKER_DEF_POWER_NAME           "power"
-#define ESP_RMAKER_DEF_BRIGHTNESS_NAME      "brightness"
-#define ESP_RMAKER_DEF_HUE_NAME             "hue"
-#define ESP_RMAKER_DEF_SATURATION_NAME      "saturation"
-#define ESP_RMAKER_DEF_INTENSITY_NAME       "intensity"
-#define ESP_RMAKER_DEF_CCT_NAME             "cct"
-#define ESP_RMAKER_DEF_DIRECTION_NAME       "direction"
-#define ESP_RMAKER_DEF_SPEED_NAME           "speed"
-#define ESP_RMAKER_DEF_TEMPERATURE_NAME     "temperature"
-#define ESP_RMAKER_DEF_OTA_STATUS_NAME      "status"
-#define ESP_RMAKER_DEF_OTA_INFO_NAME        "info"
-#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_NAME_PARAM           "Name"
+#define ESP_RMAKER_DEF_POWER_NAME           "Power"
+#define ESP_RMAKER_DEF_BRIGHTNESS_NAME      "Brightness"
+#define ESP_RMAKER_DEF_HUE_NAME             "Hue"
+#define ESP_RMAKER_DEF_SATURATION_NAME      "Saturation"
+#define ESP_RMAKER_DEF_INTENSITY_NAME       "Intensity"
+#define ESP_RMAKER_DEF_CCT_NAME             "CCT"
+#define ESP_RMAKER_DEF_DIRECTION_NAME       "Direction"
+#define ESP_RMAKER_DEF_SPEED_NAME           "Speed"
+#define ESP_RMAKER_DEF_TEMPERATURE_NAME     "Temperature"
+#define ESP_RMAKER_DEF_OTA_STATUS_NAME      "Status"
+#define ESP_RMAKER_DEF_OTA_INFO_NAME        "Info"
+#define ESP_RMAKER_DEF_OTA_URL_NAME         "URL"
+#define ESP_RMAKER_DEF_TIMEZONE_NAME        "TZ"
+#define ESP_RMAKER_DEF_TIMEZONE_POSIX_NAME  "TZ-POSIX"
 
 /**
  * Create standard name param

components/esp_rainmaker/src/core/esp_rmaker_time_sync.c

@@ -25,7 +25,7 @@ static const char *TAG = "esp_rmaker_time_sync";
 
 #define ESP_RMAKER_NVS_PART_NAME            "nvs"
 
-#define ESP_RMAKER_TIME_SERV_NAME           "time"
+#define ESP_RMAKER_TIME_SERV_NAME           "Time"
 #define ESP_RMAKER_NVS_TIME_NAMESPACE       "rmaker_time"
 #define ESP_RMAKER_TZ_POSIX_NVS_NAME        "tz_posix"
 #define ESP_RMAKER_TZ_NVS_NAME              "tz"

components/esp_rainmaker/src/ota/esp_rmaker_ota_using_params.c

@@ -27,7 +27,7 @@
 
 static const char *TAG = "esp_rmaker_ota_using_params";
 
-#define ESP_RMAKER_OTA_SERV_NAME    "ota"
+#define ESP_RMAKER_OTA_SERV_NAME    "OTA"
 
 void esp_rmaker_ota_finish_using_params(esp_rmaker_ota_t *ota)
 {

examples/fan/main/app_main.c

@@ -35,7 +35,7 @@ static esp_err_t write_cb(const esp_rmaker_device_t *device, const esp_rmaker_pa
         ESP_LOGI(TAG, "Received value = %s for %s - %s",
                 val.val.b? "true" : "false", device_name, param_name);
         app_fan_set_power(val.val.b);
-    } else if (strcmp(param_name, "speed") == 0) {
+    } else if (strcmp(param_name, ESP_RMAKER_DEF_SPEED_NAME) == 0) {
         ESP_LOGI(TAG, "Received value = %d for %s - %s",
                 val.val.i, device_name, param_name);
         app_fan_set_speed(val.val.i);
@@ -82,7 +82,7 @@ void app_main()
     /* Create a device and add the relevant parameters to it */
     fan_device = esp_rmaker_fan_device_create("Fan", NULL, DEFAULT_POWER);
     esp_rmaker_device_add_cb(fan_device, write_cb, NULL);
-    esp_rmaker_device_add_param(fan_device, esp_rmaker_speed_param_create("speed", DEFAULT_SPEED));
+    esp_rmaker_device_add_param(fan_device, esp_rmaker_speed_param_create(ESP_RMAKER_DEF_SPEED_NAME, DEFAULT_SPEED));
     esp_rmaker_node_add_device(node, fan_device);
 
     /* Start the ESP RainMaker Agent */

examples/homekit_switch/main/app_driver.c

@@ -52,7 +52,7 @@ static void push_btn_cb(void *arg)
     bool new_state = !g_power_state;
     app_driver_set_state(new_state);
     esp_rmaker_param_update_and_report(
-            esp_rmaker_device_get_param_by_name(switch_device, "power"),
+            esp_rmaker_device_get_param_by_name(switch_device, ESP_RMAKER_DEF_POWER_NAME),
             esp_rmaker_bool(new_state));
     app_homekit_update_state(new_state);
 }

examples/homekit_switch/main/app_homekit.c

@@ -13,6 +13,8 @@
 #include <esp_log.h>
 
 #include <esp_rmaker_core.h>
+#include <esp_rmaker_standard_params.h>
+
 #include <hap.h>
 #include <hap_apple_servs.h>
 #include <hap_apple_chars.h>
@@ -91,7 +93,7 @@ static int switch_write(hap_write_data_t write_data[], int count,
             hap_char_update_val(write->hc, &(write->val));
             /* Report to RainMaker */
             esp_rmaker_param_update_and_report(
-                esp_rmaker_device_get_param_by_name(switch_device, "power"),
+                esp_rmaker_device_get_param_by_name(switch_device, ESP_RMAKER_DEF_POWER_NAME),
                 esp_rmaker_bool(write->val.b));
 
             *(write->status) = HAP_STATUS_SUCCESS;

examples/homekit_switch/main/app_main.c

@@ -31,7 +31,7 @@ esp_rmaker_device_t *switch_device;
 static esp_err_t write_cb(const esp_rmaker_device_t *device, const esp_rmaker_param_t *param,
             const esp_rmaker_param_val_t val, void *priv_data, esp_rmaker_write_ctx_t *ctx)
 {
-    if (strcmp(esp_rmaker_param_get_name(param), "power") == 0) {
+    if (strcmp(esp_rmaker_param_get_name(param), ESP_RMAKER_DEF_POWER_NAME) == 0) {
         ESP_LOGI(TAG, "Received value = %s for %s - %s",
                 val.val.b? "true" : "false", esp_rmaker_device_get_name(device),
                 esp_rmaker_param_get_name(param));
@@ -128,12 +128,12 @@ void app_main()
      * user friendly custom name from the phone apps. All devices are recommended to have this
      * parameter.
      */
-    esp_rmaker_device_add_param(switch_device, esp_rmaker_name_param_create("name", "Switch"));
+    esp_rmaker_device_add_param(switch_device, esp_rmaker_name_param_create(ESP_RMAKER_DEF_NAME_PARAM, "Switch"));
 
     /* Add the standard power parameter (type: esp.param.power), which adds a boolean param
      * with a toggle switch ui-type.
      */
-    esp_rmaker_param_t *power_param = esp_rmaker_power_param_create("power", DEFAULT_POWER);
+    esp_rmaker_param_t *power_param = esp_rmaker_power_param_create(ESP_RMAKER_DEF_POWER_NAME, DEFAULT_POWER);
     esp_rmaker_device_add_param(switch_device, power_param);
 
     /* Assign the power parameter as the primary, so that it can be controlled from the

examples/led_light/main/app_main.c

@@ -38,15 +38,15 @@ static esp_err_t write_cb(const esp_rmaker_device_t *device, const esp_rmaker_pa
         ESP_LOGI(TAG, "Received value = %s for %s - %s",
                 val.val.b? "true" : "false", device_name, param_name);
         app_light_set_power(val.val.b);
-    } else if (strcmp(param_name, "brightness") == 0) {
+    } else if (strcmp(param_name, ESP_RMAKER_DEF_BRIGHTNESS_NAME) == 0) {
         ESP_LOGI(TAG, "Received value = %d for %s - %s",
                 val.val.i, device_name, param_name);
         app_light_set_brightness(val.val.i);
-    } else if (strcmp(param_name, "hue") == 0) {
+    } else if (strcmp(param_name, ESP_RMAKER_DEF_HUE_NAME) == 0) {
         ESP_LOGI(TAG, "Received value = %d for %s - %s",
                 val.val.i, device_name, param_name);
         app_light_set_hue(val.val.i);
-    } else if (strcmp(param_name, "saturation") == 0) {
+    } else if (strcmp(param_name, ESP_RMAKER_DEF_SATURATION_NAME) == 0) {
         ESP_LOGI(TAG, "Received value = %d for %s - %s",
                 val.val.i, device_name, param_name);
         app_light_set_saturation(val.val.i);
@@ -94,9 +94,9 @@ void app_main()
     light_device = esp_rmaker_lightbulb_device_create("Light", NULL, DEFAULT_POWER);
     esp_rmaker_device_add_cb(light_device, write_cb, NULL);
 
-    esp_rmaker_device_add_param(light_device, esp_rmaker_brightness_param_create("brightness", DEFAULT_BRIGHTNESS));
-    esp_rmaker_device_add_param(light_device, esp_rmaker_hue_param_create("hue", DEFAULT_HUE));
-    esp_rmaker_device_add_param(light_device, esp_rmaker_saturation_param_create("saturation", DEFAULT_SATURATION));
+    esp_rmaker_device_add_param(light_device, esp_rmaker_brightness_param_create(ESP_RMAKER_DEF_BRIGHTNESS_NAME, DEFAULT_BRIGHTNESS));
+    esp_rmaker_device_add_param(light_device, esp_rmaker_hue_param_create(ESP_RMAKER_DEF_HUE_NAME, DEFAULT_HUE));
+    esp_rmaker_device_add_param(light_device, esp_rmaker_saturation_param_create(ESP_RMAKER_DEF_SATURATION_NAME, DEFAULT_SATURATION));
 
     esp_rmaker_node_add_device(node, light_device);
 

examples/multi_device/main/app_main.c

@@ -40,10 +40,10 @@ static esp_err_t write_cb(const esp_rmaker_device_t *device, const esp_rmaker_pa
         if (strcmp(device_name, "Switch") == 0) {
             app_driver_set_state(val.val.b);
         }
-    } else if (strcmp(param_name, "brightness") == 0) {
+    } else if (strcmp(param_name, ESP_RMAKER_DEF_BRIGHTNESS_NAME) == 0) {
         ESP_LOGI(TAG, "Received value = %d for %s - %s",
                 val.val.i, device_name, param_name);
-    } else if (strcmp(param_name, "speed") == 0) {
+    } else if (strcmp(param_name, ESP_RMAKER_DEF_SPEED_NAME) == 0) {
         ESP_LOGI(TAG, "Received value = %d for %s - %s",
                 val.val.i, device_name, param_name);
     } else {
@@ -96,17 +96,18 @@ void app_main()
     light_device = esp_rmaker_lightbulb_device_create("Light", NULL, DEFAULT_LIGHT_POWER);
     esp_rmaker_device_add_cb(light_device, write_cb, NULL);
 
-    esp_rmaker_device_add_param(light_device, esp_rmaker_brightness_param_create("brightness", DEFAULT_LIGHT_BRIGHTNESS));
+    esp_rmaker_device_add_param(light_device,
+            esp_rmaker_brightness_param_create(ESP_RMAKER_DEF_BRIGHTNESS_NAME, DEFAULT_LIGHT_BRIGHTNESS));
 
-    esp_rmaker_device_add_attribute(light_device, "serial_number", "012345");
-    esp_rmaker_device_add_attribute(light_device, "mac", "xx:yy:zz:aa:bb:cc");
+    esp_rmaker_device_add_attribute(light_device, "Serial Number", "012345");
+    esp_rmaker_device_add_attribute(light_device, "MAC", "xx:yy:zz:aa:bb:cc");
 
     esp_rmaker_node_add_device(node, light_device);
 
     /* Create a Fan device and add the relevant parameters to it */
     fan_device = esp_rmaker_fan_device_create("Fan", NULL, DEFAULT_FAN_POWER);
     esp_rmaker_device_add_cb(fan_device, write_cb, NULL);
-    esp_rmaker_device_add_param(fan_device, esp_rmaker_speed_param_create("speed", DEFAULT_FAN_SPEED));
+    esp_rmaker_device_add_param(fan_device, esp_rmaker_speed_param_create(ESP_RMAKER_DEF_SPEED_NAME, DEFAULT_FAN_SPEED));
     esp_rmaker_node_add_device(node, fan_device);
 
     /* Create a Temperature Sensor device and add the relevant parameters to it */