add dataformat

src/dataformat.txt

@@ -0,0 +1,124 @@
+// MQTT command data package of the rig-PC.
+// Topic: rd/set01/rig01/cmd
+{
+    // ts: time stamp
+    // en: experimental name
+    // ec: comment on the experiment
+    // es: status of the experiment (start/stop). IFC data interface is acting accordingly to this staus.
+    "ts": "yyyy-MM-dd'T'HH-mm-ss.SSSZ", 
+    "en": "Name of Experiment",
+    "ec": "Comment discribing the experiment",
+    "es": "start/stop"
+}
+
+// MQTT log data package of the rig-PC.
+// Topic: rd/set01/rig01/log
+// Every entry in the v-object is dynamicaly generated. The list of elements depends on the experimental setup.
+// Therefore the names and the values can vary from experiment to experiment.
+// The number of elements is not limited by the Vee program yet.
+{
+    "ts": "yyyy-MM-dd'T'HH-mm-ss.SSSZ",
+    "v":[
+        {
+            "n": "V1", // Valve 1 Bypass
+            "v": 0.0
+        },
+        {
+            "n": "V2", // Valve 2 Flow regulation
+            "v": 0.0
+        },
+        {
+            "n": "V3", // Valve 3
+            "v": 0.0
+        },
+        {
+            "n": "Vx", // Valve x
+            "v": 0.0
+        },
+        {
+            "n": "pump", // Valve 3
+            "v": 0 // pump speed (0 = off, 1 = slow, 2 = fast)
+        },
+        {
+            "n": "p1", // value of pressure sensor 1
+            "v": 0.0 
+        },
+        {
+            "n": "p2", // value of pressure sensor 2
+            "v": 0.0 
+        },
+        {
+            "n": "Vflow1",
+            "v": 0.0 // MID Current value
+        },
+        {
+            "n": "Vflow2",
+            "v": 0.0 // MID Current value
+        },
+        {
+            "n": "Airflow",
+            "v": 0.0 // norm l/s
+        }
+    ],        
+}
+
+// MQTT watch dog package of IFCRDI.
+// One topic for each device:
+// Topic: rd/set01/dev05/adm/wd
+// Topic: rd/set01/dev06/adm/wd
+{
+    // cnt: 32 bit counter which is incremented on a regular basis (e.g. every 5 seconds).
+    // increment only if data can be read by raspberry (m-tackt changes, sample cnt is incrementing)
+    "cnt": 0x00000000
+}
+
+// MQTT measurement data package of IFCRDI.
+// One topic for each device:
+// Topic: rd/set01/dev05/egm/md
+// Topic: rd/set01/dev06/egm/md
+{
+    "ts": "time of first sample",
+    "dt": "sampling time"
+    "values": [
+        0x00000000, // 1st value (0x00FFFFFF -> 24 bit raw data mask, 0x02000000 -> mag. field polarity mask (1 = +1, 0 = -1) , 0x04000000 -> data validation mask (1 = valid, 0 = invalid))
+        0x00000000, // 2nd value        
+        "..."
+        0x00000000, // 1000th value
+    ]
+}
+
+// One topic for each device:
+// Topic: rd/set01/dev05/egm/md
+// Topic: rd/set01/dev06/egm/md
+{
+    "ts": "time of first sample",
+    "dt": "sampling time"
+    "values": [
+        0x00000000, // 1st value (0x00FFFFFF -> 24 bit raw data mask, 0x02000000 -> mag. field polarity mask (1 = +1, 0 = -1) , 0x04000000 -> data validation mask (1 = valid, 0 = invalid))
+        0x00000000, // 2nd value        
+        "..."
+        0x00000000, // 1000th value
+    ]
+}
+
+// KI Rojal
+// One topic for each device:
+// Topic: rd/set02/dev05/kir/md
+{
+    "ts": "time of first sample",
+    "values": [
+        [ 0x00000000, 0x00000000 ], // real, imagine
+        [ 0x00000000, 0x00000000 ],
+        "..."
+        [ 0x00000000, 0x00000000 ]
+    ]
+}
+
+
+// MQTT sync. data package of IFCRDI.
+// One topic for each device:
+// Topic: rd/set01/dev05/egm/sd
+// Topic: rd/set01/dev06/egm/sd
+{
+    "ts": "time of rising edge" // value in us.
+}