Metainformationen zur Seite

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung		Vorhergehende Überarbeitung
plugins:lox2mqtt:start [2023/09/06 22:50] – [Plugin functionality] Martin Barnasconiplugins:lox2mqtt:start [2024/02/20 21:06] (aktuell) – Struct-Daten geändert Martin Barnasconi
Zeile 28: Zeile 28:
  
 The plugin detects and lists the available Miniservers. For each Miniserver, the following configuration options are available: The plugin detects and lists the available Miniservers. For each Miniserver, the following configuration options are available:
 +
 +  * **Enable Miniserver in MQTT communication**: Enable or disable Miniserver in MQTT communication (default: enabled). Note that Miniserver(s) configured as Client can be controlled via a Gateway Miniserver and do not need to be enabled explicitly.
  
   * **Miniserver topic name**: MQTT topic name used when publishing control state changes and subscribing to Miniserver control commands (default: loxone)   * **Miniserver topic name**: MQTT topic name used when publishing control state changes and subscribing to Miniserver control commands (default: loxone)
Zeile 42: Zeile 44:
   * **Miniserver password**: Miniserver password (if enabled, default: empty)   * **Miniserver password**: Miniserver password (if enabled, default: empty)
  
-When saving the configuration, the Lox2MQTT plugin will be restarted automatically. Updates to the general Miniserver settings or plugin logging level will also restart this plugin. The process status of the Lox2MQTT plugin is shown at the bottom of the configuration page. When the status is colored green, the process is running as expected. In case of issues, the text color is red. In this case, check the log file for more details.+When saving the configuration, the Lox2MQTT plugin will be restarted automatically. Updates to the general Miniserver settings or plugin logging level will also restart this plugin. The process status of the Lox2MQTT plugin is shown at the bottom of the configuration page. When the status is colored green, the process is running as expected. In case of issues, the text color is red and check the log file for more details.
  
 //**WARNING!** Publishing and subscribing to control state changes will increase the load on your Loxone Miniserver(s) and MQTT server.// //**WARNING!** Publishing and subscribing to control state changes will increase the load on your Loxone Miniserver(s) and MQTT server.//
Zeile 51: Zeile 53:
  
  
-''<mqtt_topic_ms>/<serialnr>/<uuid> <value>'' +''<mqttTopic>/<serialnr>/<uuid> <value>'' 
  
-Each MQTT message uses a topic name ''<mqtt_topic_ms>'' as is defined in the configuration, to identify messages send to or from a Loxone Miniserver. The next topic level specifies the serial number ''serialnr'' of the Miniserver, followed by a unique identifier ''uuid'' representing a control state, which can be found in the Loxone structure file ''LoxAPP3.json'' on your Miniserver.+Each MQTT message uses a topic name ''<mqttTopic>'' as is defined in the configuration, to identify messages send to or from a Loxone Miniserver. The next topic level specifies the serial number ''serialnr'' of the Miniserver, followed by a unique identifier ''uuid'' representing a control state, which can be found in the Loxone structure file ''LoxAPP3.json'' on your Miniserver.
  
 If enabled, each last Miniserver control state broadcast is retained by the MQTT server. This enables MQTT clients to receive the latest state values immediately after subscribing to the topic. If enabled, each last Miniserver control state broadcast is retained by the MQTT server. This enables MQTT clients to receive the latest state values immediately after subscribing to the topic.
Zeile 68: Zeile 70:
 Broadcasting the Miniserver structure might be relevant for MQTT subscribers such as mobile apps to receive information on the available controls, their properties, capabilties and states. If enabled, the Miniserver structure (''LoxAPP3.json'') is broadcasted over MQTT, but only once, at plugin startup. It uses the following topic structure: Broadcasting the Miniserver structure might be relevant for MQTT subscribers such as mobile apps to receive information on the available controls, their properties, capabilties and states. If enabled, the Miniserver structure (''LoxAPP3.json'') is broadcasted over MQTT, but only once, at plugin startup. It uses the following topic structure:
  
-''<mqtt_topic_ms>/<serialnr>/structure <LoxAPP3.json>''+''<mqttTopic>/<serialnr>/structure <LoxAPP3.json>''
  
 If enabled, the Miniserver structure is retained by the MQTT server. This enables MQTT clients to receive the latest structure immediately after subscribing to the topic. If enabled, the Miniserver structure is retained by the MQTT server. This enables MQTT clients to receive the latest structure immediately after subscribing to the topic.
Zeile 76: Zeile 78:
 To control a Loxone Miniserver, a messages should be send using the following topic structure: To control a Loxone Miniserver, a messages should be send using the following topic structure:
  
-''<mqtt_topic_ms>/<serialnr>/<uuid>/cmd <command>''+''<mqttTopic>/<serialnr>/<uuid>/cmd <command>''
 or or
-''<mqtt_topic_ms>/<serialnr>/<uuid>/<subcontrol>/cmd <command>''+''<mqttTopic>/<serialnr>/<uuid>/<subcontrol>/cmd <command>''
  
  
Zeile 98: Zeile 100:
 **Q: I receive state information from my Miniserver over MQTT, but I do not recognize the format and identifiers** **Q: I receive state information from my Miniserver over MQTT, but I do not recognize the format and identifiers**
  
-A: A received MQTT message has the following format: ''<mqtt_topic_ms>/<serialnr>/<uuid> <value>''. Each MQTT message uses the Miniserver topic name (''mqtt_topic_ms'') as defined in the configuration to identify messages coming from a Loxone Miniserver. The next topic level specifies the serial number (''serialnr'') of your Miniserver, followed by the unique identifier (''uuid'') representing a control state as defined in the Loxone structure file ''LoxAPP3.json'' on your Miniserver.+A: A received MQTT message has the following format: ''<mqttTopic>/<serialnr>/<uuid> <value>''. Each MQTT message uses the Miniserver topic name (''mqttTopic'') as defined in the configuration to identify messages coming from a Loxone Miniserver. The next topic level specifies the serial number (''serialnr'') of your Miniserver, followed by the unique identifier (''uuid'') representing a control state as defined in the Loxone structure file ''LoxAPP3.json'' on your Miniserver.
  
 **Q: Can I change the Miniserver control states via MQTT?** **Q: Can I change the Miniserver control states via MQTT?**
  
-A: Yes, you can send MQTT messages which are converted to commands for the Loxone Miniserver. A transmited MQTT message should have the following format: ''<mqtt_topic_ms>/<serialnr>/<uuid>/cmd <command>''. Note the command extension (''/cmd'') in this message, which has been added to the unique identifier of a control or subcontrol. The allowed values for ''command'' are defined in the [[https://www.loxone.com/dede/wp-content/uploads/sites/2/2022/06/1300_Structure-File.pdf|Loxone Structure File]].+A: Yes, you can send MQTT messages which are converted to commands for the Loxone Miniserver. A transmited MQTT message should have the following format: ''<mqttTopic>/<serialnr>/<uuid>/cmd <command>''. Note the command extension (''/cmd'') in this message, which has been added to the unique identifier of a control or subcontrol. The allowed values for ''command'' are defined in the [[https://www.loxone.com/wp-content/uploads/datasheets/StructureFile.pdf|Loxone Structure File]].
  
 **Q: Where can I find my Loxone Miniserver structure file ''LoxAPP3.json''?** **Q: Where can I find my Loxone Miniserver structure file ''LoxAPP3.json''?**
Zeile 117: Zeile 119:
 pluginuebersicht.logo : :plugins:lox2mqtt:icon_512.png pluginuebersicht.logo : :plugins:lox2mqtt:icon_512.png
 pluginuebersicht.status : BETA pluginuebersicht.status : BETA
-pluginuebersicht.version : 0.4.6+pluginuebersicht.version : 0.8.0
 pluginuebersicht.min_lb_version : 3.0.0 pluginuebersicht.min_lb_version : 3.0.0
 pluginuebersicht.url_release :  pluginuebersicht.url_release : 
-pluginuebersicht.url_prerelease : https://github.com/nufke/LoxBerry-Plugin-Lox2MQTT/archive/refs/tags/v0.4.6.zip +pluginuebersicht.url_prerelease : https://github.com/nufke/LoxBerry-Plugin-Lox2MQTT/archive/refs/tags/v0.8.0.zip 
-pluginuebersicht.description : LoxBerry Miniserver to MQTT Gateway+pluginuebersicht.description : LoxBerry plugin to enable communication between the Loxone Miniserver and MQTT
 pluginuebersicht.languages : EN pluginuebersicht.languages : EN
 pluginuebersicht.discussion :  pluginuebersicht.discussion : 
 ---- ----