Vertrag¶
Der maschinenlesbare Vertrag beschreibt die Form jeder Nachricht des
Protokolls: ein OpenRPC-Dokument, dessen
Nachrichten in JSON Schema beschrieben sind, ergänzt um x-etm-…-Erweiterungen für das,
was OpenRPC nicht ausdrücken kann — Transport, Rückfall-Automat, benannte Prüfregeln,
Toleranzen, geschlossene Listen.
Die Engine bringt ihn mit, und ihre Tests wie die Konformitäts-Testsuite prüfen ihn auf beiden Seiten. Die Tabellen der Seite Protokoll werden daraus erzeugt.
Den Vertrag herunterladen¶
etm-powersync-optimizer-protocol.openrpc.json herunterladen
Die Website liefert die Datei unverändert, Byte für Byte, aus dem Standard-Branch des Engine-Repositorys. Ihr Steckbrief:
| Contract | |
|---|---|
| Title | etm-powersync — protocole moteur ↔ optimiseur |
| Protocol version | 1.8 |
| Format | OpenRPC 1.3.2, JSON Schema in components.schemas |
| License | GPL-3.0-or-later |
| File | etm-powersync-optimizer-protocol.openrpc.json |
| Size | 109892 bytes |
| SHA-256 | f8b6c501617752e7a67022a68cae6fc3b198be48c49d18ebbd89cd3f525d1d46 |
| Methods | Handshake · GetPlan · UpdateLearned |
| Schemas | 54 |
| Semantic rules | 19 |
| Extensions (document) | x-etm-error-message · x-etm-fallback-machine · x-etm-generated · x-etm-message-errors · x-etm-reason-params · x-etm-semantic-rules · x-etm-tolerances · x-etm-transport |
| Extensions (methods) | x-etm-direction · x-etm-errors-engine · x-etm-notification · x-etm-timeout-s |
Der Vertrag Ihrer Box: NymeaEnergy.GetOptimizerProtocol¶
Der hier veröffentlichte Vertrag folgt der Entwicklung der Engine; Ihre Box kann eine
ältere Version tragen. Um den Vertrag der installierten Engine zu erfahren, fragen Sie
die Box: Die JSON-RPC-Methode NymeaEnergy.GetOptimizerProtocol liefert den, den sie
mitbringt. Dieser ist für einen an diese Box angebundenen Optimierer maßgeblich.
Sie gehört zu den NymeaEnergy.*-Methoden des Optimierers (Verbindungspunkt, gemeinsames
Geheimnis, Zustand); ihre genaue Form liefert die Box selbst über JSONRPC.Introspect. Die Verbindung zur API
beschreibt die Seite JSON-RPC-API.
Nachrichten prüfen¶
Das Engine-Repository enthält einen Validator, tools/etm-powersync-schema-check (Python,
Standardbibliothek): Er prüft eine Nachricht, eine vollständig aufgezeichnete Sitzung oder
Aufzeichnungen gegen den Vertrag und wendet auf Wunsch die benannten Prüfregeln an.