C-SDK v3.2.1

1. 新增rrpc同步通信功能及示例
2. 新增广播功能及示例
3. 网关增加绑定/解绑子设备接口
4. 更新文档

Author: spikelin

.clang-format

@@ -5,5 +5,6 @@ AlignConsecutiveMacros: true
 AlignConsecutiveAssignments: true
 AllowShortFunctionsOnASingleLine: Inline
 AllowShortIfStatementsOnASingleLine: false
+SortIncludes: false
 IndentWidth: 4
 ColumnLimit: 120

CMakeLists.txt

@@ -60,6 +60,12 @@ set(FEATURE_SYSTEM_COMM_ENABLED ON)
 # 是否使用HTTPS下载固件
 set(FEATURE_OTA_USE_HTTPS ON)
 
+# 是否打开广播功能
+set(FEATURE_BROADCAST_ENABLED ON)
+
+# 是否打开RRPC功能
+set(FEATURE_RRPC_ENABLED ON)
+
 # 是否打开AT模组TCP功能
 set(FEATURE_AT_TCP_ENABLED OFF)
 
@@ -147,6 +153,8 @@ 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})
 option(OTA_USE_HTTPS "Enable OTA_USE_HTTPS" ${FEATURE_OTA_USE_HTTPS})
 option(AT_TCP_ENABLED "Enable AT_TCP" ${FEATURE_AT_TCP_ENABLED})
+option(BROADCAST_ENABLED "Enable BROADCAST" ${FEATURE_BROADCAST_ENABLED})
+option(RRPC_ENABLED "Enable RRPC" ${FEATURE_RRPC_ENABLED})
 
 if(AT_TCP_ENABLED STREQUAL "ON")
 	option(AT_UART_RECV_IRQ "Enable AT_UART_RECV_IRQ" ${FEATURE_AT_UART_RECV_IRQ})

Makefile

@@ -90,6 +90,14 @@ $(call CompLib_Map, AT_TCP_ENABLED, \
 	$(SRC_DIR)/network/at_socket \
 )
 
+$(call CompLib_Map, BROADCAST_ENABLED, \
+	$(SRC_DIR)/services/broadcast \
+)
+
+$(call CompLib_Map, RRPC_ENABLED, \
+	$(SRC_DIR)/services/rrpc \
+)
+
 IOTSDK_SRC_FILES := \
 
 $(foreach v, \

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

@@ -41,6 +41,7 @@ C-SDK 的使用可以根据具体场景需求，配置相应的参数，满足
 接口使用示例代码请参考samples目录下的对应代码，以及docs/IoT_Hub目录下的文档说明
 
 ### 1. MQTT 接口
+关于MQTT接口使用介绍，可以参考SDK docs/IoT_Hub/mqtt_sample_快速入门文档
 
 | 序号 | 函数名               | 说明                                            |
 | ---- | -------------------- | ----------------------------------------------- |
@@ -63,6 +64,7 @@ MQTT构造时候除了提供设备信息，还需要提供一个回调函数，
 
 ### 2. 设备影子接口
 关于设备影子功能介绍，可以参考[设备影子详情](https://cloud.tencent.com/document/product/634/11918)
+同时可以参考SDK docs/IoT_Hub/设备影子文档
 
 | 序号  | 函数名                                             | 说明                                            |
 | ---- | -------------------------------------------------- | ---------------------------------------------- |
@@ -85,7 +87,8 @@ MQTT构造时候除了提供设备信息，还需要提供一个回调函数，
 | 17   | IOT_Shadow_JSON_ConstructDesireAllNull             | 在JSON文档中添加 "desired": null 字段             |
 | 18   | IOT_Shadow_Get_Mqtt_Client                         | 获取该ShadowClient对应的MQTTclient             |
 
-### 3. CoAP 接口
+### CoAP 接口
+关于CoAP功能介绍，可以参考SDK docs/IoT_Hub/CoAP通讯文档
 
 | 序号 | 函数名                       | 说明                                                |
 | ---- | ---------------------------- | ------------------------------------------------- |
@@ -98,8 +101,9 @@ MQTT构造时候除了提供设备信息，还需要提供一个回调函数，
 | 7    | IOT_COAP_GetMessageCode      | 获取 COAP Response 消息错误码                      |
 | 9    | IOT_COAP_GetDeviceInfo       | 获取该 COAPclien对应的设备信息             |
 
-### 4. OTA 接口
+### OTA 接口
 关于 OTA 固件下载功能介绍，可以参考[设备固件升级](https://cloud.tencent.com/document/product/634/14674)
+同时可以参考SDK docs/IoT_Hub/固件升级文档
 
 | 序号  | 函数名                        | 说明                                              |
 | ---- | ---------------------------- | ------------------------------------------------- |
@@ -117,8 +121,8 @@ MQTT构造时候除了提供设备信息，还需要提供一个回调函数，
 | 12   | IOT_OTA_ReportUpgradeSuccess | 当固件升级成功之后，向服务器上报升级成功的状态                         |
 | 13   | IOT_OTA_ReportUpgradeFail    | 当固件升级失败之后，向服务器上报升级失败的状态        |
 
-### 5. 日志接口
-设备日志上报云端功能的详细说明可以参考SDK docs目录下物联网通信平台文档设备日志上报功能部分
+### 日志接口
+设备日志上报云端功能的说明可以参考SDK docs/IoT_Hub/设备日志上报文档
 
 | 序号 | 函数名                     | 说明                                          |
 | ---- | -------------------------- | --------------------------------------------- |
@@ -132,29 +136,47 @@ MQTT构造时候除了提供设备信息，还需要提供一个回调函数，
 | 8    | IOT_Log_Get_Upload_Level   | 返回 SDK 日志上报的等级                            |
 | 9    | Log_d/i/w/e                | 按级别打印添加 SDK 日志的接口                         |
 
-### 6. 系统时间接口
+### 系统时间接口
 
 | 序号  | 函数名                      | 说明                                              |
 | ---- | ---------------------------- | ------------------------------------------------- |
 | 1    | IOT_Get_SysTime              | 获取 IoT hub 后台系统时间，目前仅支持 MQTT 通道对时功能 |
 
-### 7. 网关功能接口
-关于网关功能介绍，可以参考SDK docs目录下物联网通信平台文档网关产品部分
+### 网关功能接口
+关于网关功能介绍，可以参考SDK docs/IoT_Hub/网关功能文档
 
 | 序号 | 函数名                       | 说明                                                |
 | ---- | ---------------------------- | ------------------------------------------------- |
 | 1    | IOT_Gateway_Construct        | 构造 Gateway client 并完成 MQTT 连接                   |
 | 2    | IOT_Gateway_Destroy          | 关闭 MQTT 连接并销毁 Gateway client                    |
-| 3    | IOT_Gateway_Subdev_Online    | 子设备上线              |
-| 4    | IOT_Gateway_Subdev_Offline   | 子设备下线                                    |
-| 3    | IOT_Gateway_Yield            | 在当前线程上下文中，进行 MQTT 报文读取，消息处理，超时请求，心跳包及重连状态管理等任务 |
-| 4    | IOT_Gateway_Publish          | 发布 MQTT 消息                                  |
-| 5    | IOT_Gateway_Subscribe        | 订阅 MQTT 主题                                  |
-| 6    | IOT_Gateway_Unsubscribe      | 取消订阅已订阅的 MQTT 主题                      |
-| 18   | IOT_Gateway_Get_Mqtt_Client  | 获取该GatewayClient对应的MQTTclient             |
-
-### 8. 动态注册接口
+| 3    | IOT_Gateway_Subdev_Bind      | 网关绑定子设备              |
+| 4    | IOT_Gateway_Subdev_Unbind    | 网关解绑子设备                                    |
+| 5    | IOT_Gateway_Subdev_Online    | 代理子设备上线              |
+| 6    | IOT_Gateway_Subdev_Offline   | 代理子设备下线                                    |
+| 7    | IOT_Gateway_Yield            | 在当前线程上下文中，进行 MQTT 报文读取，消息处理，超时请求，心跳包及重连状态管理等任务 |
+| 8    | IOT_Gateway_Publish          | 发布 MQTT 消息                                  |
+| 9    | IOT_Gateway_Subscribe        | 订阅 MQTT 主题                                  |
+| 10   | IOT_Gateway_Unsubscribe      | 取消订阅已订阅的 MQTT 主题                      |
+| 11   | IOT_Gateway_Get_Mqtt_Client  | 获取该GatewayClient对应的MQTTclient             |
+
+### 动态注册接口
+关于动态注册功能介绍，可以参考SDK docs/IoT_Hub/动态注册文档
 
 | 序号  | 函数名                      | 说明                                              |
 | ---- | ---------------------------- | ------------------------------------------------- |
 | 1    | IOT_DynReg_Device            | 向后台动态注册设备并获取设备密钥或者证书 |
+
+### 广播通信接口
+关于广播通信功能介绍，可以参考SDK docs/IoT_Hub/广播通信文档
+
+| 序号  | 函数名                      | 说明                                              |
+| ---- | ---------------------------- | ------------------------------------------------- |
+| 1    | IOT_Broadcast_Subscribe      | 订阅接收广播消息的主题并提供消息回调处理函数 |
+
+### 同步通信接口
+关于同步通信rrpc功能介绍，可以参考SDK docs/IoT_Hub/同步通信文档
+
+| 序号  | 函数名                      | 说明                                              |
+| ---- | ---------------------------- | ------------------------------------------------- |
+| 1    | IOT_RRPC_Init            | 订阅接收rrpc消息的主题并提供消息回调处理函数 |
+| 2    | IOT_RRPC_Reply            | 回复rrpc消息 |

docs/IoT_Hub/IoT_Hub通信平台快速入门.md

@@ -1,9 +1,9 @@
 # 腾讯云物联网通信 C-SDK
 腾讯云物联网通信IoT Hub C-SDK 依靠安全且性能强大的数据通道，为物联网领域开发人员提供设备终端和云端的双向通信能力。
-本文档介绍SDK的各项功能。
+以下为SDK各项功能对应的文档。
 
 ## 快速入门
-请参考**mqtt_sample_快速入门.md**文档，介绍如何在腾讯云物联网通信IoT Hub控制台申请设备, 并结合本 SDK 的**mqtt_sample**快速体验设备端通过 MQTT 协议连接到腾讯云IoT Hub, 发送和接收消息。
+请参考**mqtt_sample_快速入门.md**文档，介绍如何在腾讯云物联网通信IoT Hub控制台创建设备, 并结合本 SDK 的**mqtt_sample**快速体验设备端通过 MQTT 协议连接到腾讯云IoT Hub, 发送和接收消息。
 
 ## 设备影子
 请参考**shadow_sample_设备影子.md**文档，介绍设备影子功能，并结合 SDK 的**shadow_sample**展示影子的数据流和功能
@@ -20,54 +20,15 @@
 ## 动态注册
 请参考**dynreg_dev_sample_动态注册.md**文档，介绍腾讯云物联网的设备接入认证以及动态注册功能。
 
-## 设备日志上报功能
-设备端日志上报功能，可将设备端的Log通过HTTP上报到云端，并可在控制台展示，方便用户远程调试、诊断及监控设备运行状况。目前该功能仅支持MQTT模式。
-只要将SDK的编译宏FEATURE_LOG_UPLOAD_ENABLED置为y（默认为y），并在控制台设置上报级别，则在代码中调用Log_e/w/i/d接口的日志除了会在终端打印出来，还会上报云端并在控制台展示，如下图。
-![](https://main.qcloudimg.com/raw/cae7f9e7cf1e354cfc1e3578eb6746bc.png)
-
-上报级别设置可参见下图，Level级别越大则上报的日志越多，比如Level3(信息)会将ERROR/WARN/INFO级别的日志都上报而DEBUG级别则不上报。控制台默认为关闭状态，则表示设备端仅在MQTT连接失败的时候才会上报ERROR级别日志。
-![](https://main.qcloudimg.com/raw/826b648993a267b1cc2f082148d8d073.png)
+## 广播通信
+请参考**broadcast_sample_广播通信.md**文档，介绍腾讯云物联网的广播通信功能。
 
-代码具体用例可以参考mqtt_sample以及qcloud_iot_export_log.h注释说明，用户除了打开编译宏开关，还需要调用IOT_Log_Init_Uploader函数进行初始化。SDK在IOT_MQTT_Yield函数中会定时进行上报，此外，用户可根据自身需要，在程序出错退出的时候调用IOT_Log_Upload(true)强制上报。同时SDK提供在HTTP通讯出错无法上报日志时的缓存和恢复正常后重新上报机制，但需要用户根据设备具体情况提供相关回调函数，如不提供回调或回调函数提供不全则该缓存机制不生效，HTTP通讯失败时日志会被丢掉。
+## 同步通信
+请参考**rrpc_sample_同步通信.md**文档，介绍腾讯云物联网的同步通信功能。
 
-打开日志上报功能，请确保编译配置文件CMakeLists.txt中使能下面选项
-```
-set(FEATURE_LOG_UPLOAD_ENABLED ON)
-```
+## 设备日志上报功能
+请参考**log_upload_设备日志上报.md**文档，介绍设备日志上报功能及使用
 
 ## CoAP通讯
-IoT Hub支持设备端通过CoAP协议接入，请参考[CoAP 协议说明](https://cloud.tencent.com/document/product/634/14063)
-
-编译运行示例程序coap_sample，首先修改CMakeLists.txt确保以下选项存在(以密钥认证设备为例)
-```
-set(BUILD_TYPE                   "release")
-set(COMPILE_TOOLS                "gcc") 
-set(PLATFORM 	                "linux")
-set(FEATURE_COAP_COMM_ENABLED ON)
-set(FEATURE_AUTH_MODE "KEY")
-set(FEATURE_AUTH_WITH_NOTLS OFF)
-set(FEATURE_DEBUG_DEV_INFO_USED  OFF)
-```
-编译SDK，将控制台创建的设备信息填入device_info.json中
-再执行coap_sample
-```
-./output/release/bin/coap_sample 
-INF|2019-09-16 23:49:36|device.c|iot_device_info_set(67): SDK_Ver: 3.1.0, Product_ID: S3EUVBRJLB, Device_Name: test_device
-INF|2019-09-16 23:49:38|coap_client.c|IOT_COAP_Construct(82): coap connect success
-INF|2019-09-16 23:49:38|coap_client_message.c|coap_message_send(402): add coap message id: 9734 into wait list ret: 0
-DBG|2019-09-16 23:49:38|coap_client_message.c|_coap_message_handle(295): receive coap piggy ACK message, id 9734
-INF|2019-09-16 23:49:38|coap_client_auth.c|_coap_client_auth_callback(43): auth token message success, code_class: 2 code_detail: 5
-DBG|2019-09-16 23:49:38|coap_client_auth.c|_coap_client_auth_callback(53): auth_token_len = 10, auth_token = YWAIGGUGUC
-DBG|2019-09-16 23:49:38|coap_client_message.c|_coap_message_list_proc(146): remove the message id 9734 from list
-INF|2019-09-16 23:49:38|coap_client_message.c|_coap_message_list_proc(85): remove node
-INF|2019-09-16 23:49:38|coap_client.c|IOT_COAP_Construct(91): device auth successfully, connid: Xy9W9
-INF|2019-09-16 23:49:38|coap_sample.c|main(170): topic name is S3EUVBRJLB/test_device/data
-INF|2019-09-16 23:49:38|coap_client_message.c|coap_message_send(402): add coap message id: 9735 into wait list ret: 0
-DBG|2019-09-16 23:49:38|coap_sample.c|main(177): client topic has been sent, msg_id: 9735
-DBG|2019-09-16 23:49:39|coap_client_message.c|_coap_message_handle(295): receive coap piggy ACK message, id 9735
-INF|2019-09-16 23:49:39|coap_sample.c|event_handler(78): message received ACK, msgid: 9735
-DBG|2019-09-16 23:49:39|coap_client_message.c|_coap_message_list_proc(146): remove the message id 9735 from list
-INF|2019-09-16 23:49:39|coap_client_message.c|_coap_message_list_proc(85): remove node
-INF|2019-09-16 23:49:39|coap_client.c|IOT_COAP_Destroy(125): coap release!
-```
+请参考**coap_sample.md**文档，介绍腾讯云物联网的CoAP协议通信功能