Documentation updates.

Sun, 12 May 2019 17:44:39 +0200

author
Michiel Broek <mbroek@mbse.eu>
date
Sun, 12 May 2019 17:44:39 +0200
changeset 364
487274c2e9dc
parent 363
0aa27f92a8f9
child 366
a14a31bfc73b
child 367
003f67218a49

Documentation updates.

README.design file | annotate | diff | comparison | revisions
doc/bms-ch6.sgml file | annotate | diff | comparison | revisions
doc/bms-ch8.sgml file | annotate | diff | comparison | revisions
--- a/README.design	Sun May 12 17:24:34 2019 +0200
+++ b/README.design	Sun May 12 17:44:39 2019 +0200
@@ -1,88 +1,7 @@
-Centrale daemon 'bmsd' regelt de dagelijkse berichten tussen MQTT en de
-database. Om deze berichten betrouwbaar af te handelen is MQTT er tussen
-gezet.
-Alle sensoren en controllers communiceren uitsluitend via MQTT.
-
-Sensoren en controllers:
-
-  1.  Vergisting controllers.
-  2.  Temperatuur loggen.
-  3.  Hergisting drukmeters. (druk + temp).
-  4.  Brouw controllers.
-  5.  Ispindel.
-
-
-Stappen:
-
-  1.  Importeren oude vergisting en brouw logs.  DONE.
-  2.  Thermferm moet DLOG berichten gaan sturen, per wijziging en per 5 minuten.  DONE.
-  3.  bmsd moet deze DLOG berichten verwerken. Versie 0.0.2. Bier producten in database. DONE.
-  4.  Versie 0.0.2 handmatig installeren op productie. DONE.
-  5.  Thermferm uitbreiden met vergisting stage. DONE.
-  6.  Brouw controller uitbreiden met MQTT. Niet, ESP32 wordt onstabiel.
-  7.  bmsd uitbreiden met brouw controller berichten. Niet, zie hierboven.
-  8.  bmsd productie platform upgraden, versie 0.0.3 DONE.
-  9.  bmsd recepten editor implementeren. DONE.
- 10.  bmsd uitbreiden met productie (brews) stappen, met hierin recepten. DONE.
- 11.  bmsd koppelen logs aan productie. DONE.
-
-
-
-
-MQTT structuur volgens Sparkplug model.
-
-mbv1.0/fermenters/[NBIRTH,DBIRTH]/<hostname>/
-mbv1.0/fermenters/DDATA/<hostname>/<unitalias>/
-
----------------------------------------------------------------------------
-
-namespace/group_id/message_type/edge_node_id/{device_id}
-
-namespace is de root, "mbv1.0"
-
-group_id oa: fermenters, brewcontrol, env_sensor
-
-message_type:	NBIRTH	- Birth certificate for MQTT EoN nodes.
-		NDEATH	- Death certificate for MQTT EoN nodes.
-		NCMD	- Node command message.
-		DBIRTH	- Birth certificate for devices.
-		DDEATH	- Death certificate for devices.
-		NDATA	- Node data message.
-		DDATA	- Device data message.
-		DLOG	- Device data logging.
-		DCMD	- Device command message.
-		STATE	- Critical application state message.
-
-NCMD:	reboot (application restart)
-	rebirth
-
-DCMD:	fermenter state change + temperature settings.
-	fermenter profile install.
-	fermenter load product.
-	fermenter set stage
-
-
-Product: code, uuid en naam.
-	Stage:  Plan Wait Brew Primary Secondary Tertiary Package Carbonation Mature Taste Ready Closed
-	                    |     |       |         |        |          |
-	                    |     |       |         |        |          +-------------	Log/rapport
-	                    |     |       |         |        +------------------------	rapport/etiketten
-	                    |     +-------+---------+---------------------------------	Log/rapport
-	                    +---------------------------------------------------------	Log/rapport
 
 	Main table: products.
-	  In progress: overview. DONE.
-	  In Progress: view charts. DONE.
 	  In Progress: view logs. 
-	  In Progress: update state. DONE.
-	  In Progress: Tabbed screens. DONE.
-          Start new: some sort of wizzard like a new recipe. DONE.
-	  Archive: select via name/code/date. DONE.
 	  Calendar: shows upcoming events.
-	  Recipes can be copied to 'recipes' or 'brews', imported from 'recipes'/'products' or created manual. DONE.
-          Products recipes Beerxml import. DONE.
-	  Recipes Beerxml import.
-
 
 -----------------------------------------------------------------------------
 
--- a/doc/bms-ch6.sgml	Sun May 12 17:24:34 2019 +0200
+++ b/doc/bms-ch6.sgml	Sun May 12 17:44:39 2019 +0200
@@ -8,4 +8,26 @@
 Productie tekst.
 </para>
 
+<sect1 id="prodfases">
+<title>Productie fases.</title>
+<para>Het productie proces is verdeeld in de volgende stappen:</para>
+
+<orderedlist>
+<listitem><para>Planning.</para></listitem>
+<listitem><para>Wachten.</para></listitem>
+<listitem><para>Brouwen.</para></listitem>
+<listitem><para>Hoofdgisting.</para></listitem>
+<listitem><para>Nagisting.</para></listitem>
+<listitem><para>Lageren.</para></listitem>
+<listitem><para>Verpakken.</para></listitem>
+<listitem><para>Hergisten.</para></listitem>
+<listitem><para>Rijpen.</para></listitem>
+<listitem><para>Proeven.</para></listitem>
+<listitem><para>Gereed.</para></listitem>
+<listitem><para>Afgesloten.</para></listitem>
+</orderedlist>
+
+
+</sect1>
+
 </chapter>
--- a/doc/bms-ch8.sgml	Sun May 12 17:24:34 2019 +0200
+++ b/doc/bms-ch8.sgml	Sun May 12 17:44:39 2019 +0200
@@ -45,15 +45,16 @@
 MQTT clients altijd zichtbaar. Bij het starten van een node wordt er een payload
 verzonden, zie het payload formaat voor een node. Als een node afsluit wordt juist geen
 payload verzonden zodat het bericht verdwijnt.</para></listitem>
-<listitem><para>NDATA wordt verstuurd als er veranderingen zijn voor de node,
-maar ook iedere vijf minuten om aan te geven dat de node nog "levend" en aanwezig
-is.</para></listitem>
 <listitem><para>NDEATH wordt verstuurd als een node offline gaat. Maar het kan ook
 ontvangen worden als de MQTT verbinding verbroken wordt met een node, het NDEATH
 bericht is ook het `last will' bericht van een node. Maar als het echt fout gaat
 dan zal er mogenlijk nooit een NDEATH bericht gezien worden.</para></listitem>
 <listitem><para>NCMD is een commando bestemd voor een node.
 Dit kan bijvoorbeeld een reboot commando zijn.</para></listitem>
+<listitem><para>NDATA wordt verstuurd als er veranderingen zijn voor de node,
+maar ook iedere vijf minuten om aan te geven dat de node nog "levend" en aanwezig
+is.</para></listitem>
+
 <listitem><para>DBIRTH is een of meer berichten van een apparaat wat online komt
 en ingeschakeld is. Een apparaat is een deel van een node.
 Bij het opstarten van de node is er geen <code>device_id</code>
@@ -61,10 +62,10 @@
 ingeschakeld wordt dan is er wel een geldige <code>device_id</code> aanwezig.
 Hier ook weer, er is een payload bij opstarten en geen payload bij afsluiten om het
 persistente bericht goed te houden.</para></listitem>
+<listitem><para>DDEATH wordt verstuurd als een node offline gaat, of als het apparaat
+uitgeschakelt wordt.</para></listitem>
 <listitem><para>DDATA heeft altijd een payload, maar deze hoeft niet volledig te zijn,
 enkel de gewijzigde data moet in het bericht zitten.</para></listitem>
-<listitem><para>DDEATH wordt verstuurd als een node offline gaat, of als het apparaat
-uitgeschakelt wordt.</para></listitem>
 <listitem><para>DLOG is een data log. Hier bestaat de payload uit gegevens die de
 bms applicatie in de database zet.</para></listitem>
 <listitem><para>DCMD is een commando voor een apparaat wat op een node geinstalleerd is.

mercurial