Skip to content

Instantly share code, notes, and snippets.

@Nall-chan
Last active May 13, 2023 19:22
Show Gist options
  • Save Nall-chan/e8772a4ded3590a74e99659796f72b36 to your computer and use it in GitHub Desktop.
Save Nall-chan/e8772a4ded3590a74e99659796f72b36 to your computer and use it in GitHub Desktop.
IPSModule with doc
<?php
/** @mainpage Reference list of IPSModule methods
*
* This file has been generated using IPSModuleDoku.php
*/
/**
* @file
* @brief generated ipsymcon ipsmodule reference using IPSModuleDoku.php
*/
class IPSModule
{
protected $InstanceID;
/**
* Der Konstruktor wird bei jeglichem Funktionsaufruf aufgerufen und kümmert sich um die Instanzierung.<br>
Die Basisklasse nutzt den Konstruktor um z.B. die InstanzID zu setzen.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/construct/
* @returns void Keine Rückgabe
* @param string $InstanzID ID dieser Instanz
*/
public function __construct(string $InstanzID)
{
}
/**
* Wird ausgeführt, wenn auf der Konfigurationsseite "Übernehmen" gedrückt wird und nach dem unittelbaren Erstellen der Instanz.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/applychanges/
* @returns void Keine Rückgabe
*/
public function ApplyChanges()
{
}
/**
* Die Funktion verbindet die Instanz mit einer vorhandenen übergeordneten kompatiblen (Parent) Instanz. Sollte diese nicht vorhanden sein, wird diese erstellt und anschließend verbunden.<br>
Eine Liste der verfügbaren ModulIDs (GUID) kann HIER entnommen werden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/connectparent/
* @returns void Keine Rückgabe
* @param string $ÜbergeordneteGUID GUID
*/
public function ConnectParent(string $ÜbergeordneteGUID)
{
}
/**
* Im Gegensatz zu Construct wird diese Funktion nur einmalig beim Erstellen der Instanz und Start von IP-Symcon aufgerufen. Deshalb sollten hier Statusvariablen und Modul-Eigenschaften erstellt werden, die das Modul dauerhaft braucht.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/create/
* @returns void Keine Rückgabe
*/
public function Create()
{
}
/**
* Diese Funktion wird beim Löschen der Instanz im laufenden Betrieb und bei Update via "Module Control" aufgerufen. Die Funktion wird nicht beim Beenden von IP-Symcon aufgerufen.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/destroy/
* @returns void Keine Rückgabe
*/
public function Destroy()
{
}
/**
* Deaktiviert die Standardaktion der Statusvariable. Dadurch ist diese in der Visualisierung nicht mehr veränderbar, sondern kann nur gelesen werden. Sofern EnableAction nicht aufrufen wurde, muss diese Funktion nicht aufgerufen werden, da alle Statusvariablen standardmäßig ohne Standardaktion erstellt werden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/disableaction/
* @returns void Keine Rückgabe
* @param string $Ident Ident der Variable
*/
public function DisableAction(string $Ident)
{
}
/**
* Aktiviert die Standardaktion der Statusvariable. Dadurch ist diese in der Visualisierung veränderbar und kann auch beschrieben werden. Diese Funktion muss aufgerufen werden, da alle Statusvariablen standardmäßig ohne Standardaktion erstellt werden. Sofern die Standardaktion aktiviert ist, muss auf Änderungsanfragen innerhalb von RequestAction reagiert werden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/enableaction/
* @returns void Keine Rückgabe
* @param string $Ident Ident der Variable
*/
public function EnableAction(string $Ident)
{
}
/**
* Es wird eine Verbindung mit einer kompatiblen übergeordneten Instanz mit der GUID <b>ModulID</b> forciert. Falls die bisherige Verbindung nicht mit der gewünschten <b>ModulID</b> übereinstimmt, wird diese getrennt. Anschließend wird eine neue Instanz mit der übergordneten ModuleID erstellt und verbunden.<br>
Eine Liste der verfügbaren ModulIDs kann HIER entnommen werden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/forceparent/
* @returns void Keine Rückgabe
* @param string $ModulID GUID
*/
public function ForceParent(string $ModulID)
{
}
/**
* Diese Funktion wird von IP-Symcon aufgerufen und verarbeitet zugesendete Daten und schickt diese an die übergeordnete Instanz weiter.<br>
Daten können über die Funktion SendDataToParent versendet werden.<br>
Weitere Informationen zur Datenweiterleitung können unter Datenfluss gefunden werden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/forwarddata/
* @returns string Resultat der Funktion, welches an die aufrufendene untergeordnete Instanz zurückgegeben wird
* @param string $JSONString Datenpaket im JSON Format
*/
public function ForwardData(string $JSONString)
{
}
/**
* Diese Funktion liefert den Inhalt des Buffers mit dem Namen <b>Name</b>. Wenn der Buffer leer ist, wird ein leerer String zurückgegeben.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/getbuffer/
* @returns string Der Inhalt des Buffers
* @param string $Name Der Name des Buffers
*/
public function GetBuffer(string $Name)
{
}
/**
* Diese Funktion liefert ein Array mit den Namen aller Buffer.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/getbufferlist/
* @returns array Namensliste aller Buffer
*/
public function GetBufferList()
{
}
/**
* Der Inhalt kann überschrieben werden um so eine selbsterstellte Konfigurationsseite zu übergeben. So können dynamisch Inhalte wiedergespiegelt werden. Die "form.json" auf dem Dateisystem wird dabei vollkommen ignoriert.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/getconfigurationform/
* @returns string Inhalt der Konfigurationsseite
*/
public function GetConfigurationForm()
{
}
/**
* Der Konfiguration-String wird der übergeordeneten Instanz übergeben. Diese liest den String aus und setzt die eingetragenen Werte. Über diese Funktion eingelesene Werte können über die Konfigurationsseite nicht mehr verändert werden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/getconfigurationforparent/
* @returns string Inhalt der Konfiguration der übergeordenten Instanz
*/
public function GetConfigurationForParent()
{
}
/**
* Der Befehl sucht nach der ObjektID des Objekt mit dem Ident <b>Ident</b> und gibt diese zurück.<br>
Sollte der Ident nicht vorhanden sein, wird eine Fehlermeldung erzeugt.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/getidforident/
* @returns int ID des gefundenen Objekts, sonst FALSE
* @param string $Ident Ident des Objekts nach dem gesucht werden soll.
*/
public function GetIDForIdent(string $Ident)
{
}
/**
* Diese Funktion liefert ein Array mit allen aktiven Nachrichten, welche über RegisterMessage registriert wurden.<br>
Eine Liste der NachrichtIDs befindet sich hier: Nachrichten
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/getmessagelist/
* @returns array Array aller aktiven Nachrichten
*/
public function GetMessageList()
{
}
/**
* Diese Funktion liefert ein Array mit den IDs aller Referenzen.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/getreferencelist/
* @returns array Array mit Integer-Werten der IDs aller Referenzen
*/
public function GetReferenceList()
{
}
/**
* Diese Funktion liefert den aktuellen Status der Instanz.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/getstatus/
* @returns int Aktueller Status
*/
public function GetStatus()
{
}
/**
* Fragt den Intervall des Timers <b>Name</b> ab.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/gettimerinterval/
* @returns int Aktuell eingestelltes Intervall in Millisekunden
* @param string $Name Der Name des Timers dessen Intervall abgefragt werden soll.
*/
public function GetTimerInterval(string $Name)
{
}
/**
* Diese Funktion liefert den Wert der Statusvariable mit dem Ident <b>Ident</b>.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/getvalue/
* @returns variant Der Inhalt der Statusvariable
* @param string $Ident Ident der Statusvariable
*/
public function GetValue(string $Ident)
{
}
/**
* Diese Funktion prüft, ob alle physikalisch übergeordneten Instanzen aktiv sind. Ist in der Kette mindestens eine Instanz nicht aktiv, so gibt die Funktion <b>FALSE</b> zurück. Sind alle Instanzen aktiv, so gibt die Funktion <b>TRUE</b> zurück.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/hasactiveparent/
* @returns boolean TRUE, falls alle physikalisch übergeordneten Instanzen aktiv sind, andernfalls FALSE
*/
public function HasActiveParent()
{
}
/**
* Die Funktion schreibt unter Angabe des Typs <b>Typ</b> und der Nachricht <b>Nachricht</b> eine Nachricht ins Logfile. Zusätzlich werden diese im Meldungsfenster innerhalb der Konsole angezeigt.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/logmessage/
* @returns void Keine Rückgabe
* @param string $Nachricht Inhalt der Nachricht
* @param int $Typ <li>
KL_DEBUG
10206
Eine Debugmeldung
</li>
<li>
KL_ERROR
10205
Eine Fehlermeldung
</li>
<li>
KL_MESSAGE
10201
Eine Standardnachricht
</li>
<li>
KL_NOTIFY
10203
Eine Benachrichtigung
</li>
<li>
KL_WARNING
10204
Eine Warnungsmeldung
</li>
*/
public function LogMessage(string $Nachricht, int $Typ)
{
}
/**
* Die Funktion ruft bei <b>AktionAktivieren</b> == True die Funktion EnableAction und bei <b>AktionAktivieren</b> == False die Funktion DisableAction mit dem Ident <b>Ident</b> auf.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/maintainaction/
* @returns void Keine Rückgabe
* @param string $Ident Ident der Variable
* @param bool $AktionAktivieren Enable wenn <b>True</b>, Disable wenn <b>False</b>
*/
public function MaintainAction(string $Ident, bool $AktionAktivieren)
{
}
/**
* Wenn der Parameter <b>Beibehalten</b> == true ist, dann wird die Typ <b>Typ</b> passende Statusvariable mit dem Ident <b>Ident</b> und dem Namen <b>Name</b> erstellt.<br>
Wenn der Parameter <b>Beibehalten</b> == false ist, dann wird die Statusvariable mit dem Ident <b>Ident</b> gelöscht.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/maintainvariable/
* @returns void Keine Rückgabe
* @param string $Ident Ident der Statusvariable
* @param string $Name Name der Statusvariable
* @param int $Typ Typ der Statusvariable
* @param string $Profil Name des Variablenprofils welches verwendet werden soll
* @param int $Position Postion im Objektbaum und somit auch im WebFront
* @param bool $Beibehalten Register wenn <b>True</b>, Unregister wenn <b>False</b>
*/
public function MaintainVariable(string $Ident, string $Name, int $Typ, string $Profil, int $Position, bool $Beibehalten)
{
}
/**
* Der Inhalt der Funktion kann überschrieben werden um eigene Reaktionen auf bestimmte Nachrichten auszuführen.<br>
Die Funktion wird nur bei registrierten NachrichtenIDs/SenderIDs-Kombinationen aufgerufen.<br>
Der Zeitstempel wird für jede versendete Nachricht inkrementiert.<br>
RegisterMessage und UnregisterMessage fügt Filterregeln hinzu oder entfernt diese wieder.<br>
Eine Liste der NachrichtIDs befindet sich hier: Nachrichten
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/messagesink/
* @returns void Keine Rückgabe
* @param int $Zeitstempel Fortlaufender Zähler Zeitstempel
* @param int $SenderID ID des Senders
* @param string $NachrichtID ID der Nachricht
* @param array $Daten Daten der Nachricht
*/
public function MessageSink(int $Zeitstempel, int $SenderID, string $NachrichtID, array $Daten)
{
}
/**
* Die Funktion gibt den Wert des Attributs mit dem Namen <b>Name</b> zurück.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/readattributeboolean/
* @returns boolean Der Wert des Attributs
* @param string $Name Name des Attributs
*/
public function ReadAttributeBoolean(string $Name)
{
}
/**
* Die Funktion gibt den Wert des Attributs mit dem Namen <b>Name</b> zurück.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/readattributefloat/
* @returns float Der Wert des Attributs
* @param string $Name Name des Attributs
*/
public function ReadAttributeFloat(string $Name)
{
}
/**
* Die Funktion gibt den Wert des Attributs mit dem Namen <b>Name</b> zurück.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/readattributeinteger/
* @returns int Der Wert des Attributs
* @param string $Name Name des Attributs
*/
public function ReadAttributeInteger(string $Name)
{
}
/**
* Die Funktion gibt den Wert des Attributs mit dem Namen <b>Name</b> zurück.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/readattributestring/
* @returns string Der Wert des Attributs
* @param string $Name Name des Attributs
*/
public function ReadAttributeString(string $Name)
{
}
/**
* Die Funktion gibt den Wert der Eigenschaft mit dem Namen <b>Name</b> zurück.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/readpropertyboolean/
* @returns boolean Der Wert der Eigenschaft
* @param string $Name Name der Eigenschaft
*/
public function ReadPropertyBoolean(string $Name)
{
}
/**
* Die Funktion gibt den Wert der Eigenschaft mit dem Namen <b>Name</b> zurück.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/readpropertyfloat/
* @returns float Der Wert der Eigenschaft
* @param string $Name Name der Eigenschaft
*/
public function ReadPropertyFloat(string $Name)
{
}
/**
* Die Funktion gibt den Wert der Eigenschaft mit dem Namen <b>Name</b> zurück.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/readpropertyinteger/
* @returns int Der Wert der Eigenschaft
* @param string $Name Name der Eigenschaft
*/
public function ReadPropertyInteger(string $Name)
{
}
/**
* Die Funktion gibt den Wert der Eigenschaft mit dem Namen <b>Name</b> zurück.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/readpropertystring/
* @returns string Der Wert der Eigenschaft
* @param string $Name Name der Eigenschaft
*/
public function ReadPropertyString(string $Name)
{
}
/**
* Diese Funktion wird von IP-Symcon aufgerufen und verarbeitet zugesendete Daten und schickt diese gegenenfalls an alle untergeordneten Instanzen weiter.<br>
Daten können über die Funktion SendDataToChildren versendet werden.<br>
Weitere Informationen zur Datenweiterleitung können unter Datenfluss gefunden werden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/receivedata/
* @returns string optionale Antwort an die übergordnete Instanz
* @param string $JSONString Datenpaket im JSON Format
*/
public function ReceiveData(string $JSONString)
{
}
/**
* Diese Funktion erstellt ein Attribut vom Typ Boolean mit dem Namen <b>Name</b> und dem Standardwert <b>Standardwert</b>
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerattributeboolean/
* @returns void Keine Rückgabe
* @param string $Name Name des Attributs
* @param bool $Standardwert Standardwert des Attributs
*/
public function RegisterAttributeBoolean(string $Name, bool $Standardwert)
{
}
/**
* Diese Funktion erstellt ein Attribut vom Typ Float mit dem Namen <b>Name</b> und dem Standardwert <b>Standardwert</b>
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerattributefloat/
* @returns void Keine Rückgabe
* @param string $Name Name des Attributs
* @param float $Standardwert Standardwert des Attributs
*/
public function RegisterAttributeFloat(string $Name, float $Standardwert)
{
}
/**
* Diese Funktion erstellt ein Attribut vom Typ Integer mit dem Namen <b>Name</b> und dem Standardwert <b>Standardwert</b>
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerattributeinteger/
* @returns void Keine Rückgabe
* @param string $Name Name des Attributs
* @param int $Standardwert Standardwert des Attributs
*/
public function RegisterAttributeInteger(string $Name, int $Standardwert)
{
}
/**
* Diese Funktion erstellt ein Attribut vom Typ String mit dem Namen <b>Name</b> und dem Standardwert <b>Standardwert</b>
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerattributestring/
* @returns void Keine Rückgabe
* @param string $Name Name des Attributs
* @param string $Standardwert Standardwert des Attributs
*/
public function RegisterAttributeString(string $Name, string $Standardwert)
{
}
/**
* Diese Funktion registriert das Modul für den Empfang der Nachricht <b>NachrichtID</b> und der ID <b>SenderID</b>.<br>
Eine Liste der NachrichtIDs befindet sich hier: Nachrichten
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registermessage/
* @returns void Keine Rückgabe
* @param int $SenderID ID des Senders
* @param int $NachrichtID ID der Nachricht
*/
public function RegisterMessage(int $SenderID, int $NachrichtID)
{
}
/**
* Diese Funktion erstellt einen Timer mit dem Namen <b>Name</b> und dem Inhalt <b>Skriptinhalt</b>. Der Timer wird einmalig und sofort ausgeführt.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registeroncetimer/
* @returns void Keine Rückgabe
* @param string $Name Name des Timers
* @param string $Skriptinhalt PHP Skript ohne PHP Tags (&lt;?php … )
*/
public function RegisterOnceTimer(string $Name, string $Skriptinhalt)
{
}
/**
* Diese Funktion erstellt eine Modul-Eigenschaft vom Typ Boolean mit dem Namen <b>Name</b> und dem Standardwert <b>Standardwert</b>
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerpropertyboolean/
* @returns void Keine Rückgabe
* @param string $Name Name der Eigenschaft
* @param bool $Standardwert Standardwert der Eigenschaft
*/
public function RegisterPropertyBoolean(string $Name, bool $Standardwert)
{
}
/**
* Diese Funktion erstellt eine Eigenschaft vom Typ Float mit dem Namen <b>Name</b> und dem Standardwert <b>Standardwert</b>
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerpropertyfloat/
* @returns void Keine Rückgabe
* @param string $Name Name der Eigenschaft
* @param float $Standardwert Standardwert der Eigenschaft
*/
public function RegisterPropertyFloat(string $Name, float $Standardwert)
{
}
/**
* Diese Funktion erstellt eine Eigenschaft vom Typ Integer mit dem Namen <b>Name</b> und dem Standardwert <b>Standardwert</b>
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerpropertyinteger/
* @returns void Keine Rückgabe
* @param string $Name Name der Eigenschaft
* @param int $Standardwert Standardwert der Eigenschaft
*/
public function RegisterPropertyInteger(string $Name, int $Standardwert)
{
}
/**
* Diese Funktion erstellt eine Eigenschaft vom Typ String mit dem Namen <b>Name</b> und dem Standardwert <b>Standardwert</b>
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerpropertystring/
* @returns void Keine Rückgabe
* @param string $Name Name der Eigenschaft
* @param string $Standardwert Standardwert der Eigenschaft
*/
public function RegisterPropertyString(string $Name, string $Standardwert)
{
}
/**
* Diese Funktion registriert die ID <b>ID</b> als referenziert, sodass das Modul bei einer Referenzsuche gefunden wird.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerreference/
* @returns void Keine Rückgabe
* @param int $ID ID des Objekts
*/
public function RegisterReference(int $ID)
{
}
/**
* Erstellt ein Skript mit dem Ident <b>Ident</b>, Namen <b>Name</b>, Inhalt <b>Inhalt</b> und der Position <b>Postion</b>, sofern der angegebene Ident nicht schon vorhanden ist.<br>
In beiden Fällen wird die ObjektID des erstellten oder bereits vorhanden Skripts zurückgegeben.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registerscript/
* @returns int Gibt die ObjektID des erstellten oder bereits vorhandenen Skripts zurück
* @param string $Ident Ident des Skripts
* @param string $Name Name des Skripts
* @param string $Inhalt Inhalt, welcher in das Skript eingetragen werden soll. <br> <b>Default</b> == "&lt;?php
//Autogenerated script"
* @param int $Position Position im Objektbaum und somit auch in der Visualisierung. <br> <b>Default</b> == 0
*/
public function RegisterScript(string $Ident, string $Name, string $Inhalt, int $Position)
{
}
/**
* Diese Funktion erstellt einen Timer mit dem Namen <b>Name</b>. Es kann noch angegeben werden, welches <b>Intervall</b> beim Erstellen gesetzt werden soll und der <b>Skriptinhalt</b> wird definiert.<br>
Der Timer ist stateless. Das heißt bei jedem Neustart wird der Timer mit dem hier eingestellten <b>Intervall</b> neuerstellt. Intervalleinstellungen müssen in der ApplyChanges() neu geladen werden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registertimer/
* @returns void Keine Rückgabe
* @param string $Name Name des Timers
* @param int $Intervall Intervall in Millisekunden mit dem der Timer erstellt werden soll. 0 = Niemals
* @param string $Skriptinhalt PHP Skript ohne PHP Tags (&lt;?php … )
*/
public function RegisterTimer(string $Name, int $Intervall, string $Skriptinhalt)
{
}
/**
* Diese Funktion erstellt eine Statusvariable vom Typ Boolean mit dem Ident <b>Ident</b> dem Namen <b>Name</b>. Es kann noch angegeben werden, welches <b>Profil</b> genutzt werden und auf welcher <b>Position</b> die Statusvariable stehen soll.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registervariableboolean/
* @returns int VariablenID der erstellten Statusvariable
* @param string $Ident Ident der Statusvariable
* @param string $Name Name der Statusvariable
* @param string $Profil Name des zu verwendenen Profils. <br> <b>Default</b> == ""
* @param int $Position Position im Objektbaum und somit auch in der Visualisierung. <br> <b>Default</b> == 0
*/
public function RegisterVariableBoolean(string $Ident, string $Name, string $Profil, int $Position)
{
}
/**
* Diese Funktion erstellt eine Statusvariable vom Typ Float mit dem Ident <b>Ident</b> dem Namen <b>Name</b>. Es kann noch angegeben werden, welches <b>Profil</b> genutzt werden und auf welcher <b>Position</b> die Statusvariable stehen soll.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registervariablefloat/
* @returns int VariablenID der erstellten Statusvariable
* @param string $Ident Ident der Statusvariable
* @param string $Name Name der Statusvariable
* @param string $Profil Name des zu verwendenen Profils. <br> <b>Default</b> == ""
* @param int $Position Position im Objektbaum und somit auch in der Visualisierung. <br> <b>Default</b> == 0
*/
public function RegisterVariableFloat(string $Ident, string $Name, string $Profil, int $Position)
{
}
/**
* Diese Funktion erstellt eine Statusvariable vom Typ Integer mit dem Ident <b>Ident</b> dem Namen <b>Name</b>. Es kann noch angegeben werden, welches <b>Profil</b> genutzt werden und auf welcher <b>Position</b> die Statusvariable stehen soll.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registervariableinteger/
* @returns int VariablenID der erstellten Statusvariable
* @param string $Ident Ident der Statusvariable
* @param string $Name Name der Statusvariable
* @param string $Profil Name des zu verwendenen Profils. <br> <b>Default</b> == ""
* @param int $Position Position im Objektbaum und somit auch in der Visualisierung. <br> <b>Default</b> == 0
*/
public function RegisterVariableInteger(string $Ident, string $Name, string $Profil, int $Position)
{
}
/**
* Diese Funktion erstellt eine Statusvariable vom Typ String mit dem Ident <b>Ident</b> dem Namen <b>Name</b>. Es kann noch angegeben werden, welches <b>Profil</b> genutzt werden und auf welcher <b>Position</b> die Statusvariable stehen soll.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/registervariablestring/
* @returns int VariablenID der erstellten Statusvariable
* @param string $Ident Ident der Statusvariable
* @param string $Name Name der Statusvariable
* @param string $Profil Name des zu verwendenen Profils. <br> <b>Default</b> == ""
* @param int $Position Position im Objektbaum und somit auch in der Visualisierung. <br> <b>Default</b> == 0
*/
public function RegisterVariableString(string $Ident, string $Name, string $Profil, int $Position)
{
}
/**
* Diese Funktion lädt das Formular der Instanzkonfiguration in jeder offenen Instanzkonfiguration neu. Aktuelle Eingaben gehen dabei verloren.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/reloadform/
* @returns void Keine Rückgabe
*/
public function ReloadForm()
{
}
/**
* Wird aufgerufen wenn in der Visualisierung auf z.B. eine Schaltfläche geklickt wird.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/requestaction/
* @returns void Keine Rückgabe
* @param string $Ident Ident der Variable
* @param string $Wert Der Wert, welcher gesetzt werden soll
*/
public function RequestAction(string $Ident, string $Wert)
{
}
/**
* Sofern keine Verbindung existiert, wird eine übergeordnete Instanz mit der GUID <b>ÜbergordneteGUID</b> erstellt. Selbst dann, wenn eine kompatible übergeordneten Instanz vorhanden wäre.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/requireparent/
* @returns void Keine Rückgabe
* @param string $ÜbergordneteGUID GUID
*/
public function RequireParent(string $ÜbergordneteGUID)
{
}
/**
* Diese Funktion sendet Daten an alle verbundenen untergeordneten Instanzen.<br>
Weitere Informationen sind unter Datenfluss zu finden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/senddatatochildren/
* @returns array Ergebnisse, welches ReceiveData von den übergeordneten Instanzen liefert
* @param string $Daten JSON kodierter String
*/
public function SendDataToChildren(string $Daten)
{
}
/**
* Diese Funktion sendet Daten an eine verbundene übergeordnete Instanz.<br>
Weitere Informationen sind unter Datenfluss zu finden.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/senddatatoparent/
* @returns string Ergebnis, welches ForwardData von der übergeordneten Instanz liefert
* @param string $Daten JSON kodierter String
*/
public function SendDataToParent(string $Daten)
{
}
/**
* Gibt die Debugmeldung <b>Daten</b> unter dem Meldungsname <b>Meldungsname</b> und dem Format <b>Format</b> aus.<br>
<b>Format</b> gibt dabei an ob bei automatischer Darstellung entweder Text oder Hex Ausgabe ausgewählt wird.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/senddebug/
* @returns void Keine Rückgabe
* @param string $Meldungsname Name/Titel der Debugausgabe
* @param string $Daten Inhalt der Debugmeldung
* @param int $Format Voreinstellung für automatische Formationsauswahl (0 = Text, 1 = Hex)
*/
public function SendDebug(string $Meldungsname, string $Daten, int $Format)
{
}
/**
* Diese Funktion schreibt Daten <b>Daten</b> in den Buffer mit dem Namen <b>Name</b>.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/setbuffer/
* @returns void Keine Rückgabe
* @param string $Name Name des Buffers
* @param string $Daten Daten welche in den Buffer gepackt werden sollen.
*/
public function SetBuffer(string $Name, string $Daten)
{
}
/**
* Setzt den Filter mit der Regular Expression <b>ErforderlicheRegexRegel</b>. ForwardData() wird nur aufgerufen wenn der gesetzte Filter zutrifft.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/setforwarddatafilter/
* @returns void Keine Rückgabe
* @param string $ErforderlicheRegexRegel Regexregel welche als Filter angewendet werden soll
*/
public function SetForwardDataFilter(string $ErforderlicheRegexRegel)
{
}
/**
* Setzt den Filter mit der Regular Expression <b>ErforderlicheRegexRegel</b>. RecieveData() wird nur aufgerufen wenn der gesetzte Filter zutrifft.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/setreceivedatafilter/
* @returns void Keine Rückgabe
* @param string $ErforderlicheRegexRegel Regexregel welche als Filter angewendet werden soll
*/
public function SetReceiveDataFilter(string $ErforderlicheRegexRegel)
{
}
/**
* Setzt den Satus einer Instanz auf den Wert von <b>Statuswert</b>.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/setstatus/
* @returns void Keine Rückgabe
* @param int $Statuswert Der Statuswert auf den die Instanz gesetzt werden soll.
*/
public function SetStatus(int $Statuswert)
{
}
/**
* Diese Funktion setzt die Kurzinformation <b>Kurzinfo</b> des Objekts, welche in der Verwaltungskonsole angezeigt wird und durch IPS_GetObject wieder ausgelesen werden kann.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/setsummary/
* @returns void Keine Rückgabe
* @param string $Kurzinfo Inhalt der gesetzt werden soll
*/
public function SetSummary(string $Kurzinfo)
{
}
/**
* Setzt den Intervall des Timers <b>Name</b> auf den Wert von <b>Interval</b>.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/settimerinterval/
* @returns void Keine Rückgabe
* @param string $Name Der Name des Timers dessen Intervall gesetzt werden soll.
* @param int $Intervall Der Intervall in Millisekunden auf den der Timer gesetzt werden soll.
*/
public function SetTimerInterval(string $Name, int $Intervall)
{
}
/**
* Diese Funktion schreibt den Wert <b>Wert</b> in die Statusvariable mit dem Ident <b>Ident</b>.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/setvalue/
* @returns void Keine Rückgabe
* @param string $Ident Ident der Statusvariable
* @param mixed $Wert Wert, welcher in die Statusvariable geschrieben werden sollen.
*/
public function SetValue(string $Ident, mixed $Wert)
{
}
/**
* Übersetzt den String <b>Text</b> anhand der ausgewählten Systemsprache und der locale.json.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/translate/
* @returns string Übersetzter Text
* @param string $Text Zu übersetzender Text
*/
public function Translate(string $Text)
{
}
/**
* Diese Funktion entfernt eine Registrierung des Moduls für den Empfang der Nachricht <b>NachrichtID</b> und der ID <b>SenderID</b>.<br>
Eine Liste der NachrichtIDs befindet sich hier: Nachrichten
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/unregistermessage/
* @returns void Keine Rückgabe
* @param int $SenderID ID des Senders
* @param int $NachrichtID ID der Nachricht
*/
public function UnregisterMessage(int $SenderID, int $NachrichtID)
{
}
/**
* Diese Funktion entfernt die ID <b>ID</b> als referenziert für das Modul.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/unregisterreference/
* @returns void Keine Rückgabe
* @param int $ID ID des Objekts
*/
public function UnregisterReference(int $ID)
{
}
/**
* Der Befehl löscht die Statusvariable mit dem Ident <b>Ident</b>
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/unregistervariable/
* @returns void Keine Rückgabe
* @param string $Ident Ident der Statusvariable
*/
public function UnregisterVariable(string $Ident)
{
}
/**
* Dies Funktion setzt den Parameter <b>Parameter</b> das Formularfeldes mit dem Namen <b>Feld</b> in jeder offenen Instanzkonfiguration dieser Instanz auf den Wert <b>Wert</b>. Sollte ein Formularfeld mit diesem Namen im Element- und im Aktionsbereich existieren, so werden beide aktualisiert.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/updateformfield/
* @returns void Keine Rückgabe
* @param string $Feld Name des zu ändernden Formularfeldes
* @param string $Parameter Name des zu ändernden Parameters
* @param mixed $Wert Neuer Wert des Parameters
*/
public function UpdateFormField(string $Feld, string $Parameter, mixed $Wert)
{
}
/**
* Die Funktion schreibt den Wert <b>Wert</b> in das Attribut mit dem Namen <b>Name</b>.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/writeattributeboolean/
* @returns void Keine Rückgabe
* @param string $Name Name des Attributs
* @param bool $Wert Wert des Attributs
*/
public function WriteAttributeBoolean(string $Name, bool $Wert)
{
}
/**
* Die Funktion schreibt den Wert <b>Wert</b> in das Attribut mit dem Namen <b>Name</b>.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/writeattributefloat/
* @returns void Keine Rückgabe
* @param string $Name Name des Attributs
* @param float $Wert Wert des Attributs
*/
public function WriteAttributeFloat(string $Name, float $Wert)
{
}
/**
* Die Funktion schreibt den Wert <b>Wert</b> in das Attribut mit dem Namen <b>Name</b>.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/writeattributeinteger/
* @returns void Keine Rückgabe
* @param string $Name Name des Attributs
* @param int $Wert Wert des Attributs
*/
public function WriteAttributeInteger(string $Name, int $Wert)
{
}
/**
* Die Funktion schreibt den Wert <b>Wert</b> in das Attribut mit dem Namen <b>Name</b>.
*
* @link https://www.symcon.de/de/service/dokumentation/entwicklerbereich/sdk-tools/sdk-php/module/writeattributestring/
* @returns void Keine Rückgabe
* @param string $Name Name des Attributs
* @param string $Wert Wert des Attributs
*/
public function WriteAttributeString(string $Name, string $Wert)
{
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment