Micropython开发esp32入门笔记--MQTT篇


一、MQTT 简介

在这里插入图片描述

MQTT(Message Queuing Telemetry Transport,消息队列遥测传输协议),是一种基于客户端-服务器的消息发布/订阅(publish/subscribe)模式的"轻量级"通讯协议,该协议底层是TCP/IP协议。MQTT最大优点在于,可以以极少的代码和有限的带宽,为连接远程设备提供实时可靠的消息服务。作为一种低开销、低带宽占用的即时通讯协议,使其在物联网、小型设备、移动应用等方面有较广泛的应用。

MQTT协议是轻量、简单、开放和易于实现的,这些特点使它适用范围非常广泛。在很多情况下,包括受限的环境中,如:机器与机器(M2M)通信和物联网(IoT)。其在,通过卫星链路通信传感器、偶尔拨号的医疗设备、智能家居、及一些小型化设备中已广泛使用。

二、MQTT数据流转原理

MQTT最重要的就是发布和订阅的模式,服务器是根结点,扮演着领导中枢的角色;客户端是子节点,扮演着下属的角色,每个角色都可以充当发布者和订阅者

在这里插入图片描述

发布者(Publisher)
负责将消息发布到主题上,发布者一次只能向一个主题发送数据,发布者发布消息时也无需关心订阅者是否在线。

订阅者(Subscriber)
订阅者通过订阅主题接收消息,且可一次订阅多个主题。MQTT 还支持通过共享订阅的方式在多个订阅者之间实现订阅的负载均衡。

代理(Broker)
负责接收发布者的消息,并将消息转发至符合条件的订阅者。另外,代理也需要负责处理客户端发起的连接、断开连接、订阅、取消订阅等请求。

主题(Topic)
主题是 MQTT 进行消息路由的基础,它类似 URL 路径,使用斜杠进行分层,比如 sensor/1/temperature。一个主题可以有多个订阅者,代理会将该主题下的消息转发给所有订阅者;一个主题也可以有多个发布者,代理将按照消息到达的顺序转发。订阅者向代理订阅自己感兴趣的主题,发布者发布的所有消息中都会包含自己的主题,代理根据消息的主题判断需要将消息转发给哪些订阅者。

扫描二维码关注公众号,回复: 15692214 查看本文章

内容(payload)
可以理解为消息的内容,是指订阅者具体要使用的内容。订阅者定义其感兴趣的消息的条件,只有当消息的属性或内容满足订阅者定义的条件时,消息才会被投递到该订阅者。

通俗易懂的理解,想象一个领导给不同部门的代表开年终总结会,每个部门的代表都想了解其他部门的业务情况,那他们就会告诉领导他们感兴趣的主题,然后领导会把相关部门代表的发布的业务情况总结告诉那些感兴趣的其他部门代表。

三、ESP32开发-- 基于MQTT协议

1、超声波传感器原理

在这里插入图片描述

超声波传感器是用来测量物体的距离。首先,超声波传感器会发射一组高频声波,一般为40-45KHz,当声波遇到物体后,就会被反弹回,并被接受到。通过计算声波从发射到返回的时间,再乘以声波在媒介中的传播速度(344 米/秒,空气中)。就可以获得物体相对于传感器的距离值。

在这里插入图片描述

我们使用的超声波传感器是 H C − S R 04 HC-SR04 HCSR04 模块,根据上述时序图整体的实现思路是:
(1)采用 IO 口 TRIG 触发测距,先让ESP32的引脚给TRIG高电平。
(2)模块自动发送 8 个 40khz 的方波,自动检测是否有信号返回;
(3)检测ECHO是否有信号返回,信号返回时 ECHO 会输出一个高电平,高电平持续的时间就是超声波从发射到返回的时间,所以ECHO引脚高电平开始计时,将时间计算后转化为距离

2、Micropython实现超声波测距

Micropython实现时先要封装好几个模块,网络连接函数,消息回调函数,测距函数,接着调用连网函数然后再将MQTT客户端实例化,实例化时要传客户端名称和MQTT服务器IP,然后设置回调函数并建立客户端和服务器之间的连接,订阅"Data"主题。如果该主题的内容时"Distance",那就向服务器发送测距函数返回的值,这时候其他订阅该主题的客户端就会收到距离的数据

# umqttsimple.py

import usocket as socket
import ustruct as struct
from ubinascii import hexlify


class MQTTException(Exception):
    pass


class MQTTClient:
    def __init__(
        self,
        client_id,
        server,
        port=0,
        user=None,
        password=None,
        keepalive=0,
        ssl=False,
        ssl_params={
    
    },
    ):
        if port == 0:
            port = 8883 if ssl else 1883
        self.client_id = client_id
        self.sock = None
        self.server = server
        self.port = port
        self.ssl = ssl
        self.ssl_params = ssl_params
        self.pid = 0
        self.cb = None
        self.user = user
        self.pswd = password
        self.keepalive = keepalive
        self.lw_topic = None
        self.lw_msg = None
        self.lw_qos = 0
        self.lw_retain = False

    def _send_str(self, s):
        self.sock.write(struct.pack("!H", len(s)))
        self.sock.write(s)

    def _recv_len(self):
        n = 0
        sh = 0
        while 1:
            b = self.sock.read(1)[0]
            n |= (b & 0x7F) << sh
            if not b & 0x80:
                return n
            sh += 7

    def set_callback(self, f):
        self.cb = f

    def set_last_will(self, topic, msg, retain=False, qos=0):
        assert 0 <= qos <= 2
        assert topic
        self.lw_topic = topic
        self.lw_msg = msg
        self.lw_qos = qos
        self.lw_retain = retain

    def connect(self, clean_session=True):
        self.sock = socket.socket()
        addr = socket.getaddrinfo(self.server, self.port)[0][-1]
        self.sock.connect(addr)
        if self.ssl:
            import ussl

            self.sock = ussl.wrap_socket(self.sock, **self.ssl_params)
        premsg = bytearray(b"\x10\0\0\0\0\0")
        msg = bytearray(b"\x04MQTT\x04\x02\0\0")

        sz = 10 + 2 + len(self.client_id)
        msg[6] = clean_session << 1
        if self.user is not None:
            sz += 2 + len(self.user) + 2 + len(self.pswd)
            msg[6] |= 0xC0
        if self.keepalive:
            assert self.keepalive < 65536
            msg[7] |= self.keepalive >> 8
            msg[8] |= self.keepalive & 0x00FF
        if self.lw_topic:
            sz += 2 + len(self.lw_topic) + 2 + len(self.lw_msg)
            msg[6] |= 0x4 | (self.lw_qos & 0x1) << 3 | (self.lw_qos & 0x2) << 3
            msg[6] |= self.lw_retain << 5

        i = 1
        while sz > 0x7F:
            premsg[i] = (sz & 0x7F) | 0x80
            sz >>= 7
            i += 1
        premsg[i] = sz

        self.sock.write(premsg, i + 2)
        self.sock.write(msg)
        # print(hex(len(msg)), hexlify(msg, ":"))
        self._send_str(self.client_id)
        if self.lw_topic:
            self._send_str(self.lw_topic)
            self._send_str(self.lw_msg)
        if self.user is not None:
            self._send_str(self.user)
            self._send_str(self.pswd)
        resp = self.sock.read(4)
        assert resp[0] == 0x20 and resp[1] == 0x02
        if resp[3] != 0:
            raise MQTTException(resp[3])
        return resp[2] & 1

    def disconnect(self):
        self.sock.write(b"\xe0\0")
        self.sock.close()

    def ping(self):
        self.sock.write(b"\xc0\0")

    def publish(self, topic, msg, retain=False, qos=0):
        pkt = bytearray(b"\x30\0\0\0")
        pkt[0] |= qos << 1 | retain
        sz = 2 + len(topic) + len(msg)
        if qos > 0:
            sz += 2
        assert sz < 2097152
        i = 1
        while sz > 0x7F:
            pkt[i] = (sz & 0x7F) | 0x80
            sz >>= 7
            i += 1
        pkt[i] = sz
        # print(hex(len(pkt)), hexlify(pkt, ":"))
        self.sock.write(pkt, i + 1)
        self._send_str(topic)
        if qos > 0:
            self.pid += 1
            pid = self.pid
            struct.pack_into("!H", pkt, 0, pid)
            self.sock.write(pkt, 2)
        self.sock.write(msg)
        if qos == 1:
            while 1:
                op = self.wait_msg()
                if op == 0x40:
                    sz = self.sock.read(1)
                    assert sz == b"\x02"
                    rcv_pid = self.sock.read(2)
                    rcv_pid = rcv_pid[0] << 8 | rcv_pid[1]
                    if pid == rcv_pid:
                        return
        elif qos == 2:
            assert 0

    def subscribe(self, topic, qos=0):
        assert self.cb is not None, "Subscribe callback is not set"
        pkt = bytearray(b"\x82\0\0\0")
        self.pid += 1
        struct.pack_into("!BH", pkt, 1, 2 + 2 + len(topic) + 1, self.pid)
        # print(hex(len(pkt)), hexlify(pkt, ":"))
        self.sock.write(pkt)
        self._send_str(topic)
        self.sock.write(qos.to_bytes(1, "little"))
        while 1:
            op = self.wait_msg()
            if op == 0x90:
                resp = self.sock.read(4)
                # print(resp)
                assert resp[1] == pkt[2] and resp[2] == pkt[3]
                if resp[3] == 0x80:
                    raise MQTTException(resp[3])
                return

    # Wait for a single incoming MQTT message and process it.
    # Subscribed messages are delivered to a callback previously
    # set by .set_callback() method. Other (internal) MQTT
    # messages processed internally.
    def wait_msg(self):
        res = self.sock.read(1)
        self.sock.setblocking(True)
        if res is None:
            return None
        if res == b"":
            raise OSError(-1)
        if res == b"\xd0":  # PINGRESP
            sz = self.sock.read(1)[0]
            assert sz == 0
            return None
        op = res[0]
        if op & 0xF0 != 0x30:
            return op
        sz = self._recv_len()
        topic_len = self.sock.read(2)
        topic_len = (topic_len[0] << 8) | topic_len[1]
        topic = self.sock.read(topic_len)
        sz -= topic_len + 2
        if op & 6:
            pid = self.sock.read(2)
            pid = pid[0] << 8 | pid[1]
            sz -= 2
        msg = self.sock.read(sz)
        self.cb(topic, msg)
        if op & 6 == 2:
            pkt = bytearray(b"\x40\x02\0\0")
            struct.pack_into("!H", pkt, 2, pid)
            self.sock.write(pkt)
        elif op & 6 == 4:
            assert 0

    # Checks whether a pending message from server is available.
    # If not, returns immediately with None. Otherwise, does
    # the same processing as wait_msg.
    def check_msg(self):
        self.sock.setblocking(False)
        return self.wait_msg()
# main.py

import time
import network
from umqttsimple import MQTTClient
from machine import Pin, PWM


def do_connect():
    wlan = network.WLAN(network.STA_IF)
    wlan.active(True)
    if not wlan.isconnected():
        print('connecting to network...')
        wlan.connect('SSID', 'password')
        i = 1
        while not wlan.isconnected():
            print("正在链接...{}".format(i))
            i += 1
            time.sleep(1)
    print('network config:', wlan.ifconfig())


def sub_cb(topic, msg, distance): # 回调函数,收到服务器消息后会调用这个函数
    print(topic, msg)
    
    if topic.decode("utf-8") == "data" and msg.decode("utf-8") == "distance":
        c.publish(b"data", str(distance))
        
            
    
def measure(trig, echo):
    trig.value(1)
    time.sleep_us(10)
    trig.value(0)
    while echo.value() == 0:
        t1 = time.ticks_us()
        print("---------------------")
        print(t1)
    # 检测回响信号,为高电平时,测距开始
    while self.echo.value() == 1:
        # 开始不断递增的微秒计数器 2
        t2 = time.ticks_us()
    
        print(t2)
        t3 = time.ticks_diff(t2, t1) / 10000
        print(t3, t2-t1)
        return t3 * 340 / 2

    
            # 1. 联网
do_connect()
trig = Pin(14, Pin.OUT)
echo = Pin(12, Pin.IN)

# 2. 创建mqt
c = MQTTClient("umqtt_client", "192.168.31.195")  # 建立一个MQTT客户端
c.set_callback(sub_cb)  # 设置回调函数
c.connect()  # 建立连接
c.subscribe(b"data")

while True:
    distance = measure(trig, echo)
    c.check_msg()
    time.sleep(1)

3、创建MQTT服务器和其它MQTT客户端

博主之前在树莓派4B上用docker拉取EMQX的镜像创建了一个MQTT服务器,当然你也可以拉取mosquitto、rabbitmq的镜像,并创建本地的MQTT服务器,IP地址就是树莓派的IP

在这里插入图片描述

创建完MQTT服务器后访问 https://mqttx.app/zh,在电脑上下载MQTT客户端

在这里插入图片描述

下载完后创建一个客户端,Name 和 Client ID自己创建,Host 地址填MQTT服务器的地址,端口默认1883,然后连接

在这里插入图片描述
连接完后发送相应的话题和内容即可,比如电脑客户端上你发送"Distance"的订阅话题,你就会收到距离的数据返回;再例如你发送"led"的发布话题和"on"的数据,esp32上的灯就会亮,这样就可以实现局域网内远程控制。

总结

以上是Micropython开发esp32入门笔记的内容,本文简单介绍了esp32基于MQTT协议的外设开发。MQTT协议是物联网IOT框架下的最热门的协议之一,它为小型设备互联,实现一对多,多对一的信息传输提供了极大发展空间。

猜你喜欢

转载自blog.csdn.net/m0_55202222/article/details/129371125