Arduino MQTT客户端库PubSubClient快速入门

目的

MQTT是比较常用在物联网设备中的通讯协议,这篇文章将使用 Arudino ESP32 作为MQTT客户端进行通讯使用演示。目前Arduino的MQTT客户端库中最常使用的是 PubSubClient ,所以本文也将以此进行说明。

主页:https://pubsubclient.knolleary.net/
项目地址:https://github.com/knolleary/pubsubclient
目前 PubSubClient 库版本为 v2.8 ,主要基于 MQTT 3.1.1 ,不支持 MQTT 5.0 的新增特性,订阅主题只支持 Qos 0 和 1

This library provides a client for doing simple publish/subscribe messaging with a server that supports MQTT.

基础说明

MQTT的一些基础内容可以参考下面文章:
《MQTT基础入门与资料收集》
因为测试需要有 MQTT Broker(服务器) ,可以参考上面文章进行启动,或者也可以申请一个免费的在线的云服务使用。

PubSubClient 库使用很简单,主要就是分为下面几步:

  1. 声明 PubSubClient 对象;
  2. 因为MQTT需要在TCP之上工作,所以需要给 PubSubClient 对象一个TCP对象;
  3. 使用 setServer 方法设置MQTT服务器的地址和端口号;
  4. 使用 setCallback 方法设置通讯消息回调函数 void callback(char *topic, byte *payload, unsigned int length)(如果不需要订阅消息则无需此步骤);
  5. 使用 connect 方法启动连接;
  6. 使用 subscribe 方法订阅主题或使用 publish 方法向某个主题发布消息;

上面步骤中 2、3、4 步顺序并无要求,并且可以在第一步声明对象的构造函数中直接传入。

在使用 connect 方法进行连接时可以选择填入 Will Qos Will Retain Will Message cleanSession 信息(默认为 0 0 0 1 )。发送消息时可以选择填入 retained (默认为 false )。

默认情况下发送和接收数据都会依赖buffer,当发送或者接收的消息比buffer可容纳的空间(默认256字节)大的时候将会忽略这条消息。可以使用 setBufferSize 方法来设置buffer大小。

上面的 publish 方法发送消息时会先将消息拷贝到缓存,这在大数据发送时效率并不好,可以先使用 beginPublish 方法启动传输,然后单次或多次使用 write 方法写数据(也可以使用 print 等方法),最后使用 endPublish 完成本次消息发送,减少一次拷贝,效率上会高很多。

可以使用 setKeepAlive 方法来设置 Keep Alive 时间(默认为15s)。

使用 disconnect 方法可以关闭连接,使用 connected 方法可以检查是否连接。使用 unsubscribe 方法可以取消订阅消息。

使用 state 方法可以获得 PubSubClient 对象当前的状态,状态定义如下:

// Possible values for client.state()
#define MQTT_CONNECTION_TIMEOUT     -4
#define MQTT_CONNECTION_LOST        -3
#define MQTT_CONNECT_FAILED         -2
#define MQTT_DISCONNECTED           -1
#define MQTT_CONNECTED               0
#define MQTT_CONNECT_BAD_PROTOCOL    1
#define MQTT_CONNECT_BAD_CLIENT_ID   2
#define MQTT_CONNECT_UNAVAILABLE     3
#define MQTT_CONNECT_BAD_CREDENTIALS 4
#define MQTT_CONNECT_UNAUTHORIZED    5

示例代码

#include <WiFi.h>
#include <PubSubClient.h>

// WiFi相关配置信息
const char *wifi_ssid = "********";
const char *wifi_password = "********";

// MQTT相关配置信息
const char *mqtt_broker_addr = "********"; // 服务器地址
const uint16_t mqtt_broker_port = 1883; // 服务端口号            
const char *mqtt_username = "********"; // 账号(非必须)
const char *mqtt_password = "********"; // 密码(非必须)
const uint16_t mqtt_client_buff_size = 4096; // 客户端缓存大小(非必须)
String mqtt_client_id = "esp32_client"; // 客户端ID
const char *mqtt_topic_pub = "esp32/test"; // 需要发布到的主题
const char *mqtt_topic_sub = "esp32/test"; // 需要订阅的主题

WiFiClient tcpClient;
PubSubClient mqttClient;

// MQTT消息回调函数,该函数会在PubSubClient对象的loop方法中被调用
void mqtt_callback(char *topic, byte *payload, unsigned int length)
{
    Serial.printf("Message arrived in topic %s, length %d\n", topic, length);
    Serial.print("Message:");
    for (int i = 0; i < length; i++)
    {
        Serial.print((char)payload[i]);
    }
    Serial.println("\n----------------END----------------");
}

void setup()
{
    Serial.begin(115200);
    Serial.println();

    // 连接网络
    Serial.printf("\nConnecting to %s", wifi_ssid);
    WiFi.begin(wifi_ssid, wifi_password);
    while (WiFi.status() != WL_CONNECTED)
    {
        delay(500);
        Serial.print(".");
    }
    Serial.println("ok.");
    Serial.print("IP address: ");
    Serial.println(WiFi.localIP());

    // 设置MQTT客户端
    mqttClient.setClient(tcpClient);
    mqttClient.setServer(mqtt_broker_addr, mqtt_broker_port);
    mqttClient.setBufferSize(mqtt_client_buff_size);
    mqttClient.setCallback(mqtt_callback);
}

unsigned long previousConnectMillis = 0; // 毫秒时间记录
const long intervalConnectMillis = 5000; // 时间间隔
unsigned long previousPublishMillis = 0; // 毫秒时间记录
const long intervalPublishMillis = 5000; // 时间间隔

void loop()
{
    unsigned long currentMillis = millis(); // 读取当前时间

    // 连接MQTT服务器
    if (!mqttClient.connected()) // 如果未连接
    {
        if (currentMillis - previousConnectMillis > intervalConnectMillis)
        {
            previousConnectMillis = currentMillis;
            mqtt_client_id += String(WiFi.macAddress()); // 每个客户端需要有唯一的ID,不然上线时会把其他相同ID的客户端踢下线
            if (mqttClient.connect(mqtt_client_id.c_str())) // 尝试连接服务器
            // if (mqttClient.connect(mqtt_client_id.c_str(), mqtt_username, mqtt_password))
            {
                mqttClient.publish(mqtt_topic_pub, "hello mqtt!"); // 连接成功后可以发送消息
                mqttClient.subscribe(mqtt_topic_sub); // 连接成功后可以订阅主题
            }
        }
    }

    // 定期发送消息
    if (mqttClient.connected())
    {
        if (currentMillis - previousPublishMillis >= intervalPublishMillis) // 如果和前次时间大于等于时间间隔
        {
            previousPublishMillis = currentMillis;
            mqttClient.publish(mqtt_topic_pub, "naisu 233~~~");
        }
    }

    // 处理MQTT事务
    mqttClient.loop();
}

上面代码示例演示的是非加密的mqtt,实际业务中更多的可能会使用加密的mqtts,这个时候TCP客户端就需要使用 #include <WiFiClientSecure.h> 库中的 WiFiClientSecure 对象了。TCP客户端需要使用 setCACert 或者 getFingerprintSHA256 等方法设置证书或者指纹,另外可能需要从NTP服务器获取时间。( WiFiClientSecure对象可以使用 setInsecure 方法,可以不用管证书这些,测试使用没问题,实际使用中可能会有安全风险)

总结

MQTT作为客户端使用本身比较简单,PubSubClient用起来也非常简单,基本上一般的使用有上面内容就够了。

  • 6
    点赞
  • 45
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
### 回答1: 首先,你需要准备需要的硬件和软件(如Arduino IDE、ESP8266模块和MQTT)。然后,你需要连接ESP8266模块到Arduino IDE,并下载MQTT。最后,你需要编写代码,将ESP8266连接到MQTT服务器,并实现消息发布和订阅。 ### 回答2: 要生成ArduinoMQTT客户端,需要遵循以下步骤: 1. 首先,确保你已经安装了Arduino IDE软件,并且已经连接了你的Arduino开发板到电脑。 2. 下载并安装Arduino MQTT。这个提供了一些功能,如连接到MQTT代理服务器、发布和接收消息等等。你可以从Arduino管理器中搜索并安装适合你的MQTT。 3. 打开Arduino IDE软件并创建一个新的项目。在项目中,通过导入MQTT来使用其功能。你可以在代码中使用类似`#include <MQTT.h>`的语句引入MQTT。 4. 配置MQTT客户端的连接参数。这些参数包括MQTT代理服务器的IP地址、端口号、用户名和密码等。你可以在你的代码中使用类似`client.setServer("broker.example.com", 1883)`的语句来设置MQTT代理服务器的地址和端口。 5. 建立与MQTT代理服务器的连接。使用类似`client.connect("arduino", "user", "password")`的语句来连接到MQTT代理服务器。确保你提供了正确的用户名和密码。 6. 在连接建立之后,你可以发布和接收消息。使用`client.publish(topic, message)`来发布消息到指定的主题(topic)。使用`client.subscribe(topic)`来订阅指定主题并接收消息。 7. 最后,你可以在Arduino代码中添加其他逻辑来处理接收到的消息或者实现其他功能。 以上是生成ArduinoMQTT客户端的简要步骤。根据你的具体需求,你可以根据MQTT的文档和示例代码进行更详细的配置和使用。 ### 回答3: 生成ArduinoMQTT客户端可以通过使用Arduino实现。首先,需要安装Arduino IDE,并通过Arduino管理器安装MQTT。 安装完MQTT后,在Arduino IDE中打开一个新的项目。在代码中引入MQTT,并创建一个MQTT客户端的实例。 然后,需要设置MQTT服务器的连接信息,如服务器地址、端口号等。使用MQTT客户端的connect()函数连接到服务器。 在连接成功后,可以使用subscribe()函数订阅特定的主题,以接收指定主题下的消息。可以在回调函数中处理接收到的消息。 如果希望发布消息,可以使用publish()函数发布消息到指定的主题。 最后,在主循环中使用MQTT客户端的loop()函数来处理MQTT通信。这将负责处理与服务器的通信以及回调函数的触发。 完成以上步骤后,就成功生成了ArduinoMQTT客户端。可以根据项目需求,使用其他传感器或模块与MQTT客户端进行集成,实现更多的应用。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Naisu Xu

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值