exceedingsolutions/wmbusapi repository overview

Hier ist eine kurze Beschreibung für das Projekt:

---

⁠WMBus FastAPI - REST API for WMBus Library

Eine RESTful API-Schnittstelle für die Ansteuerung von Wireless M-Bus (WMBus) Kommunikationsmodulen über eine C-Bibliothek. Die API ermöglicht die drahtlose Kommunikation mit Verbrauchszählern (Wasser, Gas, Wärme, Strom) gemäß dem WMBus-Standard.

⁠🔧 Technische Basis

• FastAPI als modernes Web-Framework mit automatischer OpenAPI-Dokumentation
• ctypes-Anbindung an eine native C-Bibliothek (libwMBusAPI.so)
• Asynchrone Hintergrundprozesse für kontinuierlichen Empfang
• Pydantic-Modelle für strukturierte Datenvalidierung

⁠📡 Hauptfunktionen

Geräteverwaltung

• Initialisierung mit konfigurierbarer Quarzfrequenz
• Statusabfrage (initialisiert, Device Info, Version)
• Kontrolliertes Herunterfahren

Senden (WMBus)

• Einfache Übertragung von Standard-Frames
• Mehrfachübertragung (bis zu 100x)
• Custom Payloads: Versand beliebiger Hex-Daten mit automatischer CRC-Handhabung
• Unterstützung der Modi T (Meter) und C (Concentrator)

Empfangen (WMBus)

• Hintergrundempfang in separatem Thread
• Unterstützung aller WMBus-Modi: T, S-SHORT, S-LONG, C-A, C-B
• Automatische CRC-Entfernung (optional)
• Polling-Mechanismus zur Abholung von Frames aus der C-Bibliothek
• Zugriff auf empfangene Frames mit Metadaten (RSSI, SQI, PQI, Timestamp)

⁠📊 Datenmodell pro Frame

• Timestamp (ISO-Format)
• Empfangsmodus (T/C)
• Paketlänge, RSSI, Signalqualität
• Geparster Header (Hersteller, Version, Device Type)
• Rohdaten als Hex-String

⁠🚀 Typische Anwendungen

• Auslesen von Funkverbrauchszählern
• Test- und Entwicklungsplattform für WMBus-Geräte
• Integration in Smart-Home- oder Energiemonitoring-Systeme
• Prototyping und Debugging von WMBus-Kommunikation

⁠📚 API-Dokumentation

• Automatisches OpenAPI-Schema unter /docs und /redoc
• Klare Request/Response-Modelle für alle Endpunkte
• Health-Check und Test-Funktion für Library-Status

---

Die API abstrahiert die komplexe C-Bibliothek und bietet eine moderne, dokumentierte REST-Schnittstelle für die einfache Integration von WMBus-Funktionalität in beliebige Anwendungen.