Connecteur MQTT v3
Publiez les données en direct des appareils et des stratégies vers votre propre broker MQTT et acceptez les commandes qu'il envoie.
→ Aperçu
Le connecteur MQTT v3 connecte le contrôleur, en tant que client, à un broker MQTT de votre choix, par exemple le broker d'un système de gestion technique du bâtiment, d'un SCADA ou d'une plateforme domotique. Le contrôleur publie alors les valeurs en direct de tous les appareils et de toutes les stratégies, les prix de l'électricité et un message keep-alive, et il écoute les commandes telles que les consignes des appareils, l'activation et la désactivation des stratégies, les plannings External EMS et les paramètres du réseau électrique.
Le connecteur est désactivé tant que vous n'avez pas saisi de Host. Il est indépendant de la connexion au Reduxi Cloud ; les deux peuvent fonctionner en même temps.
Toute personne qui peut publier sur les topics de commande du contrôleur sur votre broker peut modifier les consignes des appareils, désactiver des stratégies, modifier les limites du réseau et redémarrer le contrôleur. Utilisez un broker avec authentification des utilisateurs, donnez au contrôleur son propre compte, et n'autorisez l'accès en écriture à controllers/<Unit ID>/…/set et à controllers/<Unit ID>/commands/… qu'aux clients de confiance.
1 Se connecter à un broker
2 Paramètres
Status
| Paramètre | Ce qu'il fait | Unité / par défaut |
|---|---|---|
| Client | ID client MQTT utilisé par le contrôleur. C'est le Unit ID du contrôleur, et il forme aussi chaque topic : controllers/<Unit ID>/…. Lecture seule. |
texte |
| Host | Le broker vers lequel pointe la configuration enregistrée. Vide = connecteur désactivé. Lecture seule. | texte |
| Connected | Coche verte = connecté au broker ; croix rouge = non connecté. Lecture seule. | — |
| Icône d'actualisation | Relit l'état. | — |
Mqtt connection
| Paramètre | Ce qu'il fait | Unité / par défaut |
|---|---|---|
| Host | Nom d'hôte ou adresse IP du broker. Laissez vide pour désactiver le connecteur. | texte · vide = désactivé |
| Port | Port TCP du broker. | nombre · par défaut 1883 |
| Username | Nom d'utilisateur sur le broker. Facultatif. | texte |
| Password | Mot de passe sur le broker. Utilisé uniquement avec Username. Le champ affiche le mot de passe en clair. | texte |
| Use SSL | Yes ouvre la connexion avec le chiffrement TLS. Si vous ne l'avez jamais réglé, il est activé automatiquement lorsqu'une chaîne de certificats CA du serveur ou un certificat client est enregistré. | Yes / No · par défaut No |
| Verify server cert | Yes vérifie le certificat du broker par rapport à Server CA chain (ou par rapport aux autorités de confiance intégrées au contrôleur si aucune chaîne n'est téléversée). No accepte n'importe quel certificat : la connexion est chiffrée, mais le contrôleur ne vérifie pas avec qui il communique. Utilisé uniquement avec Use SSL = Yes. | Yes / No · par défaut No |
| Server CA chain (PEM format) | Certificat (chaîne) de l'autorité qui a signé le certificat du broker. Cliquez sur Choose File et sélectionnez un fichier PEM. Une fois enregistré, le champ affiche à la place un bouton Download. | fichier PEM |
| Client public certificate (PEM format) | Le certificat client propre au contrôleur, pour les brokers qui authentifient les clients par certificat (TLS mutuel). Nécessite la clé privée correspondante. | fichier PEM |
| Client private key (PEM format) | Clé privée du certificat client. | fichier PEM |
La clé privée du client et le mot de passe du broker donnent accès à votre broker. Conservez les fichiers en lieu sûr, ne les envoyez pas par e-mail et ne laissez pas de copies sur des ordinateurs partagés. Toute personne ayant accès à cette page du Configurator peut télécharger les certificats enregistrés et voir le mot de passe.
Un certificat enregistré n'affiche qu'un bouton Download. Pour en téléverser un autre, cliquez sur Clear connection configuration, puis saisissez de nouveau toute la configuration de connexion avec les nouveaux fichiers.
Additional topics
| Paramètre | Ce qu'il fait | Unité / par défaut |
|---|---|---|
| Name or path | Topic à publier, relatif à controllers/<Unit ID>/. Par exemple, site/name est publié sous la forme controllers/<Unit ID>/site/name. Les lignes dont le nom est vide sont ignorées. |
texte |
| Payload | Texte fixe publié sur ce topic. | texte |
| Add | Ajoute une ligne vide. | — |
| Icône de corbeille | Supprime la ligne. Prend effet après Save. | — |
Les topics supplémentaires sont publiés avec les métadonnées du contrôleur : à chaque connexion du connecteur au broker et chaque fois que le broker envoie commands/refresh.
Publication et boutons
| Paramètre | Ce qu'il fait | Unité / par défaut |
|---|---|---|
| Readout interval | Fréquence à laquelle le contrôleur publie la valeur lue et la consigne de chaque appareil, ainsi que la valeur lue, l'état et les valeurs des paramètres de chaque stratégie. Des valeurs plus basses donnent des données plus récentes, mais plus de trafic. | s · vide = 60 s · minimum 0,25 s |
| Enregistrer | Enregistre les paramètres et redémarre le connecteur. Consigné dans l'Audit log sous la forme CONNECTOR_EDIT. |
— |
| Clear connection configuration | Après la confirmation Are you sure to clear MQTT settings? (Yes / Cancel), supprime l'hôte, le port, le nom d'utilisateur, le mot de passe, les paramètres SSL et tous les certificats. Le connecteur est désactivé. Readout interval et Additional topics sont conservés. | — |
Après Clear connection configuration, le contrôleur ne publie plus de données et n'accepte plus de commandes via MQTT. Un système qui s'appuie sur ces données, ou qui envoie des plannings External EMS, cesse de les recevoir ou de les transmettre. Vous devez saisir de nouveau le mot de passe et téléverser de nouveau les certificats pour vous reconnecter.
3 Topics
Tous les topics commencent par controllers/<Unit ID>/. Le contrôleur publie avec QoS 0 et sans l'indicateur retain, et s'abonne aux topics de commande avec QoS 1. Les charges utiles sont au format JSON ou des valeurs simples ; les formats complets des charges utiles figurent dans l'article du centre d'aide « Reduxi Controller - MQTT API ».
Publiés par le contrôleur :
| Topic | Contenu | Quand |
|---|---|---|
identifier |
Identification du contrôleur (Unit ID, versions, …) | À la connexion et sur commands/refresh
|
settings/interval/readout, settings/interval/keepAlive
|
Intervalles actuels en ms | À la connexion et lors d'une actualisation |
devices/list, devices/types, devices/<id>/info
|
Appareils configurés et leurs types | À la connexion et lors d'une actualisation |
strategies/list, strategies/types, strategies/<id>/info, strategies/<id>/parameters/list, strategies/<id>/parameters/<id>/info
|
Stratégies configurées et leurs paramètres | À la connexion et lors d'une actualisation |
<additional topic> |
Payload de Additional topics | À la connexion et lors d'une actualisation |
devices/<id>/readout |
Valeurs en direct d'un appareil | À chaque intervalle de lecture |
devices/<id>/setpoint |
Consigne actuelle d'un appareil | À chaque intervalle de lecture |
strategies/<id>/active, strategies/<id>/readout, strategies/<id>/parameters/<id>/value
|
Stratégie activée ou désactivée, valeurs en direct, valeurs des paramètres | À chaque intervalle de lecture |
prices |
Prix de l'électricité pour aujourd'hui et demain | À la connexion, lorsque les prix changent, et sur prices/refresh
|
strategies/<id>/externalEMS/<type> |
Planning External EMS enregistré (battery, evse, hvac, pv) |
Sur …/externalEMS/<type>/refresh
|
keepAlive |
Heure actuelle (Unix ms) | À chaque intervalle keep-alive, 60 s par défaut |
Commandes acceptées par le contrôleur :
| Topic | Effet |
|---|---|
commands/refresh |
Publie de nouveau les topics de métadonnées. |
commands/reboot |
Redémarre le contrôleur environ 5 s plus tard. |
prices/refresh |
Publie de nouveau prices. |
settings/interval/readout/set |
Modifie l'intervalle de lecture (ms) et l'enregistre. |
settings/interval/keepAlive/set |
Modifie l'intervalle keep-alive (ms) et l'enregistre. |
devices/<id>/setpoint/set |
Définit la consigne d'un appareil. |
strategies/<id>/parameters/<id>/value/set |
Définit un paramètre de stratégie. |
strategies/<id>/active/set |
Active ou désactive une stratégie. |
strategies/<id>/externalEMS/<type>/set |
Charge un planning External EMS pour battery, evse, hvac ou pv. Ignoré sauf si la stratégie a un mode d'optimisation External EMS. |
strategies/<id>/externalEMS/<type>/refresh |
Publie le planning External EMS enregistré. |
settings/grid/set |
Modifie les paramètres du réseau électrique (emplacement, fusibles, limite de soutirage et d'injection), éventuellement aussi dans des stratégies choisies. |
settings/grid/set écrase les valeurs de Settings → Grid et, si cela est demandé, les limites des stratégies, avec le même effet que l'enregistrement de la page Grid settings. devices/<id>/setpoint/set écrit la consigne directement dans l'appareil. N'envoyez pas de consignes d'appareil pour un appareil que pilote aussi une stratégie, sinon les deux s'écraseront mutuellement.
4 Dépannage
| Symptôme | Que vérifier |
|---|---|
| Connected reste rouge | Host et Port sont corrects ; le contrôleur peut joindre le broker (TCP port test sur l'hôte et le port du broker) ; nom d'utilisateur et mot de passe ; avec TLS, la chaîne CA correspond au certificat du broker, ou essayez Verify server cert = No pour circonscrire le problème. |
| Connecté, mais aucune donnée sur le broker | Abonnez-vous à controllers/# et vérifiez la valeur de Client : les topics utilisent l'Unit ID exactement tel qu'il y est affiché. |
| Les commandes n'ont aucun effet | Le client qui les envoie a des droits de publication sur le broker ; le topic utilise le bon ID d'appareil ou de stratégie (voir devices/list, strategies/list). |
5 Liste de contrôle
- Host et Port correspondent au broker, et Connected affiche une coche verte après une actualisation.
- Sur les sites de production : Use SSL = Yes, la chaîne CA est téléversée et Verify server cert = Yes.
- Les données arrivent sous
controllers/<Unit ID>/au Readout interval configuré. - L'accès en écriture aux topics de commande est limité aux clients de confiance sur le broker.
- Les fichiers de certificats et les mots de passe sont conservés en lieu sûr en dehors du contrôleur.