tencent cloud

本文档对 C SDK 的编译方式和编译配置选项进行说明，并介绍了 Linux 和 Windows 开发环境下的编译环境搭建以及编译示例。

C SDK 编译方式说明

C SDK 支持以下编译方式。

cmake 方式

• 推荐使用 cmake 作为跨平台的编译工具，支持在 Linux 和 Windows 开发环境下进行编译。
• cmake 方式采用 CMakeLists.txt 作为编译配置选项输入文件。

Makefile 方式

• 对于不支持 cmake 的环境，使用 Makefile 直接编译的方式。
• Makefile 方式与 SDK v3.0.3及之前的版本保持一致，采用 make.settings 作为编译配置选项输入文件，修改完成后执行 make 即可。

代码抽取方式

• 该方式可根据需求选择功能，将相关代码抽取到一个单独的文件夹，文件夹里面的代码层次目录简洁，方便用户拷贝集成到自己的开发环境。

• 该方式需要依赖 cmake 工具，在 CMakeLists.txt 中配置相关功能模块的开关，并将 EXTRACT_SRC 设置为 ON，在 Linux 环境运行以下命令：

  mkdir build
  cd build
  cmake ..
  

• 即可在 output/qcloud_iot_c_sdk 中找到相关代码文件，目录层次如下：

   qcloud_iot_c_sdk
  ├── include
  │   ├── config.h
  │   ├── exports
  ├── platform
  └── sdk_src
    └── internal_inc
  

• include 目录为 SDK 供用户使用的 API 及可变参数，其中 config.h 为根据编译选项生成的编译宏。

• platform 目录为平台相关的代码，可根据设备的具体情况进行修改适配。

• sdk_src 为 SDK 的核心逻辑及协议相关代码，一般无需修改，其中 internal_inc 为 SDK 内部使用的头文件。

说明：

用户可将 qcloud_iot_c_sdk 拷贝到其目标平台的编译开发环境，并根据具体情况修改编译选项。

C SDK 编译选项说明

编译配置选项

以下配置选项大部分都适用于 cmake 和 make.setting。cmake 中的 ON 值对应于 make.setting 的 y，OFF 对应于 n。

配置选项之间存在依赖关系，当依赖选项的值为有效值时，部分配置选项才有效，主要如下：

设备信息选项

在腾讯云物联控制台创建设备之后，需要将设备信息（ProductID/DeviceName/DeviceSecret/Cert/Key 文件）配置在 SDK 中才能正确运行。在开发阶段，SDK 提供两种方式存储设备信息：

• 存放在代码中（编译选项 DEBUG_DEV_INFO_USED = ON），则在platform/os/xxx/HAL_Device_xxx.c中修改设备信息，在无文件系统的平台下可以使用这种方式。
• 存放在配置文件中（编译选项 DEBUG_DEV_INFO_USED = OFF），则在device_info.json文件修改设备信息，此方式下更改设备信息不需重新编译 SDK，在 Linux/Windows 平台下开发推荐使用这种方式。