一分钟了解MQTT协议 ESP32/ESP8266 MQTT API指南

已于 2022-05-07 11:15:47 修改
阅读量1.4k 收藏 18
点赞数 1
分类专栏： MQTT 文章标签： 物联网 网络 网络协议
于 2022-05-07 11:14:58 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u012507643/article/details/124626921
版权

文章目录

MQTT协议

MQTT协议是一个应用层协议，他要求使用的传输层协议能提供有序的，可靠的双向字节流传输服务。

MQTT协议通信对象分为客户端和服务端，数据的传输以消息为单位，每个消息包含主题，消息服务质量和有效数据。消息的发送和接收都需要依赖主题：A订阅主题T1，B订阅主题T2，A想发送消息给B，就需要将消息发送到主题T2。

一，客户端

通信双方的身份。mqtt通信双方都是客户端，消息传递是以订阅主题的形式。

  • 发布消息到服务端以转发到其他客户端
  • 订阅主题以接收其他客户端的消息
  • 发起连接/断开

二，服务端

作为客户端与客户端之间通信的中介。

  • 接收客户端发布的消息
  • 接收客户端的连接
  • 转发消息给特定的客户端
  • 接收客户端的订阅主题请求

三，消息服务质量

消息服务质量决定了一个MQTT报文的消息应如何处理。

  • qos0：客户端仅讲报文发送一次，服务端不需要应答，报文是否送达不保证。
  • qos1：客户端发送报文，服务端接收到后必须应答，超时重发。
  • qos2：客户端发送报文，服务端接收到后应答，客户端再次发送一个release报文，服务端发送该报文到指定主题下的客户端，并应答。

qos0-qos2，服务的质量逐步提高。qos2能使客户端对报文的发送有全局的掌控。qos0很不负责任，嫁出去的女儿泼出去的水，不管了。qos1还行。

四，主题

MQTT主题是一个字符串，由服务端维护。客户端通过在服务端订阅主题，可接收来自该主题的消息。客户端可向该主题发送消息，所有订阅该主题的客户端都会受到该消息。实现的方式是：客户端向服务端发送带主题的消息到服务端，由服务端将消息转发给订阅该主题的客户端，所以服务端地位重要。

MQTT主题支持分级，如/Home/BathRoom/Mirror，/Home/LivingRoom/Tv，是同一等级下的主题。

主题也支持通配符#，发送消息到主题 /Home/# 则BathRoom和LivingRoom主题下的客户端都会收到消息。

主题也支持单层通配符+，/Home/+ 则BathRoom和LivingRoom主题下的客户端会受到消息，但/Home/BathRoom/Mirror和/Home/LivingRoom/Tv 不会收到消息，这点需要跟#区别。

五，MQTT控制报文

MQTT协议依靠MQTT控制报文来通信
在这里插入图片描述

5.1 固定报头

表示控制报文的类型，报文的一些标志位（包括消息服务质量），以及报文剩余的字节长度。

5.2 可变报头

可变报头的内容跟报文类型有关。

包含报文标识符，一个16bit的数据，用于唯一的标记此次通信的报文。当客户端处理完当前报文后，标识符可释放重用。qos0的消息不需要标识符，因为不需要服务端的应答。

5.3 有效载荷

前面都是协议规定必须的，有效载荷是真正的用户数据。不同类型的报文，有效载荷里的数据不同。

5.4 控制报文类型

不同类型的报文，其不同点在于可变报头及有效载荷。就以这两部分看看主要的报文：

5.4.1 连接报文

  • 可变报头：包含 “使用传输层协议名”（TCP），MQTT协议等级（3.1.1）,连接标志，保持连接。

连接标志：指示有效载荷部分的内容。

保持连接：MQTT客户端需要在一个时间内给服务端发送心跳报文，服务端也要在规定时间内应答。由此判断通信双方是否在线。

  • 有效载荷

由连接标志指示其内容，出现的顺序为：**客户端标识符，遗嘱主题，遗嘱消息，**用户名，密码。

客户端标志：字符串，用于唯一标志一个客户端。

遗嘱：是一种错误补救方式，当客户端以异常方式断开连接时，服务端长时间未能联系到客户端，则服务端将该客户端的遗嘱消息发布到遗嘱主题。

用户名和密码：字符串，用于识别客户端是否合法。

5.4.2 发布publish

  • 固定报头：
    在这里插入图片描述
    DUP：重发标志，是否是一个重发的报文，qos0大咩。

RETAIN:保留标志位。若为1，服务端需要在内存中保留该消息。

  • 可变报头：主题及报文标识符
  • 有效载荷：应用数据，一般是json字符串。

5.4.3 订阅主题subscribe

可订阅多个主题

  • 有效载荷：包含一个主题过滤器表示客户端要订阅的主题，消息服务质量qos。主题过滤器是一个字符串，后面跟着一个字节的消息服务质量，组成一组，一个订阅报文可包含多组这样的东西，来支持订阅多个主题。

六，安全

安全的实现主要依赖于传输层协议，推进TLS协议服务端使用8883端口。

轻量加密AES

ESP-MQTT API 指南

概括

ESP-MQTT是一个MQTT协议客户端的应用程序

一，特性

  • 支持多种传输层协议如：TCP,SSL,Websocket,wws.
  • 使用url建立连接
  • 允许一个应用中多个客户端
  • 支持订阅，发布，认证，遗嘱，保活和3个消息质量

二，应用示例

三，初始化配置

3.1 URI

  • 当前支持mqtt，mqtts，ws，wss方式

  • mqtt 使用tcp例子：

    • mqtt://mqtt.eclipse.org: MQTT over TCP, default port 1883
    • mqtt://mqtt.eclipse.org:1884 MQTT over TCP, port 1884
    • mqtt://username:password@mqtt.eclipse.org:1884 MQTT over TCP, port 1884, with username and password

  • MQTT over SSL samples:

    • mqtts://mqtt.eclipse.org: MQTT over SSL, port 8883
    • mqtts://mqtt.eclipse.org:8884: MQTT over SSL, port 8884

  • MQTT over Websocket samples:

    • ws://mqtt.eclipse.org:80/mqtt

  • MQTT over Websocket Secure samples:

    • wss://mqtt.eclipse.org:443/mqtt

  • 最小配置:

    const esp_mqtt_client_config_t mqtt_cfg = {
    .uri = "mqtt://mqtt.eclipse.org",
    // .user_context = (void *)your_context
};
esp_mqtt_client_handle_t client = esp_mqtt_client_init(&mqtt_cfg);

//注册回调函数
esp_mqtt_client_register_event(client, ESP_EVENT_ANY_ID, mqtt_event_handler, client);
esp_mqtt_client_start(client);

  • 注意，默认mqtt客户端使用事件句柄来处理mqtt的事件，如连接，订阅，发布等等。

3.2 SSL

3.3 遗嘱

MQTT支持使用遗嘱消息，当客户端意外断开连接时，遗嘱消息被服务端发送并用于通知其他客户端。在 esp_mqtt_client_config_t 中可配置遗嘱消息：

  • lwt_topic ：指向遗嘱消息的主题
  • lwt_msg：指向遗嘱消息
  • lwt_msg_len：消息有效载荷长度
  • lwt_qos：消息服务质量
  • lwt_retain：是否保留

3.4 其他配置参数

  • disable_clean_session：默认清除会话，对于连接消息，该参数关闭清除会话标志
  • keepalive：保活时间，默认120s
  • disable_auto_reconnect：关闭自动重连
  • user_context：本地参数，用于传递到事件处理句柄
  • task_prio：mqtt任务等级，默认5
  • task_stack：mqtt堆栈默认6144 bytes，menuconfig可配置
  • buffer_size：接收和缓存的长度，默认1024 bytes
  • username：连接到broker的用户名（服务器）
  • password：连接到broker的密码（服务器）
  • client_id：指向客户端id，一般是一个唯一的字符串，可从broker中获取
  • host：MQTT broker的ip地址，域名。设置了url会重写该参数
  • port：MQTT broker的端口。设置了url会重写该参数
  • transport：设置传输协议。设置了url会重写该参数
  • refresh_connection_after_ms：在多少时间（ms）后刷新连接
  • event_handle：处理mqtt事件的回调函数
  • event_loop_handle：mqtt事件组库

更多esp_mqtt_client_config_t的选项，请参考下面API：

3.5 项目配置菜单来配置mqtt

通过idf.py menuconfig项目配置菜单来配置mqtt，在Component config -> ESP-MQTT Configuration

下面的设置是可行的：

3.6 事件

mqtt主要围绕以下事件进行数据的处理：

  • MQTT_EVENT_BEFORE_CONNECT：客户端初始化完成并开始连接到broker
  • MQTT_EVENT_CONNECTED：客户端成功与broker建立连接，客户端准备好接收发送数据
  • MQTT_EVENT_DISCONNECTED：客户端由于无法接收或者发送消息而断开连接
  • MQTT_EVENT_SUBSCRIBED：broker 确认客户端的订阅请求。保留订阅消息的id
  • MQTT_EVENT_UNSUBSCRIBED：broker确认了客户端的取消订阅消息。保留取消订阅消息的id
  • MQTT_EVENT_PUBLISHED：broker确认了用户发布的消息。仅对qos为1和2的消息有效，保留发布消息的id
  • MQTT_EVENT_DATA：客户端已接收到一个发布的消息。event data包括：消息id，主题名称，数据及数据长度。若数据长度超过buffer大小，则多个MQTT_EVENT_DATA事件会被触发，*current_data_offset和*total_data_len用于保持对数据的追踪。在此可将数据读到缓存中。
  • MQTT_EVENT_ERROR：客户端遇到错误。esp_mqtt_error_type_t from error_handle in the event data 可用于判断是哪个类型的错误。

四，API参考

esp_mqtt_client_handle_t esp_mqtt_client_init(const esp_mqtt_client_config_t *config)

根据配置创建mqtt 客户端句柄。

esp_err_t esp_mqtt_client_set_uri(esp_mqtt_client_handle_t client, const char *uri);

设置mqtt连接的url，这个函数通常会重写esp_mqtt_client_init里的配置。

esp_err_t esp_mqtt_client_start(esp_mqtt_client_handle_t client);

开启mqtt客户端

esp_err_t esp_mqtt_client_reconnect(esp_mqtt_client_handle_t client);

用于强制重新连接

esp_err_t esp_mqtt_client_disconnect(esp_mqtt_client_handle_t client);

用于强制从broker中断开连接

esp_err_t esp_mqtt_client_stop(esp_mqtt_client_handle_t client);

停止mqtt客户端任务，不能再event handle中调用。

int esp_mqtt_client_subscribe(esp_mqtt_client_handle_t client, const char *topic, int qos);

客户端订阅指向服务质量的主题。

  • 客户端必须已经连接，该API可被用户任务或mqtt event 回调函数调用。该API使用信号量，所以可能导致一段时间的阻塞。

  • 返回：消息id

int esp_mqtt_client_unsubscribe(esp_mqtt_client_handle_t client, const char *topic);

取消订阅指定主题

  • 客户端必须连接
  • 线程安全。参考上面
  • 返回：消息id

int esp_mqtt_client_publish(esp_mqtt_client_handle_t client, const char *topic, const char *data, int len, int qos, int retain);

客户端发布消息到broker

  • 该API可能会阻塞几秒钟（由于网络，数据长度问题）
  • 客户端不必连接
  • 线程安全
  • 返回：消息id

参数：

  • client：客户端句柄
  • topic：主题字符串
  • data：有效载荷字符串
  • len：有效载荷字符串长度
  • qos：消息服务质量
  • retain：保留消息标志

esp_err_t esp_mqtt_client_destroy(esp_mqtt_client_handle_t client);

销毁mqtt客户端，不能再mqtt回调函数中调用

esp_err_t esp_mqtt_set_config(esp_mqtt_client_handle_t client, const esp_mqtt_client_config_t *config);

设置配置结构体，通常用于更新mqtt配置，再连接之前的回调事件中。

esp_err_t esp_mqtt_client_register_event(esp_mqtt_client_handle_t client, esp_mqtt_event_id_t event, esp_event_handler_t event_handler, void* event_handler_arg);

注册mqtt事件

参数：

  • client：

  • event：事件类型

  • event_handler:事件处理回调函数

  • event_handler_arg:事件处理回调函数传入参数

int esp_mqtt_client_get_outbox_size(esp_mqtt_client_handle_t client);

获取邮箱大小 

Ching·
关注
  • 1
    点赞
  • 踩
  • 18
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mqtt-client-1.3-API文档-中文版.zip
04-08
赠送jar包：mqtt-client-1.3.jar； 赠送原API文档：mqtt-client-1.3-javadoc.jar； 赠送源代码：mqtt-client-1.3-sources.jar； 包含翻译后的API文档：mqtt-client-1.3-javadoc-API文档-中文(简体)版.zip 对应Maven信息：groupId：org.fusesource.mqtt-client，artifactId：mqtt-client，version：1.3 使用方法：解压翻译后的API文档，用浏览器打开“index.html”文件，即可纵览文档内容。 人性化翻译，文档中的代码和结构保持不变，注释和说明精准翻译，请放心使用。
一分钟了解MQTT协议 ESP32 MQTT API指南
杀手的博客
06-08 7878
文章目录MQTT协议一，客户端二，服务端三，消息服务质量四，主题五，MQTT控制报文5.1 固定报头5.2 可变报头5.3 有效载荷5.4 控制报文类型5.4.1 连接报文5.4.2 发布publish5.4.3 订阅主题subscribe六，安全ESP-MQTT API 指南概括一，特性二，应用示例三，初始化配置3.1 URI3.2 SSL3.3 遗嘱3.4 其他配置参数3.5 项目配置菜单来配置mqtt3.6 事件四，API参考六，示例 MQTT协议 MQTT协议是一个应用层协议，他要求使用的传输层协议
单片机串口接收并解析ESP8266模块MQTT数据及MQTT透传AT固件使用例
Larry_c_12138的博客
10-26 5336
C语言编写，解析通过MQTT协议传输到串口的数据，采用MQTT透传AT固件
14- ESP8266通过mqtt服务器接收控制指令
dangerqsq的博客
03-04 1704
我这里采取的场景模式是，远程调光就会生效，物理旋钮如果在0.1秒内有超过10单位的读数变化，则读取旋钮值，并放弃远程控制的设定。既然指令也来自于消息订阅，那么让MCU去MQTT服务器匹配自己的订阅地址订阅消息就好了，根据业务需求设置合理的订阅频率，频率不要过高，不要给服务器施加太大压力（主要我的服务器没有做集群和负载均衡，扛不住啊）。操作过程复杂，就不拍摄动图了。至此我们就完美的实现了MCU通过MQTT传输数据和进行控制的接口实现，剩下的就是采用不同的应用客户端，解析数据以及生成指令的问题了。
ESP8266与MQTT服务器收发送数据
晨之清风
04-26 3384
陈拓 2021/04/20-2021/04/25 1. 概述 我们在《Win10-Ubuntu子系统构建ESP8266_RTOS_SDK开发环境》 https://zhuanlan.zhihu.com/p/346072018 https://blog.csdn.net/chentuo2000/article/details/112973413 和《用乐鑫国内镜像构建ESP8266_RTOS_SDK开发环境》 https://zhuanlan.zhihu.com/p/347711847 h.
MQTT 基础使用 及 封装 API
weixin_42285486的博客
10-17 656
在 utils 文件夹下新建mqtt.js文件，复制。mqtt调试工具：MQTTBox。上的打包构建后的源码至该文件中。在需要使用的地方引入。（以微信小程序为例）
ThingsBoard MQTT API的使用
AI_LYF1987的博客
03-06 839
选择org.eclipse.paho.ui.app-1.1.1-org.eclipse.paho.ui.app.executable.win32.win32.x86_64.zip下载，按默认流程安装即可，打开Paho，将服务器地址设置为tcp://demo.thingsboard.io（如果是本地访问，将demo.thingsboard.io换成localhost:8080,使用localhost:8080的前提是租户管理员的账号可以正常登录），客户机标识为每个机器独有，不用管它。
ESP32学习笔记（46）——MQTT客户端
Leung的博客
09-08 5716
一、MQTT简介 1.1 实现方式 实现MQTT协议需要客户端和服务器端通讯完成，在通讯过程中，MQTT协议中有三种身份：发布者（Publish）、代理（Broker）（服务器）、订阅者（Subscribe）。其中，消息的发布者和订阅者都是客户端，消息代理是服务器，消息发布者可以同时是订阅者。 MQTT传输的消息分为：主题（Topic）和负载（payload）两部分： Topic，可以理解为消息的类型，订阅者订阅（Subscribe）后，就会收到该主题的消息内容（payload）； payload，可以理解
Thingsboard MQTT 设备 API 参考
物联网平台
03-14 2214
基于ThingsBoard二次开发的物联网平台推荐：ThingsKit物联网平台，开箱即用的物联网低代码平台，提供N+1+N的产品服务体系，帮助企业快速搭建稳定可靠的物联网系统平台，为企业节省大量时间及人力成本。键始终是一个字符串，而值可以是字符串，布尔值，双精度或长整数。例如，值’1451649600512’对应于’星期五，2016年1月1日12：00：00.512 GMT’。ThingsBoard服务器节点充当MQTT代理，该代理支持QoS级别0（最多一次）和1（至少一次）以及一组预定义的主题。
ESP32的MQTT使用
热门推荐
面朝大海春暖花开
07-31 2万+
一、ESP32的MQTT函数介绍 1、esp_mqtt_client_handle_t esp_mqtt_client_init(const esp_mqtt_client_config_t *config) 函数描述：根据配置创建MQTT客户端句柄 参数esp_mqtt_client_config_t的结构体如下 typedef struct { mqtt_event_call...
物联网项目实战开发之基于STM32+ESP8266 WIFI通过MQTT协议接入腾讯连连云物联网云平台代码程序
05-26
STM32F103通过串口2跟ESP8266相连。通过MQTT协议跟腾讯云物联网平台通讯。 1、连接腾讯云物联网云平台，主动上报本地数据到平台端。支持腾讯云连连看小程序。 2、接收平台端下发的控制指令并动作。上报继电器状态、...
通过MQTT协议实现STM32+ESP8266和服务器的数据传输.zip
10-17
基于STM32F103和ESP8266的MQTT数据传输，只需要在mqtt头文件中修改参数，就可以连接到自己的服务器上，传输数据
ESP8266通过MQTT协议连接OneNet云.zip
05-23
STM32F103系列开发板，通过ESP8266模块连接OneNet云，亲测可以连接，并且可以上报数据。
STM32+ESP8266+mqtt.zip
10-21
直接可以使用的 STM32+ESP8266 通过 MQTT协议工程代码，实现消息的订阅发布操作，本资源仅供学习使用，里面大部分参考了正点原子的源码，还有mqtt协议包也是大神作品 注意！编译出来需要的RAM空间 Total RW Size (RW...
STM32F407+ESP8266+阿里云 阿里云mqtt固件库
11-10
亲测可实现单片机与阿里云的通讯，上传和下发数据
物联网嵌入式ESP32开发实战，从基础到项目程序开发125例【doc.yotill.com】
vx349014857的博客
04-20 1071
一、ESP32基础入门例程开发 二、ESP32操作系统FreeRTOS开发 三、ESP32物联网WIFI功能开发 四、ESP32摄像头及AI人工智能开发 五、ESP32开源图像库LVGL开发
【24年物联网华为杯】赛题分析与初步计划
lyh13239510484的博客
04-15 2121
官网链接：2024 年全国大学生物联网设计竞赛 (sjtu.edu.cn)含金量：属于A类赛事很多搜索结果的序号是按照选入时间排列的，与含金量无关，华为杯是23年选入的）Kimi Chat:全国大学生物联网设计竞赛（华为杯）是一项旨在促进国内物联网相关专业建设和人才培养的学科竞赛。该竞赛以物联网技术为核心，致力于激发相关专业学生的创造、创新和创业活力，同时推动高校创新创业教育的发展。自2014年起至2023年，该竞赛已成功举办了十届，并在2024年继续举办第十一届。
穿越物联网的迷雾：深入理解MQTT协议
小灰灰的博客
04-18 1292
MQTT由IBM于1999年开发，设计初衷是为了链接远程传感器与控制系统，即使在带宽非常低的网络环境下也能高效工作。它是一个基于发布/订阅模式的消息协议，非常适合用于机器对机器（M2M）和IoT应用。
以生命健康为中心的物联网旅居养老运营平台
最新发布
xingxinxyhis的博客
04-24 449
通过对这些信息的分析，平台可以更准确地了解老年客户的需求和偏好，根据不同的会员提供更加贴心、个性化的服务，如根据旅居养老者的个人喜好和需求，提供定制化的餐饮、文化娱乐、旅游活动等。因此在旅居养老运营平台中，通过借用微信，把传统线下业务，搬到线上。以生命健康为中心的物联网旅居养老运营平台是一种创新的养老服务模式，通过物联网技术的应用，提供精准的监测设备，强关联性的特点将线下服务实现了线上服务，全闭环的会员制度满足了老年人个性化的需求，关怀旅居老人的身心健康，为老年人打造一个安全、舒适、便捷的旅居养老环境。
stm32f407 + esp8266 + mqtt协议
11-18
STM32F407可以通过串口或者SPI等接口与ESP8266进行通信，将需要传输的数据通过MQTT协议封装成消息，然后通过ESP8266连接到互联网，并将消息发送到预定的消息代理服务器上。其他设备也可以通过连接同一个消息代理...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值