summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2026-03-27 14:46:04 +0100
committerxengineering <me@xengineering.eu>2026-03-27 14:46:04 +0100
commitea47c2fd4eb17cc9ce0dc9fbe6f7d325e8be77b2 (patch)
treeb19a858d67cab60bf0f4be400d332e972aa6a426 /README.md
parent0fb9d297871e57372c469c6e8ca2b43813ed1f52 (diff)
parent3158a0a132d6af4de78c9be90e45834350cfd414 (diff)
downloadsia-server-ea47c2fd4eb17cc9ce0dc9fbe6f7d325e8be77b2.tar
sia-server-ea47c2fd4eb17cc9ce0dc9fbe6f7d325e8be77b2.tar.zst
sia-server-ea47c2fd4eb17cc9ce0dc9fbe6f7d325e8be77b2.zip
Merge branch 'server-version'
This is required to let the client identify the server version.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index e0555a0..845a068 100644
--- a/README.md
+++ b/README.md
@@ -105,6 +105,17 @@ For all terms not explained here see the [MQTT version 3.1.1 documentation][9].
- `good`: Sia server is connected to MQTT broker
- `bad`: Sia server is disconnected from MQTT broker
+### `/server/version`
+
+- description: Sia server version string from VERSION.txt
+- direction: Sia server to client
+- Quality of Service: QoS 1 (at least once)
+- retained: yes
+- receives will message: no
+- topic parameters: none
+- payloads:
+ - `<version>`: version string of the publishing Sia server without newline
+
### `/contact/<id>/state`
- description: Indicates state of Homematic IP SWDO-2 contacts