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-09-15 18:23:10 +00:00
parent 9c8e833b3e
commit f93d96c79e
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/_sources/formula.rst.txt
View File

@ -9,7 +9,7 @@ Create formula
Here you can enter up to 10 values (angles + gravity) that is then used to create the formula. Angles equal to zero will be regarded as empty even if there is a gravity reading.
When you submit the values the device will try create a forumla with increasing level of complexity. It will start
When you submit the values the device will try create a formula with increasing level of complexity. It will start
with a order 2 formula and then try 3 and 4.
Once the formula has been created it will validate the formula against the supplied angles/gravity and if there is a too
@ -21,14 +21,14 @@ Under the Error Log you will also find hints to what problem the formula creator
`CALC: Validation failed on angle 33.430000, deviation too large 3.14, formula order 2`
This means that the angle 33.43 had a deviation of 5.8 SG and since the default threashold is 3, it will fail. You
This means that the angle 33.43 had a deviation of 5.8 SG and since the default threshold is 3, it will fail. You
can also see that it has failed on that point in both a order 2 and 4 formula.
.. image:: images/qa_1.png
:width: 400
:alt: Example of deviating value
So in this case you can either increase the threashold or remove the angle that has an issue. You can also
So in this case you can either increase the threshold or remove the angle that has an issue. You can also
use the graph on the calibration page to identify angles that is probably not correct.
.. image:: images/formula2.png

6
docs/formula.html
View File

@ -201,17 +201,17 @@
<span id="id1"></span><h1>Create formula<a class="headerlink" href="#create-formula" title="Permalink to this headline"></a></h1>
<a class="reference internal image-reference" href="_images/formula1.png"><img alt="Formula data" src="_images/formula1.png" style="width: 800px;"/></a>
<p>Here you can enter up to 10 values (angles + gravity) that is then used to create the formula. Angles equal to zero will be regarded as empty even if there is a gravity reading.</p>
<p>When you submit the values the device will try create a forumla with increasing level of complexity. It will start
<p>When you submit the values the device will try create a formula with increasing level of complexity. It will start
with a order 2 formula and then try 3 and 4.</p>
<p>Once the formula has been created it will validate the formula against the supplied angles/gravity and if there is a too
high difference, it will fail. You can adjust the sensitivity under advanced settings if you have issues.</p>
<p>Under the Error Log you will also find hints to what problem the formula creator encountered. Here is an example:</p>
<p><cite>CALC: Validation failed on angle 33.430000, deviation too large 5.86, formula order 4</cite></p>
<p><cite>CALC: Validation failed on angle 33.430000, deviation too large 3.14, formula order 2</cite></p>
<p>This means that the angle 33.43 had a deviation of 5.8 SG and since the default threashold is 3, it will fail. You
<p>This means that the angle 33.43 had a deviation of 5.8 SG and since the default threshold is 3, it will fail. You
can also see that it has failed on that point in both a order 2 and 4 formula.</p>
<a class="reference internal image-reference" href="_images/qa_1.png"><img alt="Example of deviating value" src="_images/qa_1.png" style="width: 400px;"/></a>
<p>So in this case you can either increase the threashold or remove the angle that has an issue. You can also
<p>So in this case you can either increase the threshold or remove the angle that has an issue. You can also
use the graph on the calibration page to identify angles that is probably not correct.</p>
<a class="reference internal image-reference" href="_images/formula2.png"><img alt="Formula graph" src="_images/formula2.png" style="width: 800px;"/></a>
<p>Once the formula is created a graph over the entered values and a simulation of the formula will give you a nice overview on how the formula will work.</p>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long