bms: comparison doc/bms-ch8.sgml

-:9d1aa6f3a4da
+:4d01937ae7af
 <orderedlist>
 <listitem><para><code>brewery</code> is voor de bms applicatie zelf. Nog uitwerken.</para></listitem>
 <listitem><para><code>fermenters</code> is voor vergisting controllers.</para></listitem>
 <listitem><para><code>co2meters</code> is een drukmeter om bijvoorbeeld hergisting op de fles
 te monitoren.</para></listitem>
+<listitem><para><code>ispindels</code> is een electronische hydrometer die in het gistvat drijft
+en de temperatuur en sg verstuurt.</para></listitem>
 </orderedlist>
 <para>De volgende <code>message_type</code> namen zijn gedefinieerd:</para>
 <orderedlist>
 <listitem><para>NBIRTH geeft aan wanneer een node opstart en met het netwerk
 De payload zoals die door een node verstuurd wordt. Het wordt in json formaat
 verzonden zonder extra spaties en opmaak zoals hieronder is te zien. Het timestamp
 is de unix tijd sinds 1 januari 1970. Niet alle controllers sturen een timestamp,
 controllers zonder klok laten dit weg. De tijd wordt dan door <code>bmsd</code>
 ingevuld en is de tijd dat het bericht ontvangen wordt.
-Het `seq' nummer wordt met ieder bericht met 1 verhoogd.</para>
+Het `seq' nummer wordt met ieder bericht met 1 verhoogd.
+Ook dit nummer is niet altijd aanwezig.</para>
+<para>In de `metric' groep is de `interval' optioneel. Dit wordt bijvoorbeeld
+verstuurd door iSpindels en is de ingestelde update interval tijd in seconden.
+Indien dit niet aanwezig is dan wordt 300 seconden als standaard waarde gebruikt.
+Deze waarde wordt gebruikt om een apparaat als offline te markeren indien het langer
+als twee maal deze tijd niet wordt gezien.</para>
 <programlisting>
 {
 "timestamp": 1532201089,
-"seq": 0,
 "metric": {
 "uuid": "b508f01c-1f82-4e8b-b0d2-d88ecfb53031",
+"interval":300,
 "properties": {
 "hardwaremake": "Raspberry",
 "hardwaremodel": "Unknown",
 "os": "Linux",
 "os_version": "4.1.19+",
 "uuid": "48c9ae27-3f58-41c9-ae4b-1d57b249c45a",
 "alias": "unit1",
 "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",
 "state": "OK",
 "temperature": 21.562
 },
 "stage": "PRIMARY",
 "mode": "BEER",
 "setpoint": {
 "low": 21.0,
-"high": 21.0
+"high": 21.5
-},
-"webcam": {
-"url":"https://the.webcamserver.com:8090/?action=stream",
-"light": 1
 },
 "alarm": 0,
 "profile": {
 "uuid": "c93ad1bb-0446-4788-9c43-83990c5f8b82",
 "name": "Witbier methode Cellis",
 "percent": 0,
 "inittemp": {
 "low": 17.9,
 "high": 18.1
 },
-"fridgemode": 0,
 "steps": [
 {
 "resttime": 2,
 "steptime": 0,
 "target": {
 bepaald dus het uiteindelijke payload formaat.
 </para>
 <programlisting>
 {
 "timestamp": 1532201089,
-"seq": 0,
 "metric": {
 "product": {
 "uuid": "1eb0c7bf-bf06-491c-a086-ac5478d521b9",
 "code": "CB0001",
 "name": "Hoppy Housebeer"
 },
 "fan": {
 "power": 100,
 "usage": 8273772
 },
-"sg": 1.023,
 "event": "Something to mark",
 "fermenter_uuid": "48c9ae27-3f58-41c9-ae4b-1d57b249c45a"
 }
 }
 </programlisting>
 Ieder brouw product heeft zijn eigen bestand.
 De bestanden staan in <code>www/logs/fermentation/</code>.
 De bestandsnamen zijn <code>product_code\ product_name.log</code>.
 Het interne formaat is:</para>
 <programlisting>
 2014-11-15 18:39:12,BEER,PRIMARY,20.312,19.750,-1.500,20.5,18.6,18.8,35,12345,0,67890,Whatsup,Fermenter
-|            |     |      |      |      |      |    |    |   |   |   |   |      |        |
+|         |     |      |      |      |      |    |    |   |   |   |   |      |        |
-0 datetime +            |     |      |      |      |      |    |    |   |   |   |   |      |        |
+0 datetime +         |     |      |      |      |      |    |    |   |   |   |   |      |        |
-1 werkwijze ------------+     |      |      |      |      |    |    |   |   |   |   |      |        |
+1 werkwijze ---------+     |      |      |      |      |    |    |   |   |   |   |      |        |
-2 vergisting fase ------------+      |      |      |      |    |    |   |   |   |   |      |        |
+2 vergisting fase ---------+      |      |      |      |    |    |   |   |   |   |      |        |
-3 temperatuur lucht -----------------+      |      |      |    |    |   |   |   |   |      |        |
+3 temperatuur lucht --------------+      |      |      |    |    |   |   |   |   |      |        |
-4 temperatuur bier -------------------------+      |      |    |    |   |   |   |   |      |        |
+4 temperatuur bier ----------------------+      |      |    |    |   |   |   |   |      |        |
-5 temperatuur koeler ------------------------------+      |    |    |   |   |   |   |      |        |
+5 temperatuur koeler ---------------------------+      |    |    |   |   |   |   |      |        |
-6 temperatuur ruimte -------------------------------------+    |    |   |   |   |   |      |        |
+6 temperatuur ruimte ----------------------------------+    |    |   |   |   |   |      |        |
-7 instelwaarde laag -------------------------------------------+    |   |   |   |   |      |        |
+7 instelwaarde laag ----------------------------------------+    |   |   |   |   |      |        |
-8 instelwaarde hoog ------------------------------------------------+   |   |   |   |      |        |
+8 instelwaarde hoog ---------------------------------------------+   |   |   |   |      |        |
-9 verwarming vermogen --------------------------------------------------+   |   |   |      |        |
+9 verwarming vermogen -----------------------------------------------+   |   |   |      |        |
-10 verwarming verbruik ------------------------------------------------------+   |   |      |        |
+10 verwarming verbruik ---------------------------------------------------+   |   |      |        |
-11 koeler vermogen --------------------------------------------------------------+   |      |        |
+11 koeler vermogen -----------------------------------------------------------+   |      |        |
-12 koeler verbruik ------------------------------------------------------------------+      |        |
+12 koeler verbruik ---------------------------------------------------------------+      |        |
-13 gebeurtenis -----------------------------------------------------------------------------+        |
+13 gebeurtenis --------------------------------------------------------------------------+        |
-14 vergister uuid -----------------------------------------------------------------------------------+
+14 vergister uuid --------------------------------------------------------------------------------+
+</programlisting>
+</sect1>
+<sect1 id="payloadco2data">
+<title>Netwerk payload data formaat voor CO2 meters.</title>
+<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
+Voor iedere actieve CO2 meter wordt bij iedere systeemstart en iedere vijf
-gestuurd. Dit is ongeveer iedere 5 minuten. Omdat de CO2 meters eenvoudige
+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
 maar in platte tekst bestanden. Hierdoor is de gelogde informatie sneller toegankelijk.
 Ieder brouw product heeft zijn eigen bestand.
 2 CO2 flesdruk in bar ---------+                  |
 3 meter uuid -------------------------------------+
 </programlisting>
 </sect1>
+<sect1 id="payloadispindeldata">
+<title>Netwerk payload data formaat voor iSpindels.</title>
+<para>
+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. De instellingen voor <code>bmsd</code> in de iSpindel zijn:
+</para>
+<orderedlist>
+<listitem><para>Unit of temperature: Celsius</para></listitem>
+<listitem><para>Service Type: HTTP</para></listitem>
+<listitem><para>Token: leeg laten</para></listitem>
+<listitem><para>Server Address: het server IP adres</para></listitem>
+<listitem><para>Server Port: 80</para></listitem>
+<listitem><para>Path / URI: /ispindel/index.php</para></listitem>
+</orderedlist>
+<para>
+De densiteit wordt standaard door de iSpindel in graden Plato gegeven en zo worden
+de gegevens ook verwerkt. Het SG wordt door de <code>/ispindel/index.php</code>
+berekend. Dit script verzorgd de omzetting van de iSpindel POST data naar MQTT
+data.
+</para>
+<informaltable frame="none" rowsep="0" colsep="0">
+<tgroup cols="2">
+<tbody>
+<row>
+<entry>
+<para>
+<figure><title>iSpindel menu.</title>
+<mediaobject>
+<imageobject>
+<imagedata valign="top" fileref="bms-ispindel-1.png" scale="15" format="png">
+</imageobject>
+</mediaobject>
+</figure>
+</para>
+</entry>
+<entry>
+<para>
+<figure><title>iSpindel configuratie.</title>
+<mediaobject>
+<imageobject>
+<imagedata valign="top" fileref="bms-ispindel-2.png" scale="15" format="png">
+</imageobject>
+</mediaobject>
+</figure>
+</para>
+</entry>
+</row>
+</tbody>
+</tgroup>
+</informaltable>
+<para>
+De ontbrekende gegevens worden aangevuld door <command>bmsd</command>
+De volgende gegevens worden via het MQTT protocol ontvangen:
+</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>
+De iSpindel stuurt geen aparte log informatie, alle informatie voor de logfile
+wordt uit het standaard bericht gehaald.
+De log gegevens worden niet opgeslagen in de SQL database
+maar weggeschreven 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>.
+De bestandsnamen zijn <code>product_code\ product_name.log</code>.
+Het interne formaat is:</para>
+<programlisting>
+2020-01-05 14:01:53,19.3750,7.08093,1.02806,3.34724,38.78126,900,c0ffeeee-cafe-dead-bee0-2af236d50dc9
+|             |       |       |       |       |      |                 |
+0 datetime +             |       |       |       |       |      |                 |
+1 temperatuur -----------+       |       |       |       |      |                 |
+2 densiteit plato ---------------+       |       |       |      |                 |
+3 densiteit SG --------------------------+       |       |      |                 |
+4 batterij voltage ------------------------------+       |      |                 |
+5 tilt hoek ---------------------------------------------+      |                 |
+6 update interval ----------------------------------------------+                 |
+7 ispindel uuid ------------------------------------------------------------------+
+</programlisting>
+</sect1>
 </chapter>

Mercurial > bms / file comparison

comparison: doc/bms-ch8.sgml

doc/bms-ch8.sgml