乐鑫esp8266学习rtos3.0笔记第5篇：基于乐鑫idf框架，研究出超稳定、掉线重连、解决内存泄露问题的Mqtt框架，支持esp8266和esp32！（附带链接）_乐鑫外部库

---

• 本系列博客学习由非官方人员 半颗心脏 潜心所力所写，不做开发板。仅仅做个人技术交流分享，不做任何商业用途。如有不对之处，请留言，本人及时更改。

1、 Esp8266之 搭建开发环境，开始一个“hellow world”串口打印。
2、 Esp8266之 利用GPIO开始使用按钮点亮你的“第一盏灯”。
3、 Esp8266之 利用 "软件定时器 " 定时0.5秒闪烁点亮一盏LED。
4 、Esp8266之 了解PWM，更为深入地用PWM控制一盏LED的亮度变化。
5 、Esp8266之 原生乐鑫SDK高级使用之封装Post与Get请求云端，拿到“天气预报信息”。
6 、Esp8266之 了解 SmartConfig与Airkiss一键配网，给8266配网上云端。无需把wifi名字密码写在固件里。
7 、Esp8266之 了解 softAP热点配网模式原理，仿“机智云”定义自己的热点配网模式协议。
8、 Esp8266之 你要找的8266作为UDP、TCP客户端或服务端的角色通讯，都在这了。
9、 Esp8266进阶之路： [小实战上篇]Windows系统搭建8266的本地Mqtt服务器，局域网点亮一盏LED灯。
10、 Esp8266进阶之路： [小实战下篇]Windows系统搭建8266的本地Mqtt服务器，局域网点亮一盏LED灯。
11、 Esp8266进阶之路： 8266接入阿里智能，点亮一盏LED灯，期待天猫精灵语音控制的不约而至！
12、 Esp8266进阶之路： 图文并茂学习阿里云主机搭建8266MQTT服务器，实现移动网络远程控制一盏LED。
13、 Esp8266进阶之路： 动手做个8266毕设小案例，smartConfig + MQTT协议轻松实现远程控制一盏LED。
14、 Esp8266进阶之路： esp8266的 FreeRtos系统学习的正确姿势 ------ 环境搭建、烧录。
15、 Esp8266进阶之路： esp8266的 物联网又一股清流，8266接入阿里云平台非阿里智能的SDS服务，点亮一盏LED灯。
16、 Esp8266进阶之路： esp8266的 基于Nonos移植红外线H1838，实现红外遥控器配网，远程控制一盏灯。
17、 Esp8266进阶之路： esp8266自研的快速上电开关五次 (开-关为一次) ，无需按键触发则8266进去一键配网模式。
18、 Esp8266进阶之路： esp8266 基于NONOS 实现 OTA 远程升级，实现无线“ 热修复 ”升级固件程序。
19、 Esp8266进阶之路： esp8266驱动 ds18b20、dht11 温湿度传感器，采集温湿度传感器到服务器。
20、 Esp8266进阶之路： 深入学习esp8266的esp now模式，仿机智云做一个小网关，实现无需网络下轻松彼此连接通讯交互数据。
21、 Esp8266进阶之路： 浅谈 esp8266 如何在本地局域网网络情况下实现最大效率地和前端实现数据交互。
22、 Esp8266进阶之路： esp8266的工程如何添加第三方静态库文件以及如何自定义文件夹，聊聊那些makeFile的事。。
23、 Esp8266进阶之路： 再来一波 esp8266 基于 freeRtos系统连接自己私有的服务器实现OTA远程升级，接触下 lwip的基本知识。。
24、 Esp8266进阶之路： 渗透学习回顾下esp8266的外置spi芯片25q系列，熟悉8266代码块在其的分布，得心应手放置图片或其他资料。
25、 Esp8266进阶之路： 深聊下esp8266的串口 Uart 通讯中断编程，为您准备好了 NONOS 版本 和 RTOS 系统的串口驱动文件。
26、 Esp8266进阶之路： RTOS分析 MQTT 实现过程，实现移植 MQTT协议在 esp8266 rtos实时系统，可断线重连。
27、 Esp8266进阶之路： 跟紧脚步，用VisualStudio Code开发 esp8266 rtos SDK v3.0版本，全新的 idf 框架，节省内存模块化开发。
28、 Esp8266进阶之路： 教你轻松自如使用cJson在乐鑫 esp8266 如何解析一段json数据以及如何生成一段json数据。
29、 Esp8266进阶之路： 百万条消息免费之乐鑫esp8266使用TCP直连模式MQTT协议接入阿里云物联网平台，支持私家服务器对接支持阿里云规则引擎。
30、 Esp8266进阶之路： 乐鑫esp8266 SDK编程使用 IIC总线驱动 0.96寸的OLED显示屏，显示天气预报信息。
31、 Esp8266进阶之路： 当esp8266遇到 Html，该怎么内置网页控制设备，理清内置网页的实现过程，实现无需路由器手机也可以控制esp8266。
32、 Esp8266进阶之路： 细聊HmacMD5的加密方法带来的安全性，并实践在esp8266上，最大保障传输的过程的信息的安全性。
33、 Esp8266进阶之路： 如何优雅地像乐鑫原厂封装esp8266底层寄存器的逻辑思维，做成自己的静态库库文件，让第三方人使用？
34、 Esp8266进阶之路： 乐鑫esp8266 NONOS SDK 3.0编程使用 SPI 驱动基于Max7219芯片的八位数码管，显示日期信息。
35、 Esp8266进阶之路： 乐鑫esp8266芯片借助机智云平台做一个商业化的七彩RGB灯泡可调整体方案项目，炫彩夺目高大尚。
36、 Esp8266之rtos3.0笔记： 认识esp8266 Rtos 3.0 sdk 工程结构，esp8266如何向esp-idf工程靠近的，如何自定义头文件编译？
37、 Esp8266之rtos3.0笔记： 你要找的基本外设功能都在这里了，包括Gpio、Pwm 和 Uart 接口使用。
38、 Esp8266之rtos3.0笔记： 一篇文章带你搞掂存储技术 NVS 的认识和使用，如何利用NVS保存整型、字符串、数组以及结构体。
39、 Esp8266之rtos3.0笔记： 捋一捋微信公众号配网智能设备 esp8266 并绑定设备的过程，移植并成功实现在 esp8266 rtos3.1 。
40、 Esp8266之rtos3.0笔记： 基于乐鑫idf框架，研究出超稳定、掉线重连、解决内存泄露问题的Mqtt框架！支持esp8266和esp32！
41、 Esp8266之rtos3.0笔记： esp8266-12模块基于rtos3.1版本ota功能远程空中升级固件，官网基础之上增加dns域名解析！
42、 Esp8266之rtos3.0笔记： 我又来了，基于rtos3.0版本 SDK编程 SPI 驱动 ws2812b 七彩灯，代码全部开源奉献给你们！
43、 Esp8266之rtos3.0笔记： esp8266-12模块基于rtos3.0版本扫描周围获取附近可用的 Wi-Fi 热点路由器信息，同样适合esp32。
44、 Esp8266之rtos3.0笔记： 整理分享那些我在项目中常用的esp8266 rtos3.0版本的常见驱动，Button按键长短按、PWM平滑调光等。
45、 Esp8266之rtos3.0笔记： 内置仅1M的Esp8285，如何攻破最棘手的OTA问题，大大节省资源成本开发产品。
46、 Esp8266之rtos3.0笔记： 详细分析Esp8266上电信息打印的数据，如何做到串口通讯上电不乱码打印。
47、 Esp8266之rtos3.0笔记： 无需外网，如何实现在本地局域网与控制端做数据交换的一些开发经验。
48、 Esp8266之rtos3.0笔记： 迟来的1024程序员祝福，开源分享一个驱动 ds18b20 获取温度的工程。
49、 Esp8266之rtos3.0笔记： aliyun sdk 直连接入阿里云物联网平台，实现天猫精灵找队友零配网功能和语音控制。
50、 Esp8266之rtos3.0笔记： esp产品量产方案初入门之 如何从外部读取 csv 文件的数据，比如从代码读取外部文件阿里云三元组。
51、 Esp8266之rtos3.0笔记： 体验下 Linux搭建 ESP8266_RTOS_SDK 3.0 最新环境的搭建和编译吧。
52、 Esp8266之rtos3.0笔记： 仅1M flash 的安信可 ESP-01S 模块，如何二次开发？如何对其 OTA 远程升级固件 。

---

• 很多人怎么联系我一起学习进步，下面打个小小公告和干货无偿分享：

玩转esp8266带你飞、加群QQ群，提高门槛，不喜的朋友勿喷勿加：434878850
esp8266源代码免费学习汇总（持续更新，欢迎star）：https://github.com/xuhongv/StudyInEsp8266
esp32源代码免费学习汇总（持续更新，欢迎star）：https://github.com/xuhongv/StudyInEsp32

---

一、前言。

---

         当技术到达了一种领域，貌似对新颖的技术领域再也不怎么感兴趣了！这可能是程序员的一种通病！然而，年轻的我却有了这种体会！！

         我们知道， MQTT协议一直是我们的物联网通讯的首先，因为它的确很迅捷！但，很多数情况，取决于客户端，而服务器都是成熟的，比如emq、阿里云物联网服务器等，所以，在我们嵌入式设备上做一个稳定性良好的连接，不仅仅取决了网络环境，还有自身的问题！

         于是乎，能做出一个稳定性良好的连接服务器嵌入式设备，是非常必要的 ！

---

二、为什么做框架？

---

          处于如今的互联网时代，我们实现了资源共享和万联互通。很多资源都是开源出来，而且大家免费使用！像近些年出来的前端框架 vue.js 、react native等，都是很 nice 的框架，大大减少了我们程序员的开发周期，而且官网还一直在维护中。

---

          有一天，我在想，为什么嵌入式用C语言做的框架却很少！而且也仅仅是那么几个了，近几年新推出也就 alios系统了。很多情况，这些系统都是针对某个芯片的。不像前端，用一个框架开发，全部用户都可以访问，而且限制很少！那么，我想为我们的国内的互联网做丢丢奉献，给大家整理下一个MQTT框架！

---

         既然本小题聊到了 框架，最常见的理解就是一个系统，可以这么理解，但是此“系统”还是依附在底层系统之上的！再提供 API 接口给人家用！前面我已经提到了做出一个稳定性良好的连接服务器嵌入式设备，那么结合一些现成的代码，以及思考着怎么运用最为容易上手？我封装了乐鑫 idf 框架之上的 MQTT协议连接的框架，集成很方便，让我们使用起来更得心应手！

---

三、框架如何集成？

---

• 乐鑫idf框架的基于Rtos的，其框架特点自己去官网了解下！
• 前面说到了，这个框架支持 esp8266 rtos3.0 和 esp32 idf ，这里声明一下，给这个框架在2者的代码API接口使用是一模一样的！但是并不意味着底层代码是一样的！不过你也不需要理会底层代码，我已经全部封装好了！您只需要按照我的方式集成进去就好了！
• 集成方式是一样的，直接把这个组件扔在您的工程里面就是了，具体的示范代码，我在文章后面给大家贴出来！

---

四、框架如何使用？

---

          对于我认识很多框架以及对乐鑫的idf编程熟悉，我提供大家的使用方法很简单，如下：

---

第一步，先初始化连接配置参数！

 xMQTT_CONFIG xMqttConfig =
        {
            .MQTTVersion = 4,
            .borkerHost = "www.helloworld.cn", //服务器名字
            .borkerPort = 1883,                  //端口
            .mqttCommandTimeout = 6000,
            .username = "admin",           //用户名
            .password = "xuhong2019",      //用户密码
            .clientID = (char *)deviceMac, //设备Id
            .keepAliveInterval = 60, //心跳 秒
            .cleansession = true,
        };
    xMqttInit(&xMqttConfig);
1
2
3
4
5
6
7
8
9
10
11
12
13

---

第二步，通知框架 wifi连接成功！

• 为什么要做这个API？原因在于更快地连接服务器，即使框架检测到断开AP，立即会重连服务器！而乐鑫提供的esp_event_loop_init()设置系统事件方法回调中，我们可以从 SYSTEM_EVENT_STA_GOT_IP（成功连接ap并且得到ip）和SYSTEM_EVENT_STA_DISCONNECTED（断开与AP的连接）事件中通知我们的框架！
• 调用我提供的接口方法 xMqttConnectWifiNotify()，传参为 WIFI_CONNECTED和 WIFI_DISCONNECTED，理解为字面意思！

static esp_err_t event_handler(void *ctx, system_event_t *event)
{
    switch (event->event_id)
    {
    case SYSTEM_EVENT_STA_GOT_IP:
        xMqttConnectWifiNotify(WIFI_CONNECTED); //通知框架 wifi热点连接成功！
        break;
    case SYSTEM_EVENT_STA_DISCONNECTED:
        xMqttConnectWifiNotify(WIFI_DISCONNECTED); //通知框架 wifi热点断开连接了！
        esp_wifi_connect();
        break;
    }
    return ESP_OK;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

---

第三步，创建主任务TaskMainMqtt！

• 上面步骤弄好之后，请自行通过 xTaskCreate()方法创建此任务，这个任务的名字我已经提供在了 头文件，您只需要创建就好了，具体的任务栈大小根据自己的需求去定，我这里建议是1024 * 6，级别为10！
• 还有一点主意的是，请不要重复创建！像我下面通过一个句柄来控制就好了！

    if (xHandlerMqtt == NULL)  {
           xTaskCreate(TaskMainMqtt, "TaskMainMqtt", 1024 * 6, NULL, 10, &xHandlerMqtt);
    }
1
2
3

---

第四步，创建接受数据任务！

• 老费这么多，主要还是这个为重点，我把服务器连接状态，数据接受全部都通过 队列实现！只需要不断调用xMqttReceiveMsg(xMQTT_Msg *msg);方法，其本质是xQueueReceive()方法，所以大家死循环读取就好！
• xMqttReceiveMsg(xMQTT_Msg *msg);方法里面的传参结构体的成员里面的 type 是关键！不同的 type 意味这回调不一样的框架事件，这个和乐鑫的编程非常相似！下面对这个 type 类型的不同意思我贴注释出来，大家理解即可！

void TaskXMqttRecieve(void *p)
{

    xMQTT_Msg rMsg;
    xMQTT_Msg sMsg;
    ESP_LOGI(TAG, "xMqttReceiveMsg start");
    while (1)
    {
        if (xMqttReceiveMsg(&rMsg))
        {
            switch (rMsg.type)
            {
                //接收到新的消息下发
            case xMQTT_TYPE_RECIEVE_MSG:
                ESP_LOGI(TAG, "xQueueReceive topic: %s ", rMsg.topic);
                ESP_LOGI(TAG, "xQueueReceive payload: %s", rMsg.payload);
                ESP_LOGI(TAG, "esp_get_free_heap_size : %d \n", esp_get_free_heap_size());
                break;
                //连接Mqtt服务器成功
            case xMQTT_TYPE_CONNECTED:
                strcpy((char *)rMsg.topic, MQTT_DATA_SUBLISH);
                rMsg.qos = 1;
                xMqttSubTopic(&rMsg);
                strcpy((char *)rMsg.topic, MQTT_DATA_PUBLISH);
                rMsg.qos = 0;
                xMqttSubTopic(&rMsg);
                ESP_LOGI(TAG, "xMQTT : xMQTT_TYPE_CONNECTED");
                break;
                //断开Mqtt服务器成功
            case xMQTT_TYPE_DISCONNECTED:
                ESP_LOGI(TAG, "xMQTT : xMQTT_TYPE_DISCONNECTED");
                break;
                //正在连接Mqtt服务器
            case xMQTT_TYPE_CONNECTTING:
                ESP_LOGI(TAG, "xMQTT : xMQTT_TYPE_CONNECTTING");
                break;
                //订阅主题成功
            case xMQTT_TYPE_SUB_SUCCESS:
                ESP_LOGI(TAG, "xMQTT : xMQTT_TYPE_SUB_SUCCESS");
                break;
                //ping心跳服务器
            case xMQTT_TYPE_SEND_PING:
                ESP_LOGI(TAG, "xMQTT : xMQTT_TYPE_SEND_PING");
                break;
            default:
                break;
            }
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

---

第五步，主动发送！

• 这个没什么可说的，xMqttPublicMsg() 方法调用本质是 xQueueSend() 方法，所以大家不必要担心调度和卡顿问题！具体的用户见下面！

                xMQTT_Msg sMsg;
                strcpy((char *)sMsg.topic, MQTT_DATA_PUBLISH);
                sprintf((char *)sMsg.payload, "{\"xMqttVersion\":%s,\"freeHeap\":%d}", getXMqttVersion(), esp_get_free_heap_size());
                sMsg.payloadlen = strlen((char *)sMsg.payload);
                sMsg.qos = 1;
                sMsg.retained = 0;
                sMsg.dup = 0;
                xMqttPublicMsg(&sMsg);
1
2
3
4
5
6
7
8

---

五、其他

---

• 您可以根据自己需求在头文件调整下配置，可以减少内存使用：

//接收数据缓存包设置
#define RECV_BUFF_SIZE 512
#define MQTT_PACK_SIZE 512

#define XP_MQTT_MAX_TOPICLEN 50  //最大的主题长度
#define XP_MQTT_RCV_MSG_QUEUE_LEN 5 //接受队列个数
#define XP_MQTT_SEND_MSG_QUEUE_LEN 5 //发送队列个数
1
2
3
4
5
6
7

• 下面为了证明稳定性，我大家提供我统计的这个运行一周不断电连接服务器的连接状况数据：

---

六、下载

---

• 谢谢大家一直支持我！再次声明，这个框架支持 esp8266 rtos3.0 和 esp32 idf ，这里声明一下，给这个框架的代码API接口在2者的使用是一模一样的！但是并不意味着底层代码是一样的，所以，我给大家2份工程参考！！当然了，你也不需要理会底层代码，我已经全部封装好了！您只需要按照我的方式集成进去就好了！
• 下面的提供都是以静态库封装存在的，但绝对不影响使用！！如需源码，邮箱联系我！

esp8266 （仅支持 rtos 3.0及以上 SDK）: https://github.com/xuhongv/xLibEsp8266Rtos3.1Mqtt
esp32 （idf框架即可）:https://github.com/xuhongv/xLibEsp32Rtos3.2Mqtt