Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
GitHub Action 2022-05-16 17:19:45 +00:00
parent fe0de4251d
commit 77b6c2b439
8 changed files with 36 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_images/qa_1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

2
docs/_sources/index.rst.txt
View File

@ -7,7 +7,7 @@ Welcome to GravityMon's documentation!
######################################
.. note::
This documentation reflects **v1.0**. Last updated 2022-05-15
This documentation reflects **v1.0**. Last updated 2022-05-16
* Docs for: `v0.8 <https://mp-se.github.io/gravitymon/v0.8/index.html>`_
* Docs for: `v0.9 <https://mp-se.github.io/gravitymon/v0.9/index.html>`_

17
docs/_sources/q_and_a.rst.txt
View File

@ -12,3 +12,20 @@ My device reports a temperature of -273C or -491F
-------------------------------------------------
- The DS18B20 temperature sensor cannot be found and this is the default value reported in this case.
- Check the orienation of the sensor and soldering.
Calibration error (unable to find a valid formula)
--------------------------------------------------
If you have issues to get a calibration formula. When a formula has been created the device always tries to validate the formula against the supplied values and if there is a to high deviation on any of the values then the formula will be rejected.
The image here shows such a case, one of the values is out of bounds.
.. image:: images/qa_1.png
:width: 500
:alt: Calibration Error
To fix these this you can;
- remove the value from the list (setting the angle to zero will do that)
- change the advanced setting (Formula max deviation) to a higher value and save the values again.
In the case above this paramater was changed from 1.6 SG to 4 SG and the formula was accepted. The deviation on this point was just above 3 SG.

1
docs/_sources/releases.rst.txt
View File

@ -9,6 +9,7 @@ Updates
Documentation
+++++++++++++
* Added documentation for Brewpiless as target
* Added q&a on formula creation and value deviation
v1.0.0
======

3
docs/index.html
View File

@ -207,7 +207,7 @@
<h1>Welcome to GravityMon’s documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline">#</a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This documentation reflects <strong>v1.0</strong>. Last updated 2022-05-15</p>
<p>This documentation reflects <strong>v1.0</strong>. Last updated 2022-05-16</p>
</div>
<ul class="simple">
<li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v0.8/index.html">v0.8</a></p></li>
@ -362,6 +362,7 @@ the following libraries and without these this would have been much more difficu
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q &amp; A</a><ul>
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#my-device-is-no-going-in-to-sleep-after-fully-charged">My device is no going in to sleep after fully charged</a></li>
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#my-device-reports-a-temperature-of-273c-or-491f">My device reports a temperature of -273C or -491F</a></li>
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#calibration-error-unable-to-find-a-valid-formula">Calibration error (unable to find a valid formula)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</a></li>

13
docs/q_and_a.html
View File

@ -221,6 +221,18 @@
<li><p>Check the orienation of the sensor and soldering.</p></li>
</ul>
</div>
<div class="section" id="calibration-error-unable-to-find-a-valid-formula">
<h2>Calibration error (unable to find a valid formula)<a class="headerlink" href="#calibration-error-unable-to-find-a-valid-formula" title="Permalink to this headline">#</a></h2>
<p>If you have issues to get a calibration formula. When a formula has been created the device always tries to validate the formula against the supplied values and if there is a to high deviation on any of the values then the formula will be rejected.</p>
<p>The image here shows such a case, one of the values is out of bounds.</p>
<a class="reference internal image-reference" href="_images/qa_1.png"><img alt="Calibration Error" src="_images/qa_1.png" style="width: 500px;"/></a>
<p>To fix these this you can;</p>
<ul class="simple">
<li><p>remove the value from the list (setting the angle to zero will do that)</p></li>
<li><p>change the advanced setting (Formula max deviation) to a higher value and save the values again.</p></li>
</ul>
<p>In the case above this paramater was changed from 1.6 SG to 4 SG and the formula was accepted. The deviation on this point was just above 3 SG.</p>
</div>
</div>
</article>
@ -283,6 +295,7 @@
<li><a class="reference internal" href="#">Q &amp; A</a><ul>
<li><a class="reference internal" href="#my-device-is-no-going-in-to-sleep-after-fully-charged">My device is no going in to sleep after fully charged</a></li>
<li><a class="reference internal" href="#my-device-reports-a-temperature-of-273c-or-491f">My device reports a temperature of -273C or -491F</a></li>
<li><a class="reference internal" href="#calibration-error-unable-to-find-a-valid-formula">Calibration error (unable to find a valid formula)</a></li>
</ul>
</li>
</ul>

1
docs/releases.html
View File

@ -211,6 +211,7 @@
<h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">#</a></h3>
<ul class="simple">
<li><p>Added documentation for Brewpiless as target</p></li>
<li><p>Added q&amp;a on formula creation and value deviation</p></li>
</ul>
</div>
</div>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long