Skip to content

Commit b9f5520

Browse files
Update README.md
1 parent 9942fa6 commit b9f5520

1 file changed

Lines changed: 27 additions & 17 deletions

File tree

README.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Firmware features include
2727
- [music player](#the-music-player): Play mp3 files located on an SD card [requires TCD connected wirelessly or HA/MQTT for control]
2828
- [SD card](#sd-card) support for custom audio files for effects, and music for the Music Player
2929
- 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
3131
- built-in OTA installer for firmware updates and audio files
3232

3333
## Firmware Installation
@@ -418,7 +418,7 @@ With the wiring in place, head to the Config Portal and set the option **_TCD co
418418

419419
## Home Assistant / MQTT
420420

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:
422422

423423
### Control the Dash Gauges via MQTT
424424

@@ -464,9 +464,11 @@ MQTT requires a "broker" (such as [mosquitto](https://mosquitto.org/), [EMQ X](h
464464

465465
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".
466466

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+
467469
If your broker does not allow anonymous logins, a username and password can be specified.
468470

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).
470472

471473
## Car setup
472474

@@ -530,6 +532,10 @@ This leads to the [WiFi configuration page](#wifi-configuration)
530532

531533
This leads to the [Settings page](#settings).
532534

535+
##### ⏩ HA/MQTT Settings
536+
537+
This leads to the [HomeAssistant/MQTT Settings page](#hamqtt-settings).
538+
533539
##### ⏩ Update
534540

535541
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
738744

739745
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.
740746

741-
#### <ins> Assistant / MQTT settings</ins>
742-
743-
##### &#9193; 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-
##### &#9193; 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-
##### &#9193; 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-
755747
#### <ins>Settings for wired connections</ins>
756748

757749
##### &#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
812804

813805
then reload the page in your browser.
814806

807+
### HA/MQTT Settings
808+
809+
##### &#9193; 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+
##### &#9193; 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+
##### &#9193; 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+
##### &#9193; 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+
815825
---
816826
_Text & images: (C) Thomas Winischhofer ("A10001986"). See LICENSE._ Source: https://dg.out-a-ti.me
817827
_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)_

0 commit comments

Comments
 (0)