Update documentation

docs/_sources/backlog.rst.txt

@@ -1,13 +1,18 @@
 Backlog of changes
 ##################
 
+This is a list of potential ideas to implemnt in the software. 
+
 Documentation
 -------------
 
 - Write contribution instructions
+- Example project for creating integrations and instructions
 
 Code
--------------
+----
 
 - Support for plato
 - Use pre-commit for validating check-in
+- Show indicated battery life based on interval (check if its feasable)
+- Use brewflasher for flashing

docs/_sources/index.rst.txt

@@ -23,6 +23,9 @@ The hardware design comes from the fantastic iSpindle project so that is not cov
 My approach to this software is a little different from that the original ispindle firmware. The github repository can 
 be found here; `GravityMon on Github <https://github.com/mp-se/gravitymon>`_
 
+
+
+
 .. note::
   This software is in the early stages even though its more than one year old so if you find issues, please 
   open a ticket on github.
@@ -30,29 +33,36 @@ be found here; `GravityMon on Github <https://github.com/mp-se/gravitymon>`_
   I dont take responsibility for any errors that can cause problems with the use. I have tested v0.4 on 5+ brews 
   over the last 6 months without any issues.
 
-
 The main differences:
 ---------------------
 
-* Operates in two modes ``gravity monitoring`` and ``configuration mode``
-* Send data to multiple endpoints when pushing data.
+* Operates in two modes gravity monitoring and configuration mode (simplify calibration)
+* Modern web based UI for configuration (in config mode)
+* REST API
+* Send data to multiple endpoints when pushing data (2xhttp, brewfather, influxdb v2, mqtt supported)
 * Automatic temperature adjustment of gravity reading
 * OTA support from local webserver
-* Build in function to create gravity formulas
-
-There are also a experimental features such as:
-
+* Built in function to create gravity formulas, no need for additional software, just enter tilt/gravity. 
+* Visual graph showing how formula will be interpreted
 * Using the temperature sensor in gyro instead of DS18B20 (faster)
-* Performance measurements (used to optimise code)
+* Built in performance measurements (used to optimise code)
 
 For a complete breakdown see the :ref:`functionallity`
 
+This is a simple overview of the different components that the software contains. The green ones are only active during `configuration mode` in 
+order to save battery.
+
+.. image:: images/software_design.png
+  :width: 600
+  :alt: Software design
+
+
 Credits to
 ----------
 Ideas to some of these functions have been picked up from disucssions in the iSpindle forums. This software uses 
 the following libraries and without these this would have been much more difficult to acheive:
 
-* https://github.com/jrowberg/i2cdevlib.git 
+* https://github.com/jrowberg/i2cdevlib 
 
   This library contains the basic code to interact with the gyro + many more chips.
 

docs/backlog.html

@@ -195,10 +195,12 @@
         <article role="main">
           <div class="section" id="backlog-of-changes">
 <h1>Backlog of changes<a class="headerlink" href="#backlog-of-changes" title="Permalink to this headline">¶</a></h1>
+<p>This is a list of potential ideas to implemnt in the software.</p>
 <div class="section" id="documentation">
 <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li><p>Write contribution instructions</p></li>
+<li><p>Example project for creating integrations and instructions</p></li>
 </ul>
 </div>
 <div class="section" id="code">
@@ -206,6 +208,8 @@
 <ul class="simple">
 <li><p>Support for plato</p></li>
 <li><p>Use pre-commit for validating check-in</p></li>
+<li><p>Show indicated battery life based on interval (check if its feasable)</p></li>
+<li><p>Use brewflasher for flashing</p></li>
 </ul>
 </div>
 </div>

docs/index.html

@@ -217,25 +217,28 @@ over the last 6 months without any issues.</p>
 <div class="section" id="the-main-differences">
 <h2>The main differences:<a class="headerlink" href="#the-main-differences" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
-<li><p>Operates in two modes <code class="docutils literal notranslate"><span class="pre">gravity</span> <span class="pre">monitoring</span></code> and <code class="docutils literal notranslate"><span class="pre">configuration</span> <span class="pre">mode</span></code></p></li>
-<li><p>Send data to multiple endpoints when pushing data.</p></li>
+<li><p>Operates in two modes gravity monitoring and configuration mode (simplify calibration)</p></li>
+<li><p>Modern web based UI for configuration (in config mode)</p></li>
+<li><p>REST API</p></li>
+<li><p>Send data to multiple endpoints when pushing data (2xhttp, brewfather, influxdb v2, mqtt supported)</p></li>
 <li><p>Automatic temperature adjustment of gravity reading</p></li>
 <li><p>OTA support from local webserver</p></li>
-<li><p>Build in function to create gravity formulas</p></li>
-</ul>
-<p>There are also a experimental features such as:</p>
-<ul class="simple">
+<li><p>Built in function to create gravity formulas, no need for additional software, just enter tilt/gravity.</p></li>
+<li><p>Visual graph showing how formula will be interpreted</p></li>
 <li><p>Using the temperature sensor in gyro instead of DS18B20 (faster)</p></li>
-<li><p>Performance measurements (used to optimise code)</p></li>
+<li><p>Built in performance measurements (used to optimise code)</p></li>
 </ul>
 <p>For a complete breakdown see the <a class="reference internal" href="functionallity.html#functionallity"><span class="std std-ref">Functionallity</span></a></p>
+<p>This is a simple overview of the different components that the software contains. The green ones are only active during <cite>configuration mode</cite> in
+order to save battery.</p>
+<a class="reference internal image-reference" href="_images/software_design.png"><img alt="Software design" src="_images/software_design.png" style="width: 600px;"/></a>
 </div>
 <div class="section" id="credits-to">
 <h2>Credits to<a class="headerlink" href="#credits-to" title="Permalink to this headline">¶</a></h2>
 <p>Ideas to some of these functions have been picked up from disucssions in the iSpindle forums. This software uses
 the following libraries and without these this would have been much more difficult to acheive:</p>
 <ul>
-<li><p><a class="reference external" href="https://github.com/jrowberg/i2cdevlib.git">https://github.com/jrowberg/i2cdevlib.git</a></p>
+<li><p><a class="reference external" href="https://github.com/jrowberg/i2cdevlib">https://github.com/jrowberg/i2cdevlib</a></p>
 <p>This library contains the basic code to interact with the gyro + many more chips.</p>
 </li>
 <li><p><a class="reference external" href="https://github.com/codeplea/tinyexpr">https://github.com/codeplea/tinyexpr</a></p>