Plugin ‚cli‘ Konfiguration

plugin logo

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

Beschreibung

Anforderungen

  • Minimum SmartHomeNG Version: 1.9.0

Konfiguration

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

hashed_password

  • Datentyp: str

ip

  • Datentyp: ip

  • Standardwert: 127.0.0.1

port

  • Datentyp: int

  • Standardwert: 2323

  • Minimalwert: 0

  • Maximalwert: 65535

update

  • Datentyp: bool

  • Standardwert: False

Item Attribute

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

Keine

Item-Structs

Das Plugin stellt die folgenden Item-Structs zur Verfügung. Diese Informationen sind aus der plugin.yaml entnommen und möglicherweise nicht vollständig.

Keine

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.

add_command(command, function, group, usage)

  • Die Funktion liefert kein Ergebnis

command

  • Datentyp: str

function

  • Datentyp: function

group

  • Datentyp: str

  • Mögliche Werte:

    • item

    • log

    • logic

    • scheduler

usage

  • Datentyp: str

remove_command(command)

  • Ergebnistyp der Funktion: bool

command

  • Datentyp: str