原创 Air780EP模组LuatOS脚本开发MQTT应用示例

本文应各位大佬邀请，详细讲解了Air780EP模组LuatOS开发的多个MQTT应用示例。

一、相关准备工作 

1.1 硬件准备

EVB_Air780EP开发板一套，包括天线、SIM卡；

USB线

PC电脑

1.2 软件准备

登录官方IoT后台：

https://iot.openluat.com/

LuatOS固件下载：

https://gitee.com/openLuat/LuatOS/releases

DEMO源码下载：

https://gitee.com/openLuat/LuatOS/tree/master/demo/mqtt

注：进入LuatOS固件页面按下Ctrl+F，搜索Air780EP即可找到对应的固件。

推荐选用：相关型号固件名称后面数字版本号最高的最新relase版本进行调试。

二、名词解析及API说明 

2.1 名词解析

1）user_name用户名

password密码

client_id用户标识

MQTT可以通过前两个参数保证连接的安全，通过client_id确保设备唯一性。

2）QOS消息质量

分为0/1/2三个等级，分别表示只发一次，至少收到一次和只收到一次。通过QOS可以根据数据的重要性灵活，选择发送方式以节省带宽和保证数据可靠。

3）关于publish时QOS值的说明：

QOS为0时，压入底层TCP发送堆栈，视为成功；

QOS为1时，收到服务器回应PUBACK，视为成功；

QOS为2时，收到服务器响应PUBREC，立即上行PUBCOMP压入TCP发送队列，视为成功。

4）mqtt_host主机服务器地址

mqtt_port端口

MQTT需要连接的服务器参数。

mqtt_host可以说是ip或者域名。

5）topic主题

根据主题区别消息类型和来源，主要用来分类数据。同时mqtt是发布订阅模型，topic是发布和订阅者通信的重要通道。

6）payload消息内容

发布和订阅的具体数据。

7）retain保留消息

保留消息是一条将保留标志（retained flag）置为true的普通MQTT消息。broker会针对主题依照QoS级别保留最后一条保留消息，当订阅者订阅主题时会立即收到保留消息。broker仅为每个主题保留一条保留消息。

2.2 API说明

三、MQTT实现流程 

3.1 创建一个TASK协程

接口：sys.taskInit(func, arg1, arg2, argN)

参数：

返回值：

3.2 等待网络就绪

3.3 创建一个mqtt实例

接口：

mqtt.create(adapter,host,port,ssl,isipv6)

参数：

返回值：

3.4 连接服务器

接口：

mqttc:connect()

参数：

无

返回值：

注意：本函数仅代表发起成功, 后续仍需根据ready函数判断mqtt是否连接正常。

3.5 订阅主题

接口：

mqttc:subscribe(topic, qos)

参数：

返回值：

3.6 发布消息

接口：

mqttc:publish(topic, data, qos, retain)

参数：

返回值：

3.7 接收消息

3.8 断开服务器的连接

接口：

mqttc:disconnect()

参数：

无

返回值：

四、MQTT示例说明

本文以demo_lua\LuatOS\demo\mqtt这个demo为例作为演示，以MQTTX工具来测试MQTT运行状况。

4.1 在MQTTX软件上建立连接 

4.2 在MQTTX软件上添加订阅

注意：

订阅主题格式要求默认为 /luatos/pub/ 加模块的IMEI号。

例如：/luatos/pub/868488076506128

4.3 设置MQTTX软件上发布消息的主题

注意：

格式要求默认为 /luatos/sub/ 加模块的IMEI号。

例如：/luatos/sub/868488076506128

4.4 烧录脚本

上电开机后模块会自动向服务器发送消息，这是代码默认设置的，若不需要可以删掉。

4.5 模块向服务器发送消息

通过Luatools软件可以看到：

Luatools软件下载：

https://wiki.luatos.com/pages/tools.html

五、MQTT单链接示例 

5.1 修改指定参数

在代码开头，可根据自己的服务器修改指定的参数。

注意：

user_name、password在有些服务器上是可以不传入的，或者是对传入的值没有要求限制；要根据实际服务器要求来填写。

5.2 连接/订阅/发布流程

此task实现的是MQTT的连接、订阅消息、发布消息的流程。

注意：

要先等待网络就绪之后，才可进行MQTT后续操作。

待网络就绪之后，根据代码编写情况此时client_id、pub_topic和sub_topic会发生变化，会覆盖掉代码开头部分时的配置，这点需要注意；device_id为模块的IMEI号。

示例源码下载：https://gitee.com/openLuat/LuatOS/tree/master/demo/mqtt

5.3 发送数据

此task的功能为模块每3秒向服务器发送一次数据。

5.4 mqtt-uart透传

此代码可实现mqtt-uart透传，利用串口工具给服务器发消息或者接收来着服务器的消息。

注意：

要使用串口1，且波特率为9600。

六、MQTT多链接示例 

多链接的核心，就是要创建两个mqtt客户端的对象，通过不同的变量控制，代码部分如下。

示例源码下载：

https://gitee.com/openLuat/LuatOS/tree/master/demo/mqtt

七、MQTT SSL不带证书连接示例 

示例源码下载：

https://gitee.com/openLuat/LuatOS/tree/master/demo/mqtt

八、MQTT SSL带证书连接示例 

示例源码下载：

https://gitee.com/openLuat/LuatOS/tree/master/demo/mqtt

九、常见问题Q&A 

以下针对朋友们实际应用中的反馈，整理了MQTT应用中的常见问题：

01. 模组支持MQTT最新的版本是多少？

支持MQTT_V3.1、MQTT_V3.1.1版本。

02. 模组最多支持几路链接？

MQTT/TCP/UDP的链接公用8路通道。

03. client id是否允许重复？

client id不允许重复，要保证唯一性，如果在已经有一个该id的链接情况下，另外一个设备也用了相同的clientid接入，会把另一个在连链接挤掉。

04. Qos0、Qos1、Qos2如何选择？

应用允许的情况下，建议使用Qos0；Qos1和Qos2会加重网络负担，4G网络还好，特别是2G网络，在网络拥堵和较差的情况下，数据传输的次数越多，掉线的概率就会越高。

05. 为什么mqtt ssl访问失败？

检查服务器是否支持模块支持的加密套件，用模块程序中的三元组和证书，在mqttx或者mqttfx客户端工具上尝试是否可以成功链接。

06. 排查是否设备单体问题：

如果同一地点，某些设备正常，某些设备异常，按照如下几种情况分析。

01）分析正常设备和异常设备的使用环境是否相同：

如果不同，例如异常设备固定在钢制墙壁上，正常设备放置在桌子上，钢制墙壁可能对天线射频有干扰，将异常设备和正常设备放置在同样的使用环境中，再对比测试。

如果相同，参考下方第2）步。

2）分析正常和异常的设备，驻留的小区是否相同：

如果相同，重点排查异常设备的天线射频部分。

如同不同，多测试几次，确认下，是不是在异常小区内很容易出问题，如果异常小区很容易出问题，可能就是小区拥堵造成的。