ESP8266的MQTT客户端搭建教程(基于NONS_SDK_v2.0)
前言
MQTT是IBM開發的一個即時通訊協議,面向M2M和物聯網的連接,采用輕量級發布和訂閱消息傳輸機制,并且有可能成為物聯網的重要組成部分。
ESP8266是一款物美價廉的Wi-Fi芯片,集成Tensilica L106 鉆石系列的32 位處理器和片上SRAM,多達17 個GPIO口,并擁有IIC、IIS、UART、PWM、IR遙控等片上資源。
ESP8266還提供官方的軟件開發開發包(SDK),目前最新版本是「ESP8266 NONOS SDK V2.0.0」。
這篇文章主要講解如何使用ESP8266(基于NONS_SDK_v2.0)作為MQTT客戶端,并連上在本地電腦搭建的MQTT服務器。
開發環境
首先簡單說明一下博主的開發環境:
- ESP8266開發環境:ESP8266 IDE 2.0
- ESP8266 SDK版本:esp8266_nonos_sdk_v2.0.0_16_08_10_0
- MQTT服務器:Apollo 1.7.1(本地搭建)
- 操作系統:64位 Win10系統
- ESP8266開發板:NodeMCU(4MB Flash)
提醒
閱讀本教程時,如果有使用esp8266_nonos_sdk_v2.0.0的開發經驗,會更輕松的使用本教程。如果遇到代碼編譯出錯、燒寫下載不行以及下載后出現異常的問題,請先參考其他資料再繼續本文。
導入工程
本教程基于ESP8266 IDE 2.0,如果讀者使用一樣的環境,那么步驟1~4就好理解了,不是的話直接看圖片和步驟5:
工程目錄圖。注意紅色方塊內的文件。
MQTT代碼使用簡析
示例工程中最重要的是這兩個文件:user目錄下的user_main.c和inlcude目錄下的mqtt_config.h。
其中user_main.c不用說了,玩過ESP8266的朋友都知道這是放主代碼的地方,其中user_init函數是SDK提供開發者放置初始化代碼的地方。下面主要分析mqtt_config.h。
mqtt_config.h代碼清單
#ifndef __MQTT_CONFIG_H__ #define __MQTT_CONFIG_H__#define CFG_HOLDER 0x00FF55A4 /* Change this value to load default configurations */ #define CFG_LOCATION 0x79 /* Please don't change or if you know what you doing */ #define MQTT_SSL_ENABLE/*DEFAULT CONFIGURATIONS*/#define MQTT_HOST "192.168.1.100" //or "mqtt.yourdomain.com" #define MQTT_PORT 1883 #define MQTT_BUF_SIZE 1024 #define MQTT_KEEPALIVE 120 /*second*/#define MQTT_CLIENT_ID "DVES_%08X" #define MQTT_USER "DVES_USER" #define MQTT_PASS "DVES_PASS"#define STA_SSID "DVES_HOME" #define STA_PASS "yourpassword" #define STA_TYPE AUTH_WPA2_PSK#define MQTT_RECONNECT_TIMEOUT 5 /*second*/#define DEFAULT_SECURITY 0 #define QUEUE_BUFFER_SIZE 2048#define PROTOCOL_NAMEv31 /*MQTT version 3.1 compatible with Mosquitto v0.15*/ //PROTOCOL_NAMEv311 /*MQTT version 3.11 compatible with https://eclipse.org/paho/clients/testing/*/#endif // __MQTT_CONFIG_H__- 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
在這個文件中,有幾個宏定義可能需要修改的:
- MQTT_HOST:MQTT服務器地址
- MQTT_PORT:MQTT服務器端口
- MQTT_USER:MQTT服務器用戶名
- MQTT_PASS:MQTT服務器密碼
- STA_SSID:WI-FI帳號
- STA_PASS:WI-FI密碼
注意?
還有一個最重要的宏定義——CFG_HOLDER,因為這個MQTT示例在ESP8266運行過一次后會把這些信息保存到FLASH中,如果要繼續修改這些信息,記得要修改CFG_HOLDER這個宏定義,改成另一個數值即可。
CFG_HOLDER作的用是:在CFG_Load函數中,如果發現從FLASH讀取出來的CFG_HOLDER數值和宏定義的不一樣,則會更新這些信息,并保存到FLASH中。不修改CFG_HOLDER的話可能會發覺明明用戶名和密碼都正確但是就是連接不上去。
修改代碼及測試
修改代碼
根據上面分析,下面我們就可以修改示例代碼:
編譯下載
編譯,查看Console窗口,如果輸出
那說明代碼已經編譯成功。另外要注意,ESP8266 SDK v2.0版本生成的eagle.irom0text.bin燒寫起始地址是0x10000,而之前的版本燒寫地址是0x40000;eagle.flash.bin還是0x00000。由于博主使用的是4MB Flash的ESP8266,所以也建議讀者先確定手頭的ESP8266是不是4MB Flash(即32Mbit Flash,注意單位!4MB=32Mbit,Flash一般是以bit計算!)
另外如果Problems窗口報Errors的,只要Console窗口編譯通過,就可以不用管。
下載配置,僅供參考:
提醒
blank.bin和default.bin燒寫一次就行,另外也要留意不同的Flash大小,blank.bin和default.bin燒寫地址也不同。
另外,給NodeMCU燒寫固件的時候,SPI MODE選項可能要選DIO。詳細細節參考這里。?
其他的ESP8266開發板一般則選擇默認的QIO就行了。
上電測試
如果前面一切順利,打開串口,設置波特率為115200,上電后前面的亂碼不用管,之后串口打印信息如下,省略了一部分信息:
load ... default configuration MQTT_InitConnection MQTT_InitClient WIFI_INIT……(省略)connected with <WiFi名>, channel 6 dhcp client start... STATION_IDLE STATION_IDLE ip:<ESP8266的IP>,mask:255.255.255.0,gw:<WiFi網關IP> TCP: Connect to ip <MQTT服務器IP:PORT> MQTT: Connected to broker <MQTT服務器IP:PORT> MQTT: Sending, type: 1, id: 0000 TCP: Sent TCP: data received 4 bytes MQTT: Connected to <MQTT服務器IP:PORT> MQTT: Connected MQTT: queue subscribe, topic"/mqtt/topic/0", id: 1 MQTT: queue subscribe, topic"/mqtt/topic/1", id: 2 MQTT: queue subscribe, topic"/mqtt/topic/2", id: 3 MQTT: queuing publish, length: 23, queue size(66/2048) MQTT: queuing publish, length: 25, queue size(91/2048) MQTT: queuing publish, length: 25, queue size(118/2048) ……- 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
其中帶尖括號的字段根據測試環境不同而不同。
同時看源碼和串口信息可知,ESP8266向MQTT服務器訂閱了三個主題,假設使用的是本地搭建的MQTT服務器,那么查看MQTT服務器后臺就可以看到:
同時在后臺的Connects頁面也可以看到ESP8266的鏈接:
MQTT本地服務器搭建教程Windows版鏈接在后面。
另外博主已經用ESP8266的MQTT連接上了OneNET云,連接該云需要注釋掉下面這條語句,在user_init函數下。
MQTT_InitLWT(&mqttClient, "/lwt", "offline", 0, 0);- 1
原因是OneNET不支持MQTT協議的Will字段,否則可能連接不上。
其他
-
【MQTT服務器】
- 在Windows下搭建本地MQTT服務器教程
- MQTT服務器Apollo下載地址:http://activemq.apache.org/apollo/download.html
-
【ESP8266 IDE】
- 由于上面提供的ESP8266 IDE下載鏈接已經失效,筆者這里自己上傳了一個,供大家下載:鏈接:https://pan.baidu.com/s/1c2tBHW8?密碼: qyjs
-
【示例代碼】本博客ESP8266端代碼下載地址:
- CSDN:?http://download.csdn.net/detail/u012163234/9687996
-
【ESP8266資料】
- ESP8266官網資源
評論統一回復
上電亂碼
評論區很多朋友回復上電后打印亂碼,我都不知道你們的亂碼是怎樣的?請確保已經修改了WiFi帳號和密碼。同時請確定自己的ESP8266是否是4MB Flash(32Mbit Flash)。(評論區出現好幾個這樣的情況:第一次燒寫后重啟成功,之后重啟芯片就不行的情況,如果有讀者知道原因的希望告知下,謝謝。另,我估計絕對不是本教程的問題。)
上電啟動信息默認波特率是76800bps,進入user_init后串口被初始化為115200bps。
如果反復打印STATION_IDLE?,說明沒有連上WiFi。
load ... default configuration MQTT_InitConnection MQTT_InitClient WIFI_INITSystem started ... mode : sta(18:fe:34:**:**:**) add if0 STATION_IDLE STATION_IDLE STATION_IDLE scandone no your_wifi_ssid found, reconnect after 1s reconnect STATION_IDLE STATION_IDLE STATION_IDLE STATION_IDLE scandone no your_wifi_ssid found, reconnect after 1s reconnect STATION_IDLE STATION_IDLE STATION_IDLE STATION_IDLE STATION_IDLE scandone no your_wifi_ssid found, reconnect after 1s reconnect STATION_NO_AP_FOUND scandone STATION_IDLE STATION_IDLE STATION_IDLE STATION_IDLE scandone no your_wifi_ssid found, reconnect after 1s- 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
另外一定要注意:ESP8266 SDK v2.0版本生成的文件燒寫地址:
| eagle.flash.bin | 0x00000 |
| eagle.irom0text.bin | 0x10000 |
燒寫錯誤會導致芯片不斷的重啟!請仔細閱讀「編譯下載」小節。
另外v2.0以下版本的SDK(不包括v2.0)eagle.irom0text.bin是燒寫在0x40000,請自行參考其他資料。
安全連接
關于MQTT的安全連接,在配置文件中和這兩個宏定義有關:
//第6行左右 #define MQTT_SSL_ENABLE//第25行左右 #define DEFAULT_SECURITY 0- 1
- 2
- 3
- 4
- 5
其中我查看源碼,宏定義MQTT_SSL_ENABLE是SSL連接的預編譯,如果不定義MQTT_SSL_ENABLE則表示不支持SSL(最好看源碼理解)。?
DEFAULT_SECURITY是SSL是否使能,0為禁能,1為使能。
esp_mqtt_proj/mqtt/mqtt.c文件下的MQTT_Connect函數部分源碼:
void ICACHE_FLASH_ATTR MQTT_Connect(MQTT_Client *mqttClient) {//省略……if (mqttClient->security){#ifdef MQTT_SSL_ENABLEespconn_secure_connect(mqttClient->pCon);#elseINFO("TCP: Do not support SSL\r\n");#endif}else{espconn_connect(mqttClient->pCon);}//省略…… }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
其中mqttClient->security由DEFAULT_SECURITY賦值。在esp_mqtt_proj/modules/config.c的CFG_Load函數里。
sysCfg.security = DEFAULT_SECURITY; /* default non ssl */- 1
最后會在user_init函數初始化。
MQTT_InitConnection(&mqttClient, sysCfg.mqtt_host, sysCfg.mqtt_port, sysCfg.security);- 1
總結
以上是生活随笔為你收集整理的ESP8266的MQTT客户端搭建教程(基于NONS_SDK_v2.0)的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: MQTT之mosquitto_passw
- 下一篇: ESP8266和MQTT