Anwenderdokumentation v1.8.2 Logo
  • Einleitung
  • Installation
    • Hard- u. Software Anforderungen
      • Hardware
      • Betriebssystem
      • weitere Software
    • Komplettanleitung
      • Debian Linux installieren
        • Softwareauswahl
        • Einloggen via SSH oder an der Konsole
        • Systemaktualisierung
        • Restarbeiten am System
      • SmartHomeNG installieren
        • zusätzliche Linux Pakete installieren
        • SmartHomeNG Quellcode laden
        • Weitere Python Bibliotheken installieren
        • Erstmaliger Start von SmartHomeNG
        • Initiale Konfiguration per GUI
        • Erstmalige Konfiguration per Kommandozeile (für Fortgeschrittene)
      • MQTT Broker installieren
        • Mosquitto installieren
        • Mosquitto konfigurieren
      • smartVISU installieren
        • zusätzliche Pakete installieren
        • SmartVISU Quellcode laden
        • Zugriff auf die SmartVISU testen
        • Eigene Visu Seiten anlegen
        • Nachinstallation der Kurzanleitung
        • SmartHomeNG Plugin visu_smartvisu
      • knxd installieren
        • knxd unter Debian Buster installieren
        • knxd unter älteren Debian Versionen installieren
        • knxd konfigurieren
        • knxd und systemd
        • SmartHomeNG Plugin konfigurieren
      • Onewire installieren
        • zusätzliche Linux Pakete installieren
        • Owserver konfigurieren
        • SmartHomeNG Plugin konfigurieren
      • Samba installieren
        • zusätzliche Linux Pakete installieren
        • Samba konfigurieren
      • SmartHomeNG als Dienst einrichten update
    • Installation über Docker
      • Einführung
      • Docker-Compose
      • Anleitung
    • Update von einer älteren Version
      • Vorgehensweise
        • Plan B
      • Betriebssystemupdate
      • Versionsdetails
        • Update von SmarthomeNG ab v1.6 und höher
        • Update von SmarthomeNG ab v1.1 und höher
        • Upgrade von Smarthome.py
      • Konvertierung von *.conf-Dateien
  • Konfiguration
    • Allgemeines zur Konfiguration
      • Verzeichnisse in SmartHomeNG
        • Dateien im Verzeichnis ../etc
        • Dateien im Verzeichnis ../items
    • Konfiguration über die GUI
      • Konfigurations-Dialoge
      • Editoren für YAML Konfigurationen
        • Systemkonfiguration
        • Konfiguration von Plugins
        • Konfiguration von Items
    • Konfiguration über Dateien
      • Verzeichnisse
        • Verzeichnis ../etc
        • Verzeichnis ../items
        • Verzeichnis ../logics
        • Verzeichnis ../scenes
      • Aufbau der Konfigurationsdateien
        • Neues Dateiformat - .yaml Dateien
        • Vorteile von YAML
        • Altes Dateiformat - .conf Dateien
      • YAML Syntax
        • Grundlegende YAML Regeln
        • Basis DataTypen in YAML
      • Konfigurationsdateien
        • smarthome.yaml
        • holidays.yaml
        • module.yaml
        • plugin.yaml
        • logic.yaml
        • logging.yaml
        • struct.yaml
        • items/*.yaml
        • logics/*.py
        • scenes/*.yaml
    • Items
      • Initiale Item-Konfiguration
        • Beispiele für erstmaliges Setup
      • Standard Attribute
        • autotimer
        • crontab
        • cycle
        • enforce_updates
        • enforce_change Neu
        • eval und eval_trigger
        • on_update und on_change
        • struct
        • type
      • Plugin-spezifische Attribute
        • Vererbung von Attributen update
      • Relative Item Referenzen
        • Syntax der relativen Referenzen
        • Beispiele
        • Nutzung in eval_trigger und eval
        • Nutzung relativer Item Referenzen in Plugins
      • Properties eines Items
      • Funktionen eines Items
        • Beispiele für die Nutzung von Funktionen
      • Überblick
      • Namensvergabe
      • Attribute
      • Properties und Funktionen
    • structs (Item Strukturen)
      • Überblick
      • struct bei Plugins
        • Anwendung
        • Multi-Instance Unterstützung
      • struct bei selbst definierte Item-Struktur-Templates
        • Anwendung
        • Verschachtelte struct Definitionen (nested structs)
        • Re-Definieren von Attributen (außer list-Attributen)
        • Re-Definieren von list-Attributen
      • Beispiele
    • Module
      • Module http
        • Konfiguration
      • Module websocket Neu
        • Anforderungen
        • Konfiguration
      • Module admin
        • Konfiguration
      • Module mqtt
        • Konfiguration
    • Plugins
      • Multi-Instance Fähigkeit
      • Liste der verfügbaren Plugins
    • Logiken
      • Standard Parameter
    • Logging
      • Konfiguration des Loggings
      • Plugin und Logik Entwicklung
      • Best Practices
    • Szenen
      • Funktionsweise von Szenen
    • Konfiguration Sichern und Wiederherstellen
      • Sichern
      • Wiederherstellen
      • Umfang der Sicherung
  • Plugins
    • System Plugins
      • backend
        • Konfiguration
      • cli
        • Konfiguration
        • Weiterführende Informationen
        • Plugin Konfigurationsparameter
        • Zugriff auf die CLI
        • CLI Befehle
      • database
        • Konfiguration
        • Web Interface
      • executor
        • Einführung
        • Konfiguration
        • Beispiele für Eval
        • Beispiel Python Code
      • operationlog
        • Requirements
        • Konfiguration
      • rtr2
        • Plugin Instanz hinzufügen
        • Konfiguration
        • Visualisierung
        • Web Interface
      • simulation
        • Konfiguration
        • Aufzeichnung
        • Abspielen
        • Visualisierung
        • Event Datei Format
        • Statusdiagramm
      • smartvisu
        • Konfiguration
        • Weiterführende Informationen
      • stateengine
        • Allgemein
        • Konfiguration
        • Regelwerk-Item
        • Zustand-Item
        • Bedingungen
        • Aktionen
        • Ausführungszeitpunkt
        • Beispiel
        • Zustand-Templates
        • Funktionen und Variablen
        • Besondere Zustände
        • Aktionen - einzeln
        • Sonstiges
      • uzsu
        • Einführung
        • Konfiguration
        • SmartVISU
        • Datenformat
        • Interpolation
        • Funktionen
        • Webinterface
        • Beispiel
      • visu_smartvisu
        • Mischung von generierten und manuell erstellten Seiten
        • Empfohlenes Vorgehen für manuell erstellte Seiten
      • visu_websocket
        • Konfiguration
        • Web Interface
        • Informationen für Entwickler
    • Gateway Plugins
      • bose_soundtouch
      • casambi
        • Konfiguration
        • Web Interface
      • dlms
        • Konfiguration
        • Web Interface
      • DMX
        • Vorbedingungen
        • Konfiguration
        • Methoden
      • homematic
        • Konfiguration
        • Web Interface
      • hue2
        • Plugin Instanz hinzufügen
        • Konfiguration
        • Web Interface
      • knx
        • Konfiguration
      • lirc
        • Konfiguration
        • Items
      • onewire
        • Anforderungen
        • Konfiguration
        • Beispiel
        • Web Interface
      • shelly
        • Shelly Device in Betrieb nehmen
        • Konfiguration
        • Web Interface des Plugins
      • squeezebox
        • Konfiguration
        • Items
        • Struct Vorlagen
        • Kommandos
      • tasmota
        • Konfiguration
        • Web Interface des Plugins
    • Interface Plugins
      • alexarc4shng
        • Konfiguration
        • Web Interface
      • avdevice
        • Konfiguration
        • Items
        • Kommandos
        • Struct Vorlagen
        • Übersetzungen
        • Wildcards
        • Webinterface
        • Fehlerbehebung
      • avm
        • Konfiguration
        • Konfiguration der Fritz!Box
        • Web Interface
      • drexelundweiss
        • Einführung
        • Konfiguration
        • Items Attribute
      • helios_tcp
        • Voraussetzungen
        • Einrichtung
        • Verknüpfung von Items
        • Variablen
      • kodi
        • Konfiguration
        • Hinweise zu Verbindungen
        • Items
        • Struct Vorlagen
      • neato/vorwerk
        • Konfiguration
        • Web Interface
      • resol
        • Konfiguration
      • Solarlog
        • Requirements
        • Todo
        • Konfiguration
        • Funktionen
      • viessmann
        • Changelog
        • Anforderungen
        • Konfiguration
        • Funktionen
        • Web-Interface
        • Standalone-Modus
      • xiamo_vac
        • Konfiguration
        • Funktionen
        • Webinterface
      • Yamaha
        • Anforderungen
        • Konfiguration
        • Beispiele
        • Web Interface
      • yamahayxc
        • Anmerkungen
        • Anforderungen
        • Konfiguration
    • Protokoll Plugins
      • mqtt
        • Konfiguration
        • Web Interface
      • Network
        • Requirements
        • Konfiguration
        • Benutzung
        • Funktionen
    • Web/Cloud Plugins
      • alexa4p3
        • Konfiguration
      • darksky
        • Konfiguration
        • Web Interface
      • ical
        • Einführung
        • Konfiguration
        • Funktionen
        • Beispiel
      • openweathermap
        • Konfiguration
        • Web Interface
      • prowl
        • Anforderungen
        • Konfiguration
        • Beispiele
      • Speech
        • Funktionsweise
      • telegram
        • Abhängigkeiten
        • Konfiguration
        • msg_broadcast
        • photo_broadcast
        • Beispiel
      • vacations
        • Konfiguration
        • Web Interface
      • webservices
        • Konfiguration
        • Web Interface
      • wunderground
        • Konfiguration
        • Web Interface
    • Nicht klassifizierte Plugins
  • Logiken
    • Grundlegende Struktur
    • Verfügbare Objekte und Methoden
      • Logging in Logiken Neu
      • Feiertage, Daten und Zeiten
      • Zeit, Sonne und Mond
        • sh.sun
        • sh.moon
      • Item Methoden
        • return_item(path)
        • return_items()
        • match_items(regex)
        • find_items(configattribute)
        • find_children(parentitem, configattribute)
      • Scheduler Methoden
        • sh.scheduler.trigger() / sh.trigger()
        • sh.scheduler.change()
      • sh.tools Methoden
        • sh.tools.ping()
        • sh.tools.dewpoint()
        • sh.tools.fetch_url()
        • sh.tools.dt2ts(dt)
        • sh.tools.dt2js(dt)
        • sh.tools.rel2abs(temp, hum)
        • sh.tools.runtime()
      • Das logic Objekt
      • trigger Dict
      • Das logics Objekt
      • Geladene Python Module
    • Konfiguration
    • Persistente Variablen
      • Einrichtung
      • Existenz einer Variablen sicherstellen
      • Nutzung selbst definierter Parameter
      • Einrichtung (Logik übergreifend)
        • Unterschiede zu lokalen persistenten Variablen
    • Nutzung von Funktionen
    • Klassen in Logiken Neu
    • Nutzung von MQTT in Logiken
      • Das mqtt Objekt
        • mqtt.publish_topic()
        • mqtt.subscribe_topic()
        • mqtt.unsubscribe_topic()
      • Beispiel Logik
  • Visualisierung mit smartVISU Update
    • Überblick
    • Generierung der Visu Seiten
      • Änderungen ab v1.8
      • Automatische Generierung
        • Features der Generierung
        • Deprecated Widget Warnings
        • Navigation Structure Definition
        • Seiten aus mehreren Sub-Trees
      • Item Attribute zur Generierung
        • sv_page
        • sv_overview
        • sv_img
        • sv_nav_aside
        • sv_nav_aside2
        • sv_widget
        • sv_widget2
        • sv_item_type
        • sv_heading_left
        • sv_heading_center
        • sv_heading_right
        • Example
      • Vollständiges Beispiel
      • Installation von Widgets
        • smartVISU Widget-Handling
      • Widgets für Plugins
        • Ein Widget zu einem Plugin hinzufügen
        • Notwendige Modifikationen der smartVISU vor v2.9
    • Optionale Definition der Navigationsstruktur
    • Kommunikation mit der Visu
      • Websocket Kommunikation
      • NGINX als ReverseProxy
  • Administrations-Interface Update
    • System
      • System Eigenschaften
        • Übersicht
        • Ressource Graphen
        • PyPI Check
        • Urheberrechtshinweise
      • System Konfiguration
        • Allgemein
        • Http Modul
        • Admin Modul
        • MQTT Modul
    • Dienste
      • Übersicht
      • eval Syntax-Prüfer
      • YAML Syntax-Prüfer
      • CONF-YAML Konverter
      • Cache Prüfung
    • Items
      • Item Baum
      • Item Konfiguration
      • Struktur Templates
      • Struktur Konfiguration
    • Logiken
      • Liste der Logiken
      • Logik Editor
        • Code Editor
        • Parameter Editor
    • Scheduler
    • Plugins
      • Liste der geladenen Plugins
      • Plugin Konfiguration
        • Liste der konfigurierten Plugins
        • Konfiguration eines Plugins
    • Szenen
      • Szenen Liste
      • Szenen Konfiguration
    • Threads
    • Logs
      • Logs anzeigen
        • Große Log Dateien
      • Liste der Logger
      • Logging Konfiguration
  • Beispiele, Tipps & Tricks
    • Items: eval und eval_trigger
    • Items: Tipps und Tricks
    • Logiken
      • Einfache Beispiele
        • Berechnung der Windstärke
        • Steuerung des dyn.zenith-Icons
        • Darstellung von DPT 2 Werten
        • Nachdimmen von Leuchten
      • Komplexere Beispiele
        • Berechnung von Zeitdaten
        • Blinken per Logik
      • Weitere Beispiele
    • structs (Item Strukturen)
    • knxd: Hinweise und Konfiguration
  • Tools
    • backup_restore.py
    • build_requirements.py
    • conf_to_yaml_converter.py
    • getshngpid
    • plugin_metadata_checker.py
  • Fehlersuche
  • FAQ - Häufig gestellte Fragen
  • Referenz Neu
    • SmartHomeNG (der Core)
      • Kommandozeilen-Optionen
      • Ablauf des Starts von SmartHomeNG
        • Erste Schritte der Initialisierung
        • Initialisierung des smarthome Objektes
        • Laufzeit von SmartHomeNG
        • Beendigung von SmartHomeNG
      • Feiertage
    • Items
      • Standard Attribute
        • autotimer
        • crontab
        • cycle
        • enforce_updates
        • enforce_change Neu
        • eval und eval_trigger
        • on_update und on_change
        • struct
        • type
      • Plugin-spezifische Attribute
        • Vererbung von Attributen update
      • Relative Item Referenzen
        • Syntax der relativen Referenzen
        • Beispiele
        • Nutzung in eval_trigger und eval
        • Nutzung relativer Item Referenzen in Plugins
      • Properties eines Items
      • Funktionen eines Items
        • Beispiele für die Nutzung von Funktionen
      • SmartHomeNG Items
      • Umgebungsbezogene Items
        • Tag/Nacht
        • Mondlicht / -stand
        • Sonnenaufgang / Sonnenstand
      • System Items
    • Module
      • Modul http
        • API des Moduls
        • README
        • Metadaten
      • Modul admin
        • API des Moduls
        • API des Moduls admin.rest
        • API des Moduls api_plugins
        • API des Moduls api_plugin
        • API des Moduls (WebApi)
        • README
        • Metadaten
      • Modul mqtt
        • API des Moduls
        • README
        • Metadaten
      • Module websocket new
        • API des Moduls
        • Metadaten
        • Konfiguration
    • Plugins
      • Metadaten für Plugins
        • plugin
        • parameters
        • item_attributes
        • item_structs
        • item_attribute_prefixes
        • logic_parameters
        • plugin_functions
    • Metadaten
      • Metadaten für Module
        • module
        • parameters
      • Metadaten für Plugins
        • plugin
        • parameters
        • item_attributes
        • item_structs
        • item_attribute_prefixes
        • logic_parameters
        • plugin_functions
  • Entwicklung Neu
    • Logiken
      • Einführung
      • Konfigurations Parameter
        • watch_item
        • cycle
        • crontab
        • enabled
        • prio
        • Andere Parameter
      • Grundstruktur einer Logik
      • Bereits geladene Python Module
      • Vorhandene Objekte und Methoden
        • logic
        • trigger
      • logger und sh.log
      • SmartHomeNG Methoden
        • sh.now und sh.utcnow
        • sh.sun
        • sh.moon
      • Scheduler
        • sh.scheduler.trigger() / sh.trigger()
        • sh.scheduler.change()
      • sh.tools Objekt
        • sh.tools.ping()
        • sh.tools.dewpoint()
        • sh.tools.fetch_url()
        • sh.tools.dt2ts(dt)
        • sh.tools.dt2js(dt)
        • sh.tools.rel2abs(temp, hum)
      • Zugriffe auf Items
        • items.return_item(path)
        • items.return_items()
        • items.match_items(regex)
        • items.find_items(configattribute)
        • find_children(parentitem, configattribute):
    • Plugins
      • Plugin development guidelines
        • GIT / github
        • Python Version
        • Coding style
        • Start Coding
      • In 5 Minuten zum eigenen Plugin…
        • Beschreibung des Plugins
        • Vordefinierte Funktionen des Plugins
        • Funktionen von SmartHomeNG
        • Zusammenfassung
      • Class SmartPlugin
      • Class MqttPlugin new
      • Plugin-Metadata update
        • Detaillierte Beschreibung
        • plugin
        • parameters
        • item_attributes
        • item_structs
        • logic_parameters
        • plugin_functions
      • Dateien der Plugin-Dokumentation
        • user_doc.rst / user_doc.md
        • developer_doc.rst / developer_doc.md
      • Webinterface update
        • Erweitern eines bestehenden Plugins
        • Das Webinterface mit Inhalt füllen
        • Unterstützung mehrerer Sprachen new
        • Automatische Updates der Daten im Webinterface new
        • Interaktion des Webinterface mit dem Plugin new
        • Komponenten von Drittanbietern für Webinterfaces
      • Unterstützung mehrerer Sprachen Update
        • Text als mehrsprachig kennzeichnen
        • Wie Mehrsprachigkeit funktioniert
        • Sprachen und Übersetzungen hinzufügen
        • Platzhalter in Übersetzungen nutzen Neu
      • Beispielplugin update
        • Die Metadaten-Datei:
        • Der Quelltext:
        • Das Webinterface (template file):
        • Die Datei für Mehrsprachigkeit:
        • Die Dokumentation:
      • Beispielplugin mit MQTT-Unterstützung new
        • Die Metadaten-Datei:
        • Der Quelltext:
        • Das Webinterface (template file):
        • Die Datei für Mehrsprachigkeit:
        • Die Dokumentation:
      • Programm Module zur Nutzung in Plugins
        • lib.connection
        • lib.db
        • lib.logutils
        • lib.network
        • lib.orb
        • lib.tools
        • lib.utils
      • visu_smartvisu
        • Visualisation plugin (smartVISU support) - for developers
        • Files of the Plugin
        • Handling of smartVISU widgets
      • visu_websocket
        • Visualisation plugin (Websocket Protocol) - for developers
        • WebSocket Interface
        • Requests sent from the Visu to SmartHomeNG
        • Requests sent from SmartHomeNG to the Visu
    • APIs von SmartHomeNG
      • Items-API
        • lib.item
      • Plugins-API
        • lib.plugin
      • Shtime-API
        • lib.shtime
      • Logics-API
        • lib.logic
      • Scheduler-API
        • lib.scheduler
    • Libraries für Plugins und Logiken
      • lib.connection
      • lib.db
      • lib.logutils
      • lib.network
      • lib.orb
      • lib.tools
      • lib.utils
    • Module
      • Module http
        • API des Moduls
      • Modul admin
        • API des Moduls
        • API des Moduls admin.rest
        • API des Moduls api_plugins
        • API des Moduls api_plugin
        • API des Moduls (WebApi)
        • README
        • Metadaten
      • Module mqtt
        • README
        • Metadata
      • Module websocket new
        • API des Moduls
        • Metadaten
        • Konfiguration
      • Metadaten
        • module
        • parameters
    • Entwicklung des Core
      • Der Core von SmartHomeNG
        • smarthome.py
      • Programm Module
        • lib.config
        • lib.constants
        • lib.daemon
        • lib.item_conversion
        • lib.log
        • lib.metadata
        • lib.module
        • lib.scene
        • lib.shyaml
        • lib.translation
        • lib.connection
        • lib.db
        • lib.logutils
        • lib.network
        • lib.orb
        • lib.tools
        • lib.utils
    • Bau der Dokumentation
      • Checkout und Bau der Dokumentation
      • Optionen des Build Skripts
    • Virtuelle Umgebungen
      • Venv
      • Pyenv
      • Pipenv
  • Release Notes
    • Release 1.8.2 - xx. Februar 2021
      • Überblick
        • Minimum Python Version
      • Änderungen am Core
        • Bugfixes in the CORE
      • Änderungen bei Plugins
        • Plugin Updates
      • Weitere Änderungen
        • Documentation
    • Release 1.8.1 - 24. Januar 2021
      • Überblick
        • Minimum Python Version
      • Änderungen am Core
        • Bugfixes in the CORE
        • Updates in the CORE
      • Änderungen bei Plugins
        • Plugin Updates
      • Weitere Änderungen
        • Documentation
    • Release 1.8 - 15. Januar 2021
      • Überblick
        • Unterstützte Python Versionen
        • Minimum Python Version
      • Änderungen am Core
        • Bugfixes in the CORE
        • Updates in the CORE
      • Änderungen bei Plugins
        • New Plugins
        • Plugin Updates and Bugfixes
        • Outdated Plugins
        • Retired Plugins
      • Weitere Änderungen
        • Tools
        • Documentation
    • Release 1.7.2 - 23. Juni 2020
      • Überblick
      • Änderungen am Core
      • Änderungen bei Plugins
    • Release 1.7.1 - 14. April 2020
      • Überblick
      • Änderungen am Core
      • Änderungen bei Plugins
    • Release 1.7 - 6. April 2020
      • Überblick
      • Änderungen am Core
      • Änderungen bei Plugins
    • Release 1.6.1 - 10. August 2019
      • Neue Plugins
      • Plugin Erweiterungen
    • Release 1.6 - 11. Mai 2019
    • Release 1.5.1 - 15. Juli 2018
    • Release 1.5 - 8. Juli 2018
    • Release 1.4.2 - 2. Januar 2018
    • Release 1.4.1 - 23. Dezember 2017
    • Release 1.4 - 17. Dezember 2017
    • Release 1.3 - 5. August 2017
    • Release 1.2 - 16. Mai 2016
    • Release 1.1 - 13. April 2016
    • Release 1.0 und davor
      • Release 1.0 - November 14th, 2013
        • With Contributions from:
        • New Plugins
        • Base Features
        • Plugin Features
        • Changes:
        • Migrate:
      • Release 0.9 - June 6th 2013
        • New Plugins
        • Features
        • Bug Fixes
      • Release 0.8 - January 31st, 2013
        • New Plugins
        • Features
        • Bug Fixes
      • Release 0.7 - September 27th 2012
        • Features
        • Bug Fixes
      • Release 0.6 - June 21th, 2012
        • Nonfunctional changes
        • Features
        • Bug Fixes
      • Release 0.5 - July 12th, 2012
        • Features
        • Bug Fixes
      • Release 0.4 - October 10th, 2011
        • Feature
      • Release 0.3 - August 14th, 2011
        • Features
        • Nonfunctional changes
        • Bug Fixes
      • Release 0.2 - June 21st, 2011
        • Features
        • Bug Fixes
      • Release 0.1 - April 09th, 2011
  • Stichwort Verzeichnis
  • Impressum
  • Datenschutzerklärung
  • English translation of this documentation
Anwenderdokumentation v1.8.2
  • Docs »
  • Referenz Neu »
  • Items

Items

In den folgenden Abschnitten sind Informationen zu den Items in SmartHomeNG zu finden.

  • Standard Attribute
  • Plugin-spezifische Attribute
    • Vererbung von Attributen update
  • Relative Item Referenzen
    • Syntax der relativen Referenzen
    • Beispiele
    • Nutzung in eval_trigger und eval
    • Nutzung relativer Item Referenzen in Plugins
      • Beispiel
  • Properties eines Items
  • Funktionen eines Items
    • Beispiele für die Nutzung von Funktionen
  • SmartHomeNG Items
  • Umgebungsbezogene Items
    • Tag/Nacht
    • Mondlicht / -stand
    • Sonnenaufgang / Sonnenstand
  • System Items
Next Previous

© Copyright 2016-2021 SmartHomeNG Team, SmartHomeNG is based on smarthome.py © Marcus Popp