Merge remote-tracking branch 'upstream/main'

Author: CircuitSetup

README.md

@@ -27,7 +27,7 @@ Firmware features include
 - [music player](#the-music-player): Play mp3 files located on an SD card [requires TCD connected wirelessly or HA/MQTT for control]
 - [SD card](#sd-card) support for custom audio files for effects, and music for the Music Player
 - advanced network-accessible [Config Portal](#the-config-portal) for setup (http://gauges.local, hostname configurable)
-- [Home Assistant](#home-assistant--mqtt) (MQTT 3.1.1) support
+- [Home Assistant](#home-assistant--mqtt) (MQTT) support
 - built-in OTA installer for firmware updates and audio files
 
 ## Firmware Installation
@@ -44,17 +44,17 @@ The firmware comes with a sound-pack which needs to be installed separately. The
 
 The first step is to download "install/sound-pack-dgXX.zip" and extract it. It contains one file named "DGA.bin".
 
-Then there are two alternative ways to proceed. Note that both methods *require an SD card*.
+Next, head to the [Config Portal](#the-config-portal), click on *Update*, select the "DGA.bin" file in the bottom file selector and click on *Upload*.
 
-1) Through the [Config Portal](#the-config-portal). Click on *Update*, select the "DGA.bin" file in the bottom file selector and click on *Upload*.
+<details>
+<summary>More...</summary>
 
-2) Via SD card:
-- Copy "DGA.bin" to the root directory of a FAT32 formatted SD card;
+Alternatively, you can install the sound-pack the following way:
+- Using a computer, copy "DGA.bin" to the root directory of a FAT32 formatted SD card;
 - power down the Dash Gauges,
 - insert this SD card into the slot and 
 - power up the Dash Gauges; the sound-pack will be installed automatically.
-
-After installation, the SD card can be re-used for [other purposes](#sd-card).
+</details>
 
 ## Initial Configuration
 
@@ -407,7 +407,7 @@ You can use BTTF-Network and MQTT at the [same time](#receive-commands-from-time
 
 For wiring information, please see [here](Hardware.md#connecting-a-tcd-to-the-dash-gauges-by-wire).
 
-With the wiring in place, head to the Config Portal and set the option **_TCD connected by wire_**. On the TCD, the option "Control props connected by wire" must be set.
+With the wiring in place, head to the Config Portal and set the option **_TCD connected by wire_**. On the TCD, the option [TT-OUT] _"signals Time Travel"_ must be checked.
 
 <details>
 <summary>More...</summary>
@@ -418,7 +418,7 @@ With the wiring in place, head to the Config Portal and set the option **_TCD co
 
 ## Home Assistant / MQTT
 
-The Dash Gauges support the MQTT protocol version 3.1.1 for the following features:
+The Dash Gauges support MQTT protocol versions 3.1.1 and 5.0 for the following features:
 
 ### Control the Dash Gauges via MQTT
 
@@ -452,9 +452,9 @@ _The Refill (009) command is not supported through INJECT; use the REFILL MQTT-c
 
 ### Receive commands from Time Circuits Display
 
-If both TCD and Dash Gauges are connected to the same broker, and the option **_Send time travel/alarm event notifications_** is checked on the TCD's side, the Dash Gauges will receive information on time travel and alarm and play their sequences in sync with the TCD. Unlike BTTFN, however, no other communication takes place.
+If both TCD and Dash Gauges are connected to the same broker, and the option **_Publish time travel and alarm events_** is checked on the TCD's side, the Dash Gauges will receive information on time travel and alarm and play their sequences in sync with the TCD. Unlike BTTFN, however, no other communication takes place.
 
-MQTT and BTTFN can co-exist. However, the TCD only sends out time travel and alarm notifications through either MQTT or BTTFN, never both. If you have other MQTT-aware devices listening to the TCD's public topic (bttf/tcd/pub) in order to react to time travel or alarm messages, use MQTT (ie check **_Send time travel/alarm event notifications_**). If only BTTFN-aware devices are to be used, uncheck this option to use BTTFN as it has less latency.
+MQTT and BTTFN can co-exist. However, the TCD only sends out time travel and alarm notifications through either MQTT or BTTFN, never both. If you have other MQTT-aware devices listening to the TCD's public topic (bttf/tcd/pub) in order to react to time travel or alarm messages, use MQTT (ie check **_Publish time travel and alarm events_**). If only BTTFN-aware devices are to be used, uncheck this option to use BTTFN as it has less latency.
 
 ### Setup
 
@@ -464,9 +464,11 @@ MQTT requires a "broker" (such as [mosquitto](https://mosquitto.org/), [EMQ X](h
 
 The broker's address needs to be configured in the Config Portal. It can be specified either by domain or IP (IP preferred, spares us a DNS call). The default port is 1883. If a different port is to be used, append a ":" followed by the port number to the domain/IP, such as "192.168.1.5:1884". 
 
+If your broker supports protocol version 3.1.1, stick with 3.1.1. Version 5.0 has no advantages, but more overhead.
+
 If your broker does not allow anonymous logins, a username and password can be specified.
 
-Limitations: MQTT Protocol version 3.1.1; TLS/SSL not supported; ".local" domains (MDNS) not supported; server/broker must respond to PING (ICMP) echo requests. For proper operation with low latency, it is recommended that the broker is on your local network. MQTT is disabled when the Dash Gauges are operated in AP-mode or when connected to the TCD run in AP-Mode (TCD-AP).
+Limitations: TLS/SSL not supported; ".local" domains (MDNS) not supported; server/broker must respond to PING (ICMP) echo requests. For proper operation with low latency, it is recommended that the broker is on your local network. MQTT is disabled when the Dash Gauges are operated in AP-mode or when connected to the TCD run in AP-Mode (TCD-AP).
 
 ## Car setup
 
@@ -530,6 +532,10 @@ This leads to the [WiFi configuration page](#wifi-configuration)
 
 This leads to the [Settings page](#settings).
 
+##### &#9193; HA/MQTT Settings
+
+This leads to the [HomeAssistant/MQTT Settings page](#hamqtt-settings).
+
 ##### &#9193; Update
 
 This leads to the firmware and audio upload page. 
@@ -738,20 +744,6 @@ If this option is checked, and your TCD is equipped with a fake power switch, th
 
 If the dash gauges are connected to a TCD through BTTFN, this option allows to trigger a synchronized time travel on all BTTFN-connected devices when pressing the Time Travel button, just as if the Time Travel was triggered by the TCD. If this option is unchecked, pressing the Time Travel button only triggers a Time Travel sequence on the Dash Gauges.
 
-#### <ins> Assistant / MQTT settings</ins>
-
-##### &#9193; Use  Assistant (MQTT 3.1.1)
-
-If checked, the Dash Gauges will connect to the broker (if configured) and send and receive messages via [MQTT](#home-assistant--mqtt).
-
-##### &#9193; Broker IP[:port] or domain[:port]
-
-The broker server address. Can be a domain (eg. "my.me") or an IP address (eg "192.168.1.5"). The default port is 1883. If different port is to be used, it can be specified after the domain/IP and a colon ":", for example: "192.168.1.5:1884". Specifying the IP address is preferred over a domain since the DNS call adds to the network overhead. Note that ".local" (MDNS) domains are not supported.
-
-##### &#9193; User[:Password]
-
-The username (and optionally the password) to be used when connecting to the broker. Can be left empty if the broker accepts anonymous logins.
-
 #### <ins>Settings for wired connections</ins>
 
 ##### &#9193; TCD connected by wire
@@ -812,6 +804,24 @@ This selects the type of gauge hardware and the way of connection. In order to p
 
 then reload the page in your browser.
 
+### HA/MQTT Settings
+
+##### &#9193; Home Assistant support (MQTT)
+
+If checked, the Dash Gauges will connect to the broker (if configured) and send and receive messages via [MQTT](#home-assistant--mqtt).
+
+##### &#9193; Broker IP[:port] or domain[:port]
+
+The broker server address. Can be a domain (eg. "my.me") or an IP address (eg "192.168.1.5"). The default port is 1883. If different port is to be used, it can be specified after the domain/IP and a colon ":", for example: "192.168.1.5:1884". Specifying the IP address is preferred over a domain since the DNS call adds to the network overhead. Note that ".local" (MDNS) domains are not supported.
+
+##### &#9193; Protocol version
+
+The firmware supports MQTT 3.1.1 and 5.0. There is no difference in features, so there is no advantage in selecting 5.0. This was implemented only for brokers that do not support 3.1.1.
+
+##### &#9193; User[:Password]
+
+The username (and optionally the password) to be used when connecting to the broker. Can be left empty if the broker accepts anonymous logins.
+
 ---
 _Text & images: (C) Thomas Winischhofer ("A10001986"). See LICENSE._ Source: https://dg.out-a-ti.me  
 _Other props: [Time Circuits Display](https://tcd.out-a-ti.me) ... [Flux Capacitor](https://fc.out-a-ti.me) ... [SID](https://sid.out-a-ti.me) ... [VSR](https://vsr.out-a-ti.me) ... [Remote Control](https://remote.out-a-ti.me) ... [TFC](https://tfc.out-a-ti.me)_

install/dashgauges-A10001986.ino.nodemcu-32s.bin

@@ -115,6 +115,24 @@
 
 /*  Changelog
  *  
+ *  2025/11/26 (A10001986) [1.28]
+ *    - Prevent P1-speed from becoming the reason to switch to adapting to
+ *      TCD-provided speed in speedo-less time-travel sequences
+ *  2025/11/22 (A10001986)
+ *    - Sync'd TT: Handle abort in P0
+ *  2025/11/21 (A10001986)
+ *    - WM: Minor HTML tweaks; make page width dynamic for better display
+ *      on handheld devices
+ *  2025/11/19 (A10001986)
+ *    - Add support for MQTT v5.0 (tested with mosquitto only). Has no
+ *      advantages over 3.1.1 (but more overhead), only there to use brokers
+ *      that lack support for 3.1.1.
+ *    - Move HA/MQTT settings to separate page
+ *    - Add MQTT connection state info on HA/MQTT Settings page
+ *  2025/11/16 (A10001986)
+ *    - WM: Require HTTP_POST for params save pages. Also, check if request 
+ *      has parameter, do not overwrite current value with null (protects from 
+ *      overwriting settings by errorneous page reloads)
  *  2025/11/14 (A10001986) [1.27]
  *    - Remove BTTFN_MC conditional
  *  2025/11/13 (A10001986)

src/dashgauges-A10001986.ino

@@ -15,8 +15,8 @@
  ***                          Version Strings                          ***
  *************************************************************************/
 
-#define DG_VERSION       "V1.27"
-#define DG_VERSION_EXTRA "NOV142025"
+#define DG_VERSION       "V1.28"
+#define DG_VERSION_EXTRA "NOV262025"
 
 //#define DG_DBG              // debug output on Serial
 

src/dg_global.h

@@ -933,6 +933,15 @@ void main_loop()
 
                     // Nothing.
 
+                } else if(networkAbort) {
+
+                    // If we are aborted in P0,
+                    // the entire TT is over for us.
+                    TTP0 = false;
+                    TTrunning = false;
+                    isTTKeyPressed = false;
+                    ssRestartTimer();
+
                 } else {
 
                     TTP0 = false;
@@ -981,17 +990,21 @@ void main_loop()
 
                     TTP1 = false;
                     TTP2 = true;
+
+                    // P1 ends with empty; even if we were aborted in P1.
+                    // There is no "half empty".
                     gauges.setValuePercent(0, left_gauge_empty);
                     gauges.setValuePercent(1, center_gauge_empty);
                     gauges.setValuePercent(2, right_gauge_empty);
                     gauges.UpdateAll();
+                    
                     TTstart = now;
 
                 }
             }
             if(TTP2) {   // Reentry - up to us
 
-                if(now - TTstart > P2_ALARM_DELAY) {
+                if(networkAbort || (now - TTstart > P2_ALARM_DELAY)) {
 
                     // At very end:
                     checkGauges();
@@ -2146,15 +2159,22 @@ static void handle_tcd_notification(uint8_t *buf)
     case BTTFN_NOT_SPD:
         seqCnt = GET32(buf, 12);
         if(seqCnt > bttfnTCDSeqCnt || seqCnt == 1) {
-            gpsSpeed = (int16_t)(buf[6] | (buf[7] << 8));
-            if(gpsSpeed > 88) gpsSpeed = 88;
             switch(buf[8] | (buf[9] << 8)) {
             case BTTFN_SSRC_GPS:
                 spdIsRotEnc = false;
                 break;
+            case BTTFN_SSRC_P1:
+                // If packets come out-of-order, we might
+                // get this one before TTrunning, and we
+                // don't want a switch to usingGPSS only 
+                // because of P1 speed
+                if(!TTrunning) return;
+                // fall through
             default:
                 spdIsRotEnc = true;
             }
+            gpsSpeed = (int16_t)(buf[6] | (buf[7] << 8));
+            if(gpsSpeed > 88) gpsSpeed = 88;
         } else {
             #ifdef DG_DBG
             Serial.printf("Out-of-sequence packet received from TCD %d %d\n", seqCnt, bttfnTCDSeqCnt);

src/dg_main.cpp

@@ -507,6 +507,7 @@ static bool read_settings(File configFile, int cfgReadCount)
         #ifdef DG_HAVEMQTT
         wd |= CopyCheckValidNumParm(json["useMQTT"], settings.useMQTT, sizeof(settings.useMQTT), 0, 1, 0);
         wd |= CopyTextParm(json["mqttServer"], settings.mqttServer, sizeof(settings.mqttServer));
+        wd |= CopyCheckValidNumParm(json["mqttV"], settings.mqttVers, sizeof(settings.mqttVers), 0, 1, 0);
         wd |= CopyTextParm(json["mqttUser"], settings.mqttUser, sizeof(settings.mqttUser));
         #endif
 
@@ -594,6 +595,7 @@ void write_settings()
     #ifdef DG_HAVEMQTT
     json["useMQTT"] = (const char *)settings.useMQTT;
     json["mqttServer"] = (const char *)settings.mqttServer;
+    json["mqttV"] = (const char *)settings.mqttVers;
     json["mqttUser"] = (const char *)settings.mqttUser;
     #endif
 

src/dg_settings.cpp

@@ -147,6 +147,7 @@ struct Settings {
 
 #ifdef DG_HAVEMQTT  
     char useMQTT[4]         = "0";
+    char mqttVers[4]        = "0"; // 0 = 3.1.1, 1 = 5.0
     char mqttServer[80]     = "";  // ip or domain [:port]  
     char mqttUser[128]      = "";  // user[:pass] (UTF8)
 #endif