Dokumentation
Befehlsreferenz
Die Befehlsreferenz beinhaltet die Befehle, welche IP-Symcon zur Verfügung stellt und zur eigenen Verwaltung nutzt.
Hier befindet sich eine Auflistung der IP-Symcon spezifischen Befehle.
Eine Auflistung der modulspezifischen Befehle kann unter Modulreferenz gefunden werden.
Ablaufsteuerung
Funktionen in dieser Gruppe erlauben es, auf den Ablauf eines Skripts Einfluss zu nehmen.
| IPS_Execute | startet ein externes Programm |
| IPS_ExecuteEx | startet ein externes Programm im Userkontext |
| IPS_RunAction | führt eine einzelne Aktion aus |
| IPS_RunActionWait | führt eine einzelne Aktion aus und wartet auf das Resultat |
| IPS_RunScript | startet ein anderes IP-Symcon Skript |
| IPS_RunScriptEx | startet ein anderes IP-Symcon Skript und übergibt Variablen |
| IPS_RunScriptText | startet einen Text als IP-Symcon Skript |
| IPS_RunScriptTextEx | startet einen Text als IP-Symcon Skript und übergibt Variablen |
| IPS_RunScriptTextWait | startet einen Text als IP-Symcon Skript |
| IPS_RunScriptTextWaitEx | startet einen Text als IP-Symcon Skript und übergibt Variablen |
| IPS_RunScriptWait | startet ein anderes IP-Symcon Skript und wartet auf das Resultat |
| IPS_RunScriptWaitEx | startet ein anderes IP-Symcon Skript und übergibt Variablen |
| IPS_SemaphoreEnter | erlaubt die Synchronisation mit anderen, gleichzeitig laufenden Skripts |
| IPS_SemaphoreLeave | erlaubt die Synchronisation mit anderen, gleichzeitig laufenden Skripts |
| IPS_Sleep | verzögert ein Skript um ein bestimme zeit |
Ereignisverwaltung
Funktionen in dieser Gruppe dienen der Verwaltung von Kategorien.
| IPS_CreateEvent | legt ein neues Ereignis an |
| IPS_DeleteEvent | löscht eine bestehendes Ereignis |
| IPS_EventExists | prüft, ob ein Ereignis bereits existiert |
| IPS_GetEvent | liefert umfassende Informationen über ein Ereignis |
| IPS_GetEventIDByName | ermittelt die ID eines Ereignisses anhand des Namens |
| IPS_GetEventList | liefert eine Liste aller existierenden Ereignisse |
| IPS_GetEventListByType | liefert eine Liste aller Ereignisse eines bestimmten Typs |
| IPS_IsConditionPassing | prüft ob eine Bedingung erfüllt ist |
| IPS_SetEventAction | setzt die auszuführende Aktion |
| IPS_SetEventActive | aktiviert/deaktiviert ein Ereignis |
| IPS_SetEventCondition | modifiziert die Bedingung eines Ereignisses |
| IPS_SetEventConditionDateRule | modifiziert die Regel einer Bedingung eines Ereignisses für Datumsvergleiche |
| IPS_SetEventConditionDayOfTheWeekRule | modifiziert die Regel einer Bedingung eines Ereignisses für Wochentagsvergleiche |
| IPS_SetEventConditionTimeRule | modifiziert die Regel einer Bedingung eines Ereignisses für Uhrzeitvergleiche |
| IPS_SetEventConditionVariableDynamicRule | modifiziert die Regel einer Bedingung eines Ereignisses für Variablenvergleiche |
| IPS_SetEventConditionVariableRule | modifiziert die Regel einer Bedingung eines Ereignisses für Variablenvergleiche |
| IPS_SetEventConditionVariableStaticRule | modifiziert die Regel einer Bedingung eines Ereignisses für Variablenvergleiche |
| IPS_SetEventCyclic | konfiguriert ein zyklisches Ereignis |
| IPS_SetEventCyclicDateBounds | konfiguriert die Zeitspanne (Datum) |
| IPS_SetEventCyclicDateFrom | konfiguriert das Startdatum |
| IPS_SetEventCyclicDateTo | konfiguriert das Enddatum |
| IPS_SetEventCyclicTimeBounds | konfiguriert die Zeitspanne (Zeit) |
| IPS_SetEventCyclicTimeFrom | konfiguriert die Startzeit |
| IPS_SetEventCyclicTimeTo | konfiguriert die Endzeit |
| IPS_SetEventLimit | limitiert die Anzahl der Ereignissaufrufe |
| IPS_SetEventScheduleAction | modifiziert die Aktionsstabelle eines Wochenplans und setzt die Aktion dabei auf "Führe PHP Code aus" |
| IPS_SetEventScheduleActionEx | modifiziert die Aktionsstabelle eines Wochenplans |
| IPS_SetEventScheduleGroup | modifiziert die Gruppierung der Tage eines Wochenplans |
| IPS_SetEventScheduleGroupPoint | modifiziert einen Schaltpunkt der Gruppe eines Wochenplans |
| IPS_SetEventScript | setzt die Aktion auf "Führe PHP Code aus" und definiert den auszuführenden Code |
| IPS_SetEventTrigger | konfiguriert ein ausgelöstes Ereignis |
| IPS_SetEventTriggerSubsequentExecution | konfiguriert, ob Ereignis bei gleichem Wert erneut ausgelöst wird |
| IPS_SetEventTriggerValue | konfiguriert den Wert bei dem Ausgelöst werden sol |
Instanzenverwaltung
Funktionen in dieser Gruppe dienen der Verwaltung von Instanzen.
| Debug | |||||||||||||||||
| |||||||||||||||||
| IPS_CreateInstance | legt eine Instanz an | ||||||||||||||||
| IPS_DeleteInstance | löscht eine Instanz | ||||||||||||||||
| IPS_GetInstance | liefert umfassende Informationen zu einer bestimmten Instanz | ||||||||||||||||
| IPS_GetInstanceIDByName | liefert die ID einer Instanz anhand des Namens | ||||||||||||||||
| IPS_GetInstanceList | liefert eine Aufstellung aller existierenden Instanzen | ||||||||||||||||
| IPS_GetInstanceListByModuleID | liefert alle Instanzen die von einer bestimmten ModulID sind | ||||||||||||||||
| IPS_GetInstanceListByModuleType | liefert eine Liste aller Instanzen eines bestimmten Typs | ||||||||||||||||
| IPS_InstanceExists | prüft, ob eine bestimmte Instanz existiert | ||||||||||||||||
| Konfiguration | |||||||||||||||||
| |||||||||||||||||
| Referenzen | |||||||||||||||||
| |||||||||||||||||
| StatusVariablen | |||||||||||||||||
| Verbindungen | |||||||||||||||||
| |||||||||||||||||
Kategorieverwaltung
Funktionen in dieser Gruppe dienen der Verwaltung von Kategorien.
| IPS_CategoryExists | prüft, ob eine Kategorie bereits existiert |
| IPS_CreateCategory | legt eine neue Kategorie an |
| IPS_DeleteCategory | löscht eine bestehende Kategorie |
| IPS_GetCategoryIDByName | sucht und liefert die ID einer bestehenden Kategorie über dessen Namen |
| IPS_GetCategoryList | liefert eine Liste aller existierenden Kategorien |
Linkverwaltung
Funktionen in dieser Gruppe dienen der Verwaltung von Links.
| IPS_CreateLink | legt einen neuen Link an |
| IPS_DeleteLink | löscht einen bestehenden Link |
| IPS_GetLink | liefert umfassende Informationen über einen Link |
| IPS_GetLinkIDByName | ermittelt die ID eines Links anhand des Namens |
| IPS_GetLinkList | liefert eine Liste aller existierenden Links |
| IPS_LinkExists | prüft, ob ein Link bereits existiert |
| IPS_SetLinkTargetID | setzt die Verknüpfung für den Link |
Medienverwaltung
Funktionen in dieser Gruppe dienen der Medienverwaltung.
| IPS_CreateMedia | legt ein neues Medienobjekt im MedienPool an |
| IPS_DeleteMedia | löscht ein Medienobjekt aus dem MedienPool |
| IPS_GetMedia | liefert umfassende Information über ein bestimmtes Medienobjekt |
| IPS_GetMediaContent | liefert den Inhalt eines Medienobjekts |
| IPS_GetMediaID | ermittelt die ID eines Medienobjekts |
| IPS_GetMediaIDByFile | ermittelt die ID eines Medienobjekts anhand der Datei |
| IPS_GetMediaIDByName | ermittelt die ID eines Medienobjekts anhand des Namens |
| IPS_GetMediaList | liefert eine Liste aller Medienobjekte im MedienPool |
| IPS_GetMediaListByType | liefert eine Liste aller Medienobjekte eines bestimmten Typs |
| IPS_MediaExists | prüft, ob sich ein bestimmtes Medienobjekt bereits im MedienPool befindet |
| IPS_SendMediaEvent | sendet eine Mitteilung, dass ein Medienobjekt sich geändert hat |
| IPS_SetMediaCached | aktiviert, dass ein Medienobjekt nur im Arbeitsspeicher bearbeitet wird |
| IPS_SetMediaContent | setzt den Inhalt eines Medienobjekts |
| IPS_SetMediaFile | bindet eine Mediendatei an ein Medienobjekt |
Modulverwaltung
Funktionen in dieser Gruppe dienen der Verwaltung von Modulen und Bibliotheken.
| IPS_GetCompatibleModules | liefert alle Kompatiblen Module zu einem bestimmten Modul |
| IPS_GetLibrary | gibt Details zu einer Bibliothek |
| IPS_GetLibraryList | liefert eine Liste der Bibliotheken |
| IPS_GetLibraryModules | gibt eine Liste der Module einer Bibliothek |
| IPS_GetModule | gibt Details zu einem Modul |
| IPS_GetModuleList | gibt eine Liste aller Module |
| IPS_GetModuleListByType | gibt eine Liste aller Module des typs |
| IPS_IsModuleCompatible | überprüft, ob zwei Modul miteinander Kompatibel sind |
| IPS_LibraryExists | überprüft, ob Bibliothek existiert |
| IPS_ModuleExists | überprüft, ob Modul existiert |
Objektverwaltung
Funktionen in dieser Gruppe erlauben es, Objekte zu manipulieren.
| IPS_GetChildrenIDs | liefert eine Aufstellung aller untergeordneten Objekte |
| IPS_GetLocation | liefert den kompletten Pfad des Objekts |
| IPS_GetName | liefert den Namen des Objekts |
| IPS_GetObject | liefert umfassende Informationen über ein Objekt |
| IPS_GetObjectIDByIdent | liefert die ID eines Objekts anhand des Identifikators |
| IPS_GetObjectIDByName | liefert die ID eines Objekts anhand des Namens |
| IPS_GetObjectList | liefert eine Aufstellung aller existierenden Objekte |
| IPS_GetParent | liefert die ParentID des Objekts |
| IPS_HasChildren | prüft, ob Objekt untergeordnete Objekte hat |
| IPS_IsChild | prüft, ob Objekt einem anderen Objekt untergeordnet ist |
| IPS_ObjectExists | prüft, ob ein bestimmtes Objekt existiert |
| IPS_SetDisabled | Setzt ein Objekt für das WebFront inaktiv |
| IPS_SetHidden | setzt die Sichtbarkeit eines beliebigen Objekts |
| IPS_SetIcon | ordnet einem beliebigen Objekt ein Icon zu |
| IPS_SetIdent | ordnet einem beliebigen Objekt einen Identifikator zu |
| IPS_SetInfo | ordnet einem beliebigen Objekt erweiterte Informationen zu |
| IPS_SetName | ordnet einem beliebigen Objekt einen Namen zu |
| IPS_SetParent | verschiebt ein Objekt im logischen Strukturbaum |
| IPS_SetPosition | ordnet einem beliebigen Objekt eine Position zu |
Programminformationen
Funktionen in dieser Gruppe liefern Informationen zu IP-Symcon selbst.
| IPS_FunctionExists | prüft, ob eine bestimmte Funktion existiert |
| IPS_GetFunction | liefert umfassende Informationen über eine Funktion |
| IPS_GetFunctionList | liefert eine Liste mit allen Verfügbaren Funktionsnamen |
| IPS_GetFunctionListByModuleID | liefert eine Liste mit allen verfügbaren Funktionen eines Moduls |
| IPS_GetKernelArchitecture | liefert die Architektur für die IP-Symcon erstellt wurde |
| IPS_GetKernelDate | liefert das Datum der Erstellung des Kernels |
| IPS_GetKernelDir | liefert den Pfad zum IP-Symcon Programmverzeichnis |
| IPS_GetKernelDirEx | liefert den Pfad zum IP-Symcon Installationsverzeichnis |
| IPS_GetKernelDirSpace | Liefert freien/verfügbaren/gesamt Speicherplatz auf dem Laufwerk, auf dem alle Daten von IP-Symcon gespeichert werden |
| IPS_GetKernelPlatform | liefert das Betriebssystem auf dem IP-Symcon läuft |
| IPS_GetKernelRevision | liefert eine eindeutige Revisionskennung |
| IPS_GetKernelRunlevel | liefert den Runlevel des Kernels |
| IPS_GetKernelStartTime | liefert den Zeitpunkt, an dem IP-Symcon gestartet wurde |
| IPS_GetKernelVersion | liefert die Versionsnummer des verwendeten Kernels |
| IPS_GetLogDir | liefert den Pfad zum IP-Symcon Logverzeichnis |
| IPS_GetSystemLanguage | liefert die Sytemsprache des Betriebssystems auf dem IP-Symcon läuft |
| IPS_GetUpdateChannel | liefert den aktuellen konfigurierten Update-Kanal zurück |
| IPS_LogMessage | schreibt eine benutzerdefinierte Meldung in die Log-Datei |
Skriptverwaltung
Funktionen in dieser Gruppe dienen der Skriptsteuerung und -verwaltung.
| IPS_CreateScript | legt ein neues Skript an |
| IPS_DeleteScript | entfernt eine bestehendes Skript aus der Skriptliste |
| IPS_GetScript | liefert umfassende Informationen über ein Skript |
| IPS_GetScriptContent | liefert den Inhalt eines Skripts |
| IPS_GetScriptEventList | liefert alle Ereignisse die einem Skript zugeordnet sind |
| IPS_GetScriptFile | ermittelt den Dateinamen zur SkriptID |
| IPS_GetScriptIDByFile | liefert die ID eines Skripts andhand der Datei |
| IPS_GetScriptIDByName | liefert die ID eines Skripts andhand des Namens |
| IPS_GetScriptList | liefert eine Aufstellung aller existierenden Skripte |
| IPS_GetScriptTimer | ermittelt den Startwert des ScriptTimers |
| IPS_ScriptExists | prüft, ob ein bestimmtes Skript existiert |
| IPS_SetScriptContent | setzt den Inhalt eines Skripts |
| IPS_SetScriptFile | ordnet einem Skript einen Dateinamen zu |
| IPS_SetScriptTimer | setzt den Startwert des ScriptTimers |
Variablenverwaltung
Funktionen in dieser Gruppe dienen der Variablenvarwaltung und Variablenwertänderung.
| IPS_CreateVariable | legt eine Variable an | ||||||||||||||||||||||
| IPS_DeleteVariable | löscht eine Variable | ||||||||||||||||||||||
| IPS_GetVariable | liefert umfassende Informationen zu einer bestimmten Variablen | ||||||||||||||||||||||
| IPS_GetVariableEventList | liefert alle Ereignisse die einer Variable zugeordnet sind | ||||||||||||||||||||||
| IPS_GetVariableIDByName | liefert die ID einer Variablen anhand des Namens | ||||||||||||||||||||||
| IPS_GetVariableList | liefert eine Liste aller existierenden Variablen | ||||||||||||||||||||||
| IPS_SetVariableCustomAction | ordnet der Variable ein benutzerdefiniertes Aktionsskript zu | ||||||||||||||||||||||
| IPS_SetVariableCustomProfile | ordnet der Variable ein benutzerdefiniertes Profil zu | ||||||||||||||||||||||
| IPS_VariableExists | prüft, ob eine bestimmte Variable existiert | ||||||||||||||||||||||
| Variablenprofile | |||||||||||||||||||||||
| |||||||||||||||||||||||
Variablenzugriff
Funktionen in dieser Gruppe sind für den lesenden und schreibenden Zugriff auf IP-Symcon Variable
| GetValue | holt den Wert einer IP-Symcon Variable unabhängig des Typs |
| GetValueBoolean | holt den Wert einer IP-Symcon Variable vom Typ Boolean |
| GetValueFloat | holt den Wert einer IP-Symcon Variable vom Typ Float |
| GetValueFormatted | holt den Wert einer IP-Symcon Variable und formatiert ihn anhand des Profils |
| GetValueFormattedEx | gibt einen Wert formatiert anhand des Profils einer Variable zurück |
| GetValueInteger | holt den Wert einer IP-Symcon Variable vom Typ Integer |
| GetValueString | holt den Wert einer IP-Symcon Variable vom Typ String |
| HasAction | prüft, ob eine Aktion definiert ist |
| RequestAction | führe die Aktion einer IP-Symcon Variable aus |
| RequestActionEx | führe die Aktion einer IP-Symcon Variable mit individuellen Sender aus |
| SetValue | setzt den Wert einer IP-Symcon Variable unabhängig des Typs |
| SetValueBoolean | setzt den Wert einer IP-Symcon Variable vom Typ Boolean |
| SetValueFloat | setzt den Wert einer IP-Symcon Variable vom Typ Float |
| SetValueInteger | setzt den Wert einer IP-Symcon Variable vom Typ Integer |
| SetValueString | setzt den Wert einer IP-Symcon Variable vom Typ String |