MQTT NUR BROKER¶
Die Box enthält einen MQTT-Broker. Er verbindet Geräte und Software, die MQTT sprechen, mit der Box. Die Box veröffentlicht nicht von sich aus den Zustand ihrer Geräte oder die Daten der Engine per MQTT: Zum Lesen dient die JSON-RPC-API.
Der Broker der Box¶
Beim ersten Start legt nymea eine Standardkonfiguration an:
| Einstellung | Standardwert |
|---|---|
| Lauschadresse | 0.0.0.0 (alle Schnittstellen der Box) |
| Port | 1883 |
| TLS | deaktiviert |
| Authentifizierung | aktiviert |
Die Box kündigt den Broker im lokalen Netz an (ZeroConf, Dienst _mqtt._tcp).
Bei aktivierter Authentifizierung wird ein MQTT-Client nur angenommen, wenn eine Policy für ihn existiert. Eine Policy besteht aus:
| Feld | Bedeutung |
|---|---|
clientId |
die MQTT-Client-ID, für die sie gilt |
username, password |
die Zugangsdaten, die dieser Client vorlegen muss |
allowedPublishTopicFilters |
die Topics, auf denen er veröffentlichen darf |
allowedSubscribeTopicFilters |
die Topics, die er abonnieren darf |
Die Filter kennen die Platzhalter + und #. Ein Client ohne Policy oder mit falschen
Zugangsdaten wird abgewiesen, ebenso eine Veröffentlichung oder ein Abonnement außerhalb der
Filter. Deaktivieren Sie die Authentifizierung einer Konfiguration, wird dort jeder Client
angenommen, ohne Einschränkung der Topics.
Die Standardkonfiguration hat keine gespeicherte Policy: Ein Client, den Sie selbst einrichten, kann sich erst verbinden, wenn Sie ihm eine anlegen.
Einstellen¶
Dafür gibt es in der App keinen Bildschirm. Der Broker wird über die JSON-RPC-API eingestellt, und jede dieser Methoden verlangt das Administratorrecht (ADMIN):
| Methode | Was sie tut |
|---|---|
Configuration.GetMqttServerConfigurations |
listet die Lauschkonfigurationen des Brokers |
Configuration.SetMqttServerConfiguration |
legt eine Konfiguration an oder ändert die mit derselben id (Adresse, Port, TLS, Authentifizierung) |
Configuration.DeleteMqttServerConfiguration |
löscht eine Konfiguration |
Configuration.GetMqttPolicies |
listet die gespeicherten Policies |
Configuration.SetMqttPolicy |
legt eine Policy an oder ändert die mit derselben clientId |
Configuration.DeleteMqttPolicy |
löscht eine Policy |
Wer ihn nutzt¶
Drei Plugins nutzen den Broker der Box:
- Tasmota: Beim Hinzufügen eines Geräts legt die Box einen eigenen Zugang dafür an (zufällige Zugangsdaten, Topics auf sein eigenes Präfix beschränkt) und richtet ihn auf dem Gerät ein, das danach über den Broker mit der Box kommuniziert.
- go-eCharger, wenn Sie den Parameter
useMqtt(Use MQTT interface, standardmäßig aus) setzen: Die Box legt ebenso einen Zugang für die Wallbox an und teilt ihr die Adresse des Brokers mit. - MQTT-Client: Er abonniert einen Topic-Filter und erzeugt bei jeder Nachricht ein Ereignis Publish received (Topic, Inhalt); seine Aktion Publish veröffentlicht eine Nachricht (Topic, Inhalt, QoS, Retain). Der interne Client spricht mit dem Broker der Box, der Client ohne Zusatz mit dem Broker, dessen Adresse Sie eingeben.
Die Zugänge, die Tasmota, go-eCharger und der interne Client anlegen, leben im Speicher:
Configuration.GetMqttPolicies zeigt sie nicht.
Was es nicht gibt¶
- Die Box veröffentlicht weder Gerätezustände noch Messwerte noch Daten der Engine per MQTT. Über den Broker läuft nur, was die Plugins oben und die von Ihnen zugelassenen Clients veröffentlichen. Zum Lesen dieser Daten nutzen Sie die JSON-RPC-API und ihre Benachrichtigungen.
- Es gibt daher keine Liste von „ETM-PowerSync“-Topics und kein Nachrichtenformat zu dokumentieren.