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.

392 lines
11 KiB

6 years ago
  1. /*
  2. WEBSOCKET MODULE
  3. Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
  4. */
  5. #if WEB_SUPPORT
  6. #include <ESPAsyncTCP.h>
  7. #include <ESPAsyncWebServer.h>
  8. #include <ArduinoJson.h>
  9. #include <Ticker.h>
  10. #include <vector>
  11. #include "libs/WebSocketIncommingBuffer.h"
  12. AsyncWebSocket _ws("/ws");
  13. Ticker _web_defer;
  14. std::vector<ws_on_send_callback_f> _ws_on_send_callbacks;
  15. std::vector<ws_on_action_callback_f> _ws_on_action_callbacks;
  16. std::vector<ws_on_after_parse_callback_f> _ws_on_after_parse_callbacks;
  17. // -----------------------------------------------------------------------------
  18. // Private methods
  19. // -----------------------------------------------------------------------------
  20. #if MQTT_SUPPORT
  21. void _wsMQTTCallback(unsigned int type, const char * topic, const char * payload) {
  22. if (type == MQTT_CONNECT_EVENT) wsSend_P(PSTR("{\"mqttStatus\": true}"));
  23. if (type == MQTT_DISCONNECT_EVENT) wsSend_P(PSTR("{\"mqttStatus\": false}"));
  24. }
  25. #endif
  26. bool _wsStore(String key, String value) {
  27. // HTTP port
  28. if (key == "webPort") {
  29. if ((value.toInt() == 0) || (value.toInt() == 80)) {
  30. return delSetting(key);
  31. }
  32. }
  33. if (value != getSetting(key)) {
  34. return setSetting(key, value);
  35. }
  36. return false;
  37. }
  38. bool _wsStore(String key, JsonArray& value) {
  39. bool changed = false;
  40. unsigned char index = 0;
  41. for (auto element : value) {
  42. if (_wsStore(key + index, element.as<String>())) changed = true;
  43. index++;
  44. }
  45. // Delete further values
  46. for (unsigned char i=index; i<SETTINGS_MAX_LIST_COUNT; i++) {
  47. if (!delSetting(key, index)) break;
  48. changed = true;
  49. }
  50. return changed;
  51. }
  52. void _wsParse(AsyncWebSocketClient *client, uint8_t * payload, size_t length) {
  53. //DEBUG_MSG_P(PSTR("[WEBSOCKET] Parsing: %s\n"), length ? (char*) payload : "");
  54. // Get client ID
  55. uint32_t client_id = client->id();
  56. // Parse JSON input
  57. DynamicJsonBuffer jsonBuffer;
  58. JsonObject& root = jsonBuffer.parseObject((char *) payload);
  59. if (!root.success()) {
  60. DEBUG_MSG_P(PSTR("[WEBSOCKET] Error parsing data\n"));
  61. wsSend_P(client_id, PSTR("{\"message\": 3}"));
  62. return;
  63. }
  64. // Check actions -----------------------------------------------------------
  65. const char* action = root["action"];
  66. if (action) {
  67. DEBUG_MSG_P(PSTR("[WEBSOCKET] Requested action: %s\n"), action);
  68. if (strcmp(action, "reboot") == 0) deferredReset(100, CUSTOM_RESET_WEB);
  69. if (strcmp(action, "reconnect") == 0) _web_defer.once_ms(100, wifiDisconnect);
  70. JsonObject& data = root["data"];
  71. if (data.success()) {
  72. // Callbacks
  73. for (unsigned char i = 0; i < _ws_on_action_callbacks.size(); i++) {
  74. (_ws_on_action_callbacks[i])(client_id, action, data);
  75. }
  76. // Restore configuration via websockets
  77. if (strcmp(action, "restore") == 0) {
  78. if (settingsRestoreJson(data)) {
  79. wsSend_P(client_id, PSTR("{\"message\": 5}"));
  80. } else {
  81. wsSend_P(client_id, PSTR("{\"message\": 4}"));
  82. }
  83. }
  84. }
  85. };
  86. // Check configuration -----------------------------------------------------
  87. JsonObject& config = root["config"];
  88. if (config.success()) {
  89. DEBUG_MSG_P(PSTR("[WEBSOCKET] Parsing configuration data\n"));
  90. String adminPass;
  91. bool save = false;
  92. #if MQTT_SUPPORT
  93. bool changedMQTT = false;
  94. #endif
  95. for (auto kv: config) {
  96. bool changed = false;
  97. String key = kv.key;
  98. JsonVariant& value = kv.value;
  99. // Check password
  100. if (key == "adminPass") {
  101. if (!value.is<JsonArray&>()) continue;
  102. JsonArray& values = value.as<JsonArray&>();
  103. if (values.size() != 2) continue;
  104. if (values[0].as<String>().equals(values[1].as<String>())) {
  105. String password = values[0].as<String>();
  106. if (password.length() > 0) {
  107. setSetting(key, password);
  108. save = true;
  109. wsSend_P(client_id, PSTR("{\"action\": \"reload\"}"));
  110. }
  111. } else {
  112. wsSend_P(client_id, PSTR("{\"message\": 7}"));
  113. }
  114. continue;
  115. }
  116. // Store values
  117. if (value.is<JsonArray&>()) {
  118. if (_wsStore(key, value.as<JsonArray&>())) changed = true;
  119. } else {
  120. if (_wsStore(key, value.as<String>())) changed = true;
  121. }
  122. // Update flags if value has changed
  123. if (changed) {
  124. save = true;
  125. #if MQTT_SUPPORT
  126. if (key.startsWith("mqtt")) changedMQTT = true;
  127. #endif
  128. }
  129. }
  130. // Save settings
  131. if (save) {
  132. // Callbacks
  133. for (unsigned char i = 0; i < _ws_on_after_parse_callbacks.size(); i++) {
  134. (_ws_on_after_parse_callbacks[i])();
  135. }
  136. // This should got to callback as well
  137. // but first change management has to be in place
  138. #if MQTT_SUPPORT
  139. if (changedMQTT) mqttReset();
  140. #endif
  141. // Persist settings
  142. saveSettings();
  143. wsSend_P(client_id, PSTR("{\"message\": 8}"));
  144. } else {
  145. wsSend_P(client_id, PSTR("{\"message\": 9}"));
  146. }
  147. }
  148. }
  149. void _wsUpdate(JsonObject& root) {
  150. root["heap"] = getFreeHeap();
  151. root["uptime"] = getUptime();
  152. root["rssi"] = WiFi.RSSI();
  153. root["distance"] = wifiDistance(WiFi.RSSI());
  154. #if NTP_SUPPORT
  155. if (ntpSynced()) root["now"] = now();
  156. #endif
  157. }
  158. void _wsOnStart(JsonObject& root) {
  159. #if USE_PASSWORD && WEB_FORCE_PASS_CHANGE
  160. String adminPass = getSetting("adminPass", ADMIN_PASS);
  161. bool changePassword = adminPass.equals(ADMIN_PASS);
  162. #else
  163. bool changePassword = false;
  164. #endif
  165. if (changePassword) {
  166. root["webMode"] = WEB_MODE_PASSWORD;
  167. } else {
  168. char chipid[7];
  169. snprintf_P(chipid, sizeof(chipid), PSTR("%06X"), ESP.getChipId());
  170. uint8_t * bssid = WiFi.BSSID();
  171. char bssid_str[20];
  172. snprintf_P(bssid_str, sizeof(bssid_str),
  173. PSTR("%02X:%02X:%02X:%02X:%02X:%02X"),
  174. bssid[0], bssid[1], bssid[2], bssid[3], bssid[4], bssid[5]
  175. );
  176. root["webMode"] = WEB_MODE_NORMAL;
  177. root["app_name"] = APP_NAME;
  178. root["app_version"] = APP_VERSION;
  179. root["app_build"] = buildTime();
  180. root["manufacturer"] = MANUFACTURER;
  181. root["chipid"] = String(chipid);
  182. root["mac"] = WiFi.macAddress();
  183. root["bssid"] = String(bssid_str);
  184. root["channel"] = WiFi.channel();
  185. root["device"] = DEVICE;
  186. root["hostname"] = getSetting("hostname");
  187. root["network"] = getNetwork();
  188. root["deviceip"] = getIP();
  189. root["sketch_size"] = ESP.getSketchSize();
  190. root["free_size"] = ESP.getFreeSketchSpace();
  191. _wsUpdate(root);
  192. root["btnDelay"] = getSetting("btnDelay", BUTTON_DBLCLICK_DELAY).toInt();
  193. root["webPort"] = getSetting("webPort", WEB_PORT).toInt();
  194. }
  195. }
  196. void _wsStart(uint32_t client_id) {
  197. for (unsigned char i = 0; i < _ws_on_send_callbacks.size(); i++) {
  198. wsSend(client_id, _ws_on_send_callbacks[i]);
  199. }
  200. }
  201. void _wsEvent(AsyncWebSocket * server, AsyncWebSocketClient * client, AwsEventType type, void * arg, uint8_t *data, size_t len){
  202. if (type == WS_EVT_CONNECT) {
  203. IPAddress ip = client->remoteIP();
  204. DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u connected, ip: %d.%d.%d.%d, url: %s\n"), client->id(), ip[0], ip[1], ip[2], ip[3], server->url());
  205. _wsStart(client->id());
  206. client->_tempObject = new WebSocketIncommingBuffer(&_wsParse, true);
  207. wifiReconnectCheck();
  208. } else if(type == WS_EVT_DISCONNECT) {
  209. DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u disconnected\n"), client->id());
  210. if (client->_tempObject) {
  211. delete (WebSocketIncommingBuffer *) client->_tempObject;
  212. }
  213. wifiReconnectCheck();
  214. } else if(type == WS_EVT_ERROR) {
  215. DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u error(%u): %s\n"), client->id(), *((uint16_t*)arg), (char*)data);
  216. } else if(type == WS_EVT_PONG) {
  217. DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u pong(%u): %s\n"), client->id(), len, len ? (char*) data : "");
  218. } else if(type == WS_EVT_DATA) {
  219. //DEBUG_MSG_P(PSTR("[WEBSOCKET] #%u data(%u): %s\n"), client->id(), len, len ? (char*) data : "");
  220. WebSocketIncommingBuffer *buffer = (WebSocketIncommingBuffer *)client->_tempObject;
  221. AwsFrameInfo * info = (AwsFrameInfo*)arg;
  222. buffer->data_event(client, info, data, len);
  223. }
  224. }
  225. void _wsLoop() {
  226. static unsigned long last = 0;
  227. if (!wsConnected()) return;
  228. if (millis() - last > WS_UPDATE_INTERVAL) {
  229. last = millis();
  230. wsSend(_wsUpdate);
  231. }
  232. }
  233. // -----------------------------------------------------------------------------
  234. // Piblic API
  235. // -----------------------------------------------------------------------------
  236. bool wsConnected() {
  237. return (_ws.count() > 0);
  238. }
  239. void wsOnSendRegister(ws_on_send_callback_f callback) {
  240. _ws_on_send_callbacks.push_back(callback);
  241. }
  242. void wsOnActionRegister(ws_on_action_callback_f callback) {
  243. _ws_on_action_callbacks.push_back(callback);
  244. }
  245. void wsOnAfterParseRegister(ws_on_after_parse_callback_f callback) {
  246. _ws_on_after_parse_callbacks.push_back(callback);
  247. }
  248. void wsSend(ws_on_send_callback_f callback) {
  249. if (_ws.count() > 0) {
  250. DynamicJsonBuffer jsonBuffer;
  251. JsonObject& root = jsonBuffer.createObject();
  252. callback(root);
  253. String output;
  254. root.printTo(output);
  255. _ws.textAll((char *) output.c_str());
  256. }
  257. }
  258. void wsSend(const char * payload) {
  259. if (_ws.count() > 0) {
  260. _ws.textAll(payload);
  261. }
  262. }
  263. void wsSend_P(PGM_P payload) {
  264. if (_ws.count() > 0) {
  265. char buffer[strlen_P(payload)];
  266. strcpy_P(buffer, payload);
  267. _ws.textAll(buffer);
  268. }
  269. }
  270. void wsSend(uint32_t client_id, ws_on_send_callback_f callback) {
  271. DynamicJsonBuffer jsonBuffer;
  272. JsonObject& root = jsonBuffer.createObject();
  273. callback(root);
  274. String output;
  275. root.printTo(output);
  276. _ws.text(client_id, (char *) output.c_str());
  277. }
  278. void wsSend(uint32_t client_id, const char * payload) {
  279. _ws.text(client_id, payload);
  280. }
  281. void wsSend_P(uint32_t client_id, PGM_P payload) {
  282. char buffer[strlen_P(payload)];
  283. strcpy_P(buffer, payload);
  284. _ws.text(client_id, buffer);
  285. }
  286. void wsConfigure() {
  287. #if USE_PASSWORD
  288. _ws.setAuthentication(WEB_USERNAME, (const char *) getSetting("adminPass", ADMIN_PASS).c_str());
  289. #endif
  290. }
  291. void wsSetup() {
  292. _ws.onEvent(_wsEvent);
  293. wsConfigure();
  294. webServer()->addHandler(&_ws);
  295. #if MQTT_SUPPORT
  296. mqttRegister(_wsMQTTCallback);
  297. #endif
  298. wsOnSendRegister(_wsOnStart);
  299. wsOnAfterParseRegister(wsConfigure);
  300. espurnaRegisterLoop(_wsLoop);
  301. }
  302. #endif // WEB_SUPPORT