Plugin ‚lms‘ Konfiguration

plugin logo

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin lms 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 interface Plugin.

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

Beschreibung

Anforderungen

  • Minimum SmartHomeNG Version: 1.9.5

  • Minimum Python Version: 3.7

Konfiguration

Im folgenden ist beschrieben, wie das Plugin lms 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:

autoconnect

Automatisches Verbinden bei Senden

  • Datentyp: bool

autoreconnect

Automatisches Neuverbinden bei Abbruch

  • Datentyp: bool

  • Standardwert: True

command_class

Klasse für Verarbeitung von Kommandos

  • Datentyp: str

  • Standardwert: SDPCommandParseStr

  • Mögliche Werte:

    • SDPCommand

    • SDPCommandParseStr

conn_type

Verbindungstyp

  • Datentyp: str

  • Standardwert: net_tcp_client

  • Mögliche Werte:

    • net_tcp_client

connect_cycle

Pause zwischen Verbindungsversuchen

  • Datentyp: num

  • Standardwert: 3

connect_retries

Anzahl Verbindungsversuche

  • Datentyp: num

  • Standardwert: 5

host

Netzwerkziel/-host

  • Datentyp: str

port

Port für CLI Netzwerkverbindung

  • Datentyp: int

  • Standardwert: 9090

recursive_custom

Vererbung von „custom“ Itemattributen an untergeordnete Items aktivieren

  • Datentyp: bool

  • Standardwert: True

retry_cycle

Pause zwischen Durchgängen von Verbindungsversuchen

  • Datentyp: num

  • Standardwert: 30

retry_suspend

Anzahl von Durchgängen vor Verbindungsabbruch oder Suspend-Modus

  • Datentyp: num

  • Standardwert: 3

suspend_item

Item-Pfad für das Standby-Item

  • Datentyp: str

terminator

Zeilen-/Antwortbegrenzer

  • Datentyp: str

  • Standardwert: r

timeout

Timeout für Geräteantwort

  • Datentyp: num

  • Standardwert: 3

web_host

Host für Webinterface-Verbindung (nötig für coverarturl bei Einsatz eines Reverse Proxy). Wird dieser Parameter nicht definiert, wird die URL unter „Host“ herangezogen.

  • Datentyp: str

web_port

Port für Webinterface-Verbindung (nötig für coverarturl). Wird der Port auf 0 gesetzt, wird für die Coverart URL kein Port verwendet (z.B. beim Einsatz eines Reverse Proxy).

  • Datentyp: int

  • Standardwert: 9000

Item Attribute

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

sqb_command

Legt das angegebene Kommando für das Item fest

  • Datentyp: str

sqb_custom1

MAC-Adresse des Wiedergabegerätes

  • Datentyp: str

sqb_lookup

Der Inhalt der Lookup-Tabelle mit dem angegebenen Namen wird beim Start einmalig als dict oder list in das Item geschrieben. Durch Anhängen von „#<mode>“ an den Namen der Tabelle kann die Art der Tabelle ausgewählt werden: - fwd liefert die Tabelle Gerät -> SmartHomeNG (Standard) - rev liefert die Tabelle SmartHomeNG -> Gerät - rci liefert die Tabelle SmarthomeNG -> Gerät in Kleinbuchstaben - list liefert die Liste der Namen für SmartHomeNG (z.B. für Auswahllisten in der Visu)

  • Datentyp: str

sqb_read

Item liest/erhält Werte vom Gerät

  • Datentyp: bool

sqb_read_cycle

Konfiguriert ein Intervall in Sekunden für regelmäßiges Lesen

  • Datentyp: num

sqb_read_group

Weist das Item der angegebenen Gruppe zum gesammelten Lesen zu. Mehrere Gruppen können als Liste angegeben werden.

  • Datentyp: list(str)

sqb_read_group_trigger

Wenn diesem Item ein beliebiger Wert zugewiesen wird, werden alle zum Lesen konfigurierten Items der angegebenen Gruppe neu vom Gerät gelesen, bei Gruppe 0 werden alle zum Lesen konfigurierten Items neu gelesen. Das Item kann nicht gleichzeitig mit sqb_command belegt werden.

  • Datentyp: str

sqb_read_initial

Legt fest, dass der Wert beim Start vom Gerät gelesen wird

  • Datentyp: bool

sqb_write

Änderung des Items werden an das Gerät gesendet

  • 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