Struktur diese Kapitels

...

Inhalt dieser Seite

Grundstruktur einer Custom-Logik

Das Grundgerüst jeder Custom-Logik ist ein JSON-Objekt mit den vier Schlüsseln

...

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 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 zu erstellen, ist es nicht erforderlich, sich vertieft in die JSON-Notation einzuarbeiten. Grundlegende Informationen zu JSON findet sich bspw. unter https://wiki.selfhtml.org/wiki/JSON oder https://de.wikipedia.org/wiki/JavaScript_Object_Notation.
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; zulässiger Wertebereich von --------------------- bis ----------------)

  • Fliesszahl (float; zulässiger Wertebereich von --------------------- bis ---------------- ). Wichtiger Hinweis: Die Werte müssen immer einen Punkt enthalten

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

  • Array: Ein Array schliesst 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 Zahl der Eingangsvariablen offengehalten werden kann, kann eine ------Multivariable------ definiert werden. Auf diese Weise kann in der grafischen Oberfläche durch Klick auf + (mehrfach) mehrere Variablen von diesem Typ als Eingang hinzugefügt werden.
  
  Bei der Definition einer ----- Multivariablen----- 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).

• …..

•  Die mit ------- gekennzeichneten Textstellen prüfen, resp. Fehlendes ergänzen Stefan Werner

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.

Ergänzende Hinweise zum Bearbeitungsprozess einer Logik

Der Bearbeitungsprozess eine Logik wird unter https://wiregate.atlassian.net/wiki/spaces/TSKB/pages/397672460/Aufbau+und+Funktionsweise+der+Logiken#Bearbeitungsprozess-einer-Logikerläutert. Für Entwickler können folgende Zusatzinfomationen von Bedeutung sein:

• Es gilt der Grundsatz “Abgerechnet wird erst am Schluss.” Das bedeutet, dass bei einem Abbruch einer Logik über den Logik-Baustein “Break” einerseits alle nachfolgenden Module im Code nicht mehr berechnet oder ausgeführt werden und andererseits dass auch keine Daten an die Ausgänge übergeben werden. Dies gilt auch namentlich auch für Variablen, die im Zeitpunkt des Erreichens des Breaks bereits berechnet worden sind.

• Variablen behalten am Ende eines Logikdurchgangs ihren Wert. Damit kann in einem nachfolgenden Durchgang (d.h. bei der nächsten Auslösung eines Triggers) auf die im vorher erfolgten Durchgang zugewiesenen Werte zurückgegriffen werden. Dies ist beispielsweise für eine bedingte Ablaufsteuerung einer Logik von Bedeutung. Das Beispiel ------------------ zeigt diese Funktionalität auf.

Level-Array

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

...

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

...

 "Level": [
    ["$true","bool",true],
    ["$false","bool",false],
    ["$Start","integer",0],
    ["$Ende","integer",0],
    ["$Zaehler","integer",0],
    ["$Period","integer",0],
    ["$Out","integer",0],
        ["$Z0", "integer",0],
        ["$Z1", "integer",1],
        ["$Z2", "integer",2],
        ["$Z3", "integer",3],
        ["$Z4", "integer",4],
        ["$Z5", "integer",5],
        ["$Z6", "integer",6],
        ["$Z7", "integer",7],
        ["$Z8", "integer",8],
        ["$Z9", "integer",9]

]

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

...

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

...