Was können wir verbessern?

Dokumentation

Befehlsreferenz

Eine Auflistung der modulspezifischen Befehle finden Sie in der Modulreferenz.

Ablaufsteuerung

Befehle in dieser Gruppe erlauben es, auf den Ablauf eines Skripts Einfluss zu nehmen.

IPS_Executestartet ein externes Programm
IPS_ExecuteExstartet ein externes Programm im Userkontext
IPS_RunScriptstartet ein anderes IP-Symcon Skript
IPS_RunScriptExstartet ein anderes IP-Symcon Skript und übergibt Variablen
IPS_RunScriptTextstartet einen Text als IP-Symcon Skript
IPS_RunScriptTextExstartet einen Text als IP-Symcon Skript und übergibt Variablen
IPS_RunScriptTextWaitstartet einen Text als IP-Symcon Skript
IPS_RunScriptTextWaitExstartet einen Text als IP-Symcon Skript und übergibt Variablen
IPS_RunScriptWaitstartet ein anderes IP-Symcon Skript und wartet auf das Resultat
IPS_RunScriptWaitExstartet ein anderes IP-Symcon Skript und übergibt Variablen
IPS_SemaphoreEntererlaubt die Synchronisation mit anderen, gleichzeitig laufenden Skripts
IPS_SemaphoreLeaveerlaubt die Synchronisation mit anderen, gleichzeitig laufenden Skripts
IPS_Sleepverzögert ein Skript um ein bestimme zeit

Ereignisverwaltung

Befehle in dieser Gruppe dienen der Verwaltung von Kategorien.

IPS_CreateEventlegt ein neues Ereignis an
IPS_DeleteEventlöscht eine bestehendes Ereignis
IPS_EventExistsprüft, ob ein Ereignis bereits existiert
IPS_GetEventliefert umfassende Informationen über ein Ereignis
IPS_GetEventIDByNameermittelt die ID eines Ereignisses anhand des Namens
IPS_GetEventListliefert eine Liste aller existierenden Ereignisse
IPS_GetEventListByTypeliefert eine Liste aller Ereignisse eines bestimmten Typs
IPS_SetEventActiveaktiviert/deaktiviert ein Ereignis
IPS_SetEventCyclickonfiguriert ein zyklisches Ereignis
IPS_SetEventCyclicDateBoundskonfiguriert die Zeitspanne (Datum)
IPS_SetEventCyclicDateFromkonfiguriert das Startdatum
IPS_SetEventCyclicDateTokonfiguriert das Enddatum
IPS_SetEventCyclicTimeBoundskonfiguriert die Zeitspanne (Zeit)
IPS_SetEventCyclicTimeFromkonfiguriert die Startzeit
IPS_SetEventCyclicTimeTokonfiguriert die Endzeit
IPS_SetEventLimitlimitiert die Anzahl der Ereignissaufrufe
IPS_SetEventScheduleActionmodifiziert die Aktionsstabelle eines Wocheplans
IPS_SetEventScheduleGroupmodifiziert die Gruppierung der Tage eines Wocheplans
IPS_SetEventScheduleGroupPointmodifiziert einen Schaltpunkt der Gruppe eines Wocheplans
IPS_SetEventScriptsetzt den auszuführenden Skriptinhalt
IPS_SetEventTriggerkonfiguriert ein ausgelöstes Ereignis
IPS_SetEventTriggerSubsequentExecutionkonfiguriert, ob Ereignis bei gleichem Wert erneut ausgelöst wird
IPS_SetEventTriggerValuekonfiguriert den Wert bei dem Ausgelöst werden sol

Instanzenverwaltung

Befehle in dieser Gruppe dienen der Verwaltung von Instanzen.

IPS_CreateInstancelegt eine Instanz an
IPS_DeleteInstancelöscht eine Instanz
IPS_GetInstanceliefert umfassende Informationen zu einer bestimmten Instanz
IPS_GetInstanceIDByNameliefert die ID einer Instanz anhand des Namens
IPS_GetInstanceListliefert eine Aufstellung aller existierenden Instanzen
IPS_GetInstanceListByModuleIDliefert alle Instanzen die von einer bestimmten ModulID sind
IPS_GetInstanceListByModuleTypeliefert eine Liste aller Instanzen eines bestimmten Typs
IPS_InstanceExistsprüft, ob eine bestimmte Instanz existiert
Konfiguration
IPS_ApplyChangesübernimmt eine veränderte Konfiguration
IPS_GetConfigurationliest eine Konfiguration aus
IPS_GetConfigurationFormliest eine Konfigurationseite aus
IPS_GetPropertyliest den aktuellen Wert einer Eigenschaft
IPS_HasChangesprüft, ob eine Konfiguration verändert wurde
IPS_ResetChangessetzt eine veränderte Konfiguration auf die aktuelle zurück
IPS_SetConfigurationsetzt eine neue Konfiguration
IPS_SetPropertysetzt einen neuen Wert für eine Eigenschaft
StatusVariablen
IPS_GetStatusVariableliefert umfassende Informationen zu einer bestimmten Status Variable
IPS_GetStatusVariableIDliefert alle Status Variablen zu einer bestimmten Instanz
IPS_GetStatusVariableIdentsliefert die VariablenIdents einer Status Variable
IPS_SetStatusVariableUseActionsetzt, ob die Standardaktion einer Status Variable genutzt werden soll
IPS_StatusVariableExistsprüft, ob eine bestimmte Status Variable existiert
Verbindungen
IPS_ConnectInstanceerstellt eine (Daten-)Verbindung zwischen zwei Instanzen
IPS_DisconnectInstancelöst eine (Daten-)Verbindung zwischen zwei Instanzen
IPS_GetCompatibleInstancesliefert kompatible Instanzen zu einer Instanz
IPS_GetInstanceChildrenIDsliefert die InstanzIDs der untergeordneten Instanzen
IPS_GetInstanceParentIDliefert die InstanzID der übergeordneten Instanz
IPS_HasInstanceChildrenprüft, ob die Instanz mit untergeordneten Instanzen verbunden ist
IPS_HasInstanceParentprüft, ob die Instanz mit einer übergeordneten Instanz verbunden ist
IPS_IsInstanceCompatibleprüft, ob eine Verbindung zwischen zwei Instanzen möglich ist

Kategorieverwaltung

Befehle in dieser Gruppe dienen der Verwaltung von Kategorien.

IPS_CategoryExistsprüft, ob eine Kategorie bereits existiert
IPS_CreateCategorylegt eine neue Kategorie an
IPS_DeleteCategorylöscht eine bestehende Kategorie
IPS_GetCategoryIDByNamesucht und liefert die ID einer bestehenden Kategorie über dessen Namen
IPS_GetCategoryListliefert eine Liste aller existierenden Kategorien

Linkverwaltung

Befehle in dieser Gruppe dienen der Verwaltung von Links.

IPS_CreateLinklegt einen neuen Link an
IPS_DeleteLinklöscht einen bestehenden Link
IPS_GetLinkliefert umfassende Informationen über einen Link
IPS_GetLinkIDByNameermittelt die ID eines Links anhand des Namens
IPS_GetLinkListliefert eine Liste aller existierenden Links
IPS_LinkExistsprüft, ob ein Link bereits existiert
IPS_SetLinkChildIDsetzt die Verknüpfung für den Link (veraltet)
IPS_SetLinkTargetIDsetzt die Verknüpfung für den Link

Medienverwaltung

Befehle in dieser Gruppe dienen der Medienverwaltung.

IPS_CreateMedialegt ein neues Medienobjekt im MedienPool an
IPS_DeleteMedialöscht ein Medienobjekt aus dem MedienPool
IPS_GetMedialiefert umfassende Information über ein bestimmtes Medienobjekt
IPS_GetMediaContentliefert den Inhalt eines Medienobjekts
IPS_GetMediaIDermittelt die ID eines Medienobjekts
IPS_GetMediaIDByFileermittelt die ID eines Medienobjekts anhand der Datei
IPS_GetMediaIDByNameermittelt die ID eines Medienobjekts anhand des Namens
IPS_GetMediaListliefert eine Liste aller Medienobjekte im MedienPool
IPS_GetMediaListByTypeliefert eine Liste aller Medienobjekte eines bestimmten Typs
IPS_MediaExistsprüft, ob sich ein bestimmtes Medienobjekt bereits im MedienPool befindet
IPS_SendMediaEventsendet eine Mitteilung, dass ein Medienobjekt sich geändert hat
IPS_SetMediaCachedaktiviert, dass ein Medienobjekt nur im Arbeitsspeicher bearbeitet wird
IPS_SetMediaContentsetzt den Inhalt eines Medienobjekts
IPS_SetMediaFilebindet eine Mediendatei an ein Medienobjekt

Modulverwaltung

Befehle in dieser Gruppe dienen der Verwaltung von Modulen und Bibliotheken.

IPS_GetCompatibleModulesliefert alle Kompatiblen Module zu einem bestimmten Modul
IPS_GetLibrarygibt Details zu einer Bibliothek
IPS_GetLibraryListliefert eine Liste der Bibliotheken
IPS_GetLibraryModulesgibt eine Liste der Module einer Bibliothek
IPS_GetModulegibt Details zu einem Modul
IPS_GetModuleListgibt eine Liste aller Module
IPS_GetModuleListByTypegibt 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

Befehle in dieser Gruppe erlauben es, Objekte zu manipulieren.

IPS_GetChildrenIDsliefert eine Aufstellung aller untergeordneten Objekte
IPS_GetLocationliefert den kompletten Pfad des Objekts
IPS_GetNameliefert den Namen des Objekts
IPS_GetObjectliefert umfassende Informationen über ein Objekt
IPS_GetObjectIDByIdentliefert die ID eines Objekts anhand des Identifikators
IPS_GetObjectIDByNameliefert die ID eines Objekts anhand des Namens
IPS_GetObjectListliefert eine Aufstellung aller existierenden Objekte
IPS_GetParentliefert die ParentID des Objekts
IPS_HasChildrenprüft, ob Objekt untergeordnete Objekte hat
IPS_IsChildprüft, ob Objekt einem anderen Objekt untergeordnet ist
IPS_IsPersistentprüft, ob Objekt persistent ist
IPS_ObjectExistsprüft, ob ein bestimmtes Objekt existiert
IPS_SetDisabledSetzt ein Objekt für das WebFront inaktiv
IPS_SetHiddensetzt die Sichtbarkeit eines beliebigen Objekts
IPS_SetIconordnet einem beliebigen Objekt ein Icon zu
IPS_SetIdentordnet einem beliebigen Objekt einen Identifikator zu
IPS_SetInfoordnet einem beliebigen Objekt erweiterte Informationen zu
IPS_SetNameordnet einem beliebigen Objekt einen Namen zu
IPS_SetParentverschiebt ein Objekt im logischen Strukturbaum
IPS_SetPositionordnet einem beliebigen Objekt eine Position zu

Programminformationen

Befehle in dieser Gruppe liefern Informationen zu IP-Symcon selbst.

IPS_FunctionExistsprüft, ob eine bestimmte Funktion existiert
IPS_GetFunctionliefert umfassende Informationen über eine Funktion
IPS_GetFunctionListliefert eine Liste mit allen Verfügbaren Funktionen
IPS_GetKernelDirliefert den Pfad zum IP-Symcon Programmverzeichnis
IPS_GetKernelDirExliefert den Pfad zum IP-Symcon Installationsverzeichnis
IPS_GetKernelRunlevelliefert den Runlevel des Kernels
IPS_GetKernelStartTimeliefert den Zeitpunkt, an dem IP-Symcon gestartet wurde
IPS_GetKernelVersionliefert die Versionsnummer des verwendeten Kernels
IPS_GetLogDirliefert den Pfad zum IP-Symcon Logverzeichnis
IPS_GetUptimeliefert den Zeitpunkt, an dem IP-Symcon gestartet wurde
IPS_LogMessageschreibt eine benutzerdefinierte Meldung in die Log-Datei

Skriptverwaltung

Befehle in dieser Gruppe dienen der Skriptsteuerung und -verwaltung.

IPS_CreateScriptlegt ein neues Skript an
IPS_DeleteScriptentfernt eine bestehendes Skript aus der Skriptliste
IPS_GetScriptliefert umfassende Informationen über ein Skript
IPS_GetScriptContentliefert den Inhalt eines Skripts
IPS_GetScriptEventListliefert alle Ereignisse die einem Skript zugeordnet sind
IPS_GetScriptFileermittelt den Dateinamen zur SkriptID
IPS_GetScriptIDliefert die ID eines Skripts
IPS_GetScriptIDByFileliefert die ID eines Skripts andhand der Datei
IPS_GetScriptIDByNameliefert die ID eines Skripts andhand des Namens
IPS_GetScriptListliefert eine Aufstellung aller existierenden Skripte
IPS_GetScriptTimerermittelt den Startwert des ScriptTimers
IPS_ScriptExistsprüft, ob ein bestimmtes Skript existiert
IPS_SetScriptContentsetzt den Inhalt eines Skripts
IPS_SetScriptFileordnet einem Skript einen Dateinamen zu
IPS_SetScriptTimersetzt den Startwert des ScriptTimers

Variablenverwaltung

Befehle in dieser Gruppe dienen der Variablenvarwaltung und Variablenwertänderung.

IPS_CreateVariablelegt eine Variable an
IPS_DeleteVariablelöscht eine Variable
IPS_GetVariableliefert umfassende Informationen zu einer bestimmten Variablen
IPS_GetVariableEventListliefert alle Ereignisse die einer Variable zugeordnet sind
IPS_GetVariableIDliefert die ID einer Variablen
IPS_GetVariableIDByNameliefert die ID einer Variablen anhand des Namens
IPS_GetVariableListliefert eine Liste aller existierenden Variablen
IPS_SetVariableCustomActionordnet der Variable ein benutzerdefiniertes Aktionsskript zu
IPS_SetVariableCustomProfileordnet der Variable ein benutzerdefiniertes Profil zu
IPS_VariableExistsprüft, ob eine bestimmte Variable existiert
Variablenprofile
IPS_CreateVariableProfilelegt ein Variablenprofil an
IPS_DeleteVariableProfilelöscht ein Variablenprofil
IPS_GetVariableProfileliefert umfassende Informationen zu einem bestimmten Variablenprofil
IPS_GetVariableProfileListliefert eine Liste aller existierenden Variablenprofile
IPS_GetVariableProfileListByTypeliefert eine Liste aller existierenden Variablenprofile eines bestimmten Typs
IPS_SetVariableProfileAssociationmodifiziert die Assoziationstabelle eines Variablenprofils
IPS_SetVariableProfileDigitssetzt die Anzahl der Nachkommastellen eines Variablenprofils
IPS_SetVariableProfileIconsetzt das Icon eines Variablenprofils
IPS_SetVariableProfileTextsetzt das Prefix und Suffix eines Variablenprofils
IPS_SetVariableProfileValuessetzt den Minimalwert, Maximalwert und die Schrittweite eines Variablenprofils
IPS_VariableProfileExistsprüft, ob ein bestimmtes Variablenprofil existiert

Variablenzugriff

Befehle in dieser Gruppe sind für den lesenden und schreibenden Zugriff auf IP-Symcon Variable

GetValueholt den Wert einer IP-Symcon Variable unabhängig des Typs
GetValueBooleanholt den Wert einer IP-Symcon Variable vom Typ Boolean
GetValueFloatholt den Wert einer IP-Symcon Variable vom Typ Float
GetValueFormattedholt den Wert einer IP-Symcon Variable und formatiert ihn anhand des Profils
GetValueIntegerholt den Wert einer IP-Symcon Variable vom Typ Integer
GetValueStringholt den Wert einer IP-Symcon Variable vom Typ String
SetValuesetzt den Wert einer IP-Symcon Variable unabhängig des Typs
SetValueBooleansetzt den Wert einer IP-Symcon Variable vom Typ Boolean
SetValueFloatsetzt den Wert einer IP-Symcon Variable vom Typ Float
SetValueIntegersetzt den Wert einer IP-Symcon Variable vom Typ Integer
SetValueStringsetzt den Wert einer IP-Symcon Variable vom Typ String