Подключаем ESP32 к брокеру Mosquitto

  • Михаил
  • 12 мин. на прочтение
  • 51
  • 11 Jan 2023
  • 12 Jan 2023

Сегодня будем учится использовать протокол mqtt для работы с брокером сообщений Mosquitto, который мы уже установили и настроили ранее, используя плату ESP32.  Для этого нам сначала нужно выполнить следующее:

Arduino IDE

Мы используем Arduino IDE, поэтому убедитесь, что плата ESP32 установлена в среде разработки.

Библиотеки MQTT

Для использования MQTT используем библиотеку Async MQTT Client:

  • Скачайте библиотеку;
  • Разархивируйте папку;
  • Переименуйте папку в «async_mqtt_client»;
  • Переместите ее в папку библиотек Arduino;
  • И наконец, откройте заново среду разработки.

Вы также можете перейти Скетч>Подключить библиотеку> Добавить .ZIP библиотеку  и выбрать только что скачанную библиотеку.

Установка библиотеки Async TCP

Эта библиотека также нам потребуется для работы брокера.

  • Скачайте библиотеку;
  • Разархивируйте папку;
  • Переименуйте папку в «AsyncTCP»;
  • Переместите ее в папку библиотек Arduino;
  • И наконец, откройте заново среду разработки.

Вы также можете перейти Скетч>Подключить библиотеку> Добавить .ZIP библиотеку  и выбрать только что скачанную библиотеку.

 

Публикация сообщений в брокере с платы ESP32

Скопируйте следующий код в вашу среду разработки. Для того, чтобы код у вас работал, потребуется ввести свои учетные данные сети, IP адрес брокера, логин и пароль от брокера.

/*
Rui Santos
Complete project details at https://RandomNerdTutorials.com/cloud-mqtt-mosquitto-broker-access-anywhere-digital-ocean/

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files.

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
*/

#include 
extern "C" {
#include "freertos/FreeRTOS.h"
#include "freertos/timers.h"
}
#include 

#define WIFI_SSID "УКАЖИТЕ_СВОЙ_SSID"
#define WIFI_PASSWORD "УКЖИТЕ_ПАРОЛЬ_СЕТИ"

// Указываем IP адрес MQTT_HOST
#define MQTT_HOST IPAddress(XXX, XXX, XXX, XXX)
// Для облачного брокера вводим доменное имя
//#define MQTT_HOST "example.com"
#define MQTT_PORT 1883

#define MQTT_USERNAME "ВВЕДИТЕ_ЛОГИН_БРОКЕРА"
#define MQTT_PASSWORD "УКАЖИТЕ_ПАРОЛЬ_БРОКЕРА"

// Тестируем брокера
#define MQTT_PUB_TEST "test"

AsyncMqttClient mqttClient;
TimerHandle_t mqttReconnectTimer;
TimerHandle_t wifiReconnectTimer;

unsigned long previousMillis = 0;   // Переменная хранит время
//последнего снятия показаний температуры
const long interval = 5000;         // Задаёт интервал, через который
//публикуются показания датчика

int i = 0;

void connectToWifi() {
Serial.println("Connecting to Wi-Fi...");
WiFi.begin(WIFI_SSID, WIFI_PASSWORD);
}

void connectToMqtt() {
Serial.println("Connecting to MQTT...");
mqttClient.connect();
}

void WiFiEvent(WiFiEvent_t event) {
Serial.printf("[WiFi-event] event: %d\n", event);
switch(event) {
case SYSTEM_EVENT_STA_GOT_IP:
Serial.println("WiFi connected");
Serial.println("IP address: ");
Serial.println(WiFi.localIP());
connectToMqtt();
break;
case SYSTEM_EVENT_STA_DISCONNECTED:
Serial.println("WiFi lost connection");
xTimerStop(mqttReconnectTimer, 0); //при попытке переподключения к WiFi
//система не будет пытаться подключиться к MQTT
xTimerStart(wifiReconnectTimer, 0);
break;
}
}

void onMqttConnect(bool sessionPresent) {
Serial.println("Connected to MQTT.");
Serial.print("Session present: ");
Serial.println(sessionPresent);
}

void onMqttDisconnect(AsyncMqttClientDisconnectReason reason) {
Serial.println("Disconnected from MQTT.");
if (WiFi.isConnected()) {
xTimerStart(mqttReconnectTimer, 0);
}
}

/*void onMqttSubscribe(uint16_t packetId, uint8_t qos) {
Serial.println("Subscribe acknowledged.");
Serial.print("  packetId: ");
Serial.println(packetId);
Serial.print("  qos: ");
Serial.println(qos);
}
void onMqttUnsubscribe(uint16_t packetId) {
Serial.println("Unsubscribe acknowledged.");
Serial.print("  packetId: ");
Serial.println(packetId);
}*/

void onMqttPublish(uint16_t packetId) {
Serial.print("Publish acknowledged.");
Serial.print("  packetId: ");
Serial.println(packetId);
}

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

mqttReconnectTimer = xTimerCreate("mqttTimer", pdMS_TO_TICKS(2000), pdFALSE, (void*)0, reinterpret_cast(connectToMqtt));
wifiReconnectTimer = xTimerCreate("wifiTimer", pdMS_TO_TICKS(2000), pdFALSE, (void*)0, reinterpret_cast(connectToWifi));

WiFi.onEvent(WiFiEvent);

mqttClient.onConnect(onMqttConnect);
mqttClient.onDisconnect(onMqttDisconnect);
/*mqttClient.onSubscribe(onMqttSubscribe);
mqttClient.onUnsubscribe(onMqttUnsubscribe);*/
mqttClient.onPublish(onMqttPublish);
mqttClient.setServer(MQTT_HOST, MQTT_PORT);
mqttClient.setCredentials(MQTT_USERNAME, MQTT_PASSWORD);
connectToWifi();
}

void loop() {
unsigned long currentMillis = millis();
// Каждые X секунд (у нас интервал 5 секунд)
// публикует новое сообщение
if (currentMillis - previousMillis >= interval) {
// Сохраняем время последней публикации
previousMillis = currentMillis;

String testString = "Hello, world! #" + String(i);
// Публикуем тестовое сообщение
uint16_t packetIdPub1 = mqttClient.publish(MQTT_PUB_TEST, 1, true, String(testString).c_str());
Serial.printf("Publishing on topic %s at QoS 1, packetId: %i", MQTT_PUB_TEST, packetIdPub1);
Serial.printf(" Message: %.2f \n", testString);
i++;
}
}

Для работы кода введите учетные данные сети в этих строках:

#define WIFI_SSID "УКАЖИТЕ_СВОЙ_SSID"
#define WIFI_PASSWORD "УКАЖИТЕ_ПАРОЛЬ”

Вводим IP адрес mqtt сервера( в нашем случае 10.10.11.50).

#define MQTT_HOST IPAddress(10, 10, 11, 50)

Если ваш брокер требует авторизации, то вводим логин и пароль:

#define MQTT_USERNAME "ЛОГИН"
#define MQTT_PASSWORD "ПАРОЛЬ"

 

Посмотреть публикацию сообщений можно в MQTT Explorer

Или же установите SSH соединение с помощью SSH клиента (например, PuTTY) и подписаться на топик введя:

mosquitto_sub -h localhost -t test -u "YOUR_USER" -P "YOUR_PASSWORD"

Вы должны начать получать сообщения, опубликованные вашей платой:

 

Подписка на топик брокера с платы ESP32


Следующий скетч реализует подписку платы к облачному брокеру для получения сообщения. Скопируйте его в свою среду разработки, укажите свои учетные данные сети, IP адрес mqtt сервера, логин и пароль брокера.

/*
Rui Santos
Complete project details at https://RandomNerdTutorials.com/cloud-mqtt-mosquitto-broker-access-anywhere-digital-ocean/

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files.

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
*/

#include 
extern "C" {
#include "freertos/FreeRTOS.h"
#include "freertos/timers.h"
}
#include 

#define WIFI_SSID "УКАЖИТЕ_СВОЙ_SSID"
#define WIFI_PASSWORD "УКАЖИТЕ_ПАРОЛЬ"

// Указываем IP адрес брокера
#define MQTT_HOST IPAddress(XXX, XXX, XXX, XXX)
// Для облачного брокера указываем доменное имя
//#define MQTT_HOST "example.com"
#define MQTT_PORT 1883

#define MQTT_USERNAME "УКАЖИТЕ_ЛОГИН_БРОКЕРА"
#define MQTT_PASSWORD "УКАЖИТЕ_ПАРОЛЬ_БРОКЕРА"

// Тестируем брокера
#define MQTT_SUB_TEST "test"

AsyncMqttClient mqttClient;
TimerHandle_t mqttReconnectTimer;
TimerHandle_t wifiReconnectTimer;

unsigned long previousMillis = 0;   // Хранит последнее время публикации
const long interval = 5000;         // Интервал публикации показаний

int i = 0;

void connectToWifi() {
Serial.println("Connecting to Wi-Fi...");
WiFi.begin(WIFI_SSID, WIFI_PASSWORD);
}

void connectToMqtt() {
Serial.println("Connecting to MQTT...");
mqttClient.connect();
}

void WiFiEvent(WiFiEvent_t event) {
Serial.printf("[WiFi-event] event: %d\n", event);
switch(event) {
case SYSTEM_EVENT_STA_GOT_IP:
Serial.println("WiFi connected");
Serial.println("IP address: ");
Serial.println(WiFi.localIP());
connectToMqtt();
break;
case SYSTEM_EVENT_STA_DISCONNECTED:
Serial.println("WiFi lost connection");
xTimerStop(mqttReconnectTimer, 0); // при переподключении к WiFi
// система не переподключается к MQTT
xTimerStart(wifiReconnectTimer, 0);
break;
}
}

// Добавляем топики, на которые нужно подписать плату
void onMqttConnect(bool sessionPresent) {
Serial.println("Connected to MQTT.");
Serial.print("Session present: ");
Serial.println(sessionPresent);

// Подписываем плату на тестовый топик
uint16_t packetIdSub = mqttClient.subscribe(MQTT_SUB_TEST, 0);
Serial.println("Subscribing at QoS 0");
}

void onMqttDisconnect(AsyncMqttClientDisconnectReason reason) {
Serial.println("Disconnected from MQTT.");
if (WiFi.isConnected()) {
xTimerStart(mqttReconnectTimer, 0);
}
}

void onMqttSubscribe(uint16_t packetId, uint8_t qos) {
Serial.println("Subscribe acknowledged.");
Serial.print("  packetId: ");
Serial.println(packetId);
Serial.print("  qos: ");
Serial.println(qos);
}

void onMqttUnsubscribe(uint16_t packetId) {
Serial.println("Unsubscribe acknowledged.");
Serial.print("  packetId: ");
Serial.println(packetId);
}

// Вы можете изменить эту функцию для получения информации о конкретном
//сообщении в конкретном топике
void onMqttMessage(char* topic, char* payload, AsyncMqttClientMessageProperties properties, size_t len, size_t index, size_t total) {
String messageTemp;
for (int i = 0; i < len; i++) {
//Serial.print((char)payload[i]);
messageTemp += (char)payload[i];
}
// Проверяем наличие новых сообщений
if (strcmp(topic, MQTT_SUB_TEST) == 0) {
Serial.println("TRUE");
}

Serial.println("Publish received.");
Serial.print("  message: ");
Serial.println(messageTemp);
Serial.print("  topic: ");
Serial.println(topic);
Serial.print("  qos: ");
Serial.println(properties.qos);
Serial.print("  dup: ");
Serial.println(properties.dup);
Serial.print("  retain: ");
Serial.println(properties.retain);
Serial.print("  len: ");
Serial.println(len);
Serial.print("  index: ");
Serial.println(index);
Serial.print("  total: ");
Serial.println(total);
}

/*void onMqttPublish(uint16_t packetId) {
Serial.print("Publish acknowledged.");
Serial.print("  packetId: ");
Serial.println(packetId);
}*/

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

mqttReconnectTimer = xTimerCreate("mqttTimer", pdMS_TO_TICKS(2000), pdFALSE, (void*)0, reinterpret_cast(connectToMqtt));
wifiReconnectTimer = xTimerCreate("wifiTimer", pdMS_TO_TICKS(2000), pdFALSE, (void*)0, reinterpret_cast(connectToWifi));

WiFi.onEvent(WiFiEvent);

mqttClient.onConnect(onMqttConnect);
mqttClient.onDisconnect(onMqttDisconnect);
mqttClient.onSubscribe(onMqttSubscribe);
mqttClient.onUnsubscribe(onMqttUnsubscribe);
//mqttClient.onPublish(onMqttPublish);
mqttClient.onMessage(onMqttMessage);
mqttClient.setServer(MQTT_HOST, MQTT_PORT);
// Указываем логин и пароль брокера
mqttClient.setCredentials(MQTT_USERNAME, MQTT_PASSWORD);
connectToWifi();
}

void loop() {

}

Для проверки получения сообщений платой запустите консоль на сервере и отправьте несколько разных сообщений:

mosquitto_pub -h localhost -t test -m "Hi #1!" -u "ruisantos" -P "YOUR_PASSWORD"
mosquitto_pub -h localhost -t test -m "Hi #2!" -u "ruisantos" -P "YOUR_PASSWORD"
mosquitto_pub -h localhost -t test -m "Hi #3!" -u "ruisantos" -P "YOUR_PASSWORD"

Ваша плата должна получать эти сообщения и выводить их в монитор порта

В этих примерах мы разобрали. как публиковать сообщения и подписываться на топики с помощью брокера. Идея в том, чтобы использовать разные платы для публикации и приема сообщений для взаимодействия между платами.