feat: Aktualisiere JSON-Schema und MQTT-Nachrichtenverarbeitung; verschiebe Preamble und Modulationsfelder ins Protokollobjekt

Author: sidey79

.devcontainer/docker-compose.yml

@@ -38,7 +38,7 @@ services:
     environment:
       - CONFIGTYPE=fhem_signalduino_example.cfg
       - FHEM_PERM_DIR=0777
-      - FHEM_PERM_FILES=0777
+      - FHEM_PERM_FILE=0777
     volumes:
       - ./fhem-data:/opt/fhem
     depends_on:

docs/architecture/decisions/ADR-006-json-output-schema.adoc

@@ -50,17 +50,17 @@ Der JSON-Output für MQTT-Nutzdaten muss **kompakt** (ohne Zeilenumbrüche und E
 | `str`
 | Die Preamble (z.B. `W125#`) des erkannten Protokolls.
 
-| `protocol.encoding`
+| `protocol.format`
 | `str`
-| Das Codierungsformat des Signals (z.B. `manchester`, `twostate`, `pulse`).
+| Das Format bzw. die Modulationsart des Signals (z.B. `manchester`, `twostate`, `2-FSK`).
 
 | `protocol.clock`
 | `float`
 | Der Takt-Wert in Mikrosekunden (`us`), der für die Demodulation verwendet wurde.
 
-| `protocol.modulation`
+| `protocol.rfmode`
 | `str`
-| (Optional) Modulationsart (z.B. `2-FSK`, `GFSK`) für FSK-Protokolle.
+| (Optional) Der RF-Modus (z.B. `Fine_Offset_WH31_868`), falls verfügbar.
 
 | `protocol.bitlength`
 | `int`

docs/architecture/snippets/json_output_schema_example.adoc

@@ -1,18 +1,18 @@
 [source,json]
 ----
 {
-  "data": "30E0A1AA4241DE6C000200000BC5",
-  "raw": "MC;LL=-1017;LH=932;...",
+  "data": "30E0A1DE4CE6C16C0002000012FC",
+  "raw": "MN;D=30E0A1DE4CE6C16C0002000012FC;R=193;A=-21;",
   "metadata": {
-    "rssi": -74,
-    "freq_afc": 123
+    "rssi": -105.5,
+    "freq_afc": -33
   },
   "protocol": {
-    "name": "WH31",
     "id": "125",
+    "model": "MN",
     "preamble": "W125#",
     "format": "2-FSK",
-    "clock": 17257
+    "rfmode": "Fine_Offset_WH31_868"
   }
 }
 ----

signalduino/mqtt.py

@@ -282,8 +282,18 @@ def _raw_frame_to_dict(raw_frame: RawFrame) -> dict:
             except Exception as e:
                 self.logger.warning("Failed to get preamble: %s", e)
 
-        # Add new 'preamble' field
-        message_dict["preamble"] = preamble
+        # Add new 'preamble' field to protocol object
+        if "protocol" not in message_dict or message_dict["protocol"] is None:
+            message_dict["protocol"] = {}
+            
+        message_dict["protocol"]["preamble"] = preamble
+
+        # Move modulation and rfmode from metadata to protocol
+        metadata = message_dict.get("metadata", {})
+        if "modulation" in metadata:
+            message_dict["protocol"]["format"] = metadata.pop("modulation")
+        if "rfmode" in metadata:
+            message_dict["protocol"]["rfmode"] = metadata.pop("rfmode")
 
         # Ensure data (formerly payload) is uppercase
         # Use getattr to be safe even if dataclass structure changed

tests/test_mqtt.py

@@ -33,6 +33,8 @@ def mock_decoded_message() -> DecodedMessage:
             "message_hex": "AABBCC",
             "message_bits": "101010101011101111001100",
             "is_repeat": False,
+            "modulation": "ASK",
+            "rfmode": "Slow",
         },
         protocol={"id": "1"}, # Hinzugefügtes Protokoll-ID-Feld
     )
@@ -131,10 +133,18 @@ async def test_mqtt_publisher_publish_success(MockClient, mock_decoded_message,
     payload_dict = json.loads(published_payload.decode("utf-8"))
     assert payload_dict["protocol"]["id"] == "1"
 
-    # Payload sollte KEINE Preamble mehr enthalten, aber das neue Feld "preamble" schon
+    # Payload sollte KEINE Preamble mehr enthalten.
+    # Preamble sollte im "protocol" Feld sein.
     # Protocol 1 (Conrad RSL v1) hat Preamble "P1#"
     assert payload_dict["data"] == "9374A400"
-    assert payload_dict["preamble"] == "P1#"
+    assert payload_dict["protocol"]["preamble"] == "P1#"
+    assert "preamble" not in payload_dict
+
+    # Check moved metadata fields
+    assert payload_dict["protocol"]["format"] == "ASK"
+    assert payload_dict["protocol"]["rfmode"] == "Slow"
+    assert "modulation" not in payload_dict["metadata"]
+    assert "rfmode" not in payload_dict["metadata"]
 
     # 'raw' sollte jetzt enthalten sein, da es ein String-Feld ist.
     assert payload_dict["raw"] == "MS;P1=1154;P2=-697;P3=559;P4=-1303;P5=-7173;D=351234341234341212341212123412343412341234341234343434343434343434;CP=3;SP=5;R=247;O;"
@@ -180,7 +190,7 @@ async def test_mqtt_publisher_strips_preamble_from_data(MockClient, mock_decoded
 
     # 2. Assert, dass die Preamble aus 'data' entfernt wurde
     assert payload_dict["data"] == "9374A400"
-    assert payload_dict["preamble"] == "P1#"
+    assert payload_dict["protocol"]["preamble"] == "P1#"
 
 
 @patch("signalduino.mqtt.mqtt.Client")