You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-17Lines changed: 27 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Firmware features include
27
27
-[music player](#the-music-player): Play mp3 files located on an SD card [requires TCD connected wirelessly or HA/MQTT for control]
28
28
-[SD card](#sd-card) support for custom audio files for effects, and music for the Music Player
29
29
- advanced network-accessible [Config Portal](#the-config-portal) for setup (http://gauges.local, hostname configurable)
30
-
-[Home Assistant](#home-assistant--mqtt) (MQTT 3.1.1) support
30
+
-[Home Assistant](#home-assistant--mqtt) (MQTT) support
31
31
- built-in OTA installer for firmware updates and audio files
32
32
33
33
## Firmware Installation
@@ -418,7 +418,7 @@ With the wiring in place, head to the Config Portal and set the option **_TCD co
418
418
419
419
## Home Assistant / MQTT
420
420
421
-
The Dash Gauges support the MQTT protocol version 3.1.1 for the following features:
421
+
The Dash Gauges support MQTT protocol versions 3.1.1 and 5.0 for the following features:
422
422
423
423
### Control the Dash Gauges via MQTT
424
424
@@ -464,9 +464,11 @@ MQTT requires a "broker" (such as [mosquitto](https://mosquitto.org/), [EMQ X](h
464
464
465
465
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".
466
466
467
+
If your broker supports protocol version 3.1.1, stick with 3.1.1. Version 5.0 has no advantages, but more overhead.
468
+
467
469
If your broker does not allow anonymous logins, a username and password can be specified.
468
470
469
-
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).
471
+
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).
470
472
471
473
## Car setup
472
474
@@ -530,6 +532,10 @@ This leads to the [WiFi configuration page](#wifi-configuration)
530
532
531
533
This leads to the [Settings page](#settings).
532
534
535
+
##### ⏩ HA/MQTT Settings
536
+
537
+
This leads to the [HomeAssistant/MQTT Settings page](#hamqtt-settings).
538
+
533
539
##### ⏩ Update
534
540
535
541
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
738
744
739
745
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.
740
746
741
-
#### <ins> Assistant / MQTT settings</ins>
742
-
743
-
##### ⏩ Use Assistant (MQTT 3.1.1)
744
-
745
-
If checked, the Dash Gauges will connect to the broker (if configured) and send and receive messages via [MQTT](#home-assistant--mqtt).
746
-
747
-
##### ⏩ Broker IP[:port] or domain[:port]
748
-
749
-
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.
750
-
751
-
##### ⏩ User[:Password]
752
-
753
-
The username (and optionally the password) to be used when connecting to the broker. Can be left empty if the broker accepts anonymous logins.
754
-
755
747
#### <ins>Settings for wired connections</ins>
756
748
757
749
##### ⏩ TCD connected by wire
@@ -812,6 +804,24 @@ This selects the type of gauge hardware and the way of connection. In order to p
812
804
813
805
then reload the page in your browser.
814
806
807
+
### HA/MQTT Settings
808
+
809
+
##### ⏩ Home Assistant support (MQTT)
810
+
811
+
If checked, the Dash Gauges will connect to the broker (if configured) and send and receive messages via [MQTT](#home-assistant--mqtt).
812
+
813
+
##### ⏩ Broker IP[:port] or domain[:port]
814
+
815
+
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.
816
+
817
+
##### ⏩ Protocol version
818
+
819
+
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.
820
+
821
+
##### ⏩ User[:Password]
822
+
823
+
The username (and optionally the password) to be used when connecting to the broker. Can be left empty if the broker accepts anonymous logins.
824
+
815
825
---
816
826
_Text & images: (C) Thomas Winischhofer ("A10001986"). See LICENSE._ Source: https://dg.out-a-ti.me
0 commit comments