TinyMqtt 项目下载及安装教程

1. 项目介绍

TinyMqtt 是一个适用于 ESP8266、ESP32 和 WROOM 的小型、快速且功能强大的 MQTT 代理和客户端。它支持保留消息、异步 WiFi 兼容、快速的消息传递、作为 MQTT 代理和/或客户端运行、MQTT 3.1.1 / Qos 0 支持、通配符支持等功能。TinyMqtt 还具有较小的内存占用和长消息支持，并且经过了广泛的单元测试，确保了其稳定性和可靠性。

2. 项目下载位置

TinyMqtt 项目托管在 GitHub 上，可以通过以下命令进行克隆：

git clone https://github.com/hsaturn/TinyMqtt.git

3. 项目安装环境配置

3.1 安装 Arduino IDE

首先，确保你已经安装了 Arduino IDE。如果没有安装，可以从 Arduino 官方网站 下载并安装。

3.2 安装 ESP8266/ESP32 开发板支持

在 Arduino IDE 中，你需要安装 ESP8266 或 ESP32 的开发板支持。

3.2.1 安装 ESP8266 开发板支持

1. 打开 Arduino IDE，进入 文件 -> 首选项。
2. 在 附加开发板管理器网址 中添加以下 URL：

   http://arduino.esp8266.com/stable/package_esp8266com_index.json
   

3. 点击 确定。
4. 进入 工具 -> 开发板 -> 开发板管理器。
5. 搜索 esp8266，选择 esp8266 by ESP8266 Community，点击 安装。

3.2.2 安装 ESP32 开发板支持

1. 打开 Arduino IDE，进入 文件 -> 首选项。
2. 在 附加开发板管理器网址 中添加以下 URL：

   https://dl.espressif.com/dl/package_esp32_index.json
   

3. 点击 确定。
4. 进入 工具 -> 开发板 -> 开发板管理器。
5. 搜索 esp32，选择 esp32 by Espressif Systems，点击 安装。

3.3 安装 TinyMqtt 库

1. 打开 Arduino IDE，进入 项目 -> 加载库 -> 管理库。
2. 搜索 TinyMqtt，选择 TinyMqtt 库，点击 安装。

4. 项目安装方式

4.1 打开示例项目

1. 在 Arduino IDE 中，进入 文件 -> 示例 -> TinyMqtt。
2. 选择一个示例项目，例如 simple-broker。

4.2 配置 WiFi 信息

在示例项目中，找到 my_credentials.h 文件，配置你的 WiFi 信息：

#define WIFI_SSID "your_wifi_ssid"
#define WIFI_PASSWORD "your_wifi_password"

4.3 上传代码

1. 选择你的开发板（ESP8266 或 ESP32）。
2. 选择正确的端口。
3. 点击 上传 按钮，将代码上传到开发板。

5. 项目处理脚本

TinyMqtt 项目包含一些处理脚本，用于自动化版本更新等任务。你可以在项目根目录下找到这些脚本，例如 bump_version.sh。

./bump_version.sh

这个脚本可以帮助你自动更新项目的版本号。

---

通过以上步骤，你已经成功下载并安装了 TinyMqtt 项目，并可以开始使用它进行开发。