В данном руководстве рассмотри, как запустить брокера Mosquitto для работы протокола MQTT на базе виртуальной машины с Ubuntu и виртуального хостинга Digital Ocean. Использование брокера через хостинг позволит подключаться к нескольким платам ESP32/ESP8266 и другим устройствам IoT отовсюду, где есть интернет. Также рассмотрим, как подключать платы к брокеру в Arduino IDE.
MQTT или Message Queue Telemetry Transport – это легкий, компактный и открытый протокол обмена данными созданный для передачи данных на удалённых локациях, где требуется небольшой размер кода и есть ограничения по пропускной способности канала.
Брокер MQTT в основном отвечает за получение всех сообщений, отправленных по этому протоколу, их фильтрацию, определение получателей и передачу их конечным устройствам.
Брокеров достаточно много, мы используем один из самых популярных – Mosquitto MQTT Broker. Он очень прост в установке, конфигурации и использовании.
В данном руководстве мы установим его на виртуальную машину Linux Ubuntu, запущенной на хостинге Digital Ocean.
В чем преимущества данного брокера? Как его использовать?
Использование облачного брокера позволяет нескольким устройствам IoT (например, платы ESP32/ESP8266) взаимодействовать друг с другом используя протокол MQTT, даже если они работают в разных сетях и разнесены в пространстве.
Собственно, как работает данная сеть? Платы подключены к одному и тому же брокеру, включенному на хостинге. Так они могут взаимодействовать друг с другом (отправлять данные путем публикации данных в топик на брокере и получать их путем подписки на соответствующий топик)
На следующей схеме изображен пример приложения с использованием облачного брокера.
Из чего состоит данное приложение?
Вы также можете установить Node-RED на этом же хостинге для управления и мониторинга ваших плат с компьютера или смартфона.
Для подключения облачного брокера потребуется хостинг, на котором можно использовать командную строке и устанавливать любой софт. Digital Ocean удовлетворяет этим требованиям.
Примечание: Вы также можете запустить брокер в локальной сети используя плату Raspberry Pi. Тем не менее, цель данного руководства заключается именно в создании облачного брокера.
Переходим по ссылке Digital Ocean и нажимаем кнопку «Sign up»
Создав аккаунт, вы получите 100$ на счет, их вы можете потратить на 60-дневный пробный период. Потребуется привязать карту, но если вы можете отменить подписку в течение пробного периода, если она больше вам не потребуется.
Создайте аккаунт:
После подтверждения аккаунта, зайдите в него:
Нажимаем «Create» для создания виртуальной машины и выбираем «Droplets» (так Digital Ocean называет виртуальные машины).
Важно: Если у вас уже есть дроплет с установленной Node RED, вы можете пропустить создание виртуальной машины. На одном сервере можно запустить одновременно и Mosquitto MQTT и Node RED.
В этом руководстве мы будем использовать Ubuntu 20.04 (LTS) x64. Вы можете использовать либо эту ОС, либо выбрать план «Basic»:
В меню ресурсов виртуальной машины стоит выбрать самый дешевый план за 5$ в месяц. Наш брокер будет нормально работать даже при таких ресурсах.
Выбираем местоположение ближайшего датацентра для виртуальной машины:
Создаем пароль для доступа к дроплету:
Ну и наконец, выбираем имя хоста для идентификации виртуальной машины (в нашем случае – «mqtt-cloud-server»). Осталось нажать большую зеленую кнопку «Create Droplet».
Ждем окончания процесса создания виртуальной машины.
Открываем созданный сервер:
Выбираем меню «Access» и нажимаем «Launch console»:
Откроется новое окно в браузере:
Введите логин и пароль для сервера и нажмите Enter:
Перед установкой софта обновите ваш сервер
|
1 |
sudo apt update && sudo apt upgrade -y |
Для установки брокера введите команду:
|
1 |
sudo apt install mosquitto mosquitto-clients -y |
Для проверки установки вы можете открыть второе окно терминала и установить SSH соединение с сервером (можно использовать PuTTY или любой другой SSH клиент):
Вводим логин и пароль от сервера. Затем вводим следующую команду подписки для проверки работы топика:
|
1 |
mosquitto_sub -h localhost -t test |
В первом окне терминала вводим команду для публикации тестового сообщения в топик:
|
1 |
mosquitto_pub -h localhost -t test -m "Hello, world!" |
Оно должно появиться во втором терминале:
Пока что любой, кто знает IP адрес вашего брокера может публиковать или подписываться на ваши топики. Мы можем добавить аутентификацию через логин и пароль на наш сервер.
Вводим простую команду (нужно заменить YOUR_USERNAME на логин, который вы будете использовать):
|
1 |
sudo mosquitto_passwd -c /etc/mosquitto/passwd YOUR_USERNAME |
Когда вы отправите эту команду, система потребует ввести пароль. Введите его и запомните.
Наконец, открываем файл default.conf для редактирования:
|
1 |
sudo nano /etc/mosquitto/conf.d/default.conf |
Добавляем в файл следующие две строки (они отвечают за требование авторизации для публикации/подписки)
|
1 2 3 |
allow_anonymous false password_file /etc/mosquitto/passwd |
Файл должен выглядеть следующим образом:
Сохраняем и закрываем файл (Ctrl+X, Y, Enter) и перезапускаем брокера.
|
1 |
sudo systemctl restart mosquito |
Теперь при попытке опубликовать тестовое сообщение без ввода логина и пароля:
|
1 |
mosquitto_pub -h localhost -t test -m "Hello, world!" |
Вы получите сообщение «Connection error: Connection refused: not authorised»
Попробуем подписаться на топик брокера с использованием аргументов –u и –P (проведение аутентификации):
|
1 |
mosquitto_sub -h localhost -t test -u "ruisantos" -P "YOUR_PASSWORD" |
Делаем то же самое для публикации сообщения:
|
1 |
mosquitto_pub -h localhost -t test -m "Hello, world!" -u "ruisantos" -P "YOUR_PASSWORD" |
Вот краткий список аргументов для брокера Mosquitto:
| -h | Hostname |
| -t | MQTT топик |
| -m | MQTT сообщение |
| -u | MQTT логин |
| -P | MQTT пароль |
Для этого нам сначала нужно выполнить следующее:
Arduino IDE
Мы используем Arduino IDE, поэтому убедитесь, что плата ESP32 установлена в среде разработки.
Библиотеки MQTT
Для использования MQTT используем библиотеку Async MQTT Client:
Вы также можете перейти Скетч>Подключить библиотеку> Добавить .ZIP библиотеку и выбрать только что скачанную библиотеку.
Установка библиотеки Async TCP
Эта библиотека также нам потребуется для работы брокера.
Вы также можете перейти Скетч>Подключить библиотеку> Добавить .ZIP библиотеку и выбрать только что скачанную библиотеку.
Скопируйте следующий код в вашу среду разработки. Для того, чтобы код у вас работал, потребуется ввести свои учетные данные сети, IP адрес дроплета, логин и пароль от брокера.
|
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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
/* 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 <WiFi.h> extern "C" { #include "freertos/FreeRTOS.h" #include "freertos/timers.h" } #include <AsyncMqttClient.h> #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_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<TimerCallbackFunction_t>(connectToMqtt)); wifiReconnectTimer = xTimerCreate("wifiTimer", pdMS_TO_TICKS(2000), pdFALSE, (void*)0, reinterpret_cast<TimerCallbackFunction_t>(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++; } } |
Для работы кода введите учетные данные сети в этих строках:
|
1 2 3 |
#define WIFI_SSID "УКАЖИТЕ_СВОЙ_SSID" #define WIFI_PASSWORD "УКАЖИТЕ_ПАРОЛЬ” |
Вводим IP адрес дроплета ( в нашем случае 178.62.83.231).
|
1 |
#define MQTT_HOST IPAddress(178, 62, 83, 231) |
Если ваш брокер требует авторизации, то вводим логин и пароль:
|
1 2 3 |
#define MQTT_USERNAME "ЛОГИН" #define MQTT_PASSWORD "ПАРОЛЬ" |
Если вы загрузили код и открыли монитор порта, вы увидите, что плата публикует сообщения каждые 5 секунд:
Установите SSH соединение с помощью SSH клиента (например, PuTTY) и введите:
|
1 |
mosquitto_sub -h localhost -t test -u "YOUR_USER" -P "YOUR_PASSWORD" |
Вы должны начать получать сообщения, опубликованные вашей платой:
Следующий скетч реализует подписку платы к облачному брокеру для получения сообщения. Скопируйте его в свою среду разработки, укажите свои учетные данные сети, IP адрес дроплета, логин и пароль брокера.
|
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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 |
/* 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 <WiFi.h> extern "C" { #include "freertos/FreeRTOS.h" #include "freertos/timers.h" } #include <AsyncMqttClient.h> #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<TimerCallbackFunction_t>(connectToMqtt)); wifiReconnectTimer = xTimerCreate("wifiTimer", pdMS_TO_TICKS(2000), pdFALSE, (void*)0, reinterpret_cast<TimerCallbackFunction_t>(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() { } |
Для работы кода введите учетные данные сети в этих строках:
|
1 2 3 |
#define WIFI_SSID "УКАЖИТЕ_СВОЙ_SSID" #define WIFI_PASSWORD "УКАЖИТЕ_ПАРОЛЬ” |
Вводим IP адрес дроплета ( в нашем случае 178.62.83.231).
|
1 |
#define MQTT_HOST IPAddress(178, 62, 83, 231) |
Если ваш брокер требует авторизации, то вводим логин и пароль:
|
1 2 3 |
#define MQTT_USERNAME "ЛОГИН" #define MQTT_PASSWORD "ПАРОЛЬ" |
Для проверки получения сообщений платой запустите консоль на сервере и отправьте несколько разных сообщений:
|
1 2 3 4 5 |
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" |
Ваша плата должна получать эти сообщения и выводить их в монитор порта:
В этих примерах мы разобрали. как публиковать сообщения и подписываться на топики с помощью облачного брокера. Идея в том, чтобы использовать разные платы для публикации и приема сообщений для взаимодействия между платами.
В этом руководстве мы разобрали как работает протокол MQTT и брокеры, а также что нужно сделать для публикации и приема сообщений на платах ESP32.
Если у вас неправильно работает сервер или брокер, вы можете написать в поддержку Digital Ocean (у них очень активная техподдержка).
Вольтик
1 комментарий. Оставить новый
Здравствуйте, вопрос: как можно управлять esp32 с хостинга с приложения flask?