add info about mqtt status messages

dewenni · Jan 1, 2025 · f8655fc · f8655fc
1 parent 95af64f
commit f8655fc
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -317,20 +317,6 @@ If everything done correct, all shutters should work like before. If not, some s
 
 # MQTT
 
-## additional information's (read only)
-
-status information about WiFi:
-
-```text
-Topic: ESP32-Jarolift-Controller/wifi = {  
-    "status":"online",  
-    "rssi":"-50",  
-    "signal":"90",  
-    "ip":"192.168.1.1",  
-    "date-time":"01.01.2022 - 10:20:30"  
-}
-```
-
 ## Commands
 
 ### Shutter
@@ -420,10 +406,46 @@ payload:    {0b0000000000010101, 0x15, 21}
 
 ```
 
+## Status
+
+The controller will also send a status **based on the commands**.  
+
+> [!IMPORTANT]
+> But it is important to know, that this status is only a "copy of the received command".  
+> It does not correspond to the real status of the roller shutter, because unfortunately the roller shutter itself does not have a status that could be analyzed. So if the roller shutter is operated via the original remote control, for example, or via local operation, or is stopped during movement, then this status is no longer correct!
+
+```text
+
+Status:     Shutter OPEN
+topic:      ../status/shutter/1 ... status/shutter/16
+payload:    {0}
+
+Status:     Shutter CLOSED
+topic:      ../status/shutter/1 ... status/shutter/16
+payload:    {100}
+
+Status:     Shutter SHADE
+topic:      ../status/shutter/1 ... status/shutter/16
+payload:    {90}
+```
 
 > [!NOTE]
 > < ../ > is the placeholder for the MQTT topic which is specified in the settings.
 
+## additional information's (read only)
+
+status information about WiFi:
+
+```text
+Topic: ESP32-Jarolift-Controller/wifi = {  
+    "status":"online",  
+    "rssi":"-50",  
+    "signal":"90",  
+    "ip":"192.168.1.1",  
+    "date-time":"01.01.2022 - 10:20:30"  
+}
+```
+
 ## Home Assistant
 
 MQTT discovery for Home Assistant makes it easy to get all values in Home Assistant.

diff --git a/README_DE.md b/README_DE.md
@@ -316,20 +316,6 @@ Wenn alles richtig gemacht wurde, sollten alle Rollläden wie vorher funktionier
 
 # MQTT
 
-### zusätzliche Informationen (nur lesen)
-
-Statusinformationen über WiFi:
-
-```text
-Topic: ESP32-Jarolift-Controller/wifi = {  
-    "status":"online",  
-    "rssi":"-50",  
-    "signal":"90",  
-    "ip":"192.168.1.1",  
-    "date-time":"01.01.2022 - 10:20:30"  
-}
-```
-
 ## Kommandos
 
 ### Rolläden
@@ -419,9 +405,45 @@ payload:    {0b0000000000010101, 0x15, 21}
 
 ```
 
+## Status
+
+Der Controller sendet auch einen Status, **basierend auf den empfangenen Kommandos.**  
+
+> [!IMPORTANT]
+> Aber es ist wichtig zu beachten, dass dieser Status nicht dem tatsächlichen Zustand des Rollladens entspricht, denn leider sendet der Rolladen selbst keinen Status den man dazu auswerten könnte. Wenn also der Rolladen z.B. über die originale Fernbedienung bedient wird oder über eine vor Ort Bedienung, oder während der Bewegung gestoppt wird, dann stimmt dieser Status hier nicht mehr!
+
+```text
+
+Status:     Rolladen OFFEN
+topic:      ../status/shutter/1 ... status/shutter/16
+payload:    {0}
+
+Status:     Rolladen GESCHLOSSEN
+topic:      ../status/shutter/1 ... status/shutter/16
+payload:    {100}
+
+Status:     Rolladen SCHATTEN
+topic:      ../status/shutter/1 ... status/shutter/16
+payload:    {90}
+```
+
 > [!NOTE]
 > < ../ > ist der Platzhalter für das MQTT-Topic, das in den Einstellungen angegeben ist.
 
+## zusätzliche Informationen (nur lesen)
+
+Statusinformationen über WiFi:
+
+```text
+Topic: ESP32-Jarolift-Controller/wifi = {  
+    "status":"online",  
+    "rssi":"-50",  
+    "signal":"90",  
+    "ip":"192.168.1.1",  
+    "date-time":"01.01.2022 - 10:20:30"  
+}
+```
+
 ## Home Assistant
 
 MQTT Discovery für Home Assistant macht es einfach, alle Werte in Home Assistant zu erhalten.