Version 2.9.0-beta3

Changes since 2.9.0-beta2 fix: regression of RF debug logging to web interface fix: issues with websocket connection when using Safari
arjenhiemstra · Nov 26, 2024 · b1b415f · b1b415f
1 parent 67da758
commit b1b415f
Show file tree

Hide file tree

Showing 10 changed files with 923 additions and 849 deletions.
diff --git a/compiled_firmware_files/firmware.json b/compiled_firmware_files/firmware.json
@@ -9,14 +9,14 @@
         "2": {
             "latest_fw": "2.8.0",
             "link": "https://github.com/arjenhiemstra/ithowifi/raw/master/compiled_firmware_files/unified_hw2_noncve/nrgitho-v2.8.0.bin",
-            "latest_beta_fw": "2.9.0-beta2",
-            "link_beta": "https://github.com/arjenhiemstra/ithowifi/raw/master/compiled_firmware_files/unified_hw2_noncve/nrgitho-v2.9.0-beta2.bin"
+            "latest_beta_fw": "2.9.0-beta3",
+            "link_beta": "https://github.com/arjenhiemstra/ithowifi/raw/master/compiled_firmware_files/unified_hw2_noncve/nrgitho-v2.9.0-beta3.bin"
         },
         "NON-CVE 1": {
             "latest_fw": "2.8.0",
             "link": "https://github.com/arjenhiemstra/ithowifi/raw/master/compiled_firmware_files/unified_hw2_noncve/nrgitho-v2.8.0.bin",
-            "latest_beta_fw": "2.9.0-beta2",
-            "link_beta": "https://github.com/arjenhiemstra/ithowifi/raw/master/compiled_firmware_files/unified_hw2_noncve/nrgitho-v2.9.0-beta2.bin"
+            "latest_beta_fw": "2.9.0-beta3",
+            "link_beta": "https://github.com/arjenhiemstra/ithowifi/raw/master/compiled_firmware_files/unified_hw2_noncve/nrgitho-v2.9.0-beta3.bin"
         }
     }
 }
diff --git a/compiled_firmware_files/unified_hw2_noncve/elf/nrgitho-v2.9.0-beta3.elf b/compiled_firmware_files/unified_hw2_noncve/elf/nrgitho-v2.9.0-beta3.elf
diff --git a/compiled_firmware_files/unified_hw2_noncve/nrgitho-v2.9.0-beta3.bin b/compiled_firmware_files/unified_hw2_noncve/nrgitho-v2.9.0-beta3.bin
diff --git a/software/NRG_itho_wifi/main/version.h b/software/NRG_itho_wifi/main/version.h
@@ -1,3 +1,3 @@
 #pragma once
 
-#define FWVERSION "2.9.0-beta2"
+#define FWVERSION "2.9.0-beta3"
diff --git a/software/NRG_itho_wifi/main/webroot/controls_js_gz.h b/software/NRG_itho_wifi/main/webroot/controls_js_gz.h
diff --git a/software/NRG_itho_wifi/main/webroot_source/controls.js b/software/NRG_itho_wifi/main/webroot_source/controls.js
@@ -17,42 +17,66 @@ var settingIndex = -1;
 var websocketServerLocation = location.protocol.indexOf("https") > -1 ? 'wss://' + window.location.hostname + ':8000/ws' : 'ws://' + window.location.hostname + ':8000/ws';
 
 let messageQueue = [];
+let connectTimeout, pingTimeout;
 let websock;
 
 function startWebsock(websocketServerLocation) {
-  if (debug) console.log(websocketServerLocation);
   messageQueue = [];
+  clearTimeout(connectTimeout);
+  clearTimeout(pingTimeout);
+  pingTimeout = !1;
+  connectTimeout = setTimeout((() => {
+    if (debug) console.log("websock connect timeout."),
+      //websock.close(),
+      startWebsock(websocketServerLocation);
+  }), 1000);
+  websock = null;
   websock = new WebSocket(websocketServerLocation);
-  websock.addEventListener('message', event => {
-    // Add message to the queue
-    messageQueue.push(event.data);
-  });
-  websock.onopen = function (a) {
+
+  websock.addEventListener('open', function (event) {
     if (debug) console.log('websock open');
+    clearTimeout(connectTimeout);
     document.getElementById("layout").style.opacity = 1;
     document.getElementById("loader").style.display = "none";
     if (lastPageReq !== "") {
       update_page(lastPageReq);
     }
     getSettings('syssetup');
-  };
-
-  websock.onclose = function (a) {
+  });
+  websock.addEventListener('message', function (event) {
+    "pong" == event.data ? (clearTimeout(pingTimeout),
+      pingTimeout = !1) : messageQueue.push(event.data);
+  });
+  websock.addEventListener('close', function (event) {
     if (debug) console.log('websock close');
-    // Try to reconnect in 200 milliseconds
-    websock = null;
     document.getElementById("layout").style.opacity = 0.3;
     document.getElementById("loader").style.display = "block";
-    setTimeout(function () { startWebsock(websocketServerLocation) }, 200);
-  };
-
-  websock.onerror = function (a) {
-    try {
-      if (debug) console.log(a);
-    } catch (error) {
-      if (debug) console.log(error);
+    // setTimeout(startWebsock, 200, websocketServerLocation);
+  });
+  websock.addEventListener('error', function (event) {
+    if (debug) console.log("websock Error!", event);
+    startWebsock(websocketServerLocation);
+    //websock.close();
+  });
+  setInterval((() => {
+    pingTimeout || websock.readyState != WebSocket.OPEN || (pingTimeout = setTimeout((() => {
+      if (debug) console.log("websock ping timeout.");
+      startWebsock(websocketServerLocation);
     }
-  };
+    ), 3e3),
+      websock_send("ping"))
+  }
+  ), 2e3)
+}
+
+function websock_send(message) {
+  if (websock.readyState === 1) {
+    if (debug) console.log(message);
+    websock.send(message);
+  }
+  else {
+    if (debug) console.log("websock.readyState != open");
+  }
 }
 
 (async function processMessages() {
@@ -306,6 +330,18 @@ function processMessage(message) {
 
 }
 
+function initButton() {
+  document.getElementById("command-button").addEventListener("click", sendCommand)
+}
+function trapKeyPress() {
+  document.getElementById("command-text").addEventListener("keypress", (e => {
+    "Enter" === e.code && (e.preventDefault(), document.getElementById("command-button").click())
+  })),
+    document.addEventListener("keydown", (e => {
+      document.activeElement && "command-text" === document.activeElement.id && ("ArrowUp" === e.code ? (commandHistoryIdx--, commandHistoryIdx < 0 && (commandHistoryIdx = commandHistory.length > 0 ? commandHistory.length - 1 : 0), commandHistoryIdx >= 0 && commandHistoryIdx < commandHistory.length && (document.getElementById("command-text").value = commandHistory[commandHistoryIdx])) : "ArrowDown" === e.code && (commandHistoryIdx++, commandHistoryIdx >= commandHistory.length && (commandHistoryIdx = 0), commandHistoryIdx >= 0 && commandHistoryIdx < commandHistory.length && (document.getElementById("command-text").value = commandHistory[commandHistoryIdx])))
+    }))
+}
+
 function clearSettingsLocStor() {
   let setlen = localStorage.getItem("itho_setlen");
   for (var index = 0; index < setlen; index++) {
@@ -859,11 +895,6 @@ $(document).ready(function () {
   });
 });
 
-function websock_send(message) {
-  websock.send(message);
-  if (debug) console.log(message);
-}
-
 var timerHandle = setTimeout(function () {
   $('#message_box').hide();
 }, 5000);
@@ -1755,7 +1786,7 @@ var html_debug = `
                 <span style="color:red">
                     WPU 5G: Make sure you set the "Max manual operation time" setting on the "Itho settings" page.<br>
                     The itho unit will remain in manual mode until the timer expires. 0 means unlimited.<br>
-                    Warning!!<br></vr></span><br>
+                    Warning!!<br></span><br>
             </fieldset><br><br><br>
         </fieldset>
     </form>

diff --git a/software/NRG_itho_wifi/main/webroot_source/controls_js_sources/html_debug.html b/software/NRG_itho_wifi/main/webroot_source/controls_js_sources/html_debug.html
@@ -149,7 +149,7 @@ <h1>Debug page</h1>
                 <span style="color:red">
                     WPU 5G: Make sure you set the "Max manual operation time" setting on the "Itho settings" page.<br>
                     The itho unit will remain in manual mode until the timer expires. 0 means unlimited.<br>
-                    Warning!!<br></vr></span><br>
+                    Warning!!<br></span><br>
             </fieldset><br><br><br>
         </fieldset>
     </form>

diff --git a/software/NRG_itho_wifi/main/webroot_source/controls_js_sources/javascript.js b/software/NRG_itho_wifi/main/webroot_source/controls_js_sources/javascript.js
@@ -16,42 +16,66 @@ var settingIndex = -1;
 var websocketServerLocation = location.protocol.indexOf("https") > -1 ? 'wss://' + window.location.hostname + ':8000/ws' : 'ws://' + window.location.hostname + ':8000/ws';
 
 let messageQueue = [];
+let connectTimeout, pingTimeout;
 let websock;
 
 function startWebsock(websocketServerLocation) {
-  if (debug) console.log(websocketServerLocation);
   messageQueue = [];
+  clearTimeout(connectTimeout);
+  clearTimeout(pingTimeout);
+  pingTimeout = !1;
+  connectTimeout = setTimeout((() => {
+    if (debug) console.log("websock connect timeout."),
+      //websock.close(),
+      startWebsock(websocketServerLocation);
+  }), 1000);
+  websock = null;
   websock = new WebSocket(websocketServerLocation);
-  websock.addEventListener('message', event => {
-    // Add message to the queue
-    messageQueue.push(event.data);
-  });
-  websock.onopen = function (a) {
+
+  websock.addEventListener('open', function (event) {
     if (debug) console.log('websock open');
+    clearTimeout(connectTimeout);
     document.getElementById("layout").style.opacity = 1;
     document.getElementById("loader").style.display = "none";
     if (lastPageReq !== "") {
       update_page(lastPageReq);
     }
     getSettings('syssetup');
-  };
-
-  websock.onclose = function (a) {
+  });
+  websock.addEventListener('message', function (event) {
+    "pong" == event.data ? (clearTimeout(pingTimeout),
+      pingTimeout = !1) : messageQueue.push(event.data);
+  });
+  websock.addEventListener('close', function (event) {
     if (debug) console.log('websock close');
-    // Try to reconnect in 200 milliseconds
-    websock = null;
     document.getElementById("layout").style.opacity = 0.3;
     document.getElementById("loader").style.display = "block";
-    setTimeout(function () { startWebsock(websocketServerLocation) }, 200);
-  };
-
-  websock.onerror = function (a) {
-    try {
-      if (debug) console.log(a);
-    } catch (error) {
-      if (debug) console.log(error);
+    // setTimeout(startWebsock, 200, websocketServerLocation);
+  });
+  websock.addEventListener('error', function (event) {
+    if (debug) console.log("websock Error!", event);
+    startWebsock(websocketServerLocation);
+    //websock.close();
+  });
+  setInterval((() => {
+    pingTimeout || websock.readyState != WebSocket.OPEN || (pingTimeout = setTimeout((() => {
+      if (debug) console.log("websock ping timeout.");
+      startWebsock(websocketServerLocation);
     }
-  };
+    ), 3e3),
+      websock_send("ping"))
+  }
+  ), 2e3)
+}
+
+function websock_send(message) {
+  if (websock.readyState === 1) {
+    if (debug) console.log(message);
+    websock.send(message);
+  }
+  else {
+    if (debug) console.log("websock.readyState != open");
+  }
 }
 
 (async function processMessages() {
@@ -305,6 +329,18 @@ function processMessage(message) {
 
 }
 
+function initButton() {
+  document.getElementById("command-button").addEventListener("click", sendCommand)
+}
+function trapKeyPress() {
+  document.getElementById("command-text").addEventListener("keypress", (e => {
+    "Enter" === e.code && (e.preventDefault(), document.getElementById("command-button").click())
+  })),
+    document.addEventListener("keydown", (e => {
+      document.activeElement && "command-text" === document.activeElement.id && ("ArrowUp" === e.code ? (commandHistoryIdx--, commandHistoryIdx < 0 && (commandHistoryIdx = commandHistory.length > 0 ? commandHistory.length - 1 : 0), commandHistoryIdx >= 0 && commandHistoryIdx < commandHistory.length && (document.getElementById("command-text").value = commandHistory[commandHistoryIdx])) : "ArrowDown" === e.code && (commandHistoryIdx++, commandHistoryIdx >= commandHistory.length && (commandHistoryIdx = 0), commandHistoryIdx >= 0 && commandHistoryIdx < commandHistory.length && (document.getElementById("command-text").value = commandHistory[commandHistoryIdx])))
+    }))
+}
+
 function clearSettingsLocStor() {
   let setlen = localStorage.getItem("itho_setlen");
   for (var index = 0; index < setlen; index++) {
@@ -858,11 +894,6 @@ $(document).ready(function () {
   });
 });
 
-function websock_send(message) {
-  websock.send(message);
-  if (debug) console.log(message);
-}
-
 var timerHandle = setTimeout(function () {
   $('#message_box').hide();
 }, 5000);

diff --git a/software/NRG_itho_wifi/main/websocket.cpp b/software/NRG_itho_wifi/main/websocket.cpp
@@ -789,8 +789,8 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventTyp
 {
   if (type == WS_EVT_CONNECT)
   {
-    // Serial.printf("ws[%s][%u] connect\n", server->url(), client->id());
-    client->ping();
+    client->setCloseClientOnQueueFull(false);
+    return;
   }
   else if (type == WS_EVT_DISCONNECT)
   {
@@ -806,14 +806,11 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventTyp
   }
   else if (type == WS_EVT_DATA)
   {
-    AwsFrameInfo *info = (AwsFrameInfo *)arg;
     std::string msg;
+    AwsFrameInfo *info = (AwsFrameInfo *)arg;
 
     if (info->final && info->index == 0 && info->len == len)
     {
-      // the whole message is in a single frame and we got all of it's data
-      // Serial.printf("ws[%s][%u] %s-message[%llu]: ", server->url(), client->id(), (info->opcode == WS_TEXT)?"text":"binary", info->len);
-
       if (info->opcode == WS_TEXT)
       {
         for (size_t i = 0; i < info->len; i++)
@@ -830,8 +827,14 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventTyp
           msg += buff;
         }
       }
+    }
+    if (strcmp(msg.c_str(), "ping") == 0)
+    {
+      client->text("pong");
+    }
+    else
+    {
       handle_ws_message(std::move(msg));
-      // Serial.printf("%s\n",msg.c_str());
     }
   }
 }

diff --git a/software/NRG_itho_wifi/platformio.ini b/software/NRG_itho_wifi/platformio.ini
@@ -12,7 +12,7 @@ default_envs =
 [env]
 ; Global data for all [env:***]
 build_flags =
-  -D VERSION=2.9.0-beta2
+  -D VERSION=2.9.0-beta3
 ;upload_port = /dev/cu.usbserial-1410 #optional, only needed if PlatformIO autodetect is not working
 ;monitor_port = /dev/cu.usbserial-1410 #optional, only needed if PlatformIO autodetect is not working
 platform = platformio/espressif32 @ ~6.9.0