RegisterVariable

RegisterVariable stellt eine Datenweiterleitungs- und -verarbeitungsschnittstelle zur Verfügung.

Konfiguration

Das RegisterVariable Modul verbindet sich nicht automatisch mit einer übergeordneten Instanz. Es muss dafür eine übergeordnete Instanz ausgewählt oder eine Neue erstellt werden. Es können auch weitere Splitter (z.B. Cutter) hinzugefügt werden, um die ankommenden Daten vor der Auswertung direkt synchronisieren zu lassen.

Die Ausführung der Skripte erfolgt seriell. Das Bedeutet, dass die Skripte nicht mit Semaphoren geschützt werden müssen.

Datenverarbeitung

Werden von der übergeordneten Instanz (Kommunikationsschnittstelle) neue Daten empfangen, wird das Ziel-Skript der RegisterVariable-Instanz ausgeführt. In diesem stehen die empfangenen Daten über $_IPS['VALUE'] zur Verfügung. Sollte die übergeordnete Instanz ein ServerSocket sein, stehen zusätzlich noch die Daten $_IPS['CLIENTIP'] und $_IPS['CLIENTPORT'] zur Verfügung.

Skripte, die durch die RegisterVariable ausgeführt werden, beinhalten diese Systemvariablen

Es gibt Datenquellen, bei denen erst mehrere empfangene Datensendungen eine sinnvolle Auswertung ermöglichen. Daher müssen die empfangenen Daten zwischengespeichert werden. Da Probleme auftreten können, wenn man binäre Daten in einer normalen String-Variable in IP-Symcon speichert (defekte IP-Symcon-Konfiguration), gibt es die Funktion RegVar_SetBuffer(integer $InstanzID, string $Puffer), die Daten im einen zur RegisterVariable-Instanz gehörigen Puffer speichert. Die im Puffer gespeicherten Daten lassen sich mit der Funktion RegVar_GetBuffer(integer $InstanzID) auslesen. Mit der Funktion RegVar_SendText(integer $InstanzID, string $Text) lassen sich Datenstrings über die Kommunikationsschnittstelle senden. Intern wird hierbei die passende Sendefunktion, wie z.B. COMPort_SendText, ausgeführt.

Der Puffer wird nach einem Neustart von IP-Symcon gelöscht!

Es soll KEINE VARIABLE als Puffer genutzt werden. Andernfalls kann es zu Instabilitäten innerhalb von IP-Symcon kommen und im schlimmsten Fall eine komplett zerstörte Konfiguration verursachen. Da sich dieses Problem auch inkrementell auf den Backup Ordner auswirken kann, ist dann unter Umständen nicht einmal eine Backup Konfiguration vorhanden. Es sollen die internen Puffer der Instanz genutzt werden, um Daten zwischenzuspeichern.
RegVar_SetBuffer / RegVar_GetBuffer

Beispiele

Aufbau

Das folgende Bild zeigt den typischen Aufbau und die Schritte für eine Registervariable. So kann die I/O Instanz in Form eines WWW-Readers zum Beispiel eine Webseite einlesen, der Cutter den Datenstrom aufbereiten und und die Registervariable im Skript einzelne Werte einer Homepage nutzbar machen und abspeichern.

Skript

Folgendes Beispiel verkettet empfangene Daten und gibt durch ; separierte Datensätze bei Vervollständigung aus:

// wenn das Skript von einer RegisterVariable-Instanz aus aufgerufen worden ist
    if ($_IPS['SENDER'] == "RegisterVariable") {
        // bereits im Puffer der Instanz vorhandene Daten in $data kopieren
        $data  = RegVar_GetBuffer($_IPS['INSTANCE']);
        // neu empfangene Daten an $data anhängen
        $data .= $_IPS['VALUE'];

        // wenn das Trennzeichen ; in $data gefunden worden ist
        if (strpos($data, ';')) {
            // $data in durch ; separierte Datensätze zerlegen
            $datasets = explode(';', $data);

            // alle nicht durch ; terminierten Datensätze ausgeben
            for ($i = 0; $i < count($datasets) - 1; $i++) {
                echo "empfangener Datensatz: ".$datasets[$i]."\n";
            }

            // $data auf den Inhalt des letzten (unvollständigen) Datensatzes setzen
            $data = $datasets[count($datasets) - 1];
        }

        // Inhalt von $data im Puffer der RegisterVariable-Instanz speichern
        RegVar_SetBuffer($_IPS['INSTANCE'], $data);
    }

Folgendes Beispiel verkettet empfangene Daten und gibt Blöcke von einer Länge von genau 16 Zeichen aus:

// wenn das Skript von einer RegisterVariable-Instanz aus aufgerufen worden ist
    if ($_IPS['SENDER'] == "RegisterVariable") {
        // bereits im Puffer der Instanz vorhandene Daten in $data kopieren
        $data  = RegVar_GetBuffer($_IPS['INSTANCE']);
        // neu empfangene Daten an $data anhängen
        $data .= $_IPS['VALUE'];

        // wenn $data mindestens 16 Zeichen lang ist
        if (strlen($data) >= 16) {
            // $data in Blöcke von bis zu 16 Zeichen zerlegen
            $datasets = str_split($data, 16);
            // $data leeren
            $data = "";

            // alle Datensätze durcharbeiten
            for ($i = 0; $i < count($datasets); $i++) {
                // vollständige Datensätze (genau 16 Zeichen lang) ausgeben
                if (strlen($datasets[$i]) == 16) {
                    echo "empfangener Datensatz: ".$datasets[$i]."\n";
                } else {
                    // Unvollständige Datensätze in $data schreiben
                    $data = $datasets[$i];
                }
            }
        }

        // Inhalt von $data im Puffer der RegisterVariable-Instanz speichern
        RegVar_SetBuffer($_IPS['INSTANCE'], $data);
    }

Tipps & Tricks

Sich alle übergeben Variable anzeigen lassen

unset($_SERVER['argv']);
unset($_SERVER['argc']);

foreach ($_SERVER as $key => $value) {
    IPS_LogMessage(IPS_GetName($IPS_INSTANCE), "Key: $key; Value: $value");
}