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.

766 lines
22 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 char _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.indexOf("#") == -1) _mqtt_topic = _mqtt_topic + "/#";
  167. // Placeholders
  168. _mqtt_topic.replace("{identifier}", getSetting("hostname"));
  169. _mqtt_topic.replace("{hostname}", getSetting("hostname"));
  170. String mac = WiFi.macAddress();
  171. mac.replace(":", "");
  172. _mqtt_topic.replace("{mac}", mac);
  173. // Getters and setters
  174. _mqtt_setter = getSetting("mqttSetter", MQTT_SETTER);
  175. _mqtt_getter = getSetting("mqttGetter", MQTT_GETTER);
  176. _mqtt_forward = !_mqtt_getter.equals(_mqtt_setter);
  177. // MQTT options
  178. _mqtt_qos = getSetting("mqttQoS", MQTT_QOS).toInt();
  179. _mqtt_retain = getSetting("mqttRetain", MQTT_RETAIN).toInt() == 1;
  180. _mqtt_keepalive = getSetting("mqttKeep", MQTT_KEEPALIVE).toInt();
  181. if (getSetting("mqttClientID").length() == 0) delSetting("mqttClientID");
  182. // Enable
  183. if (getSetting("mqttServer", MQTT_SERVER).length() == 0) {
  184. mqttEnabled(false);
  185. } else {
  186. _mqtt_enabled = getSetting("mqttEnabled", MQTT_ENABLED).toInt() == 1;
  187. }
  188. _mqtt_use_json = (getSetting("mqttUseJson", MQTT_USE_JSON).toInt() == 1);
  189. mqttQueueTopic(MQTT_TOPIC_JSON);
  190. _mqtt_reconnect_delay = MQTT_RECONNECT_DELAY_MIN;
  191. }
  192. unsigned long _mqttNextMessageId() {
  193. static unsigned long id = 0;
  194. // just reboot, get last count from EEPROM
  195. if (id == 0) {
  196. // read id from EEPROM and shift it
  197. id = EEPROM.read(EEPROM_MESSAGE_ID);
  198. if (id == 0xFF) {
  199. // There was nothing in EEPROM,
  200. // next message is first message
  201. id = 0;
  202. } else {
  203. id = (id << 8) + EEPROM.read(EEPROM_MESSAGE_ID + 1);
  204. id = (id << 8) + EEPROM.read(EEPROM_MESSAGE_ID + 2);
  205. id = (id << 8) + EEPROM.read(EEPROM_MESSAGE_ID + 3);
  206. // Calculate next block and start from there
  207. id = MQTT_MESSAGE_ID_SHIFT * (1 + (id / MQTT_MESSAGE_ID_SHIFT));
  208. }
  209. }
  210. // Save to EEPROM every MQTT_MESSAGE_ID_SHIFT
  211. if (id % MQTT_MESSAGE_ID_SHIFT == 0) {
  212. EEPROM.write(EEPROM_MESSAGE_ID + 0, (id >> 24) & 0xFF);
  213. EEPROM.write(EEPROM_MESSAGE_ID + 1, (id >> 16) & 0xFF);
  214. EEPROM.write(EEPROM_MESSAGE_ID + 2, (id >> 8) & 0xFF);
  215. EEPROM.write(EEPROM_MESSAGE_ID + 3, (id >> 0) & 0xFF);
  216. EEPROM.commit();
  217. }
  218. id++;
  219. return id;
  220. }
  221. // -----------------------------------------------------------------------------
  222. // WEB
  223. // -----------------------------------------------------------------------------
  224. #if WEB_SUPPORT
  225. void _mqttWebSocketOnSend(JsonObject& root) {
  226. root["mqttVisible"] = 1;
  227. root["mqttStatus"] = mqttConnected();
  228. root["mqttEnabled"] = mqttEnabled();
  229. root["mqttServer"] = getSetting("mqttServer", MQTT_SERVER);
  230. root["mqttPort"] = getSetting("mqttPort", MQTT_PORT);
  231. root["mqttUser"] = getSetting("mqttUser");
  232. root["mqttClientID"] = getSetting("mqttClientID");
  233. root["mqttPassword"] = getSetting("mqttPassword");
  234. root["mqttKeep"] = _mqtt_keepalive;
  235. root["mqttRetain"] = _mqtt_retain;
  236. root["mqttQoS"] = _mqtt_qos;
  237. #if ASYNC_TCP_SSL_ENABLED
  238. root["mqttsslVisible"] = 1;
  239. root["mqttUseSSL"] = getSetting("mqttUseSSL", 0).toInt() == 1;
  240. root["mqttFP"] = getSetting("mqttFP");
  241. #endif
  242. root["mqttTopic"] = getSetting("mqttTopic", MQTT_TOPIC);
  243. root["mqttUseJson"] = getSetting("mqttUseJson", MQTT_USE_JSON).toInt() == 1;
  244. }
  245. #endif
  246. // -----------------------------------------------------------------------------
  247. // SETTINGS
  248. // -----------------------------------------------------------------------------
  249. #if TERMINAL_SUPPORT
  250. void _mqttInitCommands() {
  251. settingsRegisterCommand(F("MQTT.RESET"), [](Embedis* e) {
  252. _mqttConfigure();
  253. mqttDisconnect();
  254. DEBUG_MSG_P(PSTR("+OK\n"));
  255. });
  256. }
  257. #endif // TERMINAL_SUPPORT
  258. // -----------------------------------------------------------------------------
  259. // MQTT Callbacks
  260. // -----------------------------------------------------------------------------
  261. void _mqttCallback(unsigned int type, const char * topic, const char * payload) {
  262. if (type == MQTT_CONNECT_EVENT) {
  263. // Subscribe to internal action topics
  264. mqttSubscribe(MQTT_TOPIC_ACTION);
  265. // Flag system to send heartbeat
  266. systemSendHeartbeat();
  267. }
  268. if (type == MQTT_MESSAGE_EVENT) {
  269. // Match topic
  270. String t = mqttTopicKey((char *) topic);
  271. // Actions
  272. if (t.equals(MQTT_TOPIC_ACTION)) {
  273. if (strcmp(payload, MQTT_ACTION_RESET) == 0) {
  274. deferredReset(100, CUSTOM_RESET_MQTT);
  275. }
  276. }
  277. }
  278. }
  279. void _mqttOnConnect() {
  280. DEBUG_MSG_P(PSTR("[MQTT] Connected!\n"));
  281. _mqtt_reconnect_delay = MQTT_RECONNECT_DELAY_MIN;
  282. #if MQTT_SKIP_RETAINED
  283. _mqtt_connected_at = millis();
  284. #endif
  285. // Clean subscriptions
  286. mqttUnsubscribeRaw("#");
  287. // Send connect event to subscribers
  288. for (unsigned char i = 0; i < _mqtt_callbacks.size(); i++) {
  289. (_mqtt_callbacks[i])(MQTT_CONNECT_EVENT, NULL, NULL);
  290. }
  291. }
  292. void _mqttOnDisconnect() {
  293. DEBUG_MSG_P(PSTR("[MQTT] Disconnected!\n"));
  294. // Send disconnect event to subscribers
  295. for (unsigned char i = 0; i < _mqtt_callbacks.size(); i++) {
  296. (_mqtt_callbacks[i])(MQTT_DISCONNECT_EVENT, NULL, NULL);
  297. }
  298. }
  299. void _mqttOnMessage(char* topic, char* payload, unsigned int len) {
  300. if (len == 0) return;
  301. char message[len + 1];
  302. strlcpy(message, (char *) payload, len + 1);
  303. #if MQTT_SKIP_RETAINED
  304. if (millis() - _mqtt_connected_at < MQTT_SKIP_TIME) {
  305. DEBUG_MSG_P(PSTR("[MQTT] Received %s => %s - SKIPPED\n"), topic, message);
  306. return;
  307. }
  308. #endif
  309. DEBUG_MSG_P(PSTR("[MQTT] Received %s => %s\n"), topic, message);
  310. // Send message event to subscribers
  311. for (unsigned char i = 0; i < _mqtt_callbacks.size(); i++) {
  312. (_mqtt_callbacks[i])(MQTT_MESSAGE_EVENT, topic, message);
  313. }
  314. }
  315. // -----------------------------------------------------------------------------
  316. // Public API
  317. // -----------------------------------------------------------------------------
  318. String mqttTopicKey(char * topic) {
  319. String pattern = _mqtt_topic + _mqtt_setter;
  320. int position = pattern.indexOf("#");
  321. if (position == -1) return String();
  322. String start = pattern.substring(0, position);
  323. String end = pattern.substring(position + 1);
  324. String response = String(topic);
  325. if (response.startsWith(start) && response.endsWith(end)) {
  326. response.replace(start, "");
  327. response.replace(end, "");
  328. } else {
  329. response = String();
  330. }
  331. return response;
  332. }
  333. String mqttTopic(const char * topic, bool is_set) {
  334. String output = _mqtt_topic;
  335. output.replace("#", topic);
  336. output += is_set ? _mqtt_setter : _mqtt_getter;
  337. return output;
  338. }
  339. String mqttTopic(const char * topic, unsigned int index, bool is_set) {
  340. char buffer[strlen(topic)+5];
  341. snprintf_P(buffer, sizeof(buffer), PSTR("%s/%d"), topic, index);
  342. return mqttTopic(buffer, is_set);
  343. }
  344. // -----------------------------------------------------------------------------
  345. void mqttSendRaw(const char * topic, const char * message) {
  346. if (_mqtt.connected()) {
  347. #if MQTT_USE_ASYNC
  348. unsigned int packetId = _mqtt.publish(topic, _mqtt_qos, _mqtt_retain, message);
  349. DEBUG_MSG_P(PSTR("[MQTT] Sending %s => %s (PID %d)\n"), topic, message, packetId);
  350. #else
  351. _mqtt.publish(topic, message, _mqtt_retain);
  352. DEBUG_MSG_P(PSTR("[MQTT] Sending %s => %s\n"), topic, message);
  353. #endif
  354. }
  355. }
  356. void mqttFlush() {
  357. if (!_mqtt.connected()) return;
  358. if (_mqtt_queue.size() == 0) return;
  359. DynamicJsonBuffer jsonBuffer;
  360. JsonObject& root = jsonBuffer.createObject();
  361. // Add enqueued messages
  362. for (unsigned char i=0; i<_mqtt_queue.size(); i++) {
  363. mqtt_message_t element = _mqtt_queue[i];
  364. root[element.topic] = element.message;
  365. }
  366. // Add extra propeties
  367. #if NTP_SUPPORT && MQTT_ENQUEUE_DATETIME
  368. if (ntpSynced()) root[MQTT_TOPIC_TIME] = ntpDateTime();
  369. #endif
  370. #if MQTT_ENQUEUE_MAC
  371. root[MQTT_TOPIC_MAC] = WiFi.macAddress();
  372. #endif
  373. #if MQTT_ENQUEUE_HOSTNAME
  374. root[MQTT_TOPIC_HOSTNAME] = getSetting("hostname");
  375. #endif
  376. #if MQTT_ENQUEUE_IP
  377. root[MQTT_TOPIC_IP] = getIP();
  378. #endif
  379. #if MQTT_ENQUEUE_MESSAGE_ID
  380. root[MQTT_TOPIC_MESSAGE_ID] = _mqttNextMessageId();
  381. #endif
  382. // Send
  383. String output;
  384. root.printTo(output);
  385. mqttSendRaw(_mqtt_topic_json.c_str(), output.c_str());
  386. // Clear queue
  387. for (unsigned char i = 0; i < _mqtt_queue.size(); i++) {
  388. mqtt_message_t element = _mqtt_queue[i];
  389. free(element.topic);
  390. free(element.message);
  391. }
  392. _mqtt_queue.clear();
  393. }
  394. void mqttQueueTopic(const char * topic) {
  395. String t = mqttTopic(topic, false);
  396. if (!t.equals(_mqtt_topic_json)) {
  397. mqttFlush();
  398. _mqtt_topic_json = t;
  399. }
  400. }
  401. void mqttEnqueue(const char * topic, const char * message) {
  402. // Queue is not meant to send message "offline"
  403. // We must prevent the queue does not get full while offline
  404. if (!_mqtt.connected()) return;
  405. // Force flusing the queue if the MQTT_QUEUE_MAX_SIZE has been reached
  406. if (_mqtt_queue.size() >= MQTT_QUEUE_MAX_SIZE) mqttFlush();
  407. // Enqueue new message
  408. mqtt_message_t element;
  409. element.topic = strdup(topic);
  410. element.message = strdup(message);
  411. _mqtt_queue.push_back(element);
  412. }
  413. void mqttSend(const char * topic, const char * message, bool force) {
  414. bool useJson = force ? false : _mqtt_use_json;
  415. // Equeue message
  416. if (useJson) {
  417. // Set default queue topic
  418. mqttQueueTopic(MQTT_TOPIC_JSON);
  419. // Enqueue new message
  420. mqttEnqueue(topic, message);
  421. // Reset flush timer
  422. _mqtt_flush_ticker.once_ms(MQTT_USE_JSON_DELAY, mqttFlush);
  423. // Send it right away
  424. } else {
  425. mqttSendRaw(mqttTopic(topic, false).c_str(), message);
  426. }
  427. }
  428. void mqttSend(const char * topic, const char * message) {
  429. mqttSend(topic, message, false);
  430. }
  431. void mqttSend(const char * topic, unsigned int index, const char * message, bool force) {
  432. char buffer[strlen(topic)+5];
  433. snprintf_P(buffer, sizeof(buffer), PSTR("%s/%d"), topic, index);
  434. mqttSend(buffer, message, force);
  435. }
  436. void mqttSend(const char * topic, unsigned int index, const char * message) {
  437. mqttSend(topic, index, message, false);
  438. }
  439. // -----------------------------------------------------------------------------
  440. void mqttSubscribeRaw(const char * topic) {
  441. if (_mqtt.connected() && (strlen(topic) > 0)) {
  442. #if MQTT_USE_ASYNC
  443. unsigned int packetId = _mqtt.subscribe(topic, _mqtt_qos);
  444. DEBUG_MSG_P(PSTR("[MQTT] Subscribing to %s (PID %d)\n"), topic, packetId);
  445. #else
  446. _mqtt.subscribe(topic, _mqtt_qos);
  447. DEBUG_MSG_P(PSTR("[MQTT] Subscribing to %s\n"), topic);
  448. #endif
  449. }
  450. }
  451. void mqttSubscribe(const char * topic) {
  452. mqttSubscribeRaw(mqttTopic(topic, true).c_str());
  453. }
  454. void mqttUnsubscribeRaw(const char * topic) {
  455. if (_mqtt.connected() && (strlen(topic) > 0)) {
  456. #if MQTT_USE_ASYNC
  457. unsigned int packetId = _mqtt.unsubscribe(topic);
  458. DEBUG_MSG_P(PSTR("[MQTT] Unsubscribing to %s (PID %d)\n"), topic, packetId);
  459. #else
  460. _mqtt.unsubscribe(topic);
  461. DEBUG_MSG_P(PSTR("[MQTT] Unsubscribing to %s\n"), topic);
  462. #endif
  463. }
  464. }
  465. void mqttUnsubscribe(const char * topic) {
  466. mqttUnsubscribeRaw(mqttTopic(topic, true).c_str());
  467. }
  468. // -----------------------------------------------------------------------------
  469. void mqttEnabled(bool status) {
  470. _mqtt_enabled = status;
  471. setSetting("mqttEnabled", status ? 1 : 0);
  472. }
  473. bool mqttEnabled() {
  474. return _mqtt_enabled;
  475. }
  476. bool mqttConnected() {
  477. return _mqtt.connected();
  478. }
  479. void mqttDisconnect() {
  480. if (_mqtt.connected()) {
  481. DEBUG_MSG_P(PSTR("[MQTT] Disconnecting\n"));
  482. _mqtt.disconnect();
  483. }
  484. }
  485. bool mqttForward() {
  486. return _mqtt_forward;
  487. }
  488. void mqttRegister(mqtt_callback_f callback) {
  489. _mqtt_callbacks.push_back(callback);
  490. }
  491. void mqttSetBroker(IPAddress ip, unsigned int port) {
  492. setSetting("mqttServer", ip.toString());
  493. setSetting("mqttPort", port);
  494. mqttEnabled(MQTT_AUTOCONNECT);
  495. }
  496. void mqttSetBrokerIfNone(IPAddress ip, unsigned int port) {
  497. if (!hasSetting("mqttServer")) mqttSetBroker(ip, port);
  498. }
  499. void mqttReset() {
  500. _mqttConfigure();
  501. mqttDisconnect();
  502. }
  503. // -----------------------------------------------------------------------------
  504. // Initialization
  505. // -----------------------------------------------------------------------------
  506. void mqttSetup() {
  507. DEBUG_MSG_P(PSTR("[MQTT] Async %s, SSL %s, Autoconnect %s\n"),
  508. MQTT_USE_ASYNC ? "ENABLED" : "DISABLED",
  509. ASYNC_TCP_SSL_ENABLED ? "ENABLED" : "DISABLED",
  510. MQTT_AUTOCONNECT ? "ENABLED" : "DISABLED"
  511. );
  512. #if MQTT_USE_ASYNC
  513. _mqtt.onConnect([](bool sessionPresent) {
  514. _mqttOnConnect();
  515. });
  516. _mqtt.onDisconnect([](AsyncMqttClientDisconnectReason reason) {
  517. if (reason == AsyncMqttClientDisconnectReason::TCP_DISCONNECTED) {
  518. DEBUG_MSG_P(PSTR("[MQTT] TCP Disconnected\n"));
  519. }
  520. if (reason == AsyncMqttClientDisconnectReason::MQTT_IDENTIFIER_REJECTED) {
  521. DEBUG_MSG_P(PSTR("[MQTT] Identifier Rejected\n"));
  522. }
  523. if (reason == AsyncMqttClientDisconnectReason::MQTT_SERVER_UNAVAILABLE) {
  524. DEBUG_MSG_P(PSTR("[MQTT] Server unavailable\n"));
  525. }
  526. if (reason == AsyncMqttClientDisconnectReason::MQTT_MALFORMED_CREDENTIALS) {
  527. DEBUG_MSG_P(PSTR("[MQTT] Malformed credentials\n"));
  528. }
  529. if (reason == AsyncMqttClientDisconnectReason::MQTT_NOT_AUTHORIZED) {
  530. DEBUG_MSG_P(PSTR("[MQTT] Not authorized\n"));
  531. }
  532. #if ASYNC_TCP_SSL_ENABLED
  533. if (reason == AsyncMqttClientDisconnectReason::TLS_BAD_FINGERPRINT) {
  534. DEBUG_MSG_P(PSTR("[MQTT] Bad fingerprint\n"));
  535. }
  536. #endif
  537. _mqttOnDisconnect();
  538. });
  539. _mqtt.onMessage([](char* topic, char* payload, AsyncMqttClientMessageProperties properties, size_t len, size_t index, size_t total) {
  540. _mqttOnMessage(topic, payload, len);
  541. });
  542. _mqtt.onSubscribe([](uint16_t packetId, uint8_t qos) {
  543. DEBUG_MSG_P(PSTR("[MQTT] Subscribe ACK for PID %d\n"), packetId);
  544. });
  545. _mqtt.onPublish([](uint16_t packetId) {
  546. DEBUG_MSG_P(PSTR("[MQTT] Publish ACK for PID %d\n"), packetId);
  547. });
  548. #else // not MQTT_USE_ASYNC
  549. _mqtt.setCallback([](char* topic, byte* payload, unsigned int length) {
  550. _mqttOnMessage(topic, (char *) payload, length);
  551. });
  552. #endif // MQTT_USE_ASYNC
  553. _mqttConfigure();
  554. mqttRegister(_mqttCallback);
  555. #if WEB_SUPPORT
  556. wsOnSendRegister(_mqttWebSocketOnSend);
  557. wsOnAfterParseRegister(_mqttConfigure);
  558. #endif
  559. #if TERMINAL_SUPPORT
  560. _mqttInitCommands();
  561. #endif
  562. // Register loop
  563. espurnaRegisterLoop(mqttLoop);
  564. }
  565. void mqttLoop() {
  566. if (WiFi.status() != WL_CONNECTED) return;
  567. #if MQTT_USE_ASYNC
  568. _mqttConnect();
  569. #else // not MQTT_USE_ASYNC
  570. if (_mqtt.connected()) {
  571. _mqtt.loop();
  572. } else {
  573. if (_mqtt_connected) {
  574. _mqttOnDisconnect();
  575. _mqtt_connected = false;
  576. }
  577. _mqttConnect();
  578. }
  579. #endif
  580. }
  581. #endif // MQTT_SUPPORT