Aller au contenu

MQTT BROKER SEUL

La box contient un broker MQTT. Il sert à relier à la box des appareils et des logiciels qui parlent MQTT. La box ne publie pas d'elle-même l'état de ses appareils ni les données du moteur en MQTT : pour les lire, passez par l'API JSON-RPC.


Le broker de la box

Au premier démarrage, nymea crée une configuration par défaut :

Réglage Valeur par défaut
Adresse d'écoute 0.0.0.0 (toutes les interfaces de la box)
Port 1883
TLS désactivé
Authentification activée

La box annonce le broker sur le réseau local (ZeroConf, service _mqtt._tcp).

Avec l'authentification activée, un client MQTT n'est accepté que si une policy existe à son nom. Une policy, c'est :

Champ Rôle
clientId l'identifiant de client MQTT auquel elle s'applique
username, password les identifiants que ce client doit présenter
allowedPublishTopicFilters les sujets sur lesquels il peut publier
allowedSubscribeTopicFilters les sujets auxquels il peut s'abonner

Les filtres acceptent les jokers + et #. Un client sans policy, ou avec de mauvais identifiants, est refusé ; une publication ou un abonnement hors des filtres aussi. Si vous désactivez l'authentification d'une configuration, tout client y est accepté, sans restriction de sujet.

La configuration par défaut n'a aucune policy enregistrée : un client que vous configurez vous-même ne peut pas s'y connecter tant que vous ne lui en créez pas une.


Le régler

Il n'y a pas d'écran pour cela dans l'application. Le broker se règle par l'API JSON-RPC, et chacune de ces méthodes exige le droit administrateur (ADMIN) :

Méthode Ce qu'elle fait
Configuration.GetMqttServerConfigurations liste les configurations d'écoute du broker
Configuration.SetMqttServerConfiguration crée une configuration, ou modifie celle qui a le même id (adresse, port, TLS, authentification)
Configuration.DeleteMqttServerConfiguration supprime une configuration
Configuration.GetMqttPolicies liste les policies enregistrées
Configuration.SetMqttPolicy crée une policy, ou modifie celle du même clientId
Configuration.DeleteMqttPolicy supprime une policy

Qui s'en sert

Trois plugins utilisent le broker de la box :

  • Tasmota : à l'ajout d'un appareil, la box crée pour lui un accès réservé (identifiants tirés au hasard, sujets limités à son propre préfixe) et le règle sur l'appareil, qui échange ensuite avec la box par le broker.
  • go-eCharger, si vous cochez le paramètre useMqtt (Use MQTT interface, désactivé par défaut) : la box crée de même un accès pour la borne et lui donne l'adresse du broker.
  • Client MQTT : il s'abonne à un filtre de sujets et produit un événement Publish received (sujet, contenu) à chaque message ; son action Publish publie un message (sujet, contenu, QoS, rétention). Le client interne parle au broker de la box ; le client tout court, au broker dont vous saisissez l'adresse.

Les accès que créent Tasmota, go-eCharger et le client interne vivent en mémoire : Configuration.GetMqttPolicies ne les montre pas.


Ce qui n'existe pas

  • La box ne publie ni l'état des appareils, ni les mesures, ni les données du moteur en MQTT. Sur le broker ne passe que ce que publient les plugins ci-dessus et les clients que vous autorisez. Pour lire ces données, utilisez l'API JSON-RPC et ses notifications.
  • Il n'y a donc pas de liste de sujets « ETM PowerSync » ni de format de message à documenter.