Build & Deploy docs / build-deploy (push) Failing after 10m17s

Details

feat: référence API JsonRPC générée depuis introspect.json

- Nouveau générateur scripts/gen_api_reference.py : 19 namespaces →
  docs/api/metier/ (10) + docs/api/systeme/ (9) + notifications.md +
  types.md (96 types · 55 enums · 4 flags) + SUMMARY.md literate-nav
- Badges permissionScope (perm-none/control/configure/admin) dans extra.css
- Guide docs/integrations/jsonrpc-api.md (connexion TCP/WS, auth, conventions énergie)
- mkdocs.yml : Référence API dans la nav, REST→JsonRPC renommé
- mkdocs build --strict : 0 warnings · --check idempotent

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-06-04 08:15:37 +02:00

1.6 KiB

Raw Permalink Blame History

hide

toc

Référence API JsonRPC

ETM PowerSync expose l'API JSON-RPC de nymea en local, y compris les extensions ETM (Energy, AirConditioning, EvDash).

Connexion

Mode	Adresse	Notes
TCP brut	`<ip>:2222`	nymea parle en premier (welcome JSON `\n`-delimited)
WebSocket	`ws://<ip>:4444`	le client envoie `JSONRPC.Hello` en premier

Authentification

Appeler JSONRPC.Authenticate avec username, password et deviceName → reçoit un token.
Inclure le token dans chaque requête suivante.
Activer les push : JSONRPC.SetNotificationStatus { "enabled": true }.

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
PUBLIC	`PermissionScopeNone`	Lecture publique, aucun token requis
CONTROL	`PermissionScopeControlThings` / `ExecuteRules`	Contrôle des appareils et règles
CONFIGURE	`PermissionScopeConfigureThings` / `ConfigureRules`	Configuration
ADMIN	`PermissionScopeAdmin`	Administration système

1.6 KiB Raw Permalink Blame History