MQTT2 DEVICE - Versionsgeschichte

Beta-User: /* attrTemplate */

2022-01-12T09:41:24Z

attrTemplate

← Nächstältere Version		Version vom 12. Januar 2022, 11:41 Uhr
Zeile 36:		Zeile 36:
	Für gängige Gerätetypen stehen bereits einige templates bereit. Um Ihnen die Auswahl zu erleichtern, kann mit <code>set <MQTT2-Device-Name> attrTemplate ?</code> eine Liste der vorhandenen Templates samt kurzer Beschreibung aufgerufen werden.		Für gängige Gerätetypen stehen bereits einige templates bereit. Um Ihnen die Auswahl zu erleichtern, kann mit <code>set <MQTT2-Device-Name> attrTemplate ?</code> eine Liste der vorhandenen Templates samt kurzer Beschreibung aufgerufen werden.
	Haben Sie ein passendes ''template'' gefunden, wenden Sie es mit <code>set <MQTT2-Device-Name> attrTemplate <template_name></code> an.		Haben Sie ein passendes ''template'' gefunden, wenden Sie es mit <code>set <MQTT2-Device-Name> attrTemplate <template_name></code> an.

			Die damit jeweils erzeugten Konfigurationen sind Einrichtungsbeispiele, die v.a. eine in sich konsistenze Zusammenstellung der verschiedenen Attribute enthalten. Es steht jedem User frei, diese Ausgangsbasis dann nach seinem Belieben zu ändern. Spätere Änderungen des verwendeten attrTemplate wirken sich nicht automatisch auf die durch frühere Versionen oder den User nachkonfigurierte Geräte aus! Da es vorkommen kann, dass sich die per MQTT übermittelten Daten und Topics ändern, wenn z.B. eine firmware aktualisiert wurden, kann dies Anpassungen am jeweiligen Template erforderlich machen. Grundsätzlich sollen die per attrTemplate für MQTT2_DEVICE verfügbaren Zusammenstellungen jeweils für die aktuellste verfügbare stabile firmware-Version passen.

	Wer plant, mehrere gleichartige Geräte anzulegen, aber andere Einstellungen zu wählen, als sie in den vorhandenen templates enthalten sind, kann hierfür ebenfalls die attrTemplate-Funktion mit eigenen templates nutzen. Hierfür können die vorhandenen templates aus der Datei mqtt2.template<ref>zu finden im Unterverzeichnis fhem/FHEM/lib/AttrTemplate</ref> als Basis dienen, Ihre templates speichern Sie einfach als neue Datei mit der Endung ''.template'' im selben Verzeichnis und lesen diese mit <code>{ AttrTemplate_Initialize() }</code> neu ein. Danach können Sie diese direkt verwenden.		Wer plant, mehrere gleichartige Geräte anzulegen, aber andere Einstellungen zu wählen, als sie in den vorhandenen templates enthalten sind, kann hierfür ebenfalls die attrTemplate-Funktion mit eigenen templates nutzen. Hierfür können die vorhandenen templates aus der Datei mqtt2.template<ref>zu finden im Unterverzeichnis fhem/FHEM/lib/AttrTemplate</ref> als Basis dienen, Ihre templates speichern Sie einfach als neue Datei mit der Endung ''.template'' im selben Verzeichnis und lesen diese mit <code>{ AttrTemplate_Initialize() }</code> neu ein. Danach können Sie diese direkt verwenden.

	Haben Sie ein template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag in {{Link2Forum\|Topic=94495\|LinkText=diesem Thread}}.		Haben Sie ein template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag in {{Link2Forum\|Topic=94495\|LinkText=diesem Thread}}.
	Für Fragen, die Meldung von Fehlern oder für Verbesserungsvorschläge an den templates in ''mqtt2.template'' ist {{Link2Forum\|Topic=94494\|LinkText=dieser Thread}} gedacht.		Für Fragen, die Meldung von Fehlern, durch firmware-Änderungen erforderliche Anpassungen oder für Verbesserungsvorschläge an den templates in ''mqtt2.template'' ist {{Link2Forum\|Topic=94494\|LinkText=dieser Thread}} gedacht.

	== Anwendungsbeispiele ==		== Anwendungsbeispiele ==

Beta-User: Hinweis auf clientOrder ergänzt

2022-01-12T09:35:46Z

Hinweis auf clientOrder ergänzt

← Nächstältere Version		Version vom 12. Januar 2022, 11:35 Uhr
Zeile 30:		Zeile 30:

	Legt man ein neues Device an, dessen Topics man noch nicht genau kennt, kann man das Attribut ''autocreate'' aktivieren, dann wird die ''readingList'' automatisch ergänzt, sofern am IO-Modul ''autocreate'' ebenfalls aktiv ist.		Legt man ein neues Device an, dessen Topics man noch nicht genau kennt, kann man das Attribut ''autocreate'' aktivieren, dann wird die ''readingList'' automatisch ergänzt, sofern am IO-Modul ''autocreate'' ebenfalls aktiv ist.
	{{Hinweis\|Hat man eine {{Link2CmdRef\|Anker=MQTT_GENERIC_BRIDGE\|Label=MQTT_GENERIC_BRIDGE}} definiert, sollte ''autocreate'' nicht aktiviert werden!}}		{{Hinweis\|Hat man eine {{Link2CmdRef\|Anker=MQTT_GENERIC_BRIDGE\|Label=MQTT_GENERIC_BRIDGE}} definiert, sollte ''autocreate'' nicht aktiviert werden, oder das Attribut ''clientOrder'' am IO-Modul so geändert werden, dass zuerst MQTT_GENERIC_BRIDGE alle eingehenden Nachrichten übergeben werden!}}

	== attrTemplate ==		== attrTemplate ==

DasQ: Doppeltes Wort (die) entfernt

2019-06-21T08:47:17Z

Doppeltes Wort (die) entfernt

← Nächstältere Version		Version vom 21. Juni 2019, 10:47 Uhr
Zeile 9:		Zeile 9:

	== Voraussetzungen ==		== Voraussetzungen ==
	Um ''MQTT2_DEVICE'' nutzen zu können, muss entweder FHEM mit {{Link2CmdRef\|Anker=MQTT2_SERVER\|Lang=en\|Label=MQTT2_SERVER}} als MQTT-Server fungieren oder ~~ein~~ ein {{Link2CmdRef\|Anker=MQTT2_CLIENT\|Lang=en\|Label=MQTT2_CLIENT}}-Gerät als [[Interface\|Gateway]] zu einem funktionsfähigen anderen MQTT-Server wie z.B. Mosquitto definiert sein.		Um ''MQTT2_DEVICE'' nutzen zu können, muss entweder FHEM mit {{Link2CmdRef\|Anker=MQTT2_SERVER\|Lang=en\|Label=MQTT2_SERVER}} als MQTT-Server fungieren oder ein {{Link2CmdRef\|Anker=MQTT2_CLIENT\|Lang=en\|Label=MQTT2_CLIENT}}-Gerät als [[Interface\|Gateway]] zu einem funktionsfähigen anderen MQTT-Server wie z.B. Mosquitto definiert sein.

	{{Hinweis\|Mit einem [[MQTT (Modul)\|MQTT]]-Device als Interface kann MQTT2_DEVICE nicht genutzt werden.		{{Hinweis\|Mit einem [[MQTT (Modul)\|MQTT]]-Device als Interface kann MQTT2_DEVICE nicht genutzt werden.

Beta-User: Erste Version

2019-01-23T09:42:11Z

Erste Version

Neue Seite

{{Infobox Modul
|ModPurpose=Einbinden von Geräten, die über MQTT Daten senden und empfangen
|ModType=d
|ModCmdRef=MQTT2_DEVICE
|ModForumArea=MQTT
|ModTechName=10_MQTT2_DEVICE.pm
|ModOwner=rudolfkoenig ({{Link2FU|8|Forum}} / [[Benutzer Diskussion:Rudolfkoenig|Wiki]])}}
Das Modul {{Link2CmdRef|Anker=MQTT2_DEVICE|Lang=en|Label=MQTT2_DEVICE}} ermöglicht es, Geräte einzubinden, die über eine MQTT-Schnittstelle verfügen.

== Voraussetzungen ==
Um ''MQTT2_DEVICE'' nutzen zu können, muss entweder FHEM mit {{Link2CmdRef|Anker=MQTT2_SERVER|Lang=en|Label=MQTT2_SERVER}} als MQTT-Server fungieren oder ein ein {{Link2CmdRef|Anker=MQTT2_CLIENT|Lang=en|Label=MQTT2_CLIENT}}-Gerät als [[Interface|Gateway]] zu einem funktionsfähigen anderen MQTT-Server wie z.B. Mosquitto definiert sein.

{{Hinweis|Mit einem [[MQTT (Modul)|MQTT]]-Device als Interface kann MQTT2_DEVICE nicht genutzt werden.
Eine Übersicht über die verschiedenen Möglichkeiten, MQTT in FHEM zu nutzen, ist in [[MQTT#FHEM und MQTT]] zu finden.}}

== Anwendung ==
=== Define ===

Die Syntax für das Anlegen eines MQTT2-Devices ist der {{Link2CmdRef|Anker=MQTT2_DEVICEdefine|Label=CommandRef}} zu entnehmen.

=== Attribute ===

Die eigentlichen Details zur Kommunikation sind - entsprechend der sehr flexiblen Gestaltung des MQTT-Protokolls an sich - nicht direkt im Define festgelegt, sondern werden anschließend über [[Attribut|Attribute]] festgelegt.

Die Verbindung funktioniert bidirektional:

* Mit dem Attribut 'setList' man kann Änderungen am State bzw. Readings an den Server übermitteln, der diese dann an die eigentlichen Geräte weitergibt oder dort vorhält. Für jedes Reading ist eine eigene Zeile erforderlich, das Aussehen in der Detailansicht des Geräts kann direkt über ein entsprechende widget-Definition vorgenommen werden.
* Entsprechend können über das Attribut 'getList' Abfragen an das MQTT-Gerät definiert werden.
* Mit dem Attribut 'readingList' kann man MQTT-topics abonnieren, also automatische Benachrichtigungen empfangen, sobald ein Gerät dort Änderungen einträgt. Immer wenn eine Nachricht auf dem abonnierten Topic eintrifft, wird das betreffende Reading aktualisiert. Es ist auch möglich, Perl-Code ausführen zu lassen, also insbesondere ''json2nameValue()'' aufzurufen, um JSON-Messages zu entpacken.

Legt man ein neues Device an, dessen Topics man noch nicht genau kennt, kann man das Attribut ''autocreate'' aktivieren, dann wird die ''readingList'' automatisch ergänzt, sofern am IO-Modul ''autocreate'' ebenfalls aktiv ist.
{{Hinweis|Hat man eine {{Link2CmdRef|Anker=MQTT_GENERIC_BRIDGE|Label=MQTT_GENERIC_BRIDGE}} definiert, sollte ''autocreate'' nicht aktiviert werden!}}

== attrTemplate ==
Zur Konfiguration von MQTT2_DEVICE-Geräten kann die Funktion ''attrTemplate'' genutzt werden.
Für gängige Gerätetypen stehen bereits einige templates bereit. Um Ihnen die Auswahl zu erleichtern, kann mit <code>set <MQTT2-Device-Name> attrTemplate ?</code> eine Liste der vorhandenen Templates samt kurzer Beschreibung aufgerufen werden.
Haben Sie ein passendes ''template'' gefunden, wenden Sie es mit <code>set <MQTT2-Device-Name> attrTemplate <template_name></code> an.

Wer plant, mehrere gleichartige Geräte anzulegen, aber andere Einstellungen zu wählen, als sie in den vorhandenen templates enthalten sind, kann hierfür ebenfalls die attrTemplate-Funktion mit eigenen templates nutzen. Hierfür können die vorhandenen templates aus der Datei mqtt2.template<ref>zu finden im Unterverzeichnis fhem/FHEM/lib/AttrTemplate</ref> als Basis dienen, Ihre templates speichern Sie einfach als neue Datei mit der Endung ''.template'' im selben Verzeichnis und lesen diese mit <code>{ AttrTemplate_Initialize() }</code> neu ein. Danach können Sie diese direkt verwenden.

Haben Sie ein template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag in {{Link2Forum|Topic=94495|LinkText=diesem Thread}}.
Für Fragen, die Meldung von Fehlern oder für Verbesserungsvorschläge an den templates in ''mqtt2.template'' ist {{Link2Forum|Topic=94494|LinkText=dieser Thread}} gedacht.

== Anwendungsbeispiele ==
siehe [[MQTT2-Module - Praxisbeispiele]]

== Links ==
* [[MQTT]]
* {{Link2Forum|Topic=94495|LinkText=Neue templates einreichen}}
* {{Link2Forum|Topic=94494|LinkText=Fragen, Wünsche und Kritik zu mqtt2.template}}

== Hinweise ==
<references />
[[Kategorie:HOWTOS]]
[[Kategorie:MQTT]]
[[Kategorie:IP Components|IP Komponenten]]
[[Kategorie:Other Components]]