Fork of the espurna firmware for `mhsw` switches
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

805 lines
23 KiB

8 years ago
8 years ago
6 years ago
7 years ago
7 years ago
6 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
  1. /*
  2. MQTT MODULE
  3. Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
  4. */
  5. #if MQTT_SUPPORT
  6. #include <EEPROM.h>
  7. #include <ESP8266WiFi.h>
  8. #include <ESP8266mDNS.h>
  9. #include <ArduinoJson.h>
  10. #include <vector>
  11. #include <Ticker.h>
  12. #if MQTT_USE_ASYNC // Using AsyncMqttClient
  13. #include <AsyncMqttClient.h>
  14. AsyncMqttClient _mqtt;
  15. #else // Using PubSubClient
  16. #include <PubSubClient.h>
  17. PubSubClient _mqtt;
  18. bool _mqtt_connected = false;
  19. WiFiClient _mqtt_client;
  20. #if ASYNC_TCP_SSL_ENABLED
  21. WiFiClientSecure _mqtt_client_secure;
  22. #endif // ASYNC_TCP_SSL_ENABLED
  23. #endif // MQTT_USE_ASYNC
  24. bool _mqtt_enabled = MQTT_ENABLED;
  25. bool _mqtt_use_json = false;
  26. unsigned long _mqtt_reconnect_delay = MQTT_RECONNECT_DELAY_MIN;
  27. unsigned char _mqtt_qos = MQTT_QOS;
  28. bool _mqtt_retain = MQTT_RETAIN;
  29. unsigned long _mqtt_keepalive = MQTT_KEEPALIVE;
  30. String _mqtt_topic;
  31. String _mqtt_topic_json;
  32. String _mqtt_setter;
  33. String _mqtt_getter;
  34. bool _mqtt_forward;
  35. char *_mqtt_user = 0;
  36. char *_mqtt_pass = 0;
  37. char *_mqtt_will;
  38. char *_mqtt_clientid;
  39. #if MQTT_SKIP_RETAINED
  40. unsigned long _mqtt_connected_at = 0;
  41. #endif
  42. std::vector<mqtt_callback_f> _mqtt_callbacks;
  43. typedef struct {
  44. char * topic;
  45. char * message;
  46. } mqtt_message_t;
  47. std::vector<mqtt_message_t> _mqtt_queue;
  48. Ticker _mqtt_flush_ticker;
  49. // -----------------------------------------------------------------------------
  50. // Private
  51. // -----------------------------------------------------------------------------
  52. void _mqttConnect() {
  53. // Do not connect if disabled
  54. if (!_mqtt_enabled) return;
  55. // Do not connect if already connected
  56. if (_mqtt.connected()) return;
  57. // Check reconnect interval
  58. static unsigned long last = 0;
  59. if (millis() - last < _mqtt_reconnect_delay) return;
  60. last = millis();
  61. // Increase the reconnect delay
  62. _mqtt_reconnect_delay += MQTT_RECONNECT_DELAY_STEP;
  63. if (_mqtt_reconnect_delay > MQTT_RECONNECT_DELAY_MAX) {
  64. _mqtt_reconnect_delay = MQTT_RECONNECT_DELAY_MAX;
  65. }
  66. String h = getSetting("mqttServer", MQTT_SERVER);
  67. #if MDNS_CLIENT_SUPPORT
  68. h = mdnsResolve(h);
  69. #endif
  70. char * host = strdup(h.c_str());
  71. unsigned int port = getSetting("mqttPort", MQTT_PORT).toInt();
  72. if (_mqtt_user) free(_mqtt_user);
  73. if (_mqtt_pass) free(_mqtt_pass);
  74. if (_mqtt_will) free(_mqtt_will);
  75. if (_mqtt_clientid) free(_mqtt_clientid);
  76. _mqtt_user = strdup(getSetting("mqttUser", MQTT_USER).c_str());
  77. _mqtt_pass = strdup(getSetting("mqttPassword", MQTT_PASS).c_str());
  78. _mqtt_will = strdup(mqttTopic(MQTT_TOPIC_STATUS, false).c_str());
  79. _mqtt_clientid = strdup(getSetting("mqttClientID", getIdentifier()).c_str());
  80. DEBUG_MSG_P(PSTR("[MQTT] Connecting to broker at %s:%d\n"), host, port);
  81. #if MQTT_USE_ASYNC
  82. _mqtt.setServer(host, port);
  83. _mqtt.setClientId(_mqtt_clientid);
  84. _mqtt.setKeepAlive(_mqtt_keepalive);
  85. _mqtt.setCleanSession(false);
  86. _mqtt.setWill(_mqtt_will, _mqtt_qos, _mqtt_retain, "0");
  87. if ((strlen(_mqtt_user) > 0) && (strlen(_mqtt_pass) > 0)) {
  88. DEBUG_MSG_P(PSTR("[MQTT] Connecting as user %s\n"), _mqtt_user);
  89. _mqtt.setCredentials(_mqtt_user, _mqtt_pass);
  90. }
  91. #if ASYNC_TCP_SSL_ENABLED
  92. bool secure = getSetting("mqttUseSSL", MQTT_SSL_ENABLED).toInt() == 1;
  93. _mqtt.setSecure(secure);
  94. if (secure) {
  95. DEBUG_MSG_P(PSTR("[MQTT] Using SSL\n"));
  96. unsigned char fp[20] = {0};
  97. if (sslFingerPrintArray(getSetting("mqttFP", MQTT_SSL_FINGERPRINT).c_str(), fp)) {
  98. _mqtt.addServerFingerprint(fp);
  99. } else {
  100. DEBUG_MSG_P(PSTR("[MQTT] Wrong fingerprint\n"));
  101. }
  102. }
  103. #endif // ASYNC_TCP_SSL_ENABLED
  104. DEBUG_MSG_P(PSTR("[MQTT] Client ID: %s\n"), _mqtt_clientid);
  105. DEBUG_MSG_P(PSTR("[MQTT] QoS: %d\n"), _mqtt_qos);
  106. DEBUG_MSG_P(PSTR("[MQTT] Retain flag: %d\n"), _mqtt_retain ? 1 : 0);
  107. DEBUG_MSG_P(PSTR("[MQTT] Keepalive time: %ds\n"), _mqtt_keepalive);
  108. DEBUG_MSG_P(PSTR("[MQTT] Will topic: %s\n"), _mqtt_will);
  109. _mqtt.connect();
  110. #else // not MQTT_USE_ASYNC
  111. bool response = true;
  112. #if ASYNC_TCP_SSL_ENABLED
  113. bool secure = getSetting("mqttUseSSL", MQTT_SSL_ENABLED).toInt() == 1;
  114. if (secure) {
  115. DEBUG_MSG_P(PSTR("[MQTT] Using SSL\n"));
  116. if (_mqtt_client_secure.connect(host, port)) {
  117. char fp[60] = {0};
  118. if (sslFingerPrintChar(getSetting("mqttFP", MQTT_SSL_FINGERPRINT).c_str(), fp)) {
  119. if (_mqtt_client_secure.verify(fp, host)) {
  120. _mqtt.setClient(_mqtt_client_secure);
  121. } else {
  122. DEBUG_MSG_P(PSTR("[MQTT] Invalid fingerprint\n"));
  123. response = false;
  124. }
  125. _mqtt_client_secure.stop();
  126. yield();
  127. } else {
  128. DEBUG_MSG_P(PSTR("[MQTT] Wrong fingerprint\n"));
  129. response = false;
  130. }
  131. } else {
  132. DEBUG_MSG_P(PSTR("[MQTT] Client connection failed\n"));
  133. response = false;
  134. }
  135. } else {
  136. _mqtt.setClient(_mqtt_client);
  137. }
  138. #else // not ASYNC_TCP_SSL_ENABLED
  139. _mqtt.setClient(_mqtt_client);
  140. #endif // ASYNC_TCP_SSL_ENABLED
  141. if (response) {
  142. _mqtt.setServer(host, port);
  143. if ((strlen(_mqtt_user) > 0) && (strlen(_mqtt_pass) > 0)) {
  144. DEBUG_MSG_P(PSTR("[MQTT] Connecting as user %s\n"), _mqtt_user);
  145. response = _mqtt.connect(_mqtt_clientid, _mqtt_user, _mqtt_pass, _mqtt_will, _mqtt_qos, _mqtt_retain, "0");
  146. } else {
  147. response = _mqtt.connect(_mqtt_clientid, _mqtt_will, _mqtt_qos, _mqtt_retain, "0");
  148. }
  149. DEBUG_MSG_P(PSTR("[MQTT] Client ID: %s\n"), _mqtt_clientid);
  150. DEBUG_MSG_P(PSTR("[MQTT] QoS: %d\n"), _mqtt_qos);
  151. DEBUG_MSG_P(PSTR("[MQTT] Retain flag: %d\n"), _mqtt_retain ? 1 : 0);
  152. DEBUG_MSG_P(PSTR("[MQTT] Keepalive time: %ds\n"), _mqtt_keepalive);
  153. DEBUG_MSG_P(PSTR("[MQTT] Will topic: %s\n"), _mqtt_will);
  154. }
  155. if (response) {
  156. _mqttOnConnect();
  157. } else {
  158. DEBUG_MSG_P(PSTR("[MQTT] Connection failed\n"));
  159. }
  160. #endif // MQTT_USE_ASYNC
  161. free(host);
  162. }
  163. void _mqttConfigure() {
  164. // Get base topic
  165. _mqtt_topic = getSetting("mqttTopic", MQTT_TOPIC);
  166. if (_mqtt_topic.endsWith("/")) _mqtt_topic.remove(_mqtt_topic.length()-1);
  167. // Placeholders
  168. _mqtt_topic.replace("{identifier}", getSetting("hostname"));
  169. _mqtt_topic.replace("{hostname}", getSetting("hostname"));
  170. _mqtt_topic.replace("{magnitude}", "#");
  171. if (_mqtt_topic.indexOf("#") == -1) _mqtt_topic = _mqtt_topic + "/#";
  172. String mac = WiFi.macAddress();
  173. mac.replace(":", "");
  174. _mqtt_topic.replace("{mac}", mac);
  175. // Getters and setters
  176. _mqtt_setter = getSetting("mqttSetter", MQTT_SETTER);
  177. _mqtt_getter = getSetting("mqttGetter", MQTT_GETTER);
  178. _mqtt_forward = !_mqtt_getter.equals(_mqtt_setter);
  179. // MQTT options
  180. _mqtt_qos = getSetting("mqttQoS", MQTT_QOS).toInt();
  181. _mqtt_retain = getSetting("mqttRetain", MQTT_RETAIN).toInt() == 1;
  182. _mqtt_keepalive = getSetting("mqttKeep", MQTT_KEEPALIVE).toInt();
  183. if (getSetting("mqttClientID").length() == 0) delSetting("mqttClientID");
  184. // Enable
  185. if (getSetting("mqttServer", MQTT_SERVER).length() == 0) {
  186. mqttEnabled(false);
  187. } else {
  188. _mqtt_enabled = getSetting("mqttEnabled", MQTT_ENABLED).toInt() == 1;
  189. }
  190. _mqtt_use_json = (getSetting("mqttUseJson", MQTT_USE_JSON).toInt() == 1);
  191. mqttQueueTopic(MQTT_TOPIC_JSON);
  192. _mqtt_reconnect_delay = MQTT_RECONNECT_DELAY_MIN;
  193. }
  194. unsigned long _mqttNextMessageId() {
  195. static unsigned long id = 0;
  196. // just reboot, get last count from EEPROM
  197. if (id == 0) {
  198. // read id from EEPROM and shift it
  199. id = EEPROM.read(EEPROM_MESSAGE_ID);
  200. if (id == 0xFF) {
  201. // There was nothing in EEPROM,
  202. // next message is first message
  203. id = 0;
  204. } else {
  205. id = (id << 8) + EEPROM.read(EEPROM_MESSAGE_ID + 1);
  206. id = (id << 8) + EEPROM.read(EEPROM_MESSAGE_ID + 2);
  207. id = (id << 8) + EEPROM.read(EEPROM_MESSAGE_ID + 3);
  208. // Calculate next block and start from there
  209. id = MQTT_MESSAGE_ID_SHIFT * (1 + (id / MQTT_MESSAGE_ID_SHIFT));
  210. }
  211. }
  212. // Save to EEPROM every MQTT_MESSAGE_ID_SHIFT
  213. if (id % MQTT_MESSAGE_ID_SHIFT == 0) {
  214. EEPROM.write(EEPROM_MESSAGE_ID + 0, (id >> 24) & 0xFF);
  215. EEPROM.write(EEPROM_MESSAGE_ID + 1, (id >> 16) & 0xFF);
  216. EEPROM.write(EEPROM_MESSAGE_ID + 2, (id >> 8) & 0xFF);
  217. EEPROM.write(EEPROM_MESSAGE_ID + 3, (id >> 0) & 0xFF);
  218. EEPROM.commit();
  219. }
  220. id++;
  221. return id;
  222. }
  223. // -----------------------------------------------------------------------------
  224. // WEB
  225. // -----------------------------------------------------------------------------
  226. #if WEB_SUPPORT
  227. void _mqttWebSocketOnSend(JsonObject& root) {
  228. root["mqttVisible"] = 1;
  229. root["mqttStatus"] = mqttConnected();
  230. root["mqttEnabled"] = mqttEnabled();
  231. root["mqttServer"] = getSetting("mqttServer", MQTT_SERVER);
  232. root["mqttPort"] = getSetting("mqttPort", MQTT_PORT);
  233. root["mqttUser"] = getSetting("mqttUser");
  234. root["mqttClientID"] = getSetting("mqttClientID");
  235. root["mqttPassword"] = getSetting("mqttPassword");
  236. root["mqttKeep"] = _mqtt_keepalive;
  237. root["mqttRetain"] = _mqtt_retain;
  238. root["mqttQoS"] = _mqtt_qos;
  239. #if ASYNC_TCP_SSL_ENABLED
  240. root["mqttsslVisible"] = 1;
  241. root["mqttUseSSL"] = getSetting("mqttUseSSL", 0).toInt() == 1;
  242. root["mqttFP"] = getSetting("mqttFP");
  243. #endif
  244. root["mqttTopic"] = getSetting("mqttTopic", MQTT_TOPIC);
  245. root["mqttUseJson"] = getSetting("mqttUseJson", MQTT_USE_JSON).toInt() == 1;
  246. }
  247. #endif
  248. // -----------------------------------------------------------------------------
  249. // SETTINGS
  250. // -----------------------------------------------------------------------------
  251. #if TERMINAL_SUPPORT
  252. void _mqttInitCommands() {
  253. settingsRegisterCommand(F("MQTT.RESET"), [](Embedis* e) {
  254. _mqttConfigure();
  255. mqttDisconnect();
  256. DEBUG_MSG_P(PSTR("+OK\n"));
  257. });
  258. }
  259. #endif // TERMINAL_SUPPORT
  260. // -----------------------------------------------------------------------------
  261. // MQTT Callbacks
  262. // -----------------------------------------------------------------------------
  263. void _mqttCallback(unsigned int type, const char * topic, const char * payload) {
  264. if (type == MQTT_CONNECT_EVENT) {
  265. // Subscribe to internal action topics
  266. mqttSubscribe(MQTT_TOPIC_ACTION);
  267. // Flag system to send heartbeat
  268. systemSendHeartbeat();
  269. }
  270. if (type == MQTT_MESSAGE_EVENT) {
  271. // Match topic
  272. String t = mqttMagnitude((char *) topic);
  273. // Actions
  274. if (t.equals(MQTT_TOPIC_ACTION)) {
  275. if (strcmp(payload, MQTT_ACTION_RESET) == 0) {
  276. deferredReset(100, CUSTOM_RESET_MQTT);
  277. }
  278. }
  279. }
  280. }
  281. void _mqttOnConnect() {
  282. DEBUG_MSG_P(PSTR("[MQTT] Connected!\n"));
  283. _mqtt_reconnect_delay = MQTT_RECONNECT_DELAY_MIN;
  284. #if MQTT_SKIP_RETAINED
  285. _mqtt_connected_at = millis();
  286. #endif
  287. // Clean subscriptions
  288. mqttUnsubscribeRaw("#");
  289. // Send connect event to subscribers
  290. for (unsigned char i = 0; i < _mqtt_callbacks.size(); i++) {
  291. (_mqtt_callbacks[i])(MQTT_CONNECT_EVENT, NULL, NULL);
  292. }
  293. }
  294. void _mqttOnDisconnect() {
  295. DEBUG_MSG_P(PSTR("[MQTT] Disconnected!\n"));
  296. // Send disconnect event to subscribers
  297. for (unsigned char i = 0; i < _mqtt_callbacks.size(); i++) {
  298. (_mqtt_callbacks[i])(MQTT_DISCONNECT_EVENT, NULL, NULL);
  299. }
  300. }
  301. void _mqttOnMessage(char* topic, char* payload, unsigned int len) {
  302. if (len == 0) return;
  303. char message[len + 1];
  304. strlcpy(message, (char *) payload, len + 1);
  305. #if MQTT_SKIP_RETAINED
  306. if (millis() - _mqtt_connected_at < MQTT_SKIP_TIME) {
  307. DEBUG_MSG_P(PSTR("[MQTT] Received %s => %s - SKIPPED\n"), topic, message);
  308. return;
  309. }
  310. #endif
  311. DEBUG_MSG_P(PSTR("[MQTT] Received %s => %s\n"), topic, message);
  312. // Send message event to subscribers
  313. for (unsigned char i = 0; i < _mqtt_callbacks.size(); i++) {
  314. (_mqtt_callbacks[i])(MQTT_MESSAGE_EVENT, topic, message);
  315. }
  316. }
  317. // -----------------------------------------------------------------------------
  318. // Public API
  319. // -----------------------------------------------------------------------------
  320. /**
  321. Returns the magnitude part of a topic
  322. @param topic the full MQTT topic
  323. @return String object with the magnitude part.
  324. */
  325. String mqttMagnitude(char * topic) {
  326. String pattern = _mqtt_topic + _mqtt_setter;
  327. int position = pattern.indexOf("#");
  328. if (position == -1) return String();
  329. String start = pattern.substring(0, position);
  330. String end = pattern.substring(position + 1);
  331. String magnitude = String(topic);
  332. if (magnitude.startsWith(start) && magnitude.endsWith(end)) {
  333. magnitude.replace(start, "");
  334. magnitude.replace(end, "");
  335. } else {
  336. magnitude = String();
  337. }
  338. return magnitude;
  339. }
  340. /**
  341. Returns a full MQTT topic from the magnitude
  342. @param magnitude the magnitude part of the topic.
  343. @param is_set whether to build a command topic (true)
  344. or a state topic (false).
  345. @return String full MQTT topic.
  346. */
  347. String mqttTopic(const char * magnitude, bool is_set) {
  348. String output = _mqtt_topic;
  349. output.replace("#", magnitude);
  350. output += is_set ? _mqtt_setter : _mqtt_getter;
  351. return output;
  352. }
  353. /**
  354. Returns a full MQTT topic from the magnitude
  355. @param magnitude the magnitude part of the topic.
  356. @param index index of the magnitude when more than one such magnitudes.
  357. @param is_set whether to build a command topic (true)
  358. or a state topic (false).
  359. @return String full MQTT topic.
  360. */
  361. String mqttTopic(const char * magnitude, unsigned int index, bool is_set) {
  362. char buffer[strlen(magnitude)+5];
  363. snprintf_P(buffer, sizeof(buffer), PSTR("%s/%d"), magnitude, index);
  364. return mqttTopic(buffer, is_set);
  365. }
  366. // -----------------------------------------------------------------------------
  367. void mqttSendRaw(const char * topic, const char * message, bool retain) {
  368. if (_mqtt.connected()) {
  369. #if MQTT_USE_ASYNC
  370. unsigned int packetId = _mqtt.publish(topic, _mqtt_qos, retain, message);
  371. DEBUG_MSG_P(PSTR("[MQTT] Sending %s => %s (PID %d)\n"), topic, message, packetId);
  372. #else
  373. _mqtt.publish(topic, message, retain);
  374. DEBUG_MSG_P(PSTR("[MQTT] Sending %s => %s\n"), topic, message);
  375. #endif
  376. }
  377. }
  378. void mqttSendRaw(const char * topic, const char * message) {
  379. mqttSendRaw (topic, message, _mqtt_retain);
  380. }
  381. void mqttFlush() {
  382. if (!_mqtt.connected()) return;
  383. if (_mqtt_queue.size() == 0) return;
  384. DynamicJsonBuffer jsonBuffer;
  385. JsonObject& root = jsonBuffer.createObject();
  386. // Add enqueued messages
  387. for (unsigned char i=0; i<_mqtt_queue.size(); i++) {
  388. mqtt_message_t element = _mqtt_queue[i];
  389. root[element.topic] = element.message;
  390. }
  391. // Add extra propeties
  392. #if NTP_SUPPORT && MQTT_ENQUEUE_DATETIME
  393. if (ntpSynced()) root[MQTT_TOPIC_TIME] = ntpDateTime();
  394. #endif
  395. #if MQTT_ENQUEUE_MAC
  396. root[MQTT_TOPIC_MAC] = WiFi.macAddress();
  397. #endif
  398. #if MQTT_ENQUEUE_HOSTNAME
  399. root[MQTT_TOPIC_HOSTNAME] = getSetting("hostname");
  400. #endif
  401. #if MQTT_ENQUEUE_IP
  402. root[MQTT_TOPIC_IP] = getIP();
  403. #endif
  404. #if MQTT_ENQUEUE_MESSAGE_ID
  405. root[MQTT_TOPIC_MESSAGE_ID] = _mqttNextMessageId();
  406. #endif
  407. // Send
  408. String output;
  409. root.printTo(output);
  410. mqttSendRaw(_mqtt_topic_json.c_str(), output.c_str());
  411. // Clear queue
  412. for (unsigned char i = 0; i < _mqtt_queue.size(); i++) {
  413. mqtt_message_t element = _mqtt_queue[i];
  414. free(element.topic);
  415. free(element.message);
  416. }
  417. _mqtt_queue.clear();
  418. }
  419. void mqttQueueTopic(const char * topic) {
  420. String t = mqttTopic(topic, false);
  421. if (!t.equals(_mqtt_topic_json)) {
  422. mqttFlush();
  423. _mqtt_topic_json = t;
  424. }
  425. }
  426. void mqttEnqueue(const char * topic, const char * message) {
  427. // Queue is not meant to send message "offline"
  428. // We must prevent the queue does not get full while offline
  429. if (!_mqtt.connected()) return;
  430. // Force flusing the queue if the MQTT_QUEUE_MAX_SIZE has been reached
  431. if (_mqtt_queue.size() >= MQTT_QUEUE_MAX_SIZE) mqttFlush();
  432. // Enqueue new message
  433. mqtt_message_t element;
  434. element.topic = strdup(topic);
  435. element.message = strdup(message);
  436. _mqtt_queue.push_back(element);
  437. }
  438. void mqttSend(const char * topic, const char * message, bool force, bool retain) {
  439. bool useJson = force ? false : _mqtt_use_json;
  440. // Equeue message
  441. if (useJson) {
  442. // Set default queue topic
  443. mqttQueueTopic(MQTT_TOPIC_JSON);
  444. // Enqueue new message
  445. mqttEnqueue(topic, message);
  446. // Reset flush timer
  447. _mqtt_flush_ticker.once_ms(MQTT_USE_JSON_DELAY, mqttFlush);
  448. // Send it right away
  449. } else {
  450. mqttSendRaw(mqttTopic(topic, false).c_str(), message, retain);
  451. }
  452. }
  453. void mqttSend(const char * topic, const char * message, bool force) {
  454. mqttSend(topic, message, force, _mqtt_retain);
  455. }
  456. void mqttSend(const char * topic, const char * message) {
  457. mqttSend(topic, message, false);
  458. }
  459. void mqttSend(const char * topic, unsigned int index, const char * message, bool force, bool retain) {
  460. char buffer[strlen(topic)+5];
  461. snprintf_P(buffer, sizeof(buffer), PSTR("%s/%d"), topic, index);
  462. mqttSend(buffer, message, force, retain);
  463. }
  464. void mqttSend(const char * topic, unsigned int index, const char * message, bool force) {
  465. mqttSend(topic, index, message, force, _mqtt_retain);
  466. }
  467. void mqttSend(const char * topic, unsigned int index, const char * message) {
  468. mqttSend(topic, index, message, false);
  469. }
  470. // -----------------------------------------------------------------------------
  471. void mqttSubscribeRaw(const char * topic) {
  472. if (_mqtt.connected() && (strlen(topic) > 0)) {
  473. #if MQTT_USE_ASYNC
  474. unsigned int packetId = _mqtt.subscribe(topic, _mqtt_qos);
  475. DEBUG_MSG_P(PSTR("[MQTT] Subscribing to %s (PID %d)\n"), topic, packetId);
  476. #else
  477. _mqtt.subscribe(topic, _mqtt_qos);
  478. DEBUG_MSG_P(PSTR("[MQTT] Subscribing to %s\n"), topic);
  479. #endif
  480. }
  481. }
  482. void mqttSubscribe(const char * topic) {
  483. mqttSubscribeRaw(mqttTopic(topic, true).c_str());
  484. }
  485. void mqttUnsubscribeRaw(const char * topic) {
  486. if (_mqtt.connected() && (strlen(topic) > 0)) {
  487. #if MQTT_USE_ASYNC
  488. unsigned int packetId = _mqtt.unsubscribe(topic);
  489. DEBUG_MSG_P(PSTR("[MQTT] Unsubscribing to %s (PID %d)\n"), topic, packetId);
  490. #else
  491. _mqtt.unsubscribe(topic);
  492. DEBUG_MSG_P(PSTR("[MQTT] Unsubscribing to %s\n"), topic);
  493. #endif
  494. }
  495. }
  496. void mqttUnsubscribe(const char * topic) {
  497. mqttUnsubscribeRaw(mqttTopic(topic, true).c_str());
  498. }
  499. // -----------------------------------------------------------------------------
  500. void mqttEnabled(bool status) {
  501. _mqtt_enabled = status;
  502. setSetting("mqttEnabled", status ? 1 : 0);
  503. }
  504. bool mqttEnabled() {
  505. return _mqtt_enabled;
  506. }
  507. bool mqttConnected() {
  508. return _mqtt.connected();
  509. }
  510. void mqttDisconnect() {
  511. if (_mqtt.connected()) {
  512. DEBUG_MSG_P(PSTR("[MQTT] Disconnecting\n"));
  513. _mqtt.disconnect();
  514. }
  515. }
  516. bool mqttForward() {
  517. return _mqtt_forward;
  518. }
  519. void mqttRegister(mqtt_callback_f callback) {
  520. _mqtt_callbacks.push_back(callback);
  521. }
  522. void mqttSetBroker(IPAddress ip, unsigned int port) {
  523. setSetting("mqttServer", ip.toString());
  524. setSetting("mqttPort", port);
  525. mqttEnabled(MQTT_AUTOCONNECT);
  526. }
  527. void mqttSetBrokerIfNone(IPAddress ip, unsigned int port) {
  528. if (!hasSetting("mqttServer")) mqttSetBroker(ip, port);
  529. }
  530. void mqttReset() {
  531. _mqttConfigure();
  532. mqttDisconnect();
  533. }
  534. // -----------------------------------------------------------------------------
  535. // Initialization
  536. // -----------------------------------------------------------------------------
  537. void mqttSetup() {
  538. DEBUG_MSG_P(PSTR("[MQTT] Async %s, SSL %s, Autoconnect %s\n"),
  539. MQTT_USE_ASYNC ? "ENABLED" : "DISABLED",
  540. ASYNC_TCP_SSL_ENABLED ? "ENABLED" : "DISABLED",
  541. MQTT_AUTOCONNECT ? "ENABLED" : "DISABLED"
  542. );
  543. #if MQTT_USE_ASYNC
  544. _mqtt.onConnect([](bool sessionPresent) {
  545. _mqttOnConnect();
  546. });
  547. _mqtt.onDisconnect([](AsyncMqttClientDisconnectReason reason) {
  548. if (reason == AsyncMqttClientDisconnectReason::TCP_DISCONNECTED) {
  549. DEBUG_MSG_P(PSTR("[MQTT] TCP Disconnected\n"));
  550. }
  551. if (reason == AsyncMqttClientDisconnectReason::MQTT_IDENTIFIER_REJECTED) {
  552. DEBUG_MSG_P(PSTR("[MQTT] Identifier Rejected\n"));
  553. }
  554. if (reason == AsyncMqttClientDisconnectReason::MQTT_SERVER_UNAVAILABLE) {
  555. DEBUG_MSG_P(PSTR("[MQTT] Server unavailable\n"));
  556. }
  557. if (reason == AsyncMqttClientDisconnectReason::MQTT_MALFORMED_CREDENTIALS) {
  558. DEBUG_MSG_P(PSTR("[MQTT] Malformed credentials\n"));
  559. }
  560. if (reason == AsyncMqttClientDisconnectReason::MQTT_NOT_AUTHORIZED) {
  561. DEBUG_MSG_P(PSTR("[MQTT] Not authorized\n"));
  562. }
  563. #if ASYNC_TCP_SSL_ENABLED
  564. if (reason == AsyncMqttClientDisconnectReason::TLS_BAD_FINGERPRINT) {
  565. DEBUG_MSG_P(PSTR("[MQTT] Bad fingerprint\n"));
  566. }
  567. #endif
  568. _mqttOnDisconnect();
  569. });
  570. _mqtt.onMessage([](char* topic, char* payload, AsyncMqttClientMessageProperties properties, size_t len, size_t index, size_t total) {
  571. _mqttOnMessage(topic, payload, len);
  572. });
  573. _mqtt.onSubscribe([](uint16_t packetId, uint8_t qos) {
  574. DEBUG_MSG_P(PSTR("[MQTT] Subscribe ACK for PID %d\n"), packetId);
  575. });
  576. _mqtt.onPublish([](uint16_t packetId) {
  577. DEBUG_MSG_P(PSTR("[MQTT] Publish ACK for PID %d\n"), packetId);
  578. });
  579. #else // not MQTT_USE_ASYNC
  580. _mqtt.setCallback([](char* topic, byte* payload, unsigned int length) {
  581. _mqttOnMessage(topic, (char *) payload, length);
  582. });
  583. #endif // MQTT_USE_ASYNC
  584. _mqttConfigure();
  585. mqttRegister(_mqttCallback);
  586. #if WEB_SUPPORT
  587. wsOnSendRegister(_mqttWebSocketOnSend);
  588. wsOnAfterParseRegister(_mqttConfigure);
  589. #endif
  590. #if TERMINAL_SUPPORT
  591. _mqttInitCommands();
  592. #endif
  593. // Register loop
  594. espurnaRegisterLoop(mqttLoop);
  595. }
  596. void mqttLoop() {
  597. if (WiFi.status() != WL_CONNECTED) return;
  598. #if MQTT_USE_ASYNC
  599. _mqttConnect();
  600. #else // not MQTT_USE_ASYNC
  601. if (_mqtt.connected()) {
  602. _mqtt.loop();
  603. } else {
  604. if (_mqtt_connected) {
  605. _mqttOnDisconnect();
  606. _mqtt_connected = false;
  607. }
  608. _mqttConnect();
  609. }
  610. #endif
  611. }
  612. #endif // MQTT_SUPPORT