MQTT
一、MQTT 介绍
MQTT 是一种低开销、低带宽占用的即时通讯协议,可以用极少的代码和带宽为远程设备提供实时可靠的消息服务。它适用于硬件性能低下的设备以及网络状况不佳的环境,因此在物联网(IoT)小型设备和移动应用等方面有广泛应用。
MQTT 采用发布/订阅通信模型,客户端可以发布消息到主题(Topic),也可以订阅主题来接收消息。这种模式解耦了消息的发送者和接收者。
MQTT 的消息传递质量分为三种: QoS 0:最多一次交付,即消息可能丢失; QoS 1:至少一次交付,即消息可能会重复; QoS 2:恰好一次交付,即消息不会丢失也不会重复。
二、演示功能概述
本 demo 通过使用 Air780EP 开发板,带你快速体验通过 MQTT 协议进行数据接收与发送。
三、准备硬件环境
参考:硬件环境清单第二章节内容,准备以及组装好硬件环境。
四、软件环境
“凡事预则立,不预则废。”在详细阐述本功能示例之前,我们需先精心筹备好以下软件环境。
1. Luatools工具;
2. 内核固件文件(底层core固件文件):LuatOS-SoC_V2002_Air780EP;参考项目使用的内核固件;
3. luatos需要的脚本和资源文件
脚本和资源文件右键点我,另存为,下载完整压缩文件包
lib脚本文件:使用Luatools烧录时,勾选 添加默认lib 选项,使用默认lib脚本文件;
准备好软件环境之后,接下来查看如何烧录项目文件到Air780EP核心板,将本篇文章中演示使用的项目文件烧录到Air780EP核心板中。
五、代码示例介绍
5.1 DEMO 软件流程图
5.2 配置
5.2.1 MQTT 的 4 个重要配置
- local mqtt_host = "lbsmqtt.airm2m.com"(MQTT 服务器地址,这里使用合宙提供公用测试服务器)
- local mqtt_port = 1884(MQTT 端口)
- local mqtt_clintid = "abc" (暂时只定义,但暂未使用)
- local user_name = "user"(MQTT 服务器登录用户名)
- local password = "password"(MQTT 服务器登录密码)
5.2.2 本DEMO通信使用的 2 个重要主题
- local pub_topic = "/luatos/pub/123"-- .. (mcu.unique_id():toHex())(设备发布主题,以下方源码 55 行,可自行修改)
- local sub_topic = "/luatos/sub/123"-- .. (mcu.unique_id():toHex())(设备订阅主题,以下方源码 56 行,可自行修改)
5.2 完整程序清单
注:完整复制后保存为 main.lua,可直接使用
-- LuaTools需要PROJECT和VERSION这两个信息
PROJECT = "mqttdemo"
VERSION = "1.0.0"
--[[
本demo需要mqtt库, 大部分能联网的设备都具有这个库
mqtt也是内置库, 无需require
]]
-- sys库是标配
_G.sys = require("sys")
--[[特别注意, 使用mqtt库需要下列语句]]
_G.sysplus = require("sysplus")
local netLed = require("netLed")
-- Air780EP的AT固件默认会为开机键防抖, 导致部分用户刷机很麻烦
if rtos.bsp() == "EC618" and pm and pm.PWK_MODE then
pm.power(pm.PWK_MODE, false)
end
--根据自己的服务器修改以下参数
local mqtt_host = "lbsmqtt.airm2m.com"
local mqtt_port = 1884
local mqtt_isssl = false
local ca_file = false
local client_id = "mqttx_b55c41b7"
local user_name = "user"
local password = "password"
local pub_topic = "/luatos/pub/123"-- .. (mcu.unique_id():toHex())
local sub_topic = "/luatos/sub/123"-- .. (mcu.unique_id():toHex())
local mqttc = nil
local netLed = require("netLed")
--GPIO18配置为输出,默认输出低电平,可通过setGpio18Fnc(0或者1)设置输出电平
local LEDA= gpio.setup(27, 0, gpio.PULLUP)
-- 统一联网函数
sys.taskInit(function()
local device_id = mcu.unique_id():toHex()
device_id = mobile.imei()
-- 默认都等到联网成功
sys.waitUntil("IP_READY")
sys.publish("net_ready", device_id)
end)
sys.taskInit(function()
-- 等待联网
local ret, device_id = sys.waitUntil("net_ready") --device_id为设备的IMEI号
client_id = device_id
pub_topic = device_id .. "/up" -- 设备发布的主题,开发者可自行修改
sub_topic = device_id .. "/down" -- 设备订阅的主题,开发者可自行修改
-- 打印一下上报(pub)和下发(sub)的topic名称
-- 上报: 设备 ---> 服务器
-- 下发: 设备 <--- 服务器
-- 可使用mqtt.x等客户端进行调试
log.info("mqtt", "pub", pub_topic)
log.info("mqtt", "sub", sub_topic)
-- 打印一下支持的加密套件, 通常来说, 固件已包含常见的99%的加密套件
-- if crypto.cipher_suites then
-- log.info("cipher", "suites", json.encode(crypto.cipher_suites()))
-- end
if mqtt == nil then
while 1 do
sys.wait(1000)
log.info("bsp", "本bsp未适配mqtt库, 请查证")
end
end
--配置上网指示灯
gpio.setup(11, 1, gpio.PULLUP) --配置为输出,带上拉
-------------------------------------
-------- MQTT 演示代码 --------------
-------------------------------------
mqttc = mqtt.create(nil, mqtt_host, mqtt_port, mqtt_isssl, ca_file)
mqttc:auth(client_id,user_name,password) -- client_id必填,其余选填
-- mqttc:keepalive(240) -- 默认值240s
mqttc:autoreconn(true, 3000) -- 自动重连机制
mqttc:on(function(mqtt_client, event, data, payload)
-- 用户自定义代码
log.info("mqtt", "event", event, mqtt_client, data, payload)
if event == "conack" then
-- 联上了
gpio.set(11, 0) --输出低电平
sys.publish("mqtt_conack")
mqtt_client:subscribe(sub_topic)--单主题订阅
-- mqtt_client:subscribe({[topic1]=1,[topic2]=1,[topic3]=1})--多主题订阅
elseif event == "recv" then
log.info("mqtt", "downlink", "topic", data, "payload:", payload)
log.info("mqtt", "uplink", "topic", pub_topic, "payload:", payload)
sys.publish("mqtt_pub", pub_topic, payload) --将收到的数据,通过发布主题目,进行发送
elseif event == "sent" then
log.info("mqtt", "sent", "pkgid", data)
elseif event == "disconnect" then
gpio.set(11, 1) --输出高电平
-- 非自动重连时,按需重启mqttc
-- mqtt_client:connect()
end
end)
-- mqttc自动处理重连, 除非自行关闭
mqttc:connect()
sys.waitUntil("mqtt_conack")
while true do
-- 演示等待其他task发送过来的上报信息
local ret, topic, data, qos = sys.waitUntil("mqtt_pub", 300000)
if ret then
-- 提供关闭本while循环的途径, 不需要可以注释掉
if topic == "close" then break end
mqttc:publish(topic, data, qos)
end
-- 如果没有其他task上报, 可以写个空等待
--sys.wait(6000)
end
mqttc:close()
mqttc = nil
end)
-- 用户代码已结束---------------------------------------------
-- 结尾总是这一句
sys.run()
-- sys.run()之后后面不要加任何语句!!!!!
六、功能验证
6.1 查看调试日志,获取设备发布与订阅主题
6.2 打开 MQTT 客户端 MQTT.fx 应用程序并配置
6.2.1 MQTT 客户端基本配置
ProfileName:合宙(可修改为你想要的名称)
BrokerAddress:http://lbsmqtt.airm2m.com (合宙提供的免费测试服务器,也可修改为自己的服务器)
BrokerPort:1883 (端口号)
UserName:user
Password:password
6.2.2 两个重要主题
设备发布主题:861959068926349/up (设备向服务器发送数据使用)
设备订阅主题:861959068926349/down (接收服务器数据主题)
6.3 订阅设备主题
6.4 MQTT 客户端给开发板发送数据
6.5 查 MQTT 客户端订阅的设备数据
总结
至此,我们已使用 Air780EP 开发板完成了 MQTT 通信的基本功能。
给读者的话
本篇文章由
肇朔
开发;本篇文章描述的内容,如果有错误、细节缺失、细节不清晰或者其他任何问题,总之就是无法解决您遇到的问题;
请登录合宙技术交流论坛,点击文档找错赢奖金-Air780EP-LuatOS-软件指南-网络驱动-MQTT通信
用截图标注+文字描述的方式跟帖回复,记录清楚您发现的问题;
我们会迅速核实并且修改文档;
同时也会为您累计找错积分,您还可能赢取月度找错奖金!