Aller au contenu

Contrat

Le contrat machine décrit la forme de chaque message du protocole : un document OpenRPC dont les messages sont en JSON Schema, complété par des extensions x-etm-… pour ce qu'OpenRPC ne sait pas dire — transport, machine de repli, règles de validation nommées, tolérances, listes fermées.

Le moteur l'embarque, et ses tests comme ceux de la suite de conformité le vérifient des deux côtés. Les tableaux de la page Protocole en sont générés.

Télécharger le contrat

Télécharger etm-powersync-optimizer-protocol.openrpc.json

Le site sert le fichier tel quel, octet pour octet, depuis la branche par défaut du dépôt du moteur. Sa fiche :

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

Le contrat de votre box : NymeaEnergy.GetOptimizerProtocol

Le contrat publié ici suit le développement du moteur ; votre box peut porter une version antérieure. Pour connaître le contrat du moteur installé, demandez-le à la box : la méthode JSON-RPC NymeaEnergy.GetOptimizerProtocol rend celui qu'elle embarque. C'est celui-là qui fait foi pour un optimiseur branché sur cette box.

Elle fait partie des méthodes NymeaEnergy.* de l'optimiseur (point de connexion, secret partagé, état) ; la box en rend la forme exacte par JSONRPC.Introspect. La connexion à l'API est décrite sur la page API JSON-RPC.

Valider des messages

Le dépôt du moteur fournit un validateur, tools/etm-powersync-schema-check (Python, bibliothèque standard) : il juge un message, une session complète enregistrée ou des traces contre le contrat, et applique sur demande les règles de validation nommées.