Plugin ‚homeconnect‘ Konfiguration

plugin logo

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

ACHTUNG: Dieses Plugin ist als develop gekennzeichnet. Es kann daher sein, dass es noch nicht sämtliche Funktionen unterstützt oder noch fehlerhaft ist.

Beschreibung

Anforderungen

  • Minimum SmartHomeNG Version: 1.7

Konfiguration

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

client_id

  • Datentyp: str

client_secret

  • Datentyp: str

cycle

  • Datentyp: int

  • Standardwert: 300

simulate

  • Datentyp: bool

  • Standardwert: False

Item Attribute

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

ha_id

  • Datentyp: str

homeconnect_data_type

  • Datentyp: str

  • Mögliche Werte:

    • status

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.

get_hc()

  • Ergebnistyp der Funktion: foo

get_program_options(ha_id, program_key)

  • Ergebnistyp der Funktion: list(str)

ha_id
  • Datentyp: str

program_key
  • Datentyp: str

get_programs_active(ha_id)

  • Ergebnistyp der Funktion: str

ha_id
  • Datentyp: str

get_programs_available(ha_id)

  • Ergebnistyp der Funktion: list(str)

ha_id
  • Datentyp: str

get_programs_selected(ha_id)

  • Ergebnistyp der Funktion: str

ha_id
  • Datentyp: str

get_redirect_url()

  • Ergebnistyp der Funktion: str

start_program(ha_id, program_key, options)

  • Ergebnistyp der Funktion: str

ha_id
  • Datentyp: str

program_key
  • Datentyp: str

options
  • Datentyp: str

stop_program(ha_id, program_key, options)

  • Ergebnistyp der Funktion: str

ha_id
  • Datentyp: str

program_key
  • Datentyp: str

options
  • Datentyp: str