Merge pull request #99 from SmartThingsCommunity/master_rel_1_7_0

Master rel 1 7 0

Author: stdk-scm

CHANGELOG.md

@@ -1,5 +1,22 @@
 # HISTORY
 
+## 1.7.0 :  Changes until v1.7.0
+
+New Improvements or features:
+ - Add changing device name feature
+  * New API : st_change_device_name() added
+ - Add 'esp32c3' bsp and modify related component.mk/cmake file
+ - Add capability helper for 'mode' capability
+
+Enhancements or amendments:
+ - Add the history feed displaying control options of the struct iot_cap_attr_option_t
+  * To control whether the event should be displayed in the history feed of the mobile App
+
+Bug fixed:
+ - Fix Static Code Analysis report
+  * iot_api:iot_main: Uses 'type casting' to fit in printf format sepcifier
+ - Fix multiple definition of main error for deps/json : prevent cJSON/test.c building
+
 ## 1.6.2 :  Changes until v1.6.2
 
 New Improvements or features:

README.md

@@ -12,17 +12,6 @@ We also provide the additional Reference repository so that you can refer to how
 
 It is distributed in source form and written in C99 for the purpose of portability to most platforms.
 
-## Announcements
-
-Good news! We have launched the new commercial program for MQTT devices. You will be able to submit for certification into the SmartThings mobile app later this month. To prepare for submission, please perform the necessary steps with your current integrations:
-
- - Update to the latest SmartThings SDK for Direct Connected Devices for C
-   - Please use the SDK v1.3.3 or later
- - Downlaod the updated onboarding_config.json for your devices.
- - Re-register any test devices you have registered previously.
- - Update to the latest SmartThings mobile app to test your device
-   - Please use SmartThings mobile application v1.7.51 (for Android), v1.6.51 (for iOS) or later
-
 ## Main features
 
 This core device library provides the following features :

src/Kconfig

@@ -147,6 +147,8 @@ config STDK_IOT_CORE_BSP_SUPPORT_ESP32
     bool "ESP32"
 config STDK_IOT_CORE_BSP_SUPPORT_ESP32S2
     bool "ESP32S2"
+config STDK_IOT_CORE_BSP_SUPPORT_ESP32C3
+    bool "ESP32C3"
 endchoice
 
 choice STDK_IOT_CORE_OS_SUPPORT

src/component.cmake

@@ -16,6 +16,9 @@ if(CONFIG_STDK_IOT_CORE)
 	elseif(CONFIG_STDK_IOT_CORE_BSP_SUPPORT_ESP32S2)
 		set(STDK_SRC_PATH "${STDK_SRC_PATH}" port/bsp/esp32s2)
 		set(STDK_INCLUDE_PATH "${STDK_INCLUDE_PATH}" include/bsp/esp32s2)
+	elseif(CONFIG_STDK_IOT_CORE_BSP_SUPPORT_ESP32C3)
+		set(STDK_SRC_PATH "${STDK_SRC_PATH}" port/bsp/esp32c3)
+		set(STDK_INCLUDE_PATH "${STDK_INCLUDE_PATH}" include/bsp/esp32c3)
 	elseif(CONFIG_STDK_IOT_CORE_BSP_SUPPORT_RTL8195)
 		set(STDK_SRC_PATH "${STDK_SRC_PATH}" port/bsp/rtl8195)
 		set(STDK_INCLUDE_PATH "${STDK_INCLUDE_PATH}" include/bsp/rtl8195)

src/component.mk

@@ -17,6 +17,9 @@ else ifeq ($(CONFIG_STDK_IOT_CORE_BSP_SUPPORT_ESP32),y)
 else ifeq ($(CONFIG_STDK_IOT_CORE_BSP_SUPPORT_ESP32S2),y)
 	COMPONENT_SRCDIRS += port/bsp/esp32s2
 	COMPONENT_ADD_INCLUDEDIRS += include/bsp/esp32s2
+else ifeq ($(CONFIG_STDK_IOT_CORE_BSP_SUPPORT_ESP32C3),y)
+	COMPONENT_SRCDIRS += port/bsp/esp32c3
+	COMPONENT_ADD_INCLUDEDIRS += include/bsp/esp32c3
 else ifeq ($(CONFIG_STDK_IOT_CORE_BSP_SUPPORT_RTL8195),y)
 	COMPONENT_SRCDIRS += port/bsp/rtl8195
 	COMPONENT_ADD_INCLUDEDIRS += include/bsp/rtl8195

src/deps/json/Makefile

@@ -5,7 +5,7 @@ PREFIX := cJSON_
 
 LOCAL_CFLAGS := -I$(SRCDIR)
 
-SRCS = $(wildcard $(SRCDIR)/*.c)
+SRCS = $(SRCDIR)/cJSON.c
 OBJS = $(SRCS:.c=.o)
 
 all: $(OBJS)

src/easysetup/iot_easysetup_st_mqtt.c

@@ -694,6 +694,7 @@ void *_iot_es_mqtt_registration_json(struct iot_context *ctx,
 }
 #endif /* STDK_IOT_CORE_SERIALIZE_CBOR */
 
+STATIC_FUNCTION
 iot_error_t _iot_es_mqtt_registration(struct iot_context *ctx, st_mqtt_client mqtt_ctx)
 {
 	int ret;

src/include/bsp/esp32c3/iot_bsp_custom.h

@@ -0,0 +1,24 @@
+/* ***************************************************************************
+ *
+ * Copyright 2021 Samsung Electronics All Rights Reserved.
+ *
+ * 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.
+ *
+ ****************************************************************************/
+
+#ifndef _IOT_BSP_CUSTOM_H_
+#define _IOT_BSP_CUSTOM_H_
+
+#include "sdkconfig.h"
+
+#endif /* _IOT_BSP_CUSTOM_H_ */

src/include/caps/iot_caps_helper_mode.h

@@ -0,0 +1,60 @@
+/* ***************************************************************************
+ *
+ * Copyright 2019-2021 Samsung Electronics All Rights Reserved.
+ *
+ * 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.
+ *
+ ****************************************************************************/
+
+#ifndef _IOT_CAPS_HELPER_MODE_
+#define _IOT_CAPS_HELPER_MODE_
+
+#include "iot_caps_helper.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+const static struct iot_caps_mode {
+    const char *id;
+    const struct mode_attr_supportedModes {
+        const char *name;
+        const unsigned char property;
+        const unsigned char valueType;
+    } attr_supportedModes;
+    const struct mode_attr_mode {
+        const char *name;
+        const unsigned char property;
+        const unsigned char valueType;
+    } attr_mode;
+    const struct mode_cmd_setMode { const char* name; } cmd_setMode;
+} caps_helper_mode = {
+    .id = "mode",
+    .attr_supportedModes = {
+        .name = "supportedModes",
+        .property = ATTR_SET_VALUE_ARRAY,
+        .valueType = VALUE_TYPE_STRING,
+    },
+    .attr_mode = {
+        .name = "mode",
+        .property = ATTR_SET_VALUE_REQUIRED,
+        .valueType = VALUE_TYPE_STRING,
+    },
+    .cmd_setMode = { .name = "setMode" }, // arguments: mode(string) 
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _IOT_CAPS_HERLPER_MODE_ */

src/include/iot_internal.h

@@ -46,6 +46,7 @@
 #define IOT_SUB_TOPIC_COMMAND		"/v1/commands/%s/cbor"
 #define IOT_SUB_TOPIC_NOTIFICATION	"/v1/notifications/%s/cbor"
 #define IOT_PUB_TOPIC_HEALTH		"/v1/health/cbor"
+#define IOT_PUB_TOPIC_DEVICES_UPDATE		"/v1/devices/update/cbor"
 #else
 #define IOT_PUB_TOPIC_REGISTRATION	"/v1/registrations"
 #define IOT_SUB_TOPIC_REGISTRATION	"/v1/registrations/notification/%s"
@@ -54,6 +55,7 @@
 #define IOT_SUB_TOPIC_COMMAND		"/v1/commands/%s"
 #define IOT_SUB_TOPIC_NOTIFICATION	"/v1/notifications/%s"
 #define IOT_PUB_TOPIC_HEALTH		"/v1/health"
+#define IOT_PUB_TOPIC_DEVICES_UPDATE		"/v1/devices/update"
 #endif
 
 #define IOT_PUB_TOPIC_DELETE	"/v1/devices/delete"

src/include/iot_main.h

@@ -54,6 +54,8 @@
 #define IOT_MQTT_CONNECT_CRITICAL_REJECT_MAX	3
 #define IOT_RATE_LIMIT_BREAK_TIME		60000
 
+#define IOT_DEVICE_NAME_MAX_LENGTH		20
+
 enum _iot_noti_type {
 	/* Common notifications */
 	_IOT_NOTI_TYPE_UNKNOWN = IOT_NOTI_TYPE_UNKNOWN,

src/include/st_dev.h

@@ -121,6 +121,7 @@ typedef struct {
 typedef struct {
 	uint8_t state_change;	/**< @brief force this attribute value update event */
 	char *command_id;		/**< @brief event related commandId, if not used, set NULL */
+	bool *displayed;		/**< @brief whether the event should be displayed in the history feed, if not used, set NULL */
 } iot_cap_attr_option_t;
 
 #define MAX_CAP_ARG (5)
@@ -687,6 +688,15 @@ int st_create_log_dump(IOT_CTX *iot_ctx, char **log_dump_output, size_t max_log_
  */
 int st_change_health_period(IOT_CTX *iot_ctx, unsigned int new_period);
 
+/**
+ * @brief	change device name
+ * @details	This function changes device name. It reflects ST app's device name.
+ * @param[in]	iot_ctx		iot_context handle generated by st_conn_init()
+ * @param[in]	new_name	new device name null-terminated string
+ * @return 		return `(0)` if it works successfully, non-zero for error case.
+ */
+int st_change_device_name(IOT_CTX *iot_ctx, const char *new_name);
+
 #ifdef __cplusplus
 }
 #endif

src/include/st_dev_version.h

@@ -23,10 +23,10 @@
 #define VER_MAJOR	1
 
 /* minor: feature added. keep api backward compatibility */
-#define VER_MINOR	6
+#define VER_MINOR	7
 
 /* patch: bug fix */
-#define VER_PATCH	2
+#define VER_PATCH	0
 
 #define _STDK_STR(s) #s
 #define _STDK_VERSION_STR(a, b, c)	_STDK_STR(a) "." _STDK_STR(b) "." _STDK_STR(c)

src/iot_api.c

@@ -1252,7 +1252,7 @@ iot_error_t iot_misc_info_store(iot_misc_info_t type, const void *in_data)
 		json = JSON_PARSE(old_misc_info);
 		if (json == NULL) {
 			IOT_WARN("old misc_info(%s/%u) parsing failed",
-				old_misc_info, old_misc_info_len);
+				old_misc_info, (unsigned int)old_misc_info_len);
 			json = JSON_CREATE_OBJECT();
 		} else {
 			old_misc_avail = true;

src/iot_capability.c

@@ -232,10 +232,49 @@ IOT_EVENT* st_cap_create_attr_with_option(IOT_CAP_HANDLE *cap_handle, const char
 		if (options->command_id)
 		{
 			evt_data->options.command_id = iot_os_strdup(options->command_id);
+			if (evt_data->options.command_id == NULL)
+			{
+				goto failed_creat_attr_option;
+			}
+		}
+
+		if (options->displayed != NULL)
+		{
+			evt_data->options.displayed = (bool *)iot_os_malloc(sizeof(bool));
+			if (evt_data->options.displayed != NULL)
+			{
+				*(evt_data->options.displayed) = *(options->displayed);
+			}
+			else
+			{
+				goto failed_creat_attr_option;
+			}
 		}
 	}
 
 	return (IOT_EVENT*)evt_data;
+
+failed_creat_attr_option:
+
+	if (evt_data->options.displayed != NULL)
+	{
+		iot_os_free(evt_data->options.displayed);
+		evt_data->options.displayed = NULL;
+	}
+
+	if (evt_data->options.command_id != NULL)
+	{
+		iot_os_free(evt_data->options.command_id);
+		evt_data->options.command_id = NULL;
+	}
+
+	if (evt_data != NULL)
+	{
+		_iot_free_evt_data(evt_data);
+		iot_os_free(evt_data);
+	}
+
+	return NULL;
 }
 
 DEPRECATED void st_cap_attr_free(IOT_EVENT* event)
@@ -967,6 +1006,7 @@ static JSON_H *_iot_make_evt_data(const char* component, const char* capability,
 	JSON_H *evt_subjson = NULL;
 	JSON_H *evt_subdata = NULL;
 	JSON_H *prov_data = NULL;
+	JSON_H *visibility_data = NULL;
 	char time_in_ms[16]; /* 155934720000 is '2019-06-01 00:00:00.00 UTC' */
 
 	evt_item = JSON_CREATE_OBJECT();
@@ -1021,6 +1061,15 @@ static JSON_H *_iot_make_evt_data(const char* component, const char* capability,
 		JSON_ADD_ITEM_TO_OBJECT(evt_item, "data", evt_subdata);
 	}
 
+	/* visibility */
+	if (evt_data->options.displayed != NULL)
+	{
+		visibility_data = JSON_CREATE_OBJECT();
+		JSON_ADD_BOOL_TO_OBJECT(visibility_data, "displayed", *(evt_data->options.displayed));
+
+		JSON_ADD_ITEM_TO_OBJECT(evt_item, "visibility", visibility_data);
+	}
+
 	/* providerData */
 	prov_data = JSON_CREATE_OBJECT();
 	JSON_ADD_NUMBER_TO_OBJECT(prov_data, "sequenceNumber", seq_num);
@@ -1132,5 +1181,9 @@ static void _iot_free_evt_data(iot_cap_evt_data_t* evt_data)
 	if (evt_data->options.command_id != NULL) {
 		iot_os_free(evt_data->options.command_id);
 	}
+
+	if (evt_data->options.displayed != NULL) {
+		iot_os_free(evt_data->options.displayed);
+	}
 }
 /* External API */