tencent cloud

设备端 C SDK 供用户调用的 API 函数声明，常量以及可变参数定义等头文件位于 include 目录下面，本文档主要对该目录下面的可变参数以及 API 函数进行说明。

可变参数配置

C SDK 的使用可以根据具体场景需求，配置相应的参数，满足实际业务的运行。可变接入参数包括：

1. MQTT 阻塞调用（包括连接, 订阅, 发布等）的超时时间，单位：毫秒。 建议5000毫秒。
2. MQTT 协议发送消息和接受消息的 buffer 大小默认为2048字节，最大支持16KB。
3. COAP 协议发送消息和接受消息的 buffer 大小默认为512字节，最大支持1KB。
4. MQTT 心跳消息发送周期，最大值为690秒，单位：毫秒。
5. 重连最大等待时间，单位：毫秒。设备断线重连时，若失败则等待时间会翻倍，当超过该最大等待时间则退出重连。

修改include/qcloud_iot_export_variables.h文件如下宏定义可以改变对应接入参数的配置。
修改完需要重新编译 SDK ，示例代码如下：

/* default MQTT/CoAP timeout value when connect/pub/sub (unit: ms) */
#define QCLOUD_IOT_MQTT_COMMAND_TIMEOUT                             (5 * 1000)

/* default MQTT keep alive interval (unit: ms) */
#define QCLOUD_IOT_MQTT_KEEP_ALIVE_INTERNAL                         (240 * 1000)

/* default MQTT Tx buffer size, MAX: 16*1024 */
#define QCLOUD_IOT_MQTT_TX_BUF_LEN                                  (2048)

/* default MQTT Rx buffer size, MAX: 16*1024 */
#define QCLOUD_IOT_MQTT_RX_BUF_LEN                                  (2048)

/* default COAP Tx buffer size, MAX: 1*1024 */
#define COAP_SENDMSG_MAX_BUFLEN                                     (512)

/* default COAP Rx buffer size, MAX: 1*1024 */
#define COAP_RECVMSG_MAX_BUFLEN                                     (512)

/* MAX MQTT reconnect interval (unit: ms) */
#define MAX_RECONNECT_WAIT_INTERVAL                                 (60 * 1000)

API 函数说明

以下是 C SDK v3.1.0版本提供的主要功能和对应 API 接口说明，用于客户编写业务逻辑，更加详细的说明如接口参数及返回值可查看 SDK 代码include/exports/qcloud_iot_export_*.h等头文件中的注释。

MQTT 接口

多线程环境使用说明

SDK 对于 MQTT 接口在多线程环境下的使用有如下注意事项：

• 不允许多线程调用 IOT_MQTT_Yield，IOT_MQTT_Construct 以及IOT_MQTT_Destroy。
• 可以多线程调用 IOT_MQTT_Publish，IOT_MQTT_Subscribe 及 IOT_MQTT_Unsubscribe。
• IOT_MQTT_Yield 作为从 socket 读取并处理 MQTT 报文的函数，应保证一定的执行时间，避免被长时间挂起或抢占。

设备影子接口

关于设备影子功能介绍，可以参考 设备影子详情。

CoAP 接口

OTA 接口

关于 OTA 固件下载功能介绍，可以参考 设备固件升级。

日志接口

设备日志上报云端功能的详细说明可以参考 SDK docs 目录下物联网通信平台文档设备日志上报功能部分。

系统时间接口

网关功能接口

关于网关功能介绍，可以参考 SDK docs 目录下物联网通信平台文档网关产品部分。