Setup Hardware Config File - MaxTrautwein/TAR-Weiterentwicklung-IoT-Tor GitHub Wiki

Generell

Die Setup Config Datei ist eine .json Datei, welche die Ein- und Ausgänge in einen Setup (z.b.: IoT Tor , IoT Garden , ...) definiert.

Die Datei muss nur ein mal pro neuem Setup erstellt werden und kann dann immer im gleichen Zustand verteilt werden.

Dies ist ein Beispiel einer solchen Setup Config Datei.

.json wurde als Dateiformat gewählt, da dies für die Verwendung mit javascript am geeignetsten ist sowie da .json sehr leicht verständlich ist.

Verwendungszwecke

  • hardware-config Node
  • (Geplant) Webinterface
  • (Geplant) Simulation

Aufbau

Auf der obersten Ebene befinden sich 3 Einträge:

  • Name (Wert: string) enthält den Namen des Setups z.b.: IoT Tor
  • Input (Wert: Array of Object) Liste aller Eingänge (Sensoren, Taster, ...)
  • Output (Wert: Array of Object) Liste aller Ausgänge (LED's, Motoren, ...)

Definition Eingang / Ausgang

Name Optional / Pflicht  Beschreibung
Name Pflicht Name des Ein- / Ausgangs
Description Pflicht Nähere beschreibung des Ein- / Ausgangs
Topic Pflicht Topic auf welcher empfangen / gesendet werden soll
Topic_alt Abhängig vom Interpreter Topic auf welcher alternativ empfangen / gesendet werden soll
Interpreter Pflicht Interpreter welcher verwendet werden soll (Auswahl aus liste)
payload Abhängig vom Interpreter Daten welche der Interpreter senden soll
payload_alt Abhängig vom Interpreter Alternatives payload
arg Abhängig vom Interpreter Übergibt parameter an den Interpreter
crc Abhängig vom Interpreter Zur Prüfung ob die Antwort von der erwarteten Anfrage stammt
TruePattern Abhängig vom Interpreter Array von Bytes formatiert als Hex. Wenn zutreffend dann wird True übertragen
FalsePattern Abhängig vom Interpreter Array von Bytes formatiert als Hex. Wenn zutreffend dann wird False übertragen
PatternPos Abhängig vom Interpreter Beschreibt die Startposition ab welcher der Pattern gelten soll im Data Array der Modbus-Bridge rx Nachricht.

Interpreter

Eingänge

Ausgänge

  • DoubleOnTrue
    Sendet das payload zwei mal auf der vorgegebenen Topic sofern True empfangen wird.
  • SingleOnTrue
    Sendet das payload ein mal auf der vorgegebenen Topic sofern True empfangen wird.
  • TrueFalseMessage
    Sendet das payload auf der vorgegebenen Topic wenn True empfangen wird.
    Sollte Topic_alt definiert sein, dann werden die daten der payload_alt auch darüber gesendet.

    Wenn False empfangen wird, dann wir payload_alt auf der vorgegebenen Topic gesendet.

Keiner der Interpreter passt ?

Sollte keiner der hier beschriebenen Interpreter für ihre Anwendung passend sein, so können Sie hier eine Anfrage für einen zusätzlichen Interpreter stellen.

⚠️ **GitHub.com Fallback** ⚠️