W5100S_EVB_PICO快速入门之MQTT篇（十二）

目录

1. 前言       

2. MQTT介绍

2.1 什么是mqtt？

2.2 特点

2.3 应用场景

2.4 MQTT协议实现方式

3. 硬件及接线方式

3.1 硬件准备

3.2 硬件介绍

3.3 接线图

4. 测试

4.1 MQTT测试流程图

4.2 相关代码

4.3 测试现象

5. 相关链接： 

---

1. 前言       

        随着物联网技术的快速发展，MQTT（Message Queuing Telemetry Transport）协议已成为一种广泛使用的通讯协议，它适用于设备间低带宽、高延迟、不可靠的网络通信。W5500是一款集成全硬件 TCP/IP 协议栈的嵌入式以太网控制器，同时也是一颗工业级以太网控制芯片。在以太网应用中使用 W5500 + MQTT应用协议让用户可以更加方便地在设备之间实现远程连接和通信。本教程将介绍W5500以太网MQTT应用的基本原理、使用步骤、应用实例以及注意事项，帮助读者更好地掌握这一技术。

2. MQTT介绍

2.1 什么是mqtt？

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

2.2 特点

1. 轻量级：MQTT协议非常轻量，它的开销很小，适用于低带宽、低功耗设备和网络。
2. 发布/订阅模式：MQTT采用发布/订阅模式，客户端可以订阅一个或多个主题（Topic），并且可以在不知道其他客户端的情况下发布消息到主题。
3. QoS支持：MQTT支持三种服务质量（QoS）等级，可以在发布和订阅时指定。 这些等级为0、1、2，提供不同的消息传递保证。
4. 遗嘱机制：MQTT支持遗嘱（Will）机制，当客户端异常断开连接时，可以通过遗嘱机制通知其他客户端。
5. 保留消息：MQTT支持保留消息（Retained Message），允许客户端发布一个保留的消息到主题，而后连接到该主题的新订阅者可以立即接收到该消息。
6. 连接控制：MQTT支持连接控制机制，允许客户端在连接时指定自己的客户端ID、用户名和密码。
7. 安全性：MQTT支持TLS/SSL加密通信协议，以确保数据的安全传输。
8. 基于 TCP/IP 网络连接

2.3 应用场景

1. 科学研究：在科学研究中，需要对实验数据进行采集和传输，使用MQTT协议可以有效地解决数据传输过程中的丢包问题，保证数据传输的稳定性和完整性。
2. 金融行业：在金融行业中，需要对交易信息进行实时监控和传输，使用MQTT协议可以实现实时监控和传输，并保证数据的稳定性和安全性。
3. 医疗行业：在医疗行业中，需要对患者的生命体征进行采集和传输，使用MQTT协议可以有效地解决数据传输过程中的丢包问题，保证数据传输的稳定性和完整性。
4. 能源行业：在能源行业中，需要对能源设备进行监控和控制，MQTT协议正是满足这一需求而设计的，它具有简单、可靠、灵活等特点，在能源领域中得到了广泛应用。

2.4 MQTT协议实现方式

        实现MQTT协议需要客户端和服务器端通讯完成，在通讯过程中，MQTT协议中有三种身份：发布者（Publish）、代理（Broker）（服务器）、订阅者（Subscribe）。其中，消息的发布者和订阅者都是客户端，消息代理是服务器，消息发布者可以同时是订阅者。

MQTT传输的消息分为：主题（Topic）和负载（payload）两部分：

（1）Topic，可以理解为消息的类型，订阅者订阅（Subscribe）后，就会收到该主题的消息内容（payload）；

（2）payload，可以理解为消息的内容，是指订阅者具体要使用的内容。

3. 硬件及接线方式

3.1 硬件准备

1. W5100S-EVB-Pico开发板
2. USB数据线、网线
3. 路由器
4. pc

3.2 硬件介绍

        W5100S-EVB-Pico是基于树莓派RP2040和全硬件TCP/IP协议栈控制器W5100S的微控制器开发板-基本上与树莓派Pico板相同，但通过W5100S芯片增加了以太网功能。

        W5100S采用WIZnet技术的硬件TCP / IP设计的一款嵌入式以太网控制器。在使用 W5100S时MCU 可以方便的处理 IPv4，TCP，UDP，ICMP，IGMP，ARP，PPPoE等TCP/IP 协议。W5100S 分别有 8KB 的发送缓存和接收缓存，可以减少MCU 的开销。 主机可以同时使用 W5100S 的 4 个独立的硬件SOCKETs，并基于每个硬件SOCKET 开发独立的互联网应用。

3.3 接线图

4. 测试

4.1 MQTT测试流程图

4.2 相关代码

        我们打开例程中库文件的mqttx_client.c文件用到几个函数和定义：

        1.首先我们是对收发缓存大小和收发缓存数组进行定义

        2.然后创建一个 MQTTCONNECTION结构体，里面的参数有mqttHostUrl服务器网址，port端口号，clientid客户端id，username用户名，password密码，server_ip服务器ip，pubtopic发布主题，subtopic1订阅主题，QOS发布服务质量等级。

3.接下就是定义了一个mqtt_params结构体，将结构体的参数填写进去，其中mqttHostUrl服务器网址和server_ip服务器ip填写其中一个就可以，端口固定为1883，clientid客户端id，clientid客户端id不能与同一个服务器下的clientid客户端id重名，username用户名，password密码可以任意填，也可以选择不填，订阅和发布根据自己来定，保证与另一端客户端进行通信并且不受到别人干扰。服务质量等级也是根据自己的需求来定，这里定义的是0，消息最多传送一次。如果当前客户端不可用，它将丢失这条消息

#define SOCKET_ID 0
#define ETHERNET_BUF_MAX_SIZE (1024 * 2)

#define MQTT_SEND_BUFF_SIZE 2048
#define MQTT_RECV_BUFF_SIZE 2048
uint8_t mqtt_send_buff[MQTT_SEND_BUFF_SIZE] = {0};
uint8_t mqtt_recv_buff[MQTT_RECV_BUFF_SIZE] = {0};
typedef struct MQTTCONNECTION
{
    char mqttHostUrl[1024];
    int port;
    char clientid[1024];
    char username[1024];
    char passwd[1024];
    uint8_t server_ip[4];
    char pubtopic[255];
    char subtopic1[255];
    int QOS;
} mqttconn;
mqttconn mqtt_params = {
    .server_ip = {54,244,173,190},
    .port = 1883,
    .clientid = "9a1d7719a8ac40d29311f26c5c5469dc",
    .username = "mqtt_username",
    .passwd = "123456",
    .pubtopic = "1234",
    .subtopic1 = "2345",
    .QOS = 0,
};

        1.定义一个net_info的结构体对静态网络参数进行配置，mac地址不能与已经存在的mac地址有重复，首位不能为偶数，ip地址的设置如果连接路由器这必须与路由器在同一网段，并且不能与路由器已经存在的ip有冲突，下来是sn子网掩码（常用的是255.255.255.0）和gw网关（路由器ip）dns域名解析服务器，然后dhcp设为静态获取网络

void network_init(void);
wiz_NetInfo net_info = {
    .mac = {0x00, 0x08, 0xdc, 0x16, 0xed, 0x2e},
    .ip = {192, 168, 124, 10},
    .sn = {255, 255, 255, 0},
    .gw = {192, 168, 124, 1},
    .dns = {8, 8, 8, 8},
    .dhcp = NETINFO_STATIC};
MQTTClient c = {0};  

        1.定义MQTTPacket_connectData 类型的结构体初始化连接协议、版本、心跳包的参数

        2.NewNetwork是网络设置函数，需传入的参数是网络配置的结构体指针和socket号

        3.ConnectNetwork是连接网络函数，需传入的参数是socket号、服务器ip、端口号

        4.MQTTClientInit是客户端初始化函数，需传入mqtt连接配置的结构体指针和网络配置的结构体指针、命令超时时间/ms、发送缓存和发送缓存大小、接收缓存和接收缓存大小。

        5.将得到的数据存入到结构体 MQTTPacket_connectData中

        6.MQTTConnect函数和MQTTSubscrib函数是查看监测是否连接服务器和订阅上主题，如果返回值为0则表示成功

void mqtt_init(void)
{
    int ret;

    MQTTPacket_connectData data = MQTTPacket_connectData_initializer;
    NewNetwork(&n, 1);
    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;
    connOK = MQTTConnect(&c, &data);
    printf("Connected:%s\r\n", connOK == 0 ? "success" : "failed");
    printf("Subscribing to %s\r\n", mqtt_params.subtopic1);
    ret = MQTTSubscribe(&c, mqtt_params.subtopic1, mqtt_params.QOS, messageArrived);
    printf("Subscribed:%s\r\n", ret == 0 ? "success" : "failed");
   
    sleep_ms(300);
    MQTTMessage pubmessage={
        .qos=QOS2,
        .dup=0,
        .retained=0,
        .id=0,
    };
    pubmessage.payload="hello mqtt!\r\n";
    pubmessage.payloadlen=strlen(pubmessage.payload);
    MQTTPublish(&c,mqtt_params.pubtopic,&pubmessage);
}

        messageArrived发布消息函数，传入参数是MessageData的结构体，里面主题和消息，函数里面主要是对发布消息的服务等级的判断。
        keep_alive心跳包保活函数，此函数必须放在主循环函数中

void messageArrived(MessageData* md)
{
    unsigned char messagebuffer[512];
    MQTTMessage* message = md->message;
    if (mqtt_params.QOS)
    {
        memcpy(messagebuffer,(char*)message->payload,(int)message->payloadlen);
        *(messagebuffer + (int)message->payloadlen + 1) = '\n';
        printf("%s\r\n",messagebuffer);
    }
    if (mqtt_params.QOS)
        printf("%.*s", (int)message->payloadlen, (char*)message->payload);
    else
        printf("%s%.*s%s%s", "RX:",(int)message->payloadlen, (char*)message->payload, mqtt_params.QOS,"\r\n");
}
void keep_alive(void)
{
    if (!connOK)
    {
        if (MQTTYield(&c, 30))
        {
            mqtt_init();
        }
    }
}
         主函数：主要是对串口和网络还有mqtt进行初始化

int main()                                                          
{   
    struct repeating_timer timer;
    stdio_init_all();
    sleep_ms(2000);
    wizchip_initialize();
    wizchip_setnetinfo(&net_info);
    print_network_information(net_info);
    add_repeating_timer_ms(1, repeating_timer_callback, NULL, &timer);
    mqtt_init();
    while(true)
    {
        // loopback_udpc(SOCKET_ID, ethernet_buf, destip, destport);
        keep_alive();
        sleep_ms(10);
    }
    
}

          烧录完程序后打开MQTTX工具信息配置好mqtt的信息。

        订阅和发布（对应代码上的订阅与发布信息）。

4.3 测试现象

        我们可以看到串口打印信息中打印了网络连接上且配置好网络信息，最后连接上了mqttx上的mqtt公共服务器。

        打开mqttx可以到由W5100S_EVB_PICO发来的“hello mqtt”，表示订阅成功。

         用mqttx切换到发布消息，将信息发送给W5100S_EVB_PICO。

 

        最后可以看到串口打印了mqttx下发的消息，表示发布成功。

5. 相关链接： 

        本章例程链接：mqtt_cliten example