目录

前言

什么是MQTT？

MQTT适用于哪些场景？

MQTT协议应用示例

报文格式

固定报头

可变报头

有效载荷

实例讲解

连接MQTT服务器（客户端->服务器）

确认连接（服务器->客户端)

订阅主题（客户端->服务器）

确认订阅（服务器->客户端）

发布消息（qos0）

硬件准备及接线方式

硬件准备

接线方式

连接MQTTX服务器测试

代码

测试效果

相关链接

---

前言

        上一章我们用开发板通过SNTP协议获取网络时间SNTP协议获取网络时间SNTP协议获取网络时间，本章我们介绍一下MQTT协议的内容以及把开发板当成MQTT客户端来连接到测试服务器进行发布和订阅功能的实现。

什么是MQTT？

        MQTT是一种轻量级的消息传输协议，旨在物联网（IoT）应用中实现设备间的可靠通信。它使用发布-订阅模式，其中包括一个MQTT服务端（代理或服务器）和多个MQTT客户端之间的通信。MQTT协议具有以下特点：

• 轻量级：MQTT协议设计简单，协议头部开销小，适用于资源受限的设备和网络。
• 低带宽消耗：MQTT采用二进制编码，有效地利用网络带宽。
• 异步通信：客户端可以随时发布和订阅消息，无需等待对方的响应。
• 发布-订阅模式：消息发布者将消息发布到特定的主题，而订阅者则订阅感兴趣的主题。这种模式支持松耦合的通信和灵活的消息传递。

MQTT适用于哪些场景？

1. 物联网数据采集及监控平台：MQTT可以用于从各种传感器和物联网设备（如温度传感器、湿度传感器、气压传感器、光照传感器等）收集数据，实时检测设备工作状况，汇总数据并进行可视化监控。
2. 智能家居或智慧城市系统：MQTT可以用于家庭设备、家庭安防、门禁系统、电梯管理、智慧路灯等设备之间的通信和协调，实现智能家居或智慧城市系统。
3. 物流及交通管理系统：MQTT可以用于车辆、机器人和其他物理设备之间的通信和协作，例如智能导航、智能停车、智能交通灯等。

MQTT协议应用示例

        首先我们介绍一下MQTT协议的报文组成结构。

报文格式

        MQTT控制报文由三部分组成，分别是固定报头，可变报头，有效载荷。

固定报头

        固定报头最少由两个字节组成，第一个字节的7-4位为协议类型，3-0位为标志位，从第二个字节开始为剩余长度（包括可变报头和有效载荷的长度）

        协议类型具体定义可参考下表：

        标志位可以参考下表：

        其中：

        DUP1 = 控制报文的重复分发标志

        QoS2 = PUBLISH 报文的服务质量等级

        RETAIN3 = PUBLISH 报文的保留标志

        协议类型示例如下表：

        剩余长度字段最多四个字节，最少一个字节，具体长度如下表所示：

        其中，每个字节的6-0位用于编码数据，第7位是标志位，为1则表示下一个字节也是剩余长度字段。

可变报头

        某些控制报文包含可变报头，它在固定报头（Fixed header）和有效载荷（Payload）之间。每个协议的可变报头都不一样。

        其中大多数协议都会有的字段是报文标识符。

        可变报头在各个控制报文的详细内容中再展开讲解。

有效载荷

        有效载荷是除控制报文格式以外的有效信息，CONNECT、PUBLISH、SUBSCRIBE等需要传递有效信息的协议帧都需要。

实例讲解

        MQTT报文的具体格式可以参考文档：MQTT Version 3.1.1 (oasis-open.org)

        两个MQTT客户端通信流程如下图所示：

        接下来演示客户端进行连接订阅发布的报文交互过程。

连接MQTT服务器（客户端->服务器）

（注：所有命令都为HEX格式)

10 21 00 04 4D 51 54 54 04 C2 00 3C 00 08 63 6C 69 65 6E 74 69 64 00 04 4D 51 54 54 00 05 77 35 35 30 30

报文具体描述如下：

//固定报头，10代表为请求连接

10 21(剩余33个字节)

//可变报头

00 04 4D 51 54 54 04 C2 00 3C

        具体定义可参考下图：

        以下为有效载荷部分，可变报头中的标志决定是否包含这些字段。如果包含的话，必须按这个顺序出现：客户端标识符，遗嘱主题，遗嘱消息，用户名，密码。

//clientid，长度8字节，文本内容为clientid

00 08 63 6C 69 65 6E 74 69 64

//用户名，长度4字节，文本内容为MQTT

00 04 4D 51 54 54

//密码，长度5字节，文本内容为w5500

00 05 77 35 35 30 30

确认连接（服务器->客户端)

//连接成功，会话为新会话

20 02 00 00

        其中第一个字节为固定报头，协议类型为连接请求回复，长度为2字节，第三个字节为是否为新会话（0新会话，1旧会话），第四个字节为连接返回码，具体定义如下图所示：

订阅主题（客户端->服务器）

82 0A 00 01 00 05 74 6F 70 39 63 00

//固定报头，剩余长度10字节

82 0A

//可变报头

00 01

//有效载荷（长度5字节，内容为topic，qos为0）

00 05 74 6F 70 39 63 00

        具体定义如下图所示：

确认订阅（服务器->客户端）

90 03 00 01 00

//固定报头，剩余长度3字节

90 03

//可变报头

00 01

//有效载荷，回复订阅qos为0

00

发布消息（qos0）

//固定报头，qos0消息，非重传，非保留，剩余长度10字节

30 14

//可变报头，5个字节的主题“topic”

00 05 74 6F 70 69 63

//有效载荷为消息内容“message”

6D 65 73 73 61 67 65

硬件准备及接线方式

硬件准备

1. W5500-EVB-Pico开发板或W5500IO模块+树莓派RP2040
2. 数据线、网线
3. 路由器
4. PC

接线方式

1. W5500-EVB-Pico网口通过网线接入路由器，通过USB数据线接入PC端。
2. 如为W5500IO模块+树莓派RP2040的组合，则将W5500通过网线接入到路由器，将RP2040通过USB数据线接入PC端。然后将W5500IO模块按照以下方式连接至RP2040。

• W5500IO_MISO->RP2040_GPIO16
• W5500IO_MOSI->RP2040_GPIO19
• W5500IO_CS->RP2040_GPIO17
• W5500IO_SCK->RP2040_GPIO18
• W5500IO_RST->RP2040_GPIO20

连接MQTTX服务器测试

        程序的运行框图如下所示：

代码

       在主函数中，我们还是进行初始化w5500芯片，然后再连接MQTT服务器，当连接完成之后，我们发布一条消息，最后在主循环中监听来自服务器中的消息以及进行保活。

int main()
{
    struct repeating_timer timer;
    stdio_init_all();
    sleep_ms(3000);
    printf("W5500 mqtt example.\r\n");

    wizchip_initialize(); // SPI初始化以及链路状态检测

    wizchip_setnetinfo(&net_info); // 设置网络地址信息

    print_network_information(net_info);                               // 打印网络地址信息
    add_repeating_timer_ms(1, repeating_timer_callback, NULL, &timer); // 开启1ms循环定时器
    mqtt_init();                                                       // MQTT连接订阅
    send_mqtt(mqtt_params.pubtopic, "Hello MQTT!");                    // 发布一条消息
    while (true)
    {
        keep_mqtt(); //监听及保活
    }
}

        其中mqtt初始化函数如下所示，需要注意的是，在订阅时，订阅函数的第四个参数为消息处理回调函数，当接收到该订阅主题的消息，会进入消息回调函数。

void mqtt_init(void)
{
    int ret;
    MQTTPacket_connectData data = MQTTPacket_connectData_initializer;
    NewNetwork(&n, MQTT_SOCKET);
    ConnectNetwork(&n, mqtt_params.server_ip, 1883);
    MQTTClientInit(&c, &n, 1000, mqtt_send_buff, MQTT_SEND_BUFF_SIZE, mqtt_recv_buff, MQTT_RECV_BUFF_SIZE);
    data.willFlag = 0;
    data.MQTTVersion = 3;
    data.clientID.cstring = mqtt_params.clientid;
    data.username.cstring = mqtt_params.username;
    data.password.cstring = mqtt_params.passwd;
    data.keepAliveInterval = 30;
    data.cleansession = 1;

    // 连接mqtt服务器，并打印连接状态
    connOK = MQTTConnect(&c, &data);
    printf("Connected:%s\r\n", connOK == 0 ? "success" : "failed");

    // 订阅主题，绑定消息回调函数，并打印订阅状态
    ret = MQTTSubscribe(&c, mqtt_params.subtopic, mqtt_params.QOS, messageArrived);
    printf("Subscribing to %s\r\n", mqtt_params.subtopic);
    printf("Subscribed:%s\r\n", ret == 0 ? "success" : "failed");
}

        消息处理回调函数如下，可根据自己要求自行更改。

void messageArrived(MessageData *md)
{
    unsigned char messagebuffer[512];
    MQTTMessage *message = md->message;
    printf("%s%s%s%.*s%s%s", "topic:", md->topicName, "\r\nRX:", (int)message->payloadlen, (char *)message->payload, mqtt_params.QOS, "\r\n");
}

        然后是MQTT监听及保活函数。

void keep_mqtt(void)
{
    MQTTYield(&c, 30);//第二个参数为保活间隔时间
}

        最后一定要注意，必须将MQTT库中的1ms滴答定时器绑定到我们创建的1ms定时器上。

bool repeating_timer_callback(struct repeating_timer *t)
{
    MilliTimer_Handler();
    return true;
}

测试效果

        将程序编译烧录后，打开串行监视器，可以看到，成功连接并且订阅上主题，还发布了一条信息。

        在MQTTX上我们也能收到开发板发布的消息，我们在MQTTX发布一条消息出去。开发板也同样能收到。

相关链接

        本章例程链接：mqtt_client examplehttps://gitee.com/wiznet-hk/w5500-evb-pico-routine/tree/master/examples/mqtt_client