...

...

...

Robert: Grundsätzlich geprüft, einiges fehlt aber noch (Wertbereiche, Links, etc.)

Grundstruktur einer Custom-Logik

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

• Level (Deklaration in der Custom-Logik 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).

...

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 die 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 Logikmodule 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:

  Null, ----------- Trifft dies zu? -----------------

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

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

  • Fließkommazahl (float; zulässiger Wertebereich von --------------------- bis ---------------- 1.72E35 bis 1.72E35).
    Wichtiger Hinweis: Die Dezimal-Werte müssen immer einen Punkt enthalten 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; maximal 65.534 Bytes, zulässige Zeichen sind alle Buchstaben, alle Ziffern und folgende Sonderzeichen : aus dem UTF-8-Zeichensatz. Beachten Sie, dass die Darstellung eines UTF-8---------- Welche? -----------Zeichens zwei oder mehr Bytes benötigen kann.)
    Standardmäßig werden 32 Zeichen für eine Variable reserviert. Durch die Verwendung eines längeren Initialwerts im Level-Array können mehr Zeichen reserviert werden. Die Logik arbeitet jedoch nur innerhalb der reservierten Bereiche. Wenn mehr Zeichen von einem Eingang geliefert oder durch ein Modul erzeugt werden, werden diese abgeschnitten.

  • 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.

  • Objekt: Ein Objekt wird in geschweiften Klammern ( {} ) eingeschlossen. --------- Objekte werden bei der Erstellung von eigenem Code nicht benötigt. ----------

• 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: Damit bei der Kodierung die variable Zahl von Eingangsvariablen verwendet werden kann, kann eine ------Multivariable------ 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 ) mehrere Variablen von diesem Typ als 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:

...

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.

Variable 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 (Beispiele siehe ….) ;

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

•  Verlinkung mit Beispielen Diego Clavadetscher

Es gilt folgende Syntax:

"Level": [ [<Variablenname>, <Typ>, <Init value>], ... ]

...

 "Level": [
    ["$true","bool",true],
    ["$false","bool",false],
    ["$Start","integer",0],
    ["$Ende","integer",3],
    ["$Period","float",5.0],
    ["$CronExpr","string","1 2 3 * * *"]
]

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 Logiksmoduls Logikmoduls definiert.

Es gilt folgende Syntax:

...

• 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.

  Codeblock
  "Module":[ ["And",["$In","-$Limit_ON"],"$Delayed_ON"], ],

• 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,"$Stat_Max"0,"$Stat_Mean","$Stat_Median"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.

...

  "Module": [
    ["Clocksignal","$true",0,"$Period"], // Intervalltakter
    ["Polynomial","$Z1","$Startwert",["$Start","-$Z1"]], // Startwert setzen, muss um 1 kleiner als Start sein, weil am Schluss Zaehler noch um 1 erhöht wird
    ["Polynomial","$Z1","$Endwert",["$Ende","-$Z1"]], // Endwert setzen, muss um 1 kleiner als Ende sein, siehe oben
    ["Comparator", "$Zaehler","$Test", "$Startwert"], // Prüfen, ob Zaehler über Startwert liegt
    ["Latch","$Start","$Zaehler","-$Test",0], // wenn Bedingung nicht erfüllt, Zaehler auf Start setzen
    ["Comparator", "$Zaehler", "$Test", "$Endwert"], // Prüfen, ob Zaheler über Endwert liegt
    ["Latch","$Startwert","$Zaehler","$Test",0], // wenn Bedingung erfüllt, Zaehler auf Startwert setzen
    ["Polynomial","$Z1","$Zaehler",["$Zaehler","$Z1"]] // Zaehler um 1 erhöhen
  ],

Input-Array

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

...

"Input": [
    ["Startwert","Wert (integer), der als erstes ausgegeben wird ","$Start","c" ],
    ["Endwert","Wert (integer), der als letztes ausgegeben wird ","$Ende","c" ],
    ["Intervalldauer","in Sekunden","$Period","c"] 
  ],

Output-Array

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

...

• 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:

• Grundlegende Informationen zu JSON findet sich bspw. unter https://wiki.selfhtml.org/wiki/JSON oder https://de.wikipedia.org/wiki/JavaScript_Object_Notation.