Überblick

Das einfachste Item ist eines nur mit dem Itemnamen:

# myitem.yaml
One:

Für den Itemnamen sollten nur die Zeichen A-Z und a-z verwendet werden. Ein Unterstrich oder eine Ziffer 0-9 darf _innerhalb_ des Itemnamens vorkommen. Einen Itemname wie [1w_Bus], [42] oder [_Bus] sind nicht zulässig. Außerdem ist es unzulässig für Itemnamen reservierte Worte der Programmiersprache Python zu verwenden.

Achtung

Bei Items wird zwischen Groß- und Kleinschreibung unterschieden.

Items können hierarchisch aufgebaut sein, ein Item kann Kinder-Items haben, die ihrerseits wiederum Kinder-Items haben können. Zur Kennzeichnung der Hierarchieebene wird im yaml Dateiformat eine Einrückung verwendet.

# myitem.yaml
Oma:
   Papa:
      Kind:

Die richtige Referenzierung der Items wäre hier Oma, Oma.Papa und Oma.Papa.Kind

So wie die Items oben stehen, erfüllen Sie noch keine Funktion außer einer gewissen Gliederung. Aus diesem Grund kann man den Items Attribute zuweisen.

Namensvergabe

Bei der Wahl von Itemnamen ist folgendes zu beachten:

Plugin-Instanzen und Items der obersten Ebene (Top-Level) teilen sich den Namensraum. Es sollte vermieden werden, Top-Level Items einen Namen zu geben, der in ../etc/plugin.yaml (bzw. ../etc/plugin.conf) bereits für eine Plugin-Instanz gewählt wurde. Dieses kann zu unvorhergesehenen Problemen führen.

z.B.: Wenn ein Plugin Funktionen implementiert hat, wird dies beim Aufruf dieser Funktionen zu Problemen führen, da SmartHomeNG dann versucht auf eine (nicht existierende) Methode des Items zuzugreifen, statt auf das Plugin.

Attribute

Attribute eines Items werden in der Konfigurationsdatei in der Form

# myitem.yaml
<Attribut-Name>: <Attribut-Wert>

angegeben. Normalerweise sind Attribut-Werte einzeilig. Es wird alles bis zum Zeilenende oder bis zum Beginn eines Kommentars (#) angenommen. (Seit dem Release 1.3 werden auch mehrzeilige Attribute unterstützt.)

Hinweis

Ab SmartHomeNG v1.3 wird ein neues Dateiformat für Konfigurationsdateien unterstützt. Das bisherige Format der Konfigurationsdateien wird vorerst weiter unterstützt.

Informationen zum alten und neuen Dateiformat finden Sie hier unter Aufbau der Konfigurationsdateien.

Properties und Funktionen

Properties und Funktionen von Items dienen dazu auf Item Informationen während der Laufzeit von SmartHomeNG zuzugreifen. Sie werden in Plugins, Logiken oder eval-Ausdrücken genutzt.

Viele Attribute stehen zur Laufzeit als Properties zur Verfügung und können gelesen (und zum Teil auch geschrieben) werden. Um herauszufinden, wie der Zugriff zur Laufzeit funktioniert, bitte auf der Seite Properties eines Items nachsehen.