LuaMQTT 项目启动与配置教程

1. 项目的目录结构及介绍

LuaMQTT 项目是一个使用纯 Lua 语言编写的 MQTT 协议客户端库，支持 MQTT v3.1.1 和 MQTT v5.0。项目目录结构如下：

• docs/: 存放项目文档。
• examples/: 包含了一些示例脚本，展示了如何使用 LuaMQTT 库。
• mqtt/: 核心代码目录，包含了 LuaMQTT 库的实现。
• openwrt/: 与 OpenWrt 系统集成相关的文件。
• rockspecs/: 包含了 LuaRocks 的包描述文件。
• tests/: 包含了测试脚本和测试用例。
• tools/: 包含了一些辅助工具脚本。
• .github/: 包含了 GitHub Actions 工作流文件。
• .gitignore: 定义了 Git 忽略的文件列表。
• LICENSE: MIT 许可证文件。
• README.md: 项目说明文件。
• luamqtt-scm-1.rockspec: LuaRocks 的源代码管理包描述文件。
• logo.svg: 项目图标。

2. 项目的启动文件介绍

项目的启动通常是通过 examples/ 目录下的示例脚本进行的。例如，examples/simple.lua 是一个简单的启动示例，内容如下：

-- 加载 mqtt 库
local mqtt = require("mqtt")

-- 创建 MQTT 客户端
local client = mqtt.client({
    uri = "mqtt.flespi.io",
    username = os.getenv("FLESPI_TOKEN"),
    clean = true
})

-- 为 MQTT 客户端分配事件处理函数
client:on({
    connect = function(connack)
        if connack.rc ~= 0 then
            print("connection to broker failed: ", connack.reason_string, connack)
            return
        end
        -- 连接建立，现在订阅测试主题并在连接后发布消息
        assert(client:subscribe({
            topic = "luamqtt/#",
            qos = 1,
            callback = function()
                assert(client:publish({
                    topic = "luamqtt/simpletest",
                    payload = "hello"
                }))
            end
        }))
    end,
    message = function(msg)
        assert(client:acknowledge(msg))
        -- 接收到消息后断开连接
        print("received message", msg)
        client:disconnect()
    end,
})

-- 运行 ioloop 以保持客户端运行
mqtt.run_ioloop(client)

这个脚本创建了一个 MQTT 客户端，连接到 MQTT 服务器，订阅一个主题，并发布一条消息。

3. 项目的配置文件介绍

LuaMQTT 的配置主要通过传入参数到 mqtt.client 函数中进行。在示例脚本中，我们可以看到如下配置：

• uri: MQTT 服务器的地址。
• username: 连接到 MQTT 服务器所需的用户名，通常是从环境变量中获取。
• clean: 表示是否为干净会话，即断开连接后是否清除服务器上的会话状态。

此外，还可以配置其他参数，如 password（密码）、ssl（SSL 配置）、connect_timeout（连接超时时间）等。

在 examples/ 目录下的其他脚本中，你可以找到更多配置选项的示例。