NanoSDK 项目安装与使用教程

1. 项目目录结构及介绍

NanoSDK 项目的目录结构如下：

NanoSDK/
├── cmake/
├── demo/
├── docs/
├── etc/
├── extern/
├── include/
├── src/
├── tests/
├── .clang-format
├── .codecov.yml
├── .gitattributes
├── .gitignore
├── .gitmodules
├── .grcov.yml
├── CMakeLists.txt
├── CODE_OF_CONDUCT.adoc
├── LICENSE.txt
├── README.md
├── RELEASE_NOTES.adoc

目录介绍

• cmake/: 包含 CMake 构建脚本和配置文件。
• demo/: 包含项目的示例代码，展示了如何使用 NanoSDK 进行 MQTT 通信。
• docs/: 包含项目的文档，包括 API 文档和用户手册。
• etc/: 包含项目的配置文件和模板。
• extern/: 包含项目依赖的外部库和工具。
• include/: 包含项目的头文件。
• src/: 包含项目的源代码。
• tests/: 包含项目的测试代码。
• .clang-format: 代码格式化配置文件。
• .codecov.yml: 代码覆盖率配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置文件。
• .grcov.yml: 代码覆盖率报告配置文件。
• CMakeLists.txt: CMake 构建主配置文件。
• CODE_OF_CONDUCT.adoc: 项目行为准则。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• RELEASE_NOTES.adoc: 项目发布说明。

2. 项目启动文件介绍

NanoSDK 项目的启动文件主要位于 demo/ 目录下，提供了多个示例程序来展示如何使用 NanoSDK 进行 MQTT 通信。以下是一些关键的启动文件：

• demo/mqtt-simple: 一个简单的 MQTT 客户端示例。
• demo/mqtt_async: 一个异步 MQTT 客户端示例，支持 SSL/TLS。
• demo/mqttv5-simple: 一个简单的 MQTT 5.0 客户端示例，支持异步 API。
• demo/quic-simple: 一个简单的 MQTT over QUIC 示例（需要安装 MsQUIC）。

启动示例

以 demo/mqtt-simple 为例，启动步骤如下：

1. 进入 demo/mqtt-simple 目录。
2. 编译示例程序：

   cmake -G Ninja
   ninja
   

3. 运行示例程序：

   ./mqtt-simple
   

3. 项目配置文件介绍

NanoSDK 项目的配置文件主要位于 etc/ 目录下，提供了一些模板和配置示例。以下是一些关键的配置文件：

• etc/nanomq.conf: NanoMQ 的配置文件模板，包含了 MQTT 连接、认证、日志等配置项。
• etc/nanomq_acl.conf: NanoMQ 的访问控制列表（ACL）配置文件模板。

配置示例

以 etc/nanomq.conf 为例，配置文件内容如下：

## 配置 MQTT 连接
mqtt.host = "localhost"
mqtt.port = 1883
mqtt.username = "admin"
mqtt.password = "public"

## 配置日志
log.level = "info"
log.to = "file"
log.file = "/var/log/nanomq.log"

配置说明

• mqtt.host: MQTT 服务器地址。
• mqtt.port: MQTT 服务器端口。
• mqtt.username: 连接 MQTT 服务器的用户名。
• mqtt.password: 连接 MQTT 服务器的密码。
• log.level: 日志级别，可选值为 debug, info, warn, error。
• log.to: 日志输出目标，可选值为 console, file。
• log.file: 日志文件路径。

通过修改这些配置文件，可以定制 NanoSDK 的行为，以适应不同的应用场景。