Dokumentation
Variablen
Eine Variable ist ein Behälter, der einen Wert enthält. Dieser Wert kann ein Boolean, Float, Integer oder String sein. Im Normalfall beinhalten Variablen Statuswerte von Geräten. Zusätzlich können selbsterstellte Variablen genutzt werden um eigene Werte abzuspeichern, welche z.B. ebenfalls in der Visualisierung dargestellt oder in Skripten verarbeitet werden können.
Systemvariablen haben im engeren Sinn, nichts mit normalen Variablen zu tun, da diese nur innerhalb von Skripten verfügbar sind.
Zum Austausch und zur Speicherung aller Daten benutzt IP-Symcon diese Variablen. Variablen beinhalten Statuswerte von Geräten, die es erst möglich machen, dass z.B. die Temperatur eines Thermometers auf dem WebFront sichtbar wird oder dass ein An- bzw. Ausschalten der Beleuchtung überhaupt funktioniert.
Beschreibung
Bei IP-Symcon gibt es zwei Arten von Variablen:
Status Variablen
Jede Instanz eines Gerätes kann eine oder mehrere Status-Variablen besitzen, diese werden automatisch erstellt. In diesen Variablen wird der Status des Gerätes gespeichert (z.B. An / Aus oder Temperatur in °C oder zusätzlich noch die Feuchtigkeit und der Zustand der Batterie).
Wann sich der Status bzw. dessen Wert ändert oder aktualisiert wird, hängt von dem jeweiligen System ab. Eine Wetterstation z.B. sendet periodisch die Umweltdaten an IP-Symcon, während bei anderen Systemen aktiv deren Zustand (z.B. ein Fenster- Türkontakt) abgefragt werden muss. Das (Abfrage-)Intervall wird in der Konfiguration der zugehörigen Instanz eingestellt.
Eine wichtige Besonderheit der Status-Variablen ist, dass deren Wert nicht vom Anwender verändert werden darf. Diese Variablen spiegeln nur den Zustand und die Datensätze des Gerätes wieder.
Status Variablen dürfen nicht gelöscht werden, da dies zu unvorhersehbarem Verhalten der jeweiligen Instanz führen kann.
Beispiel 1:
Um die Soll-Raumtemperatur bei einer Heizungssteuerung zu ändern, wird ein Befehl ausgeführt, welcher den Soll-Wert an das Gerät übermittelt. Es wird nicht die Status-Variable "Temperatur" selbst verändert. Die dazu notwendigen Befehle können in der jeweiligen Modulreferenz nachgelesen werden. Alternativ kann auch der Befehl "RequestAction " direkt auf die Variable angewandt werden. IP-Symcon sucht dann den dedizierten Befehl selbst und nutzt diesen.
Beispiel 2:
Ein abstrakteres Beispiel in Form eines KFZ: um ein Fahrzeug zu beschleunigen oder abzubremsen, müssen die entsprechenden Fußpedale betätigt werden. Es reicht nicht aus die Tachonadel auf die gewünschte Geschwindigkeit einzustellen.
Fazit: Status Variablen liefern ausschließlich Informationen über das Gerät und sind darum explizit als "Nur Lesen" markiert.
Benutzerdefinierte Variablen
Benutzerdefinierte-Variablen können selbst erstellt werden und einen von vier Datenypen (siehe Tabelle Variablentypen ) beinhalten. Benutzerdefinierte Variablen können vollständig Manipuliert werden.
Beispiel 1:
Soll ein bisher unbekanntes Gerät (z.B. AV-Verstärker) in IP-Symcon integriert oder ein Wert umgerechnet werden, so ist dies mithilfe der "Benutzerdefinierten Variablen" lösbar.
Beispiel 2:
Ein weiteres Beispiel wäre die Umrechnung der Außentemperatur zusätzlich in Grad Fahrenheit (°F).
Variablentypen
Variablentyp | Beschreibung | Beispiel |
---|---|---|
Boolean | True / False | z.B. An oder Aus |
Float | Gleitkommazahl | z.B. 231,956 |
Integer | Ganze Zahlen | z-B. -10 … -4 … 0 … 32 … 472 |
String | Text | “Hallo IP-Symcon. Hallo Welt” |
Neue Variablen anlegen
Eine Variable kann im Objektbaum über das "+" oder "Rechtsklick" -> "Objekt hinzufügen" -> "Variable" erstellt werden. Die zweite Variante hat den Vorteil, dass die Variable direkt unterhalb vom ausgewählten Objekt erstellt wird und nicht erst hinterher einsortiert werden muss. Im folgenden Fenster muss ein Variablentyp, Profil und ebenso ob die Variablenaufzeichnung für diese Variable aktiv sein soll ausgewählt werden. Die Aggregation gibt dabei den Typ der Variablenaufzeichnung an.
Bevor die Erstellung mit "OK" bestätigt wird, sollte darauf geachtet werden, dass die neu erstellte Variable einen aussagekräftigen Namen hat. Optional kann noch eine Bemerkung hinzugefügt und ein Icon ausgewählt werden. Der Ort der Variable kann mit dem Dialog "Ort" festlegt oder nachträglich im Objektbaum verschoben werden.
Variablenvisualisierung
Variablen werden im WebFront standardmäßig angezeigt. Dies kann durch die Visuelle Einstellung ein- oder ausgeschaltet werden.
Um Variablenwerte aufzuzeichnen und einen Graphen im WebFront anzuzeigen, muss das Aufzeichnen von Variablenveränderung (Archive Control ) aktiviert werden.
Variablen die aufgezeichnet und im WebFront angezeigt werden, öffnen über den Diagramm-Button direkt neben dem anzeigten Variablenwert ein Popup.
Innerhalb des Popups kann per "DYN" (dynamisch) eine automatisch von IP-Symcon skalierte Version des Graphen angezeigt werden.
Sollen bestimmte Eigenschaften und ein bestimmtes Aussehen vorhanden sein, ist ein Variablenprofil für die jeweilige Variable einzurichten.
Einstellungen die in den Popups gemacht werden, werden vom jeweiligen Browser gespeichert und beim nächsten Aufruf wieder geladen.
Wenn mehrere Variablen in einem Graph dargestellt werden sollen oder dauerhaft auf der Seite angezeigt werden sollen, muss ein Medienobjekt "Chart" aus den Variablen erstellt werden.
Es gelten die gleichen aggregierten dargestellten Durchschnittswerte für Standard/Hohe Dichte, wie für "Charts" . Zusätzlich wird ein Min/Max Graph bereitgestellt.
Variablenprofile
Ab IP-Symcon Version 2.1 kann einer Variable ein Profil gegeben werden, welches die Variable für die Visualisierung vorbereitet und z.B. ein °C anhängt. Diese Option kann auch nachträglich verändert werden. Eine genauere Beschreibung der Möglichkeiten befindet sich hier: Variablenprofile
Variablenwerte bearbeiten
Mit einem Doppelklick auf den Namen der Variablen kann das Profil einer Variable verändert oder die Variablenaufzeichnung in die Datenbank aktiviert werden.
Um die Werte einer Variable mitzuschneiden oder zu verändern, kann per Doppelklick auf den Wert der Variable das Fenster für den "Überwachungsmodus" aufgerufen werden. Alternativ kann per Kontextmenü auch der Eintrag “Variable verändern" auswählt werden.
Diese Funktion ist primär für Testzwecke konzipiert, um beispielsweise zu überprüfen, ob bei einer simulierten Temperatur die Heizung eingeschaltet wird. Außerdem ist es möglich die Darstellung des Variablenprofils im WebFront zu kontrollieren.
Das nachfolgende Bild zeigt das Fenster für den "Überwachungsmodus", in dem fortlaufend die Variablenwerte angezeigt werden und währenddessen modifiziert werden können. Ein Veränderung kann entweder über den Button “Schreiben” oder über die Return-Taste bestätigt werden.
Falls die Variable eine Status-Variable ist, kann der Wert modifiziert werden, obwohl dieser als schreibgeschützt markiert ist. Bei einer Wertänderung werden auch alle damit verbundenen Ereignisse ausgeführt. Das ist nützlich zum Testen eigener Ereignisse, ändert aber nicht die tatsächlichen Werte auf dem physikalischen Gerät.
Variablenaktionen
Einer Variable kann via "Eigene Aktion" eine Variablenaktion zugewiesen werden. Diese wird aufgerufen, wenn die Variable via Visualisierung (z.B. WebFront oder Mobile) angeklickt wird. Darüber hinaus wird die Variablenaktion ausgeführt, wenn die Variable geschaltet wird, beispielsweise über die Funktion RequestAction .