summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2026-03-26 21:02:20 +0100
committerxengineering <me@xengineering.eu>2026-03-26 21:34:16 +0100
commit0ec5e0034891075ca0c70c6d29e20442c8ddb46e (patch)
treeffe261f4141c823bb6d345e6e22e12ec630b8ae5 /README.md
parent443ba52ab3f49a28e8874ebcb5476e36c3defb4c (diff)
downloadsia-server-0ec5e0034891075ca0c70c6d29e20442c8ddb46e.tar
sia-server-0ec5e0034891075ca0c70c6d29e20442c8ddb46e.tar.zst
sia-server-0ec5e0034891075ca0c70c6d29e20442c8ddb46e.zip
Add Shelly / TP-Link device discovery
This announces Shelly and TP-Link devices with an empty MQTT message. This makes it possible that a client can display the available devices.
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 26 insertions, 2 deletions
diff --git a/README.md b/README.md
index cb3be93..e0555a0 100644
--- a/README.md
+++ b/README.md
@@ -118,9 +118,21 @@ For all terms not explained here see the [MQTT version 3.1.1 documentation][9].
- `open`: contact is open
- `closed`: contact is closed
+### `/cover/<id>`
+
+- description: Discovery of Shelly 2PM Gen3 covers
+- direction: Sia server to client
+- Quality of Service: QoS 1 (at least once)
+- retained: yes
+- receives will message: no
+- topic parameters:
+ - `id`: ID of the Shelly 2PM Gen3 cover
+- payloads:
+ - `exists`: a device with the given ID exists
+
### `/cover/<id>/movement`
-- description: Allows control of Shelly 2PM Gen3 covers
+- description: Control of Shelly 2PM Gen3 covers
- direction: client to Sia server
- Quality of Service: QoS 2 (exactly once)
- retained: no
@@ -132,9 +144,21 @@ For all terms not explained here see the [MQTT version 3.1.1 documentation][9].
- `retract`: cover decreases the covering surface
- `stop`: cover stops current motion if given
+### `/plug/<id>`
+
+- description: Discovery of TP-Link HS100 Wi-Fi plugs
+- direction: Sia server to client
+- Quality of Service: QoS 1 (at least once)
+- retained: yes
+- receives will message: no
+- topic parameters:
+ - `id`: ID of the TP-Link HS100 Wi-Fi plug
+- payloads:
+ - `exists`: a device with the given ID exists
+
### `/plug/<id>/action`
-- description: Implements control of tp-link HS100 Wi-Fi plugs
+- description: Control of TP-Link HS100 Wi-Fi plugs
- direction: client to Sia server
- Quality of Service: QoS 2 (exactly once)
- retained: no