Struktur einer Custom-Logik

Owned by Diego Clavadetscher
Last updated: 27. Dec 2022 by Robert M.
5 min read

Grundstruktur einer Custom-Logik

Das Grundgerüst jeder Custom-Logik sind 4 Abschnitte (im Detail ein JSON-Objekt mit den vier Schlüsseln)

  • Level (Deklaration der verwendeten Variablen),

  • Module (die eigentlichen Handlungsanweisungen, d.h. eine Abfolge von Logikbausteinen),

  • Input (Definition der Eingänge und Zuordnung der Variablen) und

  • Output (Definition der Eingänge und Zuordnung der Variablen).

Jeder dieser vier Schlüssel hat einen Array als Wert. Somit hat das JSON-Objekt einer Custom-Logik folgenden Aufbau:

{ "Level": [] , "Module": [], "Input": [], "Output": [] }

In welcher Reihenfolge die vier Schlüssel im JSON-Objekt erwähnt werden, spielt keine Rolle und ist Geschmackssache des jeweiligen Anwenders. Einige Anwender stellen bspw. Input und Output an den Anfang; andere stellen den Abschnitt Module vorab, weil dort die meisten Änderungen gemacht werden müssen und sie auf diese Weise nicht lange scrollen müssen.

Grundsätzliches zur JSON-Datenstruktur und -Notation

Um Custom-Logiken zu erstellen, ist es nicht erforderlich, sich vertieft in die JSON-Notation einzuarbeiten.
Hier sollen im Moment nur folgende Besonderheiten erläutert werden:

  • Alle Eigenschaftsnamen in einem Objekt müssen in doppelten Anführungszeichen ( " " ) notiert werden.

  • Folgende Typen können verwendet werden:

    • Boolean (bool ; zulässige Schlüsselwörter: true und false)

    • Ganzzahl (integer; 32 Bit, zulässiger Wertebereich zwischen -2 147 483 648 und 2 147 483 647)

    • Fließkommazahl (float; zulässiger Wertebereich von -1.72E35 bis 1.72E35).
      Wichtiger Hinweis: Dezimal-Werte müssen mit Punkt geschrieben werden, ein Komma ist nicht zulässig. Beim Arbeiten mit großen Wertebereichen sind die Einschränkungen der numerischen Mathematik zu berücksichtigen!

    • Zeichenkette (string; zulässige Zeichen sind alle Buchstaben, alle Ziffern und folgende Sonderzeichen: ------------- Welche? -----------

    • Array: Ein Array schließt beliebig viele durch Kommas getrennte Werte in eckigen Klammern [ ] ein; jeder Eintrag kann einen beliebigen für JSON zugelassenen Typ annehmen.

  • Variablen werden über einen String, der mit einem $ beginnt, bezeichnet. Über den Variablenname kann man sich innerhalb von “Module”, “Input” und “Output” auf den Wert dieser Variable beziehen.

  • Spezialfall bei den Variablen: Zur Verwendung einer variablen Zahl von Eingängen, muss eine Mehrfachvariable definiert werden. Auf diese Weise kann in der grafischen Oberfläche durch Klick auf + mehrfach von diesem Typ ein Eingang hinzugefügt werden.
    Bei der Definition gibt es zwei Varianten:

    • $VAR<name?>: Mehrfache, aber optionale Verwendung (0 .. n), d.h. die Variable kann auch weggelassen werden.

    • $VAR<name!>: Mindestens einmalige, optional mehrfache Verwendung (1 .. n).

Kommentare

Um die Lesbarkeit des Codes zu verbessern, empfiehlt es sich, Kommentare zu verwenden. Um Text als Kommentar zu kennzeichnen, stehen in JSON verschiedene Möglichkeiten offen:

  • Am Ende einer Zeile: Kommentar mit "//" beginnen

    ["Comparator", "$Zaehler", "$Test", "$Endwert"], // Prüfen, ob Zaheler über Endwert liegt

  • Innerhalb einer Zeile oder über mehrere Zeilen hinweg: Kommentar mit "/*"  und "*/" eingrenzen

    /* * Dieses Logik-Modul stellt eine Beleuchtungssteuerung zur Verfügung. */ ["Latch","$Start","$Zaehler","-$Test"/* Wichtig: Negation */,0],

Wie in anderen Programmiersprachen kann über Kommentar-Kennzeichnungen nicht nur der Code erläutert werden, sondern es können auch Code-Zeilen (vorübergehend) “ausgeschaltet” werden. Dies kann die Fehlersuche erleichtern.

Level-Array

Der Level-Array dient der Deklaration von Variablen. Es müssen hier sämtliche Variablen deklariert werden, die im Logikmodul angewendet werden.

Die Variablen dienen vor allem folgenden Zwecken:

  • Austausch von Informationen zwischen den Modulen, In-und Output;

  • Ablaufsteuerung innerhalb des Moduls, indem einer Variable abhängig vom erfüllen einer Bedingung einen bestimmten Wert zugewiesen wird;

  • Verwendung als Konstante, um bestimmte fixe Werte in den Modulen zu verwenden.

 

Es gilt folgende Syntax:

Zu den einzelnen Syntax-Elementen:

  • Variablenname: String, der mit einem $ beginnt.

  • Typ: Zulässig sind bool, float, integer oder string

  • Init value: Weist der Variablen ein Default-Wert zu, der bis zum ersten Beschreiben der Variable gültig ist. Der Wert muss zum Typ passen!

Beispiel:

Modul-Array

Im Modul-Array werden die Variablen mit den Ein- und Ausgängen der Modulbausteinen verknüpft und so die eigentliche(n) Funktion(en) des Logikmoduls definiert.

Es gilt folgende Syntax:

Zu den einzelnen Syntax-Elementen:

Hinweise:

  • Variablen können durch ein vorangestelltes Minuszeichen direkt bei der Übergabe an einen Modulbaustein invertiert werden (→Invertierungsfunktion). Beim Typ boolean verhält sich das Minuszeichen wie ein NOT, und bei float und integer wie ein *(-1).
    Achtung: Diese Syntax ist nur bei den Referenzen im "Modul"-Arrray erlaubt, in den Arrays "Input" sowie "Output ist sie nicht zulässig.

  • Als Parameter der Modulbausteine sind aktuell nur Variablen, die im Abschnitt Level definiert wurden erlaubt. Es können keine Parameter als Zahl eingeben werden!
    Für diese Regel besteht nur folgende Ausnahme: Wird ein Ausgangswert nicht weiter verwendet, kann anstelle einer Variablen auch der Zahlenwert 0 eingesetzt werden; man spart sich so die Definition einer Variablen. Beispiel:
    Statt: ["Statistic","$VAR<Helligkeit!>"],"$Stat_Min","$Stat_Max","$Stat_Mean","$Stat_Median"]
    kürzer zB. wenn nur der Mittelwert benötigt wird: 
    ["Statistic",["$VAR<Helligkeit!>"],0,0,"$Stat_Mean",0]

  • Alle Module werden in der Reihenfolge, wie sie im Array stehen, ausgeführt.

  • Das Modul Break nimmt eine Sonderstellung ein. Es wertet seine 0..n Eingänge aus und bricht die weitere Abarbeitung der Logikzelle ab, falls einer der Eingänge true ist.
    Damit wird das Senden der im Array “Output” definierten Ausgänge wird unterdrückt. Daher ist Break nicht geeignet, wenn beim Abbruch ein definierter Zustand (bspw. das Schliessen eines Ventils) gewünscht wird.

Beispiel:

Input-Array

Im Input-Array werden die Eingänge der Custom-Logikzelle festgelegt und je mit einer Variable verknüpft.

Es gilt folgende Syntax:

Zu den einzelnen Syntax-Elementen:

  • Name: String, mit dem der Eingang in der GUI bezeichnet wird.

  • Beschreibung: String, der als Erläuterungstext bei "Mouse over" über dem Namen angezeigt wird.

  • Variablenname: Legt fest, welche Variable mit den Eingang verknüpft ist.

  • Die Trigger-Optionen bestimmen, wann ein Signal am Eingang die Berechnung der Logikzelle anstößt ( und zulässige Optionen siehe Triggerverhalten an Eingängen).

Beispiel:

Output-Array

Im Output-Array werden die Ausgänge der Custom-Logikzelle festgelegt und je mit einer Variable verknüpft.

Es gilt folgende Syntax:

Zu den einzelnen Syntax-Elementen:

  • Name: String, mit dem der Ausgang in der GUI bezeichnet wird.

  • Beschreibung: String, der als Erläuterungstext bei "Mouse over" über dem Namen angezeigt wird.

  • Variablenname: Legt fest, welche Variable mit den Ausgang verknüpft ist.

  • Die Sende-Optionen bestimmen, wann ein Wert am Ausgang gesendet wird (Funktionsweise und zulässige Optionen siehe Sendeverhalten an Ausgängen).

Beispiel:

Hinweis:

  • Wegen der Gefahr von Endlosschlaufen ist es nicht zulässig, eine Variable sowohl im Input- wie auch im Output-Array zu verwenden. Dies führt zu einem Fehler.

  • Wird der Variablenname am Ende um ein ? ergänzt, wird der Ausgang in der Logikzelle nur angezeigt, wenn in der GUI der Eingang bewusst über das Kreuzsymbol aktiviert worden ist (zum Beispiel: ["Nacht","Schwarze Nacht","$Dark_night?","c"]).

 

Weiterführende Links:

2019 - 2023 by Elaborated Networks GmbH / Impressum / Datenschutzerklärung