Patrick Schurig 4a7a1bddf4
All checks were successful
Build & Deploy docs / build-deploy (push) Successful in 3m52s
api : référence régénérée depuis le banc en 1.15.2+etm71 (droits NymeaEnergy.* séparés, GetOptimizerProtocol)
Le badge PUBLIC de PermissionScopeNone devient AUTH : sur un transport
authentifié, nymea exige un token valide pour toute méthode sauf
JSONRPC.Hello, Authenticate et RequestPushButtonAuth
(jsonrpcserverimplementation.cpp, tag 1.15.2). « Lecture publique, aucun
token requis » était faux, en trois langues.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-20 08:49:15 +02:00

2.1 KiB

API JsonRPC Supporté

ETM PowerSync expose l'API JSON-RPC de nymea en local, étendue avec les namespaces ETM (Energy, AirConditioning, EvDash).


Connexion

Mode Adresse Notes
TCP brut <ip>:2222 Le serveur envoie un message de bienvenue JSON (\n-délimité) à la connexion
WebSocket ws://<ip>:4444 Le client envoie JSONRPC.Hello en premier

Chaque message est un objet JSON terminé par \n. Les requêtes incluent un champ id (entier) pour apparier la réponse. Les notifications n'ont pas de id.


Authentification

  1. Appeler JSONRPC.Authenticate avec username, password et deviceName → le serveur répond avec un token.
  2. Inclure le token dans chaque requête suivante.
  3. Pour recevoir les notifications : appeler JSONRPC.SetNotificationStatus avec { "namespaces": ["Energy", "Integrations", ...] }.

Conventions énergie

Grandeur Convention
Production PV valeur négative (convention producteur)
currentPowerAcquisition réseau — positif = import, 0 si export
currentPowerStorage batterie — positif = charge, négatif = décharge
Totaux d'énergie en kWh
Timestamps en secondes (Unix epoch)

Badges de permission

Badge Scope Description
AUTH PermissionScopeNone Tout compte authentifié (token requis dès que le transport exige l'authentification ; seuls JSONRPC.Hello, Authenticate et RequestPushButtonAuth passent sans)
CONTROL PermissionScopeControlThings / ExecuteRules Contrôle des appareils et règles
CONFIGURE PermissionScopeConfigureThings / ConfigureRules Configuration des intégrations et règles
ADMIN PermissionScopeAdmin Administration système

Référence complète

→ Référence API JsonRPC