Updated documentation

Sun, 12 Jan 2020 12:24:22 +0100

author
Michiel Broek <mbroek@mbse.eu>
date
Sun, 12 Jan 2020 12:24:22 +0100
changeset 592
56f9be07906a
parent 591
28738f44d42e
child 593
e0230bf4ac3f

Updated documentation

doc/bms-ch8.sgml file | annotate | diff | comparison | revisions
--- a/doc/bms-ch8.sgml	Sun Jan 12 12:12:59 2020 +0100
+++ b/doc/bms-ch8.sgml	Sun Jan 12 12:24:22 2020 +0100
@@ -93,7 +93,6 @@
 <programlisting>
 {
   "timestamp": 1532201089,
-  "seq": 0,
   "metric": {
     "uuid": "b508f01c-1f82-4e8b-b0d2-d88ecfb53031",
     "interval":300,
@@ -167,7 +166,9 @@
   "product": {
     "uuid": "1eb0c7bf-bf06-491c-a086-ac5478d521b9",
     "code": "CB0001",
-    "name": "Hoppy Housebeer"
+    "name": "Hoppy Housebeer",
+    "yeast_lo": 18.0,
+    "yeast_hi": 24.0
   },
   "air": {
     "address": "70d60411-3ec8-40ab-998a-81fead83025f",
@@ -216,11 +217,7 @@
   "mode": "BEER",
   "setpoint": {
     "low": 21.0,
-    "high": 21.0
-  },
-  "webcam": {
-    "url":"https://the.webcamserver.com:8090/?action=stream",
-    "light": 1
+    "high": 21.5
   },
   "alarm": 0,
   "profile": {
@@ -232,7 +229,6 @@
       "low": 17.9,
       "high": 18.1
     },
-    "fridgemode": 0,
     "steps": [
       {
         "resttime": 2,
@@ -282,7 +278,6 @@
 <programlisting>
 {
   "timestamp": 1532201089,
-  "seq": 0,
   "metric": {
     "product": {
       "uuid": "1eb0c7bf-bf06-491c-a086-ac5478d521b9",
@@ -313,7 +308,6 @@
       "power": 100,
       "usage": 8273772
     },
-    "sg": 1.023,
     "event": "Something to mark",
     "fermenter_uuid": "48c9ae27-3f58-41c9-ae4b-1d57b249c45a"
   }
@@ -352,18 +346,70 @@
 <para>
 Nog schrijven
 </para>
+<programlisting>
+{
+  "seq":228196,
+  "metric":{
+    "units":[
+      {
+        "uuid":"c0ffeeee-dead-beef-caf0-3c71bffe4054",
+        "alias":"unit1",
+        "mode":"ON",
+        "alarm":0,
+        "temperature":{
+          "state":"OK",
+          "address":"e001191420732a28",
+          "temperature":20.250
+        },
+        "pressure":{
+          "state":"OK",
+          "channel":7,
+          "voltage":0.322,
+          "zero":0.110,
+          "bar":0.00
+        }
+      },
+      {
+        "uuid":"c0ffeeee-dead-beef-caf1-3c71bffe4054",
+        "alias":"unit2",
+        "mode":"OFF",
+        "alarm":1,
+        "temperature":{
+          "state":"OK",
+          "address":"e001191420732a28",
+          "temperature":20.250
+        },
+        "pressure":{
+          "state":"OK",
+          "channel":6,
+          "voltage":0.075,
+          "zero":0.109,
+          "bar":0.00
+        }
+      }
+    ]
+  }
+}
+</programlisting>
 </sect1>
 
 <sect1 id="payloadco2log">
 <title>Netwerk payload log formaat voor CO2 meters.</title>
 <para>
-Voor iedere actieve CO2 meter wordt bij iedere systeemstart een logbericht
-gestuurd. Dit is ongeveer iedere 5 minuten. Omdat de CO2 meters eenvoudige
+Voor iedere actieve CO2 meter wordt bij iedere systeemstart en iedere vijf
+minuten  een logbericht gestuurd. Omdat de CO2 meters eenvoudige
 controllers zijn is er geen tijd en product informatie beschikbaar. Deze
 ontbrekende gegevens worden aangevuld door <command>bmsd</command>
 </para>
 <programlisting>
-
+{
+  "seq":228229,
+  "metric":{
+    "uuid":"c0ffeeee-dead-beef-caf0-3c71bffe4054",
+    "temperature":21.125,
+    "pressure":0.000
+  }
+}
 </programlisting>
 <para>
 De ontvangen CO2 log gegevens worden niet opgeslagen in de SQL database
@@ -386,18 +432,31 @@
 <sect1 id="payloadispindeldata">
 <title>Netwerk payload data formaat voor iSpindels.</title>
 <para>
-Nog schrijven
+Iedere actieve iSpindel stuurt bij iedere systeemstart een bericht.
+Daarna na iedere <code>interval</code> tijd in seconden een volgend bericht.
+Omdat de iSpindel eenvoudige controllers zijn is er geen tijd en product
+informatie beschikbaar.
+Deze ontbrekende gegevens worden aangevuld door <command>bmsd</command>
+De volgende gegevens worden verstuurd:
 </para>
-
+<programlisting>
+{
+  "unit":{
+    "uuid":"c0ffeeee-cafe-dead-bee0-2af236d50dc9",
+    "alias":"iSpindel000",
+    "alarm":0,
+    "interval":900,
+    "angle":42.96722,
+    "temperature":25.5625,
+    "battery":4.254432,
+    "gravity":9.306425
+  }
+}
+</programlisting>
 <para>
-Voor iedere actieve iSpindel wordt bij iedere systeemstart een bericht
-gestuurd. Dit is ongeveer iedere 15 minuten. Omdat de iSpindel eenvoudige
-controllers zijn is er geen tijd en product informatie beschikbaar. Deze
-ontbrekende gegevens worden aangevuld door <command>bmsd</command>
-</para>
-
-<para>
-De ontvangen iSpindel gegevens worden niet opgeslagen in de SQL database
+De iSpindel stuurt geen aparte log informatie, alle informatie voor de logfile
+wordt uit het standaard bericht gehaald.
+Deze gegevens worden niet opgeslagen in de SQL database
 maar in platte tekst bestanden. Hierdoor is de gelogde informatie sneller toegankelijk.
 Ieder brouw product heeft zijn eigen bestand.
 De bestanden staan in <code>www/logs/ispindel/</code>.

mercurial