MQTT-Verbindung

warp1
warp2
warp3
wem
any

`mqtt/state`

Der aktuelle MQTT-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/mqtt/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/state

{
  "connection_state": 2,
  "connection_start": 27649,
  "connection_end": 0,
  "last_error": 0
}

Name	Bedeutung
`connection_state` int	Zustand der Verbindung zum MQTT-Broker 0 - Nicht konfiguriert 1 - Nicht verbunden 2 - Verbunden 3 - Fehler
`last_error` int	Der zuletzt aufgetretene Fehler. -1 falls kein Fehler aufgetreten ist.
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`mqtt/config`

Die MQTT-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "warp-AbCd",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "warp/AbCd",
  "client_name": "warp-AbCd",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

curl http://$HOST/mqtt/config -d '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wallbox-garage",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wallbox/garage",
  "client_name": "wallbox-garage",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "warp-AbCd",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "warp/AbCd",
  "client_name": "warp-AbCd",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

Mit MQTT auf $PREFIX/mqtt/config_update

mosquitto_pub -h $BROKER -t $PREFIX/mqtt/config_update -m '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wallbox-garage",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wallbox/garage",
  "client_name": "wallbox-garage",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

Name	Bedeutung
`enable_mqtt` bool	Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll. true - Wenn MQTT aktiviert ist. false - Wenn MQTT deaktiviert ist.
`protocol` int	Das zu verwendende MQTT-Protokoll 0 - MQTT (MQTT über TCP; unverschlüsselt) 1 - MQTTS (MQTT über TLS; verschlüsselt) 2 - WS (MQTT über WebSocket; unverschlüsselt) 3 - WSS (MQTT über WebSocket Secure bzw. MQTT über WebSocket über TLS; verschlüsselt)
`broker_host` string	Hostname oder IP-Adresse des MQTT-Brokers, zu dem sich das Gerät verbinden soll.
`broker_port` int	Port des MQTT-Brokers zu dem sich das Gerät verbinden soll. Typischerweise 1883.
`broker_username` string	Username mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentifizierung verwendet wird.
`broker_password` string	Passwort mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentisierung verwendet wird.
`global_topic_prefix` string	Präfix der allen MQTT-Topics vorangestellt wird. Normalerweise warp/[UID des Geräts] bzw. warp2/[UID des Geräts].
`client_name` string	Name unter dem sich das Gerät beim Broker registriert. Das ist nicht der Username zur Authentisierung.
`interval` int (s)	Minimales Sendeintervall pro Topic in Sekunden. Nachrichten werden grundsätzlich nur verschickt, wenn Änderungen am Payload vorliegen. Durch ein Sendeintervall von x Sekunden wird alle x Sekunden höchstens eine Nachricht eines Topics verschickt. Falls sich der Inhalt in x Sekunden mehrfach ändert wird nur der aktuellste Inhalt übertragen.
`path` string	Teil der MQTT-über-WS-URL hinter dem Hostnamen. Muss mit / beginnen. Wird ignoriert wenn "protocol" 0 oder 1 gewählt sind.
`cert_id` int	ID des CA-Zertifikats, dass zur Prüfung des Zertifikats des MQTTS bzw. WSS-Servers benutzt wird. Siehe `certs/state` -1 - Verwende eingebettetes Zertifikatsbundle >= 0 - Verwende Zertifikat mit dieser ID
`client_cert_id` int	ID des Client-Zertifikats, dass zum Aufbau einer TLS-verschlüsselten Verbindung verwendet werden soll. Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID
`client_key_id` int	ID des Zertifikats-Keys mit dem das Client-Zertifikat verschlüsselt ist. (Optional) Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID

`mqtt/auto_discovery_config`

Die Konfiguration der MQTT Auto Discovery.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/mqtt/auto_discovery_config

{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }

Schreiben

curl http://$HOST/mqtt/auto_discovery_config -d '{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/auto_discovery_config

{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }

Schreiben

Mit MQTT auf $PREFIX/mqtt/auto_discovery_config_update

mosquitto_pub -h $BROKER -t $PREFIX/mqtt/auto_discovery_config_update -m '{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }'

Name Bedeutung

Name	Bedeutung
`auto_discovery_mode` int	Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll. 0 - Auto Discovery deaktiviert 1 - Auto Discovery im generischen Modus; Kompatibel zu z.B. openHAB und Domoticz 2 - Auto Discovery im Home-Assistant-Modus
`auto_discovery_prefix` string	Präfix auf den die für Auto Discovery verwendeten Informationen gesendet werden. Typischerweise homeassistent

auto_discovery_mode
int

Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll.

0 - Auto Discovery deaktiviert
1 - Auto Discovery im generischen Modus; Kompatibel zu z.B. openHAB und Domoticz
2 - Auto Discovery im Home-Assistant-Modus

auto_discovery_prefix
string

Präfix auf den die für Auto Discovery verwendeten Informationen gesendet werden. Typischerweise homeassistent

`mqtt/state`

Der aktuelle MQTT-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/mqtt/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/state

{
  "connection_state": 2,
  "connection_start": 27649,
  "connection_end": 0,
  "last_error": 0
}

Name	Bedeutung
`connection_state` int	Zustand der Verbindung zum MQTT-Broker 0 - Nicht konfiguriert 1 - Nicht verbunden 2 - Verbunden 3 - Fehler
`last_error` int	Der zuletzt aufgetretene Fehler. -1 falls kein Fehler aufgetreten ist.
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`mqtt/config`

Die MQTT-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "warp2-AbCd",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "warp2/AbCd",
  "client_name": "warp2-AbCd",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

curl http://$HOST/mqtt/config -d '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wallbox-garage",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wallbox/garage",
  "client_name": "wallbox-garage",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "warp2-AbCd",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "warp2/AbCd",
  "client_name": "warp2-AbCd",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

Mit MQTT auf $PREFIX/mqtt/config_update

mosquitto_pub -h $BROKER -t $PREFIX/mqtt/config_update -m '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wallbox-garage",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wallbox/garage",
  "client_name": "wallbox-garage",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

Name	Bedeutung
`enable_mqtt` bool	Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll. true - Wenn MQTT aktiviert ist. false - Wenn MQTT deaktiviert ist.
`protocol` int	Das zu verwendende MQTT-Protokoll 0 - MQTT (MQTT über TCP; unverschlüsselt) 1 - MQTTS (MQTT über TLS; verschlüsselt) 2 - WS (MQTT über WebSocket; unverschlüsselt) 3 - WSS (MQTT über WebSocket Secure bzw. MQTT über WebSocket über TLS; verschlüsselt)
`broker_host` string	Hostname oder IP-Adresse des MQTT-Brokers, zu dem sich das Gerät verbinden soll.
`broker_port` int	Port des MQTT-Brokers zu dem sich das Gerät verbinden soll. Typischerweise 1883.
`broker_username` string	Username mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentifizierung verwendet wird.
`broker_password` string	Passwort mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentisierung verwendet wird.
`global_topic_prefix` string	Präfix der allen MQTT-Topics vorangestellt wird. Normalerweise warp/[UID des Geräts] bzw. warp2/[UID des Geräts].
`client_name` string	Name unter dem sich das Gerät beim Broker registriert. Das ist nicht der Username zur Authentisierung.
`interval` int (s)	Minimales Sendeintervall pro Topic in Sekunden. Nachrichten werden grundsätzlich nur verschickt, wenn Änderungen am Payload vorliegen. Durch ein Sendeintervall von x Sekunden wird alle x Sekunden höchstens eine Nachricht eines Topics verschickt. Falls sich der Inhalt in x Sekunden mehrfach ändert wird nur der aktuellste Inhalt übertragen.
`path` string	Teil der MQTT-über-WS-URL hinter dem Hostnamen. Muss mit / beginnen. Wird ignoriert wenn "protocol" 0 oder 1 gewählt sind.
`cert_id` int	ID des CA-Zertifikats, dass zur Prüfung des Zertifikats des MQTTS bzw. WSS-Servers benutzt wird. Siehe `certs/state` -1 - Verwende eingebettetes Zertifikatsbundle >= 0 - Verwende Zertifikat mit dieser ID
`client_cert_id` int	ID des Client-Zertifikats, dass zum Aufbau einer TLS-verschlüsselten Verbindung verwendet werden soll. Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID
`client_key_id` int	ID des Zertifikats-Keys mit dem das Client-Zertifikat verschlüsselt ist. (Optional) Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID

`mqtt/auto_discovery_config`

Die Konfiguration der MQTT Auto Discovery.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/mqtt/auto_discovery_config

{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }

Schreiben

curl http://$HOST/mqtt/auto_discovery_config -d '{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/auto_discovery_config

{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }

Schreiben

Mit MQTT auf $PREFIX/mqtt/auto_discovery_config_update

mosquitto_pub -h $BROKER -t $PREFIX/mqtt/auto_discovery_config_update -m '{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }'

Name Bedeutung

Name	Bedeutung
`auto_discovery_mode` int	Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll. 0 - Auto Discovery deaktiviert 1 - Auto Discovery im generischen Modus; Kompatibel zu z.B. openHAB und Domoticz 2 - Auto Discovery im Home-Assistant-Modus
`auto_discovery_prefix` string	Präfix auf den die für Auto Discovery verwendeten Informationen gesendet werden. Typischerweise homeassistent

auto_discovery_mode
int

Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll.

0 - Auto Discovery deaktiviert
1 - Auto Discovery im generischen Modus; Kompatibel zu z.B. openHAB und Domoticz
2 - Auto Discovery im Home-Assistant-Modus

auto_discovery_prefix
string

Präfix auf den die für Auto Discovery verwendeten Informationen gesendet werden. Typischerweise homeassistent

`mqtt/state`

Der aktuelle MQTT-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/mqtt/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/state

{
  "connection_state": 2,
  "connection_start": 27649,
  "connection_end": 0,
  "last_error": 0
}

Name	Bedeutung
`connection_state` int	Zustand der Verbindung zum MQTT-Broker 0 - Nicht konfiguriert 1 - Nicht verbunden 2 - Verbunden 3 - Fehler
`last_error` int	Der zuletzt aufgetretene Fehler. -1 falls kein Fehler aufgetreten ist.
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`mqtt/config`

Die MQTT-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "warp3-AbCd",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "warp3/AbCd",
  "client_name": "warp3-AbCd",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

curl http://$HOST/mqtt/config -d '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wallbox-garage",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wallbox/garage",
  "client_name": "wallbox-garage",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "warp3-AbCd",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "warp3/AbCd",
  "client_name": "warp3-AbCd",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

Mit MQTT auf $PREFIX/mqtt/config_update

mosquitto_pub -h $BROKER -t $PREFIX/mqtt/config_update -m '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wallbox-garage",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wallbox/garage",
  "client_name": "wallbox-garage",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

Name	Bedeutung
`enable_mqtt` bool	Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll. true - Wenn MQTT aktiviert ist. false - Wenn MQTT deaktiviert ist.
`protocol` int	Das zu verwendende MQTT-Protokoll 0 - MQTT (MQTT über TCP; unverschlüsselt) 1 - MQTTS (MQTT über TLS; verschlüsselt) 2 - WS (MQTT über WebSocket; unverschlüsselt) 3 - WSS (MQTT über WebSocket Secure bzw. MQTT über WebSocket über TLS; verschlüsselt)
`broker_host` string	Hostname oder IP-Adresse des MQTT-Brokers, zu dem sich das Gerät verbinden soll.
`broker_port` int	Port des MQTT-Brokers zu dem sich das Gerät verbinden soll. Typischerweise 1883.
`broker_username` string	Username mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentifizierung verwendet wird.
`broker_password` string	Passwort mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentisierung verwendet wird.
`global_topic_prefix` string	Präfix der allen MQTT-Topics vorangestellt wird. Normalerweise warp/[UID des Geräts] bzw. warp2/[UID des Geräts].
`client_name` string	Name unter dem sich das Gerät beim Broker registriert. Das ist nicht der Username zur Authentisierung.
`interval` int (s)	Minimales Sendeintervall pro Topic in Sekunden. Nachrichten werden grundsätzlich nur verschickt, wenn Änderungen am Payload vorliegen. Durch ein Sendeintervall von x Sekunden wird alle x Sekunden höchstens eine Nachricht eines Topics verschickt. Falls sich der Inhalt in x Sekunden mehrfach ändert wird nur der aktuellste Inhalt übertragen.
`path` string	Teil der MQTT-über-WS-URL hinter dem Hostnamen. Muss mit / beginnen. Wird ignoriert wenn "protocol" 0 oder 1 gewählt sind.
`cert_id` int	ID des CA-Zertifikats, dass zur Prüfung des Zertifikats des MQTTS bzw. WSS-Servers benutzt wird. Siehe `certs/state` -1 - Verwende eingebettetes Zertifikatsbundle >= 0 - Verwende Zertifikat mit dieser ID
`client_cert_id` int	ID des Client-Zertifikats, dass zum Aufbau einer TLS-verschlüsselten Verbindung verwendet werden soll. Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID
`client_key_id` int	ID des Zertifikats-Keys mit dem das Client-Zertifikat verschlüsselt ist. (Optional) Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID

`mqtt/auto_discovery_config`

Die Konfiguration der MQTT Auto Discovery.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/mqtt/auto_discovery_config

{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }

Schreiben

curl http://$HOST/mqtt/auto_discovery_config -d '{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/auto_discovery_config

{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }

Schreiben

Mit MQTT auf $PREFIX/mqtt/auto_discovery_config_update

mosquitto_pub -h $BROKER -t $PREFIX/mqtt/auto_discovery_config_update -m '{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }'

Name Bedeutung

Name	Bedeutung
`auto_discovery_mode` int	Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll. 0 - Auto Discovery deaktiviert 1 - Auto Discovery im generischen Modus; Kompatibel zu z.B. openHAB und Domoticz 2 - Auto Discovery im Home-Assistant-Modus
`auto_discovery_prefix` string	Präfix auf den die für Auto Discovery verwendeten Informationen gesendet werden. Typischerweise homeassistent

auto_discovery_mode
int

Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll.

0 - Auto Discovery deaktiviert
1 - Auto Discovery im generischen Modus; Kompatibel zu z.B. openHAB und Domoticz
2 - Auto Discovery im Home-Assistant-Modus

auto_discovery_prefix
string

Präfix auf den die für Auto Discovery verwendeten Informationen gesendet werden. Typischerweise homeassistent

`mqtt/state`

Der aktuelle MQTT-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/mqtt/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/state

{
  "connection_state": 2,
  "connection_start": 27649,
  "connection_end": 0,
  "last_error": 0
}

Name	Bedeutung
`connection_state` int	Zustand der Verbindung zum MQTT-Broker 0 - Nicht konfiguriert 1 - Nicht verbunden 2 - Verbunden 3 - Fehler
`last_error` int	Der zuletzt aufgetretene Fehler. -1 falls kein Fehler aufgetreten ist.
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`mqtt/config`

Die MQTT-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wem_unterverteilung",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "wem/unterverteilung",
  "client_name": "wem_unterverteilung",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

curl http://$HOST/mqtt/config -d '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wem_unterverteilung",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wem/unterverteilung",
  "client_name": "wem_unterverteilung",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wem_unterverteilung",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "wem/unterverteilung",
  "client_name": "wem_unterverteilung",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

Mit MQTT auf $PREFIX/mqtt/config_update

mosquitto_pub -h $BROKER -t $PREFIX/mqtt/config_update -m '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wem_unterverteilung",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wem/unterverteilung",
  "client_name": "wem_unterverteilung",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

Name	Bedeutung
`enable_mqtt` bool	Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll. true - Wenn MQTT aktiviert ist. false - Wenn MQTT deaktiviert ist.
`protocol` int	Das zu verwendende MQTT-Protokoll 0 - MQTT (MQTT über TCP; unverschlüsselt) 1 - MQTTS (MQTT über TLS; verschlüsselt) 2 - WS (MQTT über WebSocket; unverschlüsselt) 3 - WSS (MQTT über WebSocket Secure bzw. MQTT über WebSocket über TLS; verschlüsselt)
`broker_host` string	Hostname oder IP-Adresse des MQTT-Brokers, zu dem sich das Gerät verbinden soll.
`broker_port` int	Port des MQTT-Brokers zu dem sich das Gerät verbinden soll. Typischerweise 1883.
`broker_username` string	Username mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentifizierung verwendet wird.
`broker_password` string	Passwort mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentisierung verwendet wird.
`global_topic_prefix` string	Präfix der allen MQTT-Topics vorangestellt wird. Normalerweise warp/[UID des Geräts] bzw. warp2/[UID des Geräts].
`client_name` string	Name unter dem sich das Gerät beim Broker registriert. Das ist nicht der Username zur Authentisierung.
`interval` int (s)	Minimales Sendeintervall pro Topic in Sekunden. Nachrichten werden grundsätzlich nur verschickt, wenn Änderungen am Payload vorliegen. Durch ein Sendeintervall von x Sekunden wird alle x Sekunden höchstens eine Nachricht eines Topics verschickt. Falls sich der Inhalt in x Sekunden mehrfach ändert wird nur der aktuellste Inhalt übertragen.
`path` string	Teil der MQTT-über-WS-URL hinter dem Hostnamen. Muss mit / beginnen. Wird ignoriert wenn "protocol" 0 oder 1 gewählt sind.
`cert_id` int	ID des CA-Zertifikats, dass zur Prüfung des Zertifikats des MQTTS bzw. WSS-Servers benutzt wird. Siehe `certs/state` -1 - Verwende eingebettetes Zertifikatsbundle >= 0 - Verwende Zertifikat mit dieser ID
`client_cert_id` int	ID des Client-Zertifikats, dass zum Aufbau einer TLS-verschlüsselten Verbindung verwendet werden soll. Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID
`client_key_id` int	ID des Zertifikats-Keys mit dem das Client-Zertifikat verschlüsselt ist. (Optional) Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID

`mqtt/state`

Der aktuelle MQTT-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/mqtt/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/state

{
  "connection_state": 2,
  "connection_start": 27649,
  "connection_end": 0,
  "last_error": 0
}

Name	Bedeutung
`connection_state` int	Zustand der Verbindung zum MQTT-Broker 0 - Nicht konfiguriert 1 - Nicht verbunden 2 - Verbunden 3 - Fehler
`last_error` int	Der zuletzt aufgetretene Fehler. -1 falls kein Fehler aufgetreten ist.
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`mqtt/config`

Die MQTT-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "warp-AbCd",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "warp/AbCd",
  "client_name": "warp-AbCd",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

curl http://$HOST/mqtt/config -d '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wallbox-garage",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wallbox/garage",
  "client_name": "wallbox-garage",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/config

{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "warp-AbCd",
  // Wird nicht zurückgegeben
  "broker_password": null,
  "global_topic_prefix": "warp/AbCd",
  "client_name": "warp-AbCd",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}

Schreiben

Mit MQTT auf $PREFIX/mqtt/config_update

mosquitto_pub -h $BROKER -t $PREFIX/mqtt/config_update -m '{
  "enable_mqtt": true,
  "broker_host": "my_mosquitto.localdomain",
  "broker_port": 1883,
  "broker_username": "wallbox-garage",
  "broker_password": "meinpasswort",
  "global_topic_prefix": "wallbox/garage",
  "client_name": "wallbox-garage",
  "interval": 1,
  "protocol": 0,
  "cert_id": -1,
  "client_cert_id": -1,
  "client_key_id": -1,
  "path": ""
}'

Name	Bedeutung
`enable_mqtt` bool	Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll. true - Wenn MQTT aktiviert ist. false - Wenn MQTT deaktiviert ist.
`protocol` int	Das zu verwendende MQTT-Protokoll 0 - MQTT (MQTT über TCP; unverschlüsselt) 1 - MQTTS (MQTT über TLS; verschlüsselt) 2 - WS (MQTT über WebSocket; unverschlüsselt) 3 - WSS (MQTT über WebSocket Secure bzw. MQTT über WebSocket über TLS; verschlüsselt)
`broker_host` string	Hostname oder IP-Adresse des MQTT-Brokers, zu dem sich das Gerät verbinden soll.
`broker_port` int	Port des MQTT-Brokers zu dem sich das Gerät verbinden soll. Typischerweise 1883.
`broker_username` string	Username mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentifizierung verwendet wird.
`broker_password` string	Passwort mit dem sich zum Broker verbunden werden soll. Leer falls keine Authentisierung verwendet wird.
`global_topic_prefix` string	Präfix der allen MQTT-Topics vorangestellt wird. Normalerweise warp/[UID des Geräts] bzw. warp2/[UID des Geräts].
`client_name` string	Name unter dem sich das Gerät beim Broker registriert. Das ist nicht der Username zur Authentisierung.
`interval` int (s)	Minimales Sendeintervall pro Topic in Sekunden. Nachrichten werden grundsätzlich nur verschickt, wenn Änderungen am Payload vorliegen. Durch ein Sendeintervall von x Sekunden wird alle x Sekunden höchstens eine Nachricht eines Topics verschickt. Falls sich der Inhalt in x Sekunden mehrfach ändert wird nur der aktuellste Inhalt übertragen.
`path` string	Teil der MQTT-über-WS-URL hinter dem Hostnamen. Muss mit / beginnen. Wird ignoriert wenn "protocol" 0 oder 1 gewählt sind.
`cert_id` int	ID des CA-Zertifikats, dass zur Prüfung des Zertifikats des MQTTS bzw. WSS-Servers benutzt wird. Siehe `certs/state` -1 - Verwende eingebettetes Zertifikatsbundle >= 0 - Verwende Zertifikat mit dieser ID
`client_cert_id` int	ID des Client-Zertifikats, dass zum Aufbau einer TLS-verschlüsselten Verbindung verwendet werden soll. Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID
`client_key_id` int	ID des Zertifikats-Keys mit dem das Client-Zertifikat verschlüsselt ist. (Optional) Siehe `certs/state` -1 - Nicht verwendet >= 0 - Verwende Zertifikat mit dieser ID

`mqtt/auto_discovery_config`

Benötigt das Feature "evse" Die Konfiguration der MQTT Auto Discovery.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/mqtt/auto_discovery_config

{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }

Schreiben

curl http://$HOST/mqtt/auto_discovery_config -d '{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/mqtt/auto_discovery_config

{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }

Schreiben

Mit MQTT auf $PREFIX/mqtt/auto_discovery_config_update

mosquitto_pub -h $BROKER -t $PREFIX/mqtt/auto_discovery_config_update -m '{ "auto_discovery_mode": 2, "auto_discovery_prefix": "homeassistant" }'

Name Bedeutung

Name	Bedeutung
`auto_discovery_mode` int	Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll. 0 - Auto Discovery deaktiviert 1 - Auto Discovery im generischen Modus; Kompatibel zu z.B. openHAB und Domoticz 2 - Auto Discovery im Home-Assistant-Modus
`auto_discovery_prefix` string	Präfix auf den die für Auto Discovery verwendeten Informationen gesendet werden. Typischerweise homeassistent

auto_discovery_mode
int

Gibt an ob eine MQTT-Verbindung zum konfigurierten Broker aufgebaut werden soll.

0 - Auto Discovery deaktiviert
1 - Auto Discovery im generischen Modus; Kompatibel zu z.B. openHAB und Domoticz
2 - Auto Discovery im Home-Assistant-Modus

auto_discovery_prefix
string

Präfix auf den die für Auto Discovery verwendeten Informationen gesendet werden. Typischerweise homeassistent

MQTT-Verbindung

mqtt/state​

Lesen​

Lesen​

mqtt/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

mqtt/auto_discovery_config​

Lesen​

Schreiben​

Lesen​

Schreiben​

mqtt/state​

Lesen​

Lesen​

mqtt/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

mqtt/auto_discovery_config​

Lesen​

Schreiben​

Lesen​

Schreiben​

mqtt/state​

Lesen​

Lesen​

mqtt/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

mqtt/auto_discovery_config​

Lesen​

Schreiben​

Lesen​

Schreiben​

mqtt/state​

Lesen​

Lesen​

mqtt/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

mqtt/state​

Lesen​

Lesen​

mqtt/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

mqtt/auto_discovery_config​

Lesen​

Schreiben​

Lesen​

Schreiben​

`mqtt/state`

Lesen

Lesen

`mqtt/config`

Lesen

Schreiben

Lesen

Schreiben

`mqtt/auto_discovery_config`

Lesen

Schreiben

Lesen

Schreiben

`mqtt/state`

Lesen

Lesen

`mqtt/config`

Lesen

Schreiben

Lesen

Schreiben

`mqtt/auto_discovery_config`

Lesen

Schreiben

Lesen

Schreiben

`mqtt/state`

Lesen

Lesen

`mqtt/config`

Lesen

Schreiben

Lesen

Schreiben

`mqtt/auto_discovery_config`

Lesen

Schreiben

Lesen

Schreiben

`mqtt/state`

Lesen

Lesen

`mqtt/config`

Lesen

Schreiben

Lesen

Schreiben

`mqtt/state`

Lesen

Lesen

`mqtt/config`

Lesen

Schreiben

Lesen

Schreiben

`mqtt/auto_discovery_config`

Lesen

Schreiben

Lesen

Schreiben