Plugin ‚hue3‘ Konfiguration

plugin logo

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

Anbindung des Philips/Signify Hue Systems über eine Hue Bridge unter Nutzung des neuen API v2

Anforderungen

  • Minimum SmartHomeNG Version: 1.10.0

Konfiguration

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

bridge_ip

IP Adresse der Philips/Signify Hue Bridge Dieser Parameter wird durch das Plugins in den Konfigurationsdaten abgelegt. Er ist in der Admin GUI nicht änderbar

  • Datentyp: ip

bridge_serial

Seriennummer der Philips/Signify Hue Bridge Dieser Parameter wird durch das Plugins in den Konfigurationsdaten abgelegt. Er ist in der Admin GUI nicht änderbar

  • Datentyp: str

bridge_user

Username/Anwendungsschlüssel um auf die Philips/Signify Hue Bridge zuzugreifen Dieser Parameter wird durch das Plugins in den Konfigurationsdaten abgelegt. Er ist in der Admin GUI nicht änderbar

  • Datentyp: str

default_transitionTime

Zeit in sekunden welche die Leuchte benötigt um in einen neuen Zustand überzugehen

  • Datentyp: float

  • Standardwert: 0.4

  • Minimalwert: 0

Item Attribute

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

hue3_function

Anzusteuernde Funktion für die gewählte Resource/ID

  • Datentyp: str

  • Mögliche Werte:

    •   -   <noch keine Funktion gewählt>

    • on   -   Ein-/Ausschalten -> bool, r/w (resource: light, group)

    • bri   -   Helligkeit in Prozent, 0 … 100 -> num, r/w (resource: light, group)

    • bri_inc   -   Relative Helligkeitsveränderung 0 … 254, w/o (resource: light, group)

    • xy   -   xy Werte -> list, r/w (resource: light, group)

    • ct   -   ct Wert -> num, w/o (resource: light, group)

    • dict   -   Mehrere Funktionen auf einmal -> dict, w/o (resource: light, group)

    • name   -   Name -> str, r/w (resource: light, group, scene, sensor)

    • reachable   -   Erreichbar -> bool, r/o (resource: light)

    • connectivity   -   Connectivity status -> str, r/o (resource: light)

    • type   -   Typ des Leuchtmittels -> str, r/o (resource: light)

    • modelid   -   Model Id des Leuchtmittels -> str, r/o (resource: light)

    • swversion   -   Software Version des Leuchtmittels -> str, r/o (resource: light)

    • activate   -   Aktivieren einer Szene für Leuchten -> bool w/o (resource: scene)

    • activate_scene   -   Aktivieren einer Szene (Szenen-Id aus dem Item Wert) für Leuchten -> str w/o (resource: scene)

    • modify_scene   -   Anpassen einer Szene für Leuchten in der selektierten Gruppe (hue3_id) -> str w/o (resource: group)

    • alert   -   Benachrichtigung -> str (Werte: none, select, lselect) (resource: light, group)

    • effect   -   Lichteffekt -> str (Werte: none, colorloop) (resource: light, group)

    • daylight   -   Tageslicht -> bool, r/o (resource: sensor)

    • sunriseoffset   -   Tageslicht: sunriseoffset -> num r/o (resource: sensor)

    • sunsetoffset   -   Tageslicht: sunsetoffset -> num r/o (resource: sensor)

    • temperature   -   Temperatur -> num r/o (resource: sensor)

    • presence   -   Präsenz -> bool, r/o (resource: sensor)

    • lightlevel   -   Sensor ‚lightlevel‘ -> num r/o (resource: sensor)

    • status   -   Sensor ‚status‘ -> num, r/o (resource: sensor)

    • event   -   Event, welches der Button sendet -> str, r/o (resource: button)

    • initial_press   -   True, wenn der Button gerade gedrückt wurde -> bool, r/o (resource: button)

    • repeat   -   True, wenn der Button repeat sendet -> bool, r/o (resource: button)

    • short_release   -   True, wenn der Button kurz gedrückt wurde -> bool, r/o (resource: button)

    • long_release   -   True, wenn der Button lang gedrückt wurde -> bool, r/o (resource: button)

    • power_status   -   Power Status -> str, r/o (resource: device_power)

    • battery_level   -   Batterie Ladung in Prozent -> num, r/o (resource: device_power)

hue3_id

ID der anzusteuernden resouce. Der Typ der resource wird mit ‚hue3_recource‘ festgelegt.

  • Datentyp: str

hue3_resource

Anzusteuernde Resource, falls nicht angegeben wird ‚light‘ angenommen

  • Datentyp: str

  • Mögliche Werte:

    • light

    • group

    • scene

    • sensor

    • button

    • device

    • device_power

hue3_transition_time

Zeit für Übergang (in sec)

  • Datentyp: num

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