前言
MQTT是IBM開發(fā)的一個(gè)即時(shí)通訊協(xié)議,面向M2M和物聯(lián)網(wǎng)的連接,采用輕量級(jí)發(fā)布和訂閱消息傳輸機(jī)制,并且有可能成為物聯(lián)網(wǎng)的重要組成部分。
ESP8266是一款物美價(jià)廉的Wi-Fi芯片,集成Tensilica L106 鉆石系列的32 位處理器和片上SRAM,多達(dá)17 個(gè)GPIO口,并擁有IIC、IIS、UART、PWM、IR遙控等片上資源。
ESP8266還提供官方的軟件開發(fā)開發(fā)包(SDK),目前最新版本是「ESP8266 NONOS SDK V2.0.0」。
這篇文章主要講解如何使用ESP8266作為MQTT客戶端,并連上在本地電腦搭建的MQTT服務(wù)器。
開發(fā)環(huán)境
首先簡(jiǎn)單說明一下博主的開發(fā)環(huán)境:
- ESP8266開發(fā)環(huán)境:ESP8266 IDE 2.0
- ESP8266 SDK版本:esp8266_nonos_sdk_v2.0.0_16_08_10_0
- MQTT服務(wù)器:Apollo 1.7.1(本地搭建)
- 操作系統(tǒng):64位 Win10系統(tǒng)
- ESP8266開發(fā)板:NodeMCU(4MB Flash)
導(dǎo)入工程
如果讀者和博主使用的開發(fā)環(huán)境一樣,那么步驟1~4就好理解了,不是的話直接看圖片和步驟5:
- 在IDE環(huán)境中通過「File」->「Import」;
- 彈窗中選擇「C/C++」->「Existing Code as Makefile project」;
- 下一步「Browse...」,編譯器選擇「Cygwin GCC」;
- 之后導(dǎo)入的工程目錄如上圖,其中給「dirver_lib」文件下面的Makeflie添加bak后綴或刪除掉,免得編譯通不過。
- 從「example」文件夾中拷貝esp_mqtt_proj文件夾到主目錄,點(diǎn)擊編譯按鈕,如果成功就完成這一步驟了。
工程目錄圖
代碼分析
示例工程中最重要的是這兩個(gè)文件:user目錄下的user_main.c和inlcude目錄下的mqtt_config.h。
其中user_main.c不用說了,玩過ESP8266的朋友都知道這是放主代碼的地方,其中user_init函數(shù)是SDK提供開發(fā)者放置初始化代碼的地方。下面主要分析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__
在這個(gè)文件中,有幾個(gè)宏定義可能需要修改的
- MQTT_HOST,MQTT服務(wù)器地址
- MQTT_PORT,MQTT服務(wù)器端口
- MQTT_USER,MQTT服務(wù)器用戶名
- MQTT_PASS,MQTT服務(wù)器密碼
- STA_SSID,WI-FI帳號(hào)
- STA_PASS,WI-FI密碼
還有一個(gè)最重要的宏定義——CFG_HOLDER,因?yàn)檫@個(gè)MQTT示例在ESP8266運(yùn)行過一次后會(huì)把這些信息保存到FLASH中,如果要繼續(xù)修改這些信息,記得要修改CFG_HOLDER這個(gè)宏定義,改成另一個(gè)數(shù)值即可。
CFG_HOLDER作的用是:在CFG_Load
函數(shù)中,如果發(fā)現(xiàn)從FLASH讀取出來的CFG_HOLDER
數(shù)值和宏定義的不一樣,則會(huì)更新這些信息,并保存到FLASH中。不修改CFG_HOLDER
的話可能會(huì)發(fā)覺明明用戶名和密碼都正確但是就是連接不上去。
修改代碼及測(cè)試
修改代碼
根據(jù)上面分析,下面我們就可以修改示例代碼:
- 把STA_SSID和STA_PASS修改為自己的WiFI名和密碼;
- 修改MQTT_USER和MQTT_PASS為對(duì)應(yīng)的MQTT服務(wù)器的用戶名和密碼,Apollo服務(wù)器默認(rèn)是admin和password;
- 修改MQTT_HOST和MQTT_PORT為MQTT服務(wù)器IP和PORT,目前是使用本地的MQTT服務(wù)器,所以是修改為自己電腦的IP和61613端口,PORT是整型值;
- 根據(jù)MQTT服務(wù)器的協(xié)議不同,可能需要使用MQTT v3.1.1版本,所以把PROTOCOL_NAMEv31注釋掉,使用PROTOCOL_NAMEv311。源碼的PROTOCOL_NAMEv311前面沒有#define,自己加上就行。
- 最后,修改CFG_HOLDER,以讓這些配置生效,直接給原來CFG_HOLDER定義的數(shù)值加1即可。
編譯下載
編譯,查看Console窗口,如果輸出
那說明代碼已經(jīng)編譯成功。另外要注意,ESP8266 SDK v2.0版本生成的eagle.irom0text.bin燒寫起始地址是0x10000,而之前的版本燒寫地址是0x40000;eagle.flash.bin還是0x00000。由于博主使用的是4MB Flash的ESP8266,所以也建議讀者先確定手頭的ESP8266是不是4MB Flash(即32Mbit Flash,注意單位!4MB=32Mbit,F(xiàn)lash一般是以bit計(jì)算!)
另外如果Problems窗口報(bào)Errors的,只要Console窗口編譯通過,就可以不用管。
下載配置參考圖片:
提醒:blank.bin和default.bin燒寫一次就行,另外也要留意不同的Flash大小,blank.bin和default.bin燒寫地址也不同。
上電測(cè)試
如果前面一切順利,打開串口,設(shè)置波特率為115200,上電后前面的亂碼不用管,之后串口打印信息如下,省略了一部分信息:
load ...
default configuration
MQTT_InitConnection
MQTT_InitClient
WIFI_INIT
……(省略)
connected with [你的WiFi名], channel 6
dhcp client start...
STATION_IDLE
STATION_IDLE
ip:[WiFi分配給ESP8266的IP],mask:255.255.255.0,gw:[WiFi網(wǎng)關(guān)IP]
TCP: Connect to ip [MQTT服務(wù)器IP:PORT]
MQTT: Connected to broker [MQTT服務(wù)器IP:PORT]
MQTT: Sending, type: 1, id: 0000
TCP: Sent
TCP: data received 4 bytes
MQTT: Connected to [MQTT服務(wù)器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)
……
其中加粗帶方括號(hào)的字段根據(jù)測(cè)試環(huán)境不同而不同。
同時(shí)看源碼和串口信息可知,ESP8266向MQTT服務(wù)器訂閱了三個(gè)主題,假設(shè)使用的是本地搭建的MQTT服務(wù)器,那么查看MQTT服務(wù)器后臺(tái)就可以看到:
同時(shí)在后臺(tái)的Connects頁面也可以看到ESP8266的鏈接:
MQTT本地服務(wù)器搭建教程Windows版鏈接在后面。
另外博主已經(jīng)用ESP8266的MQTT連接上了OneNET云,連接該云需要注釋掉下面這條語句,在user_init
函數(shù)下。
MQTT_InitLWT(&mqttClient, "/lwt", "offline", 0, 0);
原因是OneNET不支持,否則連接不上。
其他
-
【MQTT服務(wù)器】
- 下載地址:http://activemq.apache.org/apollo/download.html
- 在Windows下搭建本地的MQTT服務(wù)器教程:http://blog.csdn.net/yannanxiu/article/details/52703946
【ESP8266 IDE】由于上面提供的ESP8266 IDE下載鏈接已經(jīng)失效,筆者這里自己上傳了一個(gè),供大家下載:
鏈接: https://pan.baidu.com/s/1c2tBHW8
密碼: qyjs【示例代碼】本博客示例代碼下載地址:http://download.csdn.net/detail/u012163234/9687996
【ESP8266資料】ESP8266官網(wǎng)資源鏈接:http://espressif.com/zh-hans/products/hardware/esp8266ex/resources
本文首發(fā)于CSDN:http://blog.csdn.net/yannanxiu/article/details/53088534