Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Action committed Jan 13, 2025
1 parent 64e191e commit 492a594
Show file tree
Hide file tree
Showing 29 changed files with 242 additions and 175 deletions.
Binary file added docs/_images/ui-gravity-formula-current.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ui-gravity-formula-formula.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ui-gravity-formula-graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/ui-gravity-formula-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/ui-gravity-formula.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 25 additions & 20 deletions docs/_sources/configuration.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -246,48 +246,53 @@ Gravity - Formula

* **Gravity formula:**

Gravity formula is compatible with standard iSpindle formulas so any existing calculation option can be used. You can also use
the feature to create the formula by supplying the raw data.
Gravity formula is syntax is the same as in the iSpindle, but the formula needs to be in SG since this is the internal format used. When choosing plato
the SG value will be converted and presented as Plato. On this page to create the formula by supplying the raw data. If you use the internal formula
creator then you can enter data in plato and conversion will be handled in the device, the output formula will always be in SG.

The gravity formula accepts two parameters, **tilt** for the angle or **temp** for temperature (temperature inserted into the formula
will be in celsius). I would recommend to use the formula calculation feature instead since this is much easier.

* **Data for gravity calculation:**

Enter your gravity data SG + Angle. You can enter up to 10 datapoints. Order does not matter and values with zero as angle will be ignored.
Enter your gravity data SG + Angle. You can enter up to 20 datapoints. Order does not matter and values with zero as angle will be ignored.

* **Max allowed deviation:**

This is the maximum deviation on the formula allowed for it to be accepted. Once the formula has been derived it will be validated against the supplied
data and of the deviation on any point is bigger the formula will be rejected.
data and of the deviation on any point is bigger the formula will be rejected. Example for SG can be 0.02 points or 0.5 for Plato. Setting a higher values
will allow you to see more options.

* **Calculate new formula:**
* **Calculate formula:**

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.
When you submit the values the device will create formulas for order 1 to 4 and show those that are within the accepted deviation. You can also see
how the formula performs in relation to your datapoints and what the deviation is per angle. The more data points you have the better the graph.

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 max allowed deviation if you have issues.

Under the Support / Error Log you will also find hints to what problem the formula creator encountered. Here is an example:
.. image:: images/ui-gravity-formula-current.png
:width: 800
:alt: Gravity Current

`CALC: Validation failed on angle 33.430000, deviation too large 5.86, formula order 4`
Here a graph is shown with your current formula compared with the entered data points.

`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 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/ui-gravity-formula-formula.png
:width: 800
:alt: Gravity Formula

Here you can see the generated formulas. A drop down selector is available on the top to make it easy to select the formula you want.

Gravity - Analysis
++++++++++++++++++
.. image:: images/ui-gravity-formula-table.png
:width: 800
:alt: Gravity Table

Table with calculated values per angle that has been used and the deviation from the entered data.

.. image:: images/ui-gravity-analysis.png
.. image:: images/ui-gravity-formula-graph.png
:width: 800
:alt: Gravity Analysis
:alt: Gravity Graph

Here you can see a graph over the entered values and also how that aligns with the current formula. This can allow you to spot any
values that might be invalid.
Here a graph is shown with the created formulas. You can deselect a formula by selecting the color in the legend.


Push targets
Expand Down
5 changes: 3 additions & 2 deletions docs/_sources/functionality.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,9 @@ The main features
Another big difference is that this software can create the gravity formula in the device, just enter the
angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.

Currently the device can handle 10 data points which should be enough to get a accurate formula. At least 3 data points
is needed to get an accurate formula.
Currently the device can handle 20 data points which should be enough to get a accurate formula.

You can also analyse how the formula compares to your raw data and formulas of different complexities.

* **Customize the data format being sent to push targets**

Expand Down
6 changes: 1 addition & 5 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -93,18 +93,14 @@ the following libraries and without these this would have been much more difficu

Json parser/creator used in configuration files and API's

* https://github.com/PaulStoffregen/OneWire
* https://github.com/pstolarz/OneWireNg

Communication library used for interacting with temperature sensor.

* https://github.com/milesburton/Arduino-Temperature-Control-Library

Interaction with the DS18B20 sensor

* https://github.com/Rotario/arduinoCurveFitting

Create the gravity formula.

* https://github.com/256dpi/arduino-mqtt

Library for sending data to mqtt based on lightweight mqtt implementation.
Expand Down
32 changes: 31 additions & 1 deletion docs/_sources/releases.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,40 @@
Releases
########

v2.1.0
======

New features
++++++++++++
* Updated formula creator.

* Allow user more choice when it comes to selecting the order and varifying result.
* Will now correctly handle Plato data as input
* Formula will still be created for SG since this is the internal format used by Gravitymon
* Moved formula creation from device code to UI code to allow for more flexible formula creation.
* Removed dependant library and API.

* Extended formula points from 10 to 20

.. note::
Update the formula deviation (default 3) to a value according to your selected gravity format eg. SG = 0.003

* Added warning when mqtt payload exceeds 700 bytes to avoid crashes
* Optimized code to reduce memory usage to allow for larger payloads when pushing data
* Update dependant libraries to latest version (Json 7, AsyncWebServer, EspFwk)

Bugs fixed
++++++++++
* UI no shows clearly when gyro is moving and average is not calculated
* Fixed broken link to removing old iSpindle configuration.
* Fixed limitation that lowest plato was 1 (now 0)
* Corrected docs on home assistant auto registration option.
* Skip SSL when in config mode flag now works correctly

v2.0.1
======

* Disable LED on esp8266 since it interfear with gyro communication.
* Disable LED on esp8266 since it might collide with gyro communication.

v2.0.0
======
Expand Down
8 changes: 4 additions & 4 deletions docs/_sources/services.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -231,12 +231,12 @@ template will create two sensors and update the values for them.

.. warning::

The registration will occur when you save the format template. If Home Assistant
is restarted then the device will disappear. The first method is the most persistent one.
The registration will be sent on every push so the downside is that this will consume more time thus reducing battery life.

.. warning::
This will only work on 1.1+ since the the memory allocation on previous versions are not enough to handle this large payload.
Earlier version can handle 2 of the values.

This method is not recommended for an ESP8266 since the low RAM memory will not be enough and there is a high probability that the device
will crash insted. Testing shows that more than 1000 characters of data will likley crash the device.

::

Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '2.0.0-beta2',
VERSION: '2.1.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
6 changes: 3 additions & 3 deletions docs/compiling.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contributing" href="contributing.html" /><link rel="prev" title="Gateway" href="gateway.html" />

<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
<title>Compiling the software - GravityMon v2.0.0</title>
<title>Compiling the software - GravityMon v2.1.0</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
Expand Down Expand Up @@ -123,7 +123,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">GravityMon v2.0.0</div></a>
<a href="index.html"><div class="brand">GravityMon v2.1.0</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -149,7 +149,7 @@
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">GravityMon v2.0.0</span>
<span class="sidebar-brand-text">GravityMon v2.1.0</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
Expand Down
46 changes: 21 additions & 25 deletions docs/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Format Templates" href="format-template.html" /><link rel="prev" title="Software Installation" href="installation.html" />

<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
<title>Configuration - GravityMon v2.0.0</title>
<title>Configuration - GravityMon v2.1.0</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
Expand Down Expand Up @@ -123,7 +123,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">GravityMon v2.0.0</div></a>
<a href="index.html"><div class="brand">GravityMon v2.1.0</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -149,7 +149,7 @@
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">GravityMon v2.0.0</span>
<span class="sidebar-brand-text">GravityMon v2.1.0</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
Expand Down Expand Up @@ -387,36 +387,33 @@ <h3>Gravity - Formula<a class="headerlink" href="#gravity-formula" title="Permal
<a class="reference internal image-reference" href="_images/ui-gravity-formula.png"><img alt="Gravity Formula" src="_images/ui-gravity-formula.png" style="width: 800px;"/></a>
<ul>
<li><p><strong>Gravity formula:</strong></p>
<p>Gravity formula is compatible with standard iSpindle formulas so any existing calculation option can be used. You can also use
the feature to create the formula by supplying the raw data.</p>
<p>Gravity formula is syntax is the same as in the iSpindle, but the formula needs to be in SG since this is the internal format used. When choosing plato
the SG value will be converted and presented as Plato. On this page to create the formula by supplying the raw data. If you use the internal formula
creator then you can enter data in plato and conversion will be handled in the device, the output formula will always be in SG.</p>
<p>The gravity formula accepts two parameters, <strong>tilt</strong> for the angle or <strong>temp</strong> for temperature (temperature inserted into the formula
will be in celsius). I would recommend to use the formula calculation feature instead since this is much easier.</p>
</li>
<li><p><strong>Data for gravity calculation:</strong></p>
<p>Enter your gravity data SG + Angle. You can enter up to 10 datapoints. Order does not matter and values with zero as angle will be ignored.</p>
<p>Enter your gravity data SG + Angle. You can enter up to 20 datapoints. Order does not matter and values with zero as angle will be ignored.</p>
</li>
<li><p><strong>Max allowed deviation:</strong></p>
<p>This is the maximum deviation on the formula allowed for it to be accepted. Once the formula has been derived it will be validated against the supplied
data and of the deviation on any point is bigger the formula will be rejected.</p>
</li>
<li><p><strong>Calculate new formula:</strong></p>
<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 max allowed deviation if you have issues.</p>
<p>Under the Support / 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 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>
data and of the deviation on any point is bigger the formula will be rejected. Example for SG can be 0.02 points or 0.5 for Plato. Setting a higher values
will allow you to see more options.</p>
</li>
<li><p><strong>Calculate formula:</strong></p>
<p>When you submit the values the device will create formulas for order 1 to 4 and show those that are within the accepted deviation. You can also see
how the formula performs in relation to your datapoints and what the deviation is per angle. The more data points you have the better the graph.</p>
</li>
</ul>
</div>
<div class="section" id="gravity-analysis">
<h3>Gravity - Analysis<a class="headerlink" href="#gravity-analysis" title="Permalink to this headline"></a></h3>
<a class="reference internal image-reference" href="_images/ui-gravity-analysis.png"><img alt="Gravity Analysis" src="_images/ui-gravity-analysis.png" style="width: 800px;"/></a>
<p>Here you can see a graph over the entered values and also how that aligns with the current formula. This can allow you to spot any
values that might be invalid.</p>
<a class="reference internal image-reference" href="_images/ui-gravity-formula-current.png"><img alt="Gravity Current" src="_images/ui-gravity-formula-current.png" style="width: 800px;"/></a>
<p>Here a graph is shown with your current formula compared with the entered data points.</p>
<a class="reference internal image-reference" href="_images/ui-gravity-formula-formula.png"><img alt="Gravity Formula" src="_images/ui-gravity-formula-formula.png" style="width: 800px;"/></a>
<p>Here you can see the generated formulas. A drop down selector is available on the top to make it easy to select the formula you want.</p>
<a class="reference internal image-reference" href="_images/ui-gravity-formula-table.png"><img alt="Gravity Table" src="_images/ui-gravity-formula-table.png" style="width: 800px;"/></a>
<p>Table with calculated values per angle that has been used and the deviation from the entered data.</p>
<a class="reference internal image-reference" href="_images/ui-gravity-formula-graph.png"><img alt="Gravity Graph" src="_images/ui-gravity-formula-graph.png" style="width: 800px;"/></a>
<p>Here a graph is shown with the created formulas. You can deselect a formula by selecting the color in the legend.</p>
</div>
</div>
<div class="section" id="push-targets">
Expand Down Expand Up @@ -721,7 +718,6 @@ <h3>Other - About<a class="headerlink" href="#other-about" title="Permalink to t
<li><a class="reference internal" href="#gravity">Gravity</a><ul>
<li><a class="reference internal" href="#gravity-settings">Gravity - Settings</a></li>
<li><a class="reference internal" href="#gravity-formula">Gravity - Formula</a></li>
<li><a class="reference internal" href="#gravity-analysis">Gravity - Analysis</a></li>
</ul>
</li>
<li><a class="reference internal" href="#push-targets">Push targets</a><ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Licence" href="license.html" /><link rel="prev" title="Compiling the software" href="compiling.html" />

<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
<title>Contributing - GravityMon v2.0.0</title>
<title>Contributing - GravityMon v2.1.0</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
Expand Down Expand Up @@ -123,7 +123,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">GravityMon v2.0.0</div></a>
<a href="index.html"><div class="brand">GravityMon v2.1.0</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -149,7 +149,7 @@
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">GravityMon v2.0.0</span>
<span class="sidebar-brand-text">GravityMon v2.1.0</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
Expand Down
6 changes: 3 additions & 3 deletions docs/data.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Gateway" href="gateway.html" /><link rel="prev" title="Service Integration" href="services.html" />

<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
<title>Data Formats - GravityMon v2.0.0</title>
<title>Data Formats - GravityMon v2.1.0</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
Expand Down Expand Up @@ -123,7 +123,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">GravityMon v2.0.0</div></a>
<a href="index.html"><div class="brand">GravityMon v2.1.0</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -149,7 +149,7 @@
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">GravityMon v2.0.0</span>
<span class="sidebar-brand-text">GravityMon v2.1.0</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
Expand Down
Loading

0 comments on commit 492a594

Please sign in to comment.