Was können wir verbessern?

Dokumentation

Systemvariablen

Systemvariablen sind Variablen, die in jedem Skript verfügbar sind. Der Benutzer kann diese nutzen um effizient Skripte erstellen zu können, welche generisch Aufgaben lösen können. Je nach Absender, durch den das Skript ausgeführt wurde, werden automatisch passende Systemvariablen erstellt und zur Verfügung gestellt. Die nachfolgende Tabelle gibt einen Überblick bei welchem Skript welche Variablen automatisch zur Verfügung stehen.

Die Groß- und Kleinschreibung der Variablen ist zu beachten (Case-Sensitive)!

Tabelle: Generelle Systemvariablen

Folgende Systemvariablen stehen immer zur Verfügung.

Systemvariable Beschreibung
$_IPS['SELF'] SkriptID des aktuellen Skriptes
$_IPS['THREAD'] ThreadID des aktuellen Skriptes
$_IPS['SENDER'] Auslöser des Skriptes. Abhängig vom Wert können sich weitere globale Variablen ergeben. Mögliche Werte sind in der folgenden Tabelle "Zusätzliche Systemvariablen" genauer spezifiziert.

Tabelle: Zusätzliche Systemvariablen

Folgende Systemvariablen stehen in Abhängigkeit des $_IPS['SENDER'] zur Verfügung.

Designer

Wenn das Skript durch eine Komponente des Dashboards ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['COMPONENT'] Inhalt des Feldes IPSYMID. Dieser Wert hat immer den Typ String
$_IPS['FORM'] FormID des Formulars, von dem die Anfrage ausgeführt worden ist

Execute

Wenn das Skript aus der Verwaltungskonsole ausgeführt wurde.
Keine zusätzlichen Systemvariablen.

HeatingControl

Wenn das Skript durch ein Ereignis vom HeatingControl ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['INSTANCES'] IDs der Sende-Instanzen
$_IPS['INVERTS'] Beinhaltet ob ein Gerät invertiert ist (true/false)
$_IPS['VALUE'] Enthält ob das Gerät heizen soll (true) oder nicht heizen soll (false)

ISDN (bis Version 3.4)

Wenn das Skript durch ein Ereignis vom ISDN-Modul ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['CONNECTION'] KanalID der Verbindung
$_IPS['DATA'] Beinhaltet die gedrückte Taste, wenn das $_IPS['EVENT'] gleich DTMF ist
$_IPS['EVENT'] Die Variable kann folgende Werte beinhalten:
Incoming: Bei eingehendem Anruf
Connect: Bei aufgebauter Verbindung
Disconnect: Bei beendeter Verbindung
PlayFinish: Sobald Audiodatei zuende abgespielt wurde
DTMF: Sobald ein DTMF Ton empfangen wurde

RegisterVariable

Wenn das Skript durch eine RegisterVariable Instanz ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['INSTANCE'] ID der auslösenden RegisterVariable Instanz
$_IPS['VALUE'] Wert des Puffers, der vom Splitter oder I/O Modul empfangen wurde
$_IPS['CLIENTIP'] (nur bei I/O ServerSocket) Empfangene IP-Adresse des Clients
$_IPS['CLIENTPORT'] (nur bei I/O ServerSocket) Empfangsport des Clients
$_IPS['TYPE'] Status des Empfangsport (0 = Data; 1 = Verbunden; 2 = Getrennt)

RunScript

Wenn das Skript durch eine IPS_RunScript Funktionen ausgeführt wurde. Erweiternd kann auch IPS_RunScriptEx genutzt werden um zusätzliche Parameter zu übergeben.
Keine zusätzlichen Systemvariablen.

Shutdown

Beim IP-Symcon Shutdown (siehe EventControl).
Keine zusätzlichen Systemvariablen.

ShutterControl

Wenn das Skript durch ein ShutterControl Modul (legacy) ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['DIRECTION'] Zu fahrende Richtung:
0 = Stop
1 = Hoch
2 = Runter
$_IPS['DURATION'] Fahrdauer in Millisekunden
$_IPS['INSTANCE'] InstanzID, die im ShutterControl eingestellt ist
$_IPS['INSTANCE2'] InstanzID #2, die im ShutterControl eingestellt ist

Startup

Beim IP-Symcon Startup (siehe EventControl).
Keine zusätzlichen Systemvariablen.

StatusEvent

Wenn das Skript durch eine Statusveränderung einer Instanz ausgeführt wurde.
Nähere Informationen sind unter EventControl und IPS_GetInstance zu finden.

Systemvariable Beschreibung
$_IPS['INSTANCE'] InstanzID zur Statusänderung
$_IPS['STATUS'] Status der Instanz. Eine Auflistung ist hier zu finden: IPS_GetInstance
$_IPS['STATUSTEXT'] Kurztext passend zum Status

TimerEvent

Wenn das Skript durch ein zyklisches- oder Wochenplan-Ereignis ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['ACTION'] ID der aufzurufenden Aktion (nur Wochenplan Ereignis)
$_IPS['EVENT'] ID des auslösenden Ereignisses
$_IPS['TARGET'] ID des übergeordneten Objektes

Variable

Wenn das Skript durch ein Variablenereignis ("ausgelöstes Ereignis") ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['EVENT'] ID des auslösenden Ereignisses
$_IPS['OLDCHANGED']
(ab Version 5.1)
Zeitstempel der letzten Änderung des alten Wertes
$_IPS['OLDVALUE'] Wert der auslösenden Variable vor Auslösezeitpunkt
$_IPS['OLDUPDATED']
(ab Version 5.1)
Zeitstempel der letzten Aktualisierung des alten Wertes
$_IPS['TARGET'] ID des übergeordneten Objektes
$_IPS['TRIGGER'] Typ des auslösenden Ereignisses
$_IPS['VALUE'] Wert der auslösenden Variable zum Auslösezeitpunkt
$_IPS['VARIABLE'] ID der auslösenden Variable

Watchdog

Wenn das Skript durch den Watchdog ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['STATUSTEXT'] Der Statustext der übergeben wird
$_IPS['VALUE'] Wert der Variable, welcher außerhalb der Grenzen ist
$_IPS['VARIABLE'] ID der Variable, welche die Grenzen überschritten hat

WebFront

Wenn das Skript durch das WebFront ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['CONFIGURATOR'] ID des aktuell genutzten Konfigurators
$_IPS['VALUE'] (nur bei Aktionsskript) Neuer Wert der Variable
$_IPS['VARIABLE'] (nur bei Aktionsskript) ID der zu ändernden Variable

WebHook (ab Version 4.0)

Wenn das Skript durch einen WebHook ausgeführt wurde.

Systemvariable Beschreibung
$_SERVER['HOOK'] Vollständige URL des aufgerufenen WebHooks
$_GET Empfangene Daten über GET
$_POST Empfangene Daten über POST

WebInterface

Wenn das Skript durch den Webserver ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['INSTANCE'] ID der auslösenden WebServer Instanz
$_SERVER['DOCUMENT_ROOT'] Enthält das Document Root-Verzeichnis, unter dem das aktuelle Skript ausgeführt wird, so wie es in der Konfiguration des Servers festgelegt wurde
$_SERVER['HTTP_ACCEPT'] Enthält den Inhalt des Accept:-Headers des aktuellen Requests, sofern ein solcher gesendet wurde
$_SERVER['HTTP_ACCEPT_CHARSET'] Enthält den Inhalt des Accept-Charset:-Headers des aktuellen Requests, sofern ein solcher gesendet wurde
$_SERVER['HTTP_ACCEPT_ENCODING'] Enthält den Inhalt des Accept-Encoding:-Headers des aktuellen Requests, sofern ein solcher gesendet wurde
$_SERVER['HTTP_ACCEPT_LANGUAGE'] Enthält den Inhalt des Accept-Language:-Headers des aktuellen Requests, sofern ein solcher gesendet wurde. Beispiel: "en"
$_SERVER['HTTP_CACHE_CONTROL'] Wird genutzt, um Optionen festzulegen, denen durch alle Caching-Mechanismen entlang der Anfrage-/Antwort-Kette Folge geleistet werden muss
$_SERVER['HTTP_CONNECTION'] Enthält den Inhalt des Connection-Headers des aktuellen Requests, sofern ein solcher gesendet wurde. Beispiel: 'Keep-Alive'
$_SERVER['HTTP_CONTENT_ENCODING'] Enthält die Art der Codierung des Inhalts
$_SERVER['HTTP_COOKIE'] Enthält ein HTTP-Cookie, das zuvor vom Server gesetzt wurde
$_SERVER['HTTP_DATE'] Enthält den Zeitpunkt des Absendens
$_SERVER['HTTP_EXPIRES'] Enthält das Datum ab wann die Datei als veraltet angesehen werden kann
$_SERVER['HTTP_HOST'] Enthält den Inhalt des Host-Headers des aktuellen Requests, sofern ein solcher gesendet wurde
$_SERVER['HTTP_USER_AGENT'] Der User-Agent-String des Clients. In ihm stehen Informationen über den Client, sodass z. B. ein serverseitiges Skript an verschiedene Browser angepasste Inhalte ausliefern kann
$_SERVER['PHP_AUTH_PW'] Wenn HTTP authentication verwendet wird, wird diese Variable mit dem vom Benutzer angegebenen Passwort gefüllt
$_SERVER['PHP_AUTH_USER'] Wenn HTTP authentication verwendet wird, wird diese Variable mit dem vom Benutzer angegebenen Usernamen gefüllt
$_SERVER['PHP_SELF'] Datei/Pfad des gestarteten Skriptes
$_SERVER['QUERY_STRING'] Sofern vorhanden, der Querystring, mittels dessen auf die Seite zugegriffen wurde
$_SERVER['REMOTE_ADDR'] Die IP-Adresse, von der aus der Benutzer die aktuelle Seite ansieht
$_SERVER['REQUEST_METHOD'] Enthält die für den Zugriff auf die Seite verwendete Requestmethode, z. B. 'GET', 'HEAD', 'POST' oder 'PUT'
$_SERVER['REQUEST_URI'] Der URI, der angegeben wurde, um auf die aktuelle Seite zuzugreifen, beispielsweise '/index.html'
$_SERVER['SCRIPT_NAME'] Enthält den Pfad zum aktuellen Skript. Dies ist nützlich für Seiten, die auf sich selbst verweisen sollen

VoiceControl

Wenn das Skript durch ein Sprachsteuerungssystem (z.B. Alexa) ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['VALUE'] Beinhaltet den geschalteten Wert. Bei Szenen gibt dieser Wert beispielsweise an, ob die Szene aktiviert (true) oder deaktiviert (false) wurde. Bei einem Thermosstatwert würde der Wert den übertragenen Sollwert als Fließkommazahl beinhalten.

VoIP (ab Version 5.2)

Wenn das Skript durch ein Ereignis vom VoIP-Modul ausgeführt wurde.

Systemvariable Beschreibung
$_IPS['CONNECTION'] KanalID der Verbindung
$_IPS['DATA'] Beinhaltet die gedrückte Taste, wenn das $_IPS['EVENT'] gleich DTMF ist
$_IPS['EVENT'] Die Variable kann folgende Werte beinhalten:
Incoming: Bei eingehendem Anruf
Connect: Bei aufgebauter Verbindung
Disconnect: Bei beendeter Verbindung
PlayFinish: Sobald Audiodatei zuende abgespielt wurde
DTMF: Sobald ein DTMF Ton empfangen wurde
English website available
Zum Warenkorb
Haben Sie noch Fragen?