Updated documentation

Thu, 16 Jan 2020 16:45:18 +0100

author
Michiel Broek <mbroek@mbse.eu>
date
Thu, 16 Jan 2020 16:45:18 +0100
changeset 595
655a161bb7c7
parent 594
5e3611bf0dc2
child 596
2270a73628b5

Updated documentation

doc/bms-ch8.sgml file | annotate | diff | comparison | revisions
doc/bms-ispindel-1.png file | annotate | diff | comparison | revisions
doc/bms-ispindel-2.png file | annotate | diff | comparison | revisions
doc/bms.sgml file | annotate | diff | comparison | revisions
--- a/doc/bms-ch8.sgml	Wed Jan 15 15:30:27 2020 +0100
+++ b/doc/bms-ch8.sgml	Thu Jan 16 16:45:18 2020 +0100
@@ -435,9 +435,59 @@
 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:
+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>
 {
@@ -456,8 +506,8 @@
 <para>
 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.
+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>.
Binary file doc/bms-ispindel-1.png has changed
Binary file doc/bms-ispindel-2.png has changed
--- a/doc/bms.sgml	Wed Jan 15 15:30:27 2020 +0100
+++ b/doc/bms.sgml	Thu Jan 16 16:45:18 2020 +0100
@@ -1,4 +1,4 @@
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.4//EN" [
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.5//EN" [
 <!ENTITY chapter1 SYSTEM "bms-ch1.sgml">
 <!ENTITY chapter2 SYSTEM "bms-ch2.sgml">
 <!ENTITY chapter3 SYSTEM "bms-ch3.sgml">
@@ -20,7 +20,7 @@
     </authorgroup>
 
     <copyright>
-	<year>2018</year>
+	<year>2018-2020</year>
 	<holder role='mailto:mbse@mbse.eu'>M. Broek</holder>
     </copyright>
 

mercurial