MQTT之 PubSubClient 库

sunlichao

转发地址:

1. https://www.jianshu.com/p/7f54b92d7a7b

复制代码

我在MQTT简介中的ESP8266的示例显得有点复杂，虽说Adafruit的库貌似很强大，但从软件角度来看却显得非常的臃肿，简洁至尚才是写代码的王道。
幸亏MQTT的库有非常的多，这里我会采用一款更简单好用的库PubSubClient来做一个最简单的MQTT客户端。
PubSubClient可以在Arduino IDE的库管理器中找到：


然后我们来写个例子，当ESP8266收到来自home/devices/onoff/主题中值为1的信息就点亮板载的LED，收到0就熄灭LED。
首先定义基本的变量：

1. #include <ESP8266WiFi.h>
   
2. #include <PubSubClient.h>
   
3. 
   
4. const char* ssid = "网络SSID";
   
5. const char* password = "密码";
   
6. const char* mqtt_server = "broker.mqtt-dashboard.com"; // 使用HIVEMQ 的信息中转服务
   
7. const char* TOPIC = "home/devices/onoff/";                     // 订阅信息主题
   
8. const char* client_id = "clientId-ApjJZcy9Dh";                   // 标识当前设备的客户端编号
   
9. 
   
10. WiFiClient espClient;                                                         // 定义wifiClient实例
    
11. PubSubClient client(espClient);                                         // 定义PubSubClient的实例
    
12. long lastMsg = 0;
    

复制代码

然后是初始化

1. void setup() {
   
2.   pinMode(BUILTIN_LED, OUTPUT);     // 定义板载LED灯为输出方式
   
3.   Serial.begin(115200);
   
4.   setup_wifi();                                          //执行Wifi初始化，下文有具体描述
   
5.   client.setServer(mqtt_server, 1883);    //设定MQTT服务器与使用的端口，1883是默认的MQTT端口
   
6.   client.setCallback(callback);                 //设定回调方式，当ESP8266收到订阅消息时会调用此方法
   
7. }
   

复制代码

接下来是初始化WIFI

1. void setup_wifi() {
   
2. 
   
3.   delay(10);
   
4.   // 板子通电后要启动，稍微等待一下让板子点亮
   
5.   Serial.println();
   
6.   Serial.print("Connecting to ");
   
7.   Serial.println(ssid);
   
8. 
   
9.   WiFi.begin(ssid, password);
   
10. 
    
11.   while (WiFi.status() != WL_CONNECTED) {
    
12.     delay(500);
    
13.     Serial.print(".");
    
14.   }
    
15. 
    
16.   Serial.println("");
    
17.   Serial.println("WiFi connected");
    
18.   Serial.println("IP address: ");
    
19.   Serial.println(WiFi.localIP());
    
20. }
    

复制代码

连接成功后会在串口监视器中输出当前ESP8266的IP地址。接下来就是编写回调的逻辑，就是当收到一特定的信息时如何让ESP来执行一个具体动作：

1. void callback(char* topic, byte* payload, unsigned int length) {
   
2.   Serial.print("Message arrived [");
   
3.   Serial.print(topic);   // 打印主题信息
   
4.   Serial.print("] ");
   
5.   for (int i = 0; i < length; i++) {
   
6.     Serial.print((char)payload[i]); // 打印主题内容
   
7.   }
   
8.   Serial.println();
   
9. 
   
10.   if ((char)payload[0] == '1') {
    
11.     digitalWrite(BUILTIN_LED, HIGH);   // 亮灯
    
12.   } else {
    
13.     digitalWrite(BUILTIN_LED, LOW);   // 熄灯
    
14.   }
    
15. }
    

复制代码

1. 注意 void callback(char* topic, byte* payload, unsigned int length)的参数是固定的，是一个方法接口除了方法名可改，类型与参数个数都不能错。

复制代码

payload传递过来的内容是个二进制的流，所以可以任何的内容，当然上述代码中我们也可以将其转化为整数来用，另外还可以直接传递JSON格式的数据，这样能让数据更加可读。但在单片机的设备间通信还是以“小”为原则， 能传整数的时候绝不传字符串，这样可以大大减轻整体网络通信的负担同时也可以降低单片机运行的功耗。
接下来我们再写一个方法来防止MQTT服务下线，当断开服务时可以尝试重新连接：

1. void reconnect() {
   
2.   while (!client.connected()) {
   
3.     Serial.print("Attempting MQTT connection...");
   
4.     // Attempt to connect
   
5.     if (client.connect(client_id)) {
   
6.       Serial.println("connected");
   
7.       // 连接成功时订阅主题
   
8.       client.subscribe(TOPIC);
   
9.     } else {
   
10.       Serial.print("failed, rc=");
    
11.       Serial.print(client.state());
    
12.       Serial.println(" try again in 5 seconds");
    
13.       // Wait 5 seconds before retrying
    
14.       delay(5000);
    
15.     }
    
16.   }
    
17. }
    

复制代码

最后就是主循环,主循环的逻辑非常简单：

• MQTT是否连接，没有就重试
• 每隔2秒向home/status/主题发一个设备上线的信息
  

具体代码如下：

1. void loop() {
   
2. 
   
3.   if (!client.connected()) {
   
4.     reconnect();
   
5.   }
   
6.   client.loop();
   
7. 
   
8.   long now = millis();
   
9.   if (now - lastMsg > 2000) {
   
10.     lastMsg = now;
    
11.     client.publish("home/status/", "{device:client_id,'status':'on'}");
    
12.   }
    
13. }
    
14. 
    

复制代码

以下是本例的全部代码:

1. #include <ESP8266WiFi.h>
   
2. #include <PubSubClient.h>
   
3. 
   
4. const char* ssid = "网络SSID";
   
5. const char* password = "密码";
   
6. const char* mqtt_server = "broker.mqtt-dashboard.com"; // 使用HIVEMQ 的信息中转服务
   
7. const char* TOPIC = "home/devices/onoff/";                     // 订阅信息主题
   
8. const char* client_id = "clientId-ApjJZcy9Dh";                   // 标识当前设备的客户端编号
   
9. 
   
10. WiFiClient espClient;                                                         // 定义wifiClient实例
    
11. PubSubClient client(espClient);                                         // 定义PubSubClient的实例
    
12. long lastMsg = 0;                                                               // 记录上一次发送信息的时长
    
13. 
    
14. void setup() {
    
15.   pinMode(BUILTIN_LED, OUTPUT);                               // 定义板载LED灯为输出方式
    
16.   Serial.begin(115200);
    
17.   setup_wifi();                                                                    //执行Wifi初始化，下文有具体描述
    
18.   client.setServer(mqtt_server, 1883);                              //设定MQTT服务器与使用的端口，1883是默认的MQTT端口
    
19.   client.setCallback(callback);                                          //设定回调方式，当ESP8266收到订阅消息时会调用此方法
    
20. }
    
21. 
    
22. void setup_wifi() {
    
23. 
    
24.   delay(10);
    
25.   // 板子通电后要启动，稍微等待一下让板子点亮
    
26.   Serial.println();
    
27.   Serial.print("Connecting to ");
    
28.   Serial.println(ssid);
    
29. 
    
30.   WiFi.begin(ssid, password);
    
31. 
    
32.   while (WiFi.status() != WL_CONNECTED) {
    
33.     delay(500);
    
34.     Serial.print(".");
    
35.   }
    
36. 
    
37.   Serial.println("");
    
38.   Serial.println("WiFi connected");
    
39.   Serial.println("IP address: ");
    
40.   Serial.println(WiFi.localIP());
    
41. }
    
42. 
    
43. void callback(char* topic, byte* payload, unsigned int length) {
    
44.   Serial.print("Message arrived [");
    
45.   Serial.print(topic);   // 打印主题信息
    
46.   Serial.print("] ");
    
47.   for (int i = 0; i < length; i++) {
    
48.     Serial.print((char)payload[i]); // 打印主题内容
    
49.   }
    
50.   Serial.println();
    
51. 
    
52.   if ((char)payload[0] == '1') {
    
53.     digitalWrite(BUILTIN_LED, HIGH);   // 亮灯
    
54.   } else {
    
55.     digitalWrite(BUILTIN_LED, LOW);   // 熄灯
    
56.   }
    
57. }
    
58. 
    
59. void reconnect() {
    
60.   while (!client.connected()) {
    
61.     Serial.print("Attempting MQTT connection...");
    
62.     // Attempt to connect
    
63.     if (client.connect(client_id)) {
    
64.       Serial.println("connected");
    
65.       // 连接成功时订阅主题
    
66.       client.subscribe(TOPIC);
    
67.     } else {
    
68.       Serial.print("failed, rc=");
    
69.       Serial.print(client.state());
    
70.       Serial.println(" try again in 5 seconds");
    
71.       // Wait 5 seconds before retrying
    
72.       delay(5000);
    
73.     }
    
74.   }
    
75. }
    
76. 
    
77. void loop() {
    
78. 
    
79.   if (!client.connected()) {
    
80.     reconnect();
    
81.   }
    
82.   client.loop();
    
83. 
    
84.   long now = millis();
    
85.   if (now - lastMsg > 2000) {
    
86.     lastMsg = now;
    
87.     client.publish("home/status/", "{device:client_id,'status':'on'}");
    
88.   }
    
89. }
    

复制代码