v3.1.2

1. 移除IoT Explorer相关代码及文档
2. ca.c/h重命名为qcloud_iot_ca.c/h, device.c/h重命名为qcloud_iot_device.c/h
3. 更新部分文档说明

Author: Spike Lin

CMakeLists.txt

@@ -28,7 +28,7 @@ set(FEATURE_MQTT_DEVICE_SHADOW ON)
 set(FEATURE_COAP_COMM_ENABLED ON)
 
 # 是否打开MQTT通道网关功能
-set(FEATURE_GATEWAY_ENABLED ON)
+set(FEATURE_GATEWAY_ENABLED OFF)
 
 # 是否打开OTA固件升级总开关
 set(FEATURE_OTA_COMM_ENABLED ON)
@@ -43,13 +43,10 @@ set(FEATURE_AUTH_MODE "KEY")
 set(FEATURE_AUTH_WITH_NOTLS OFF)
 
 # 是否使能设备动态注册
-set(FEATURE_DEV_DYN_REG_ENABLED ON)
+set(FEATURE_DEV_DYN_REG_ENABLED OFF)
 
 # 是否打开日志上报云端功能
-set(FEATURE_LOG_UPLOAD_ENABLED ON)
-
-# 是否打开事件上报功能
-set(FEATURE_EVENT_POST_ENABLED ON)
+set(FEATURE_LOG_UPLOAD_ENABLED OFF)
 
 # 是否打开代码中获取设备信息功能，OFF时将从device_info.json中读取设备信息
 set(FEATURE_DEBUG_DEV_INFO_USED OFF)
@@ -144,7 +141,6 @@ option(GATEWAY_ENABLED "Enable GATEWAY" ${FEATURE_GATEWAY_ENABLED})
 option(AUTH_WITH_NOTLS "Enable AUTH_WITH_NOTLS" ${FEATURE_AUTH_WITH_NOTLS})
 option(COAP_COMM_ENABLED "Enable COAP_COMM" ${FEATURE_COAP_COMM_ENABLED})
 option(SYSTEM_COMM "Enable SYSTEM_COMM" ${FEATURE_SYSTEM_COMM_ENABLED})
-option(EVENT_POST_ENABLED "Enable EVENT_POST" ${FEATURE_EVENT_POST_ENABLED})
 option(DEV_DYN_REG_ENABLED "Enable DEV_DYN_REG" ${FEATURE_DEV_DYN_REG_ENABLED})
 option(LOG_UPLOAD "Enable LOG_UPLOAD" ${FEATURE_LOG_UPLOAD_ENABLED})
 option(DEBUG_DEV_INFO_USED "Enable DEBUG_DEV_INFO_USED" ${FEATURE_DEBUG_DEV_INFO_USED})

README.md

@@ -2,7 +2,9 @@
 
 腾讯云物联网设备端 C-SDK 依靠安全且性能强大的数据通道，为物联网领域开发人员提供设备端快速接入云端，并和云端进行双向通信的能力。
 
-在版本v3.1.0之后，SDK对编译环境，代码及目录结构进行了重构优化，提高了可用性和可移植性。 
+在版本v3.1.0之后，SDK对编译环境，代码及目录结构进行了重构优化，提高了可用性和可移植性。
+
+本SDK仅适用于物联网通信平台IoT Hub，对于物联网开发平台，请访问 [IoT Explorer C-SDK](https://github.com/tencentyun/qcloud-iot-explorer-sdk-embedded-c)
 
 ## 一、C-SDK 适用范围
 C-SDK 采用模块化设计，分离核心协议服务与硬件抽象层，并提供灵活的配置选项和多种编译方式，适用于不同设备的开发平台和使用环境。
@@ -55,9 +57,7 @@ C-SDK 支持三种编译方式：
 
 ## 四、SDK 示例体验
 
-C-SDK的samples目录有使用各个功能的示例，关于运行示例的详细说明，请参考docs目录各个文档，
-物联网通信平台请参考**docs/IoT_Hub**目录文档
-物联网开发平台请参考**docs/IoT_Explorer**目录文档
+C-SDK的samples目录有使用各个功能的示例，关于运行示例的详细说明，请参考docs目录各个文档
 
 ## 五、注意事项
 

docs/C-SDK_API及可变参数说明.md

@@ -52,6 +52,11 @@ C-SDK 的使用可以根据具体场景需求，配置相应的参数，满足
 | 7    | IOT_MQTT_IsConnected | 查看当前 MQTT 是否已连接                        |
 | 8    | IOT_MQTT_GetErrCode  | 获取IOT_MQTT_Construct失败的错误码              |
 
+- 接口使用说明
+```
+MQTT构造时候除了提供设备信息，还需要提供一个回调函数，用于接收消息包括连接状态通知，订阅主题是否成功，QoS1消息是否发布成功等等事件通知。订阅主题时则需提供另一个回调函数，用于接收该主题的消息下发。具体接口使用方式可以参考docs/IoT_Hub目录的mqtt_sample_快速入门文档。
+```
+
 - 多线程环境使用说明
 SDK对于MQTT接口在多线程环境下的使用有如下注意事项：
 ```

docs/C-SDK_Build编译环境及配置选项说明.md

@@ -61,7 +61,6 @@ sdk_src为SDK的核心逻辑及协议相关代码，一般不需要修改，其
 | FEATURE_AUTH_WITH_NOTLS          | ON/OFF        | OFF: TLS使能, ON: TLS关闭                                    |
 | FEATURE_DEV_DYN_REG_ENABLED      | ON/OFF        | 设备动态注册开关                                             |
 | FEATURE_LOG_UPLOAD_ENABLED       | ON/OFF        | 日志上报开关                                                 |
-| FEATURE_EVENT_POST_ENABLED       | ON/OFF        | 事件上报开关                                                 |
 | FEATURE_DEBUG_DEV_INFO_USED      | ON/OFF        | 设备信息获取来源开关                                         |
 | FEATURE_SYSTEM_COMM_ENABLED      | ON/OFF        | 获取后台时间开关                                             |
 | FEATURE_AT_TCP_ENABLED           | ON/OFF        | AT模组TCP功能开关                                            |
@@ -131,16 +130,18 @@ set(FEATURE_DEBUG_DEV_INFO_USED  OFF)
 4. 填写设备信息
 将在腾讯云物联网平台创建的设备的设备信息(以**密钥认证设备**为例)填写到device_info.json中，如：
 ```
-"auth_mode":"KEY",	
-"productId":"S3EUVBRJLB",
-"deviceName":"test_device",	
-"key_deviceinfo":{    
-    "deviceSecret":"vX6PQqazsGsMyf5SMfs6OA6y"
+{
+  "auth_mode":"KEY",	
+  "productId":"S3EUVBRJLB",
+  "deviceName":"test_device",	
+  "key_deviceinfo":{    
+      "deviceSecret":"vX6PQqazsGsMyf5SMfs6OA6y"
+  }
 }
 ```
 
 5. 运行示例
-示例输出位于`output/release/bin`文件夹中，比如运行data_template_sample示例，输入`./output/release/bin/data_template_sample`即可。
+示例输出位于`output/release/bin`文件夹中，比如运行mqtt_sample示例，输入`./output/release/bin/mqtt_sample`即可。
 
 
 ### Windows环境

docs/C-SDK_Porting跨平台移植概述.md

@@ -6,7 +6,7 @@
 
 #### 架构图
 
-![framework](https://main.qcloudimg.com/raw/ebcd38eda169523c4b1751dac1c630a0.png)
+![framework](https://main.qcloudimg.com/raw/b1a38c7d9a39a5414ccb3c8552d0efbc.png)
 
 #### 架构说明
 

docs/Device_Auth设备接入认证.md

@@ -22,7 +22,7 @@
  - 密钥设备要通过平台的安全认证，必须具备三元组信息：产品 ID（ProductId）、设备名（DeviceName）、设备密钥（DeviceSecret），其中设备密钥由平台生成。
 
 ## 设备身份信息烧录
-- 创建产品后，在物联网开发平台 [控制台](https://console.cloud.tencent.com/iotexplorer) 或者通过 [云 API](https://cloud.tencent.com/document/product/1081/37178) 创建设备，并获取对应的设备信息，将上述的四元组或者三元组信息，在设备生产的特定环节，烧录到非易失介质中，设备 SDK 运行时读取存放的设备信息，进行设备认证。
+- 创建产品后，将上述的四元组或者三元组信息，在设备生产的特定环节，烧录到非易失介质中，设备 SDK 运行时读取存放的设备信息，进行设备认证。
 
 - SDK提供了设备信息读写的HAL接口，必须实现。可以参考linux平台HAL_Device_linux.c中设备信息读写的实现。