Plugin ‚zigbee2mqtt‘ Konfiguration

plugin logo

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin zigbee2mqtt konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann. [1]

Es handelt sich bei diesem Plugin um ein gateway Plugin.

ACHTUNG: Dieses Plugin ist als develop gekennzeichnet. Es kann daher sein, dass es noch nicht Feature-Complete oder noch fehlerhaft ist.

Beschreibung

Plugin zur Steuerung von Geräten, die mit einem Zigbee Gateway mit der Zigbee2MQTT Firmware versehen sind. Die Kommunikation erfolgt über das MQTT Module von SmartHomeNG.

Anforderungen

  • Minimum SmartHomeNG Version: 1.9.5.6

  • Minimum Python Version: 3.8

Konfiguration

Im folgenden ist beschrieben, wie das Plugin zigbee2mqtt konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann.

Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/plugin.yaml konfiguriert werden:

base_topic

Topic, um mit dem ZigBee2MQTT-Gateway zu kommunizieren (%topic%)

  • Datentyp: str

  • Standardwert: zigbee2mqtt

poll_period

Zeitabstand in Sekunden, in dem der Status des Gateway abgefragt wird

  • Datentyp: int

  • Standardwert: 900

  • Minimalwert: 10

  • Maximalwert: 3600

read_at_init

Einlesen aller Werte beim Start

  • Datentyp: bool

  • Standardwert: True

suspend_item

Pfad zum Suspend-Item

  • Datentyp: str

z2m_gui

Web-Adresse des zigbee2mqtt-Web-GUI (Standard localhost:8080)

  • Datentyp: str

  • Standardwert: localhost:8080

Item Attribute

Das Plugin unterstützt folgende Item Attribute, die in den Dateien im Verzeichnis ../items verwendet werden:

z2m_attr

Zu lesendes/schreibendes Attribut des ZigBee2MQTT Devices

  • Datentyp: str

z2m_bool_values

Ersetzungwerte für bool-Werte (z.B. [‚OFF‘, ‚ON‘])

  • Datentyp: list

z2m_readonly

Attribut wird nur gelesen

  • Datentyp: bool

z2m_topic

Name des anzusprechenden Gerätes, entweder die Seriennummer (‚0xdeadbeef‘) oder der friendly_name

  • Datentyp: str

z2m_writeonly

Attribut wird nur geschrieben. Wenn z2m_readonly auch gesetzt ist, hat readonly Vorrang

  • Datentyp: bool

Logik Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/logic.yaml konfiguriert werden:

Keine Logik Parameter in den Metadaten beschrieben - Bitte in der README nachsehen (siehe Fußnote)

Plugin Functions

Das Plugin verfügt über folgende öffentliche Funktionen, die z.B. in Logiken aufgerufen werden können.

Keine