树莓派由英国树莓派基金会开发,是一款基于ARM的微型计算机主板。该主板提供USB接口和以太网接口,可以连接键盘、鼠标和网线,该主板具备PC的基本功能,同时树莓派集成了Wi-Fi,蓝牙以及大量GPIO,被广泛运用在教学、家庭娱乐、物联网等。
MQTT是一种基于发布/订阅模式的轻量级物联网消息传输协议 ,可以用极少的代码和带宽为联网设备提供实时可靠的消息服务,它适用于硬件资源有限的设备及带宽有限的网络环境。因此,MQTT协议广泛应用于物联网、移动互联网、智能硬件、车联网、电力能源等行业。
在此项目中,我们将在树莓派上使用Python编写简单的MQTT客户端,并实现该客户端与MQTT服务器的连接、订阅、取消订阅、收发消息等功能。
环境搭建
安装Python3
本项目使用Python3进行开发,一般情况下,树莓派系统会内置Python3,如果不确定系统内是否已经安装,可以使用下面的命令进行确认。
python3 --version
如果显示Python 3.x.x(x表示数字)则表示已经安装,否则请使用apt命令安装(或跟随Python安装指南操作)。
sudo apt install python3
安装MQTT客户端库
为了方便连接到MQTT服务器,我们需要安装paho-mqtt库。可以选择以下两种方法之一进行安装。
使用源码安装
git clone https://github.com/eclipse/paho.mqtt.python
cd paho.mqtt.python
python3 setup.py install
使用pip3安装
pip3 install paho-mqtt
MQTT的使用
连接MQTT服务器
本文将使用EMQX提供的免费公共MQTT服务器,该服务基于EMQX的MQTT物联网云平台创建。服务器接入信息如下:
- Broker: broker.emqx.io
- TCP Port: 1883
- Websocket Port: 8083
如果有需要,您也可以使用docker在本地快速安装EMQX服务器。
docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8084:8084 -p 18083:18083 emqx/emqx
连接示例代码
# test_connect.py
import paho.mqtt.client as mqtt
# 回调函数。当尝试与 MQTT broker 建立连接时,触发该函数。
# client 是本次连接的客户端实例。
# userdata 是用户的信息,一般为空。但如果有需要,也可以通过 user_data_set 函数设置。
# flags 保存服务器响应标志的字典。
# rc 是响应码。
# 一般情况下,我们只需要关注 rc 响应码是否为 0 就可以了。
def on_connect(client, userdata, flags, rc):
if rc == 0:
print("Connected success")
else:
print(f"Connected fail with code {rc}")
client = mqtt.Client()
client.on_connect = on_connect
client.connect("broker.emqx.io", 1883, 60)
client.loop_forever()
将上面的代码保存为test_connect.py文件,并运行
python3 test_connect.py
我们在on_connect函数里对响应码进行了判断,为0则输出Connected success表示连接成功。如果返回的是其它数字,我们就需要对照下面的响应码进行判断。
0: 连接成功
1: 连接失败-不正确的协议版本
2: 连接失败-无效的客户端标识符
3: 连接失败-服务器不可用
4: 连接失败-错误的用户名或密码
5: 连接失败-未授权
6-255: 未定义
如果是其它问题,可以检查网络情况,或者确认是否安装了 `paho-mqtt`。
在MQTT协议的概念中,消息是通过主题传递的,比如设备A向主题T发送消息,那么只有订阅了主题T的设备才能接收到。所以仅仅接入MQTT服务器并没有太大意议,要完整地使用MQTT服务,我们还需要知道如何订阅和发布消息。
订阅消息
打开任意编辑器,输入下面的代码,并保存为subscriber.py文件:
# subscriber.py
import paho.mqtt.client as mqtt
def on_connect(client, userdata, flags, rc):
print(f"Connected with result code {rc}")
# 订阅,需要放在 on_connect 里
# 如果与 broker 失去连接后重连,仍然会继续订阅 raspberry/topic 主题
client.subscribe("raspberry/topic")
# 回调函数,当收到消息时,触发该函数
def on_message(client, userdata, msg):
print(f"{msg.topic} {msg.payload}")
client = mqtt.Client()
client.on_connect = on_connect
client.on_message = on_message
# 设置遗嘱消息,当树莓派断电,或者网络出现异常中断时,发送遗嘱消息给其他客户端
client.will_set('raspberry/status', b'{"status": "Off"}')
# 创建连接,三个参数分别为 broker 地址,broker 端口号,保活时间
client.connect("broker.emqx.io", 1883, 60)
# 设置网络循环堵塞,在调用 disconnect() 或程序崩溃前,不会主动结束程序
client.loop_forever()
调用subscribe()函数,可以让树莓派订阅一个主题。在上面的代码中,我们使用它订阅了 raspberry/topic主题,并监听消息。
另外,我们还使用will_set()设置了遗嘱消息。遗嘱消息是MQTT的一个特性,当设备在意外断开网络连接后,会向某个特定的主题发送消息。通过这个特性,我们可以得知树莓派是否断电,或者出现网络异常。
发布消息
打开任意编辑器,输入下面的代码,并保存为publisher.py文件:
import paho.mqtt.client as mqtt
import time
def on_connect(client, userdata, flags, rc):
print(f"Connected with result code {rc}")
client = mqtt.Client()
client.on_connect = on_connect
client.connect("broker.emqx.io", 1883, 60)
# 每间隔 1 秒钟向 raspberry/topic 发送一个消息,连续发送 5 次
for i in range(5):
# 四个参数分别为:主题,发送内容,QoS, 是否保留消息
client.publish('raspberry/topic', payload=i, qos=0, retain=False)
print(f"send {i} to raspberry/topic")
time.sleep(1)
client.loop_forever()
调用publish()函数,可以向一个主题发送消息。在上面的代码中,我们使用了它向主题raspberry/topic发送消息。其中参数QoS是另一个MQTT特性,如果你想了解更多QoS的内容,可以查看MQTT QoS 0,1,2介绍,这里我们暂且设为0。
测试
我们使用MQTT 5.0客户端工具-MQTT X进行以下测试。
测试订阅消息
运行Python代码,并主动发送一个消息。
1.打开终端,运行Python代码,监听消息。
python3 subscriber.py
2.使用MQTT X客户端与MQTT服务器建立连接,并向主题raspberry/topic发送消息。
3.查看树莓派终端信息,将会看到已成功接收到MQTT X发布的消息。
测试发布消息
1.在MQTT X客户端中订阅raspberry/topic主题。
2.在终端运行Python代码。
3.在MQTT X客户端中,查看树莓派发送的消息。
测试遗嘱消息
接下来测试一下遗嘱消息是否设置成功。
1.在MQTT X客户端中,订阅raspberry/status。
2.中断程序,或者断开树莓派的网络。
3.在MQTT X客户端中,查看raspberry/status主题接收到的消息。
总结
我们完成了在树莓派上使用Python MQTT客户端库paho-mqtt编写测试客户端,并实现了测试客户端与MQTT服务器的连接、订阅、取消订阅、收发消息等功能。
至此,相信读者已经掌握了如何简单的使用MQTT服务。虽然这只是MQTT服务的一小部分,但也足够完成很多有意思的事,比如:
1.使用手机发送MQTT消息,远程控制树莓派。
2.定时将树莓派的设备信息发送到MQTT服务器,通过手机接收消息,可以进行全天候监控。
3.可以通过将树莓派接入MQTT服务器,并配合各类传感器及ESP模块创建很多有趣的物联网应用。