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 2023-02-04 11:01:25 +00:00
parent 3ac513ab85
commit e049e83c27
26 changed files with 138 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -10,7 +10,7 @@ To reduce the need for adding custom endpoints for various services there is an
.. warning:: .. warning::
Since the format templates can be big this function can be quite slow on a small device such as the esp8266. If format templates are large this feature can be slow on a small device such as the esp8266.
.. image:: images/format.png .. image:: images/format.png
:width: 800 :width: 800

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

@ -165,7 +165,7 @@ Name of organisation in Influx.
* **Influx DB v2 Bucket:** * **Influx DB v2 Bucket:**
Identifier for bucket. Token for bucket. Don't use the bucket name.
* **Influx DB v2 Token:** * **Influx DB v2 Token:**

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

@ -7,7 +7,7 @@ Welcome to GravityMon
##################### #####################
.. note:: .. note::
This documentation reflects **v1.2.1**. Last updated 2023-01-23 This documentation reflects **v1.2.1**. Last updated 2023-02-03
What is GravityMon? What is GravityMon?
-------------------- --------------------

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

@ -1,6 +1,22 @@
Q & A Q & A
##### #####
User interface does not render correctly
----------------------------------------
Since the user interface is built using bootstrap v5 the device requires access to the internet
to download required javascript and css files. Due to size it would not be possible to store these
on the device. Make sure the device can access: https://cdn.jsdelivr.net/npm/bootstrap
Data is not populated in the fields
------------------------------------
The user interface uses JQuery to fetch data from the device. This javascript library needs to be downloaded
from the internet. Due to size it would not be possible to store these on the device. Make sure the
device can access: https://code.jquery.com
Also ensure that any security tools does not block the execution of these features.
My device is no going in to sleep after fully charged My device is no going in to sleep after fully charged
----------------------------------------------------- -----------------------------------------------------
- Calibrate the device in the web interface - Calibrate the device in the web interface
@ -11,7 +27,7 @@ My device is no going in to sleep after fully charged
My device reports a temperature of -273C or -491F 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. - The DS18B20 temperature sensor cannot be found and this is the default value reported in this case.
- Check the orientation of the sensor and soldering. - Check the orientation of the sensor and the soldering.
Calibration error (unable to find a valid formula) Calibration error (unable to find a valid formula)
-------------------------------------------------- --------------------------------------------------
@ -30,18 +46,26 @@ To fix these this you can;
In the case above this parameter was changed from 1.6 SG to 4 SG and the formula was accepted. The deviation on this point was just above 3 SG. In the case above this parameter was changed from 1.6 SG to 4 SG and the formula was accepted. The deviation on this point was just above 3 SG.
User interface does not render correctly How can I filter data on influxdb without needing to know the time range
---------------------------------------- ------------------------------------------------------------------------
Since the user interface is built using bootstrap v5 the device requires access to the internet You can use any of the available fields to enter your custom data. An option is to use the token fields to
to download required javascript and css files. Due to size it would not be possible to store these add some custom information to identify your brew. This can then be used to filter your data in influxdb.
on the device. Make sure the device can access: https://cdn.jsdelivr.net/npm/bootstrap
Data is not populated in the fields When you switch brews you need to go in and change the token to identify the brewing session.
------------------------------------
The user interface uses JQuery to fetch data from the device. This javascript library needs to be downloaded Change the format template for the influx target to include the token field. Now you will have an
from the internet. Due to size it would not be possible to store these on the device. Make sure the field called event that you can filter on in influx.
device can access: https://code.jquery.com
.. code-block::
gravity-format=${gravity-unit} gravity=${gravity},corr-gravity=${corr-gravity},
angle=${angle},temp=${temp},battery=${battery},rssi=${rssi}
to
.. code-block::
gravity-format=${gravity-unit} gravity=${gravity},corr-gravity=${corr-gravity},
angle=${angle},temp=${temp},battery=${battery},rssi=${rssi},event=${token}
Also ensure that any security tools does not block the execution of these features.

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

@ -14,6 +14,11 @@ Other
+++++ +++++
* Update tinyexpr library to latest baseline. For forumula evaluation. * Update tinyexpr library to latest baseline. For forumula evaluation.
Documentation
+++++++++++++
* Minor updates and corrections to the documetation.
* Updated Q&A section
v1.2.0 v1.2.0
====== ======

2
docs/_static/documentation_options.js vendored
View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.2.0', VERSION: '1.2.1',
LANGUAGE: 'None', LANGUAGE: 'None',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
BUILDER: 'html', BUILDER: 'html',

4
docs/advanced.html
View File

@ -208,7 +208,7 @@
<p>To reduce the need for adding custom endpoints for various services there is an built in format editor that allows the user to customize the format being sent to the push target.</p> <p>To reduce the need for adding custom endpoints for various services there is an built in format editor that allows the user to customize the format being sent to the push target.</p>
<div class="admonition warning"> <div class="admonition warning">
<p class="admonition-title">Warning</p> <p class="admonition-title">Warning</p>
<p>Since the format templates can be big this function can be quite slow on a small device such as the esp8266.</p> <p>If format templates are large this feature can be slow on a small device such as the esp8266.</p>
</div> </div>
<a class="reference internal image-reference" href="_images/format.png"><img alt="Format editor" src="_images/format.png" style="width: 800px;"/></a> <a class="reference internal image-reference" href="_images/format.png"><img alt="Format editor" src="_images/format.png" style="width: 800px;"/></a>
<p>You enter the format data in the text field and the test button will show an example on what the output would look like. If the data cannot be formatted in json it will just be displayed as a long string. <p>You enter the format data in the text field and the test button will show an example on what the output would look like. If the data cannot be formatted in json it will just be displayed as a long string.
@ -359,7 +359,7 @@ The save button will save the current formula and reload the data from the devic
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/api.html
View File

@ -642,7 +642,7 @@ present or the API call will fail. You only need to include the parameters you w
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/compiling.html
View File

@ -375,7 +375,7 @@ with the option <strong>DUSE_SERIAL_PINS</strong> and attach as USB to TTL cable
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

4
docs/configuration.html
View File

@ -329,7 +329,7 @@ will not show until the device tries to push data.</p>
<ul class="simple"> <ul class="simple">
<li><p><strong>Influx DB v2 Bucket:</strong></p></li> <li><p><strong>Influx DB v2 Bucket:</strong></p></li>
</ul> </ul>
<p>Identifier for bucket.</p> <p>Token for bucket. Don’t use the bucket name.</p>
<ul class="simple"> <ul class="simple">
<li><p><strong>Influx DB v2 Token:</strong></p></li> <li><p><strong>Influx DB v2 Token:</strong></p></li>
</ul> </ul>
@ -514,7 +514,7 @@ accept data every 15 min.</p>
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/contributing.html
View File

@ -256,7 +256,7 @@ that this approach works fine.</p>
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/data.html
View File

@ -346,7 +346,7 @@ they can be uploaded manually afterwards.</p>
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/formula.html
View File

@ -249,7 +249,7 @@ use the graph on the calibration page to identify angles that is probably not co
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/functionality.html
View File

@ -417,7 +417,7 @@ temperature would reduce the total runtime with 25%. Sending data over http take
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/genindex.html
View File

@ -216,7 +216,7 @@
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/hardware.html
View File

@ -324,7 +324,7 @@ ESP32 chips for iSpindel). You need a USB to TTL converter for this to work. Thi
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

9
docs/index.html
View File

@ -205,7 +205,7 @@
<h1>Welcome to GravityMon<a class="headerlink" href="#welcome-to-gravitymon" title="Permalink to this headline"></a></h1> <h1>Welcome to GravityMon<a class="headerlink" href="#welcome-to-gravitymon" title="Permalink to this headline"></a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This documentation reflects <strong>v1.2.1</strong>. Last updated 2023-01-23</p> <p>This documentation reflects <strong>v1.2.1</strong>. Last updated 2023-02-03</p>
</div> </div>
<div class="section" id="what-is-gravitymon"> <div class="section" id="what-is-gravitymon">
<h2>What is GravityMon?<a class="headerlink" href="#what-is-gravitymon" title="Permalink to this headline"></a></h2> <h2>What is GravityMon?<a class="headerlink" href="#what-is-gravitymon" title="Permalink to this headline"></a></h2>
@ -413,11 +413,12 @@ the following libraries and without these this would have been much more difficu
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q &amp; A</a><ul> <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#user-interface-does-not-render-correctly">User interface does not render correctly</a></li>
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#data-is-not-populated-in-the-fields">Data is not populated in the fields</a></li>
<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-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#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> <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>
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#user-interface-does-not-render-correctly">User interface does not render correctly</a></li> <li class="toctree-l2"><a class="reference internal" href="q_and_a.html#how-can-i-filter-data-on-influxdb-without-needing-to-know-the-time-range">How can I filter data on influxdb without needing to know the time range</a></li>
<li class="toctree-l2"><a class="reference internal" href="q_and_a.html#data-is-not-populated-in-the-fields">Data is not populated in the fields</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -451,7 +452,7 @@ the following libraries and without these this would have been much more difficu
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/installation.html
View File

@ -348,7 +348,7 @@ with finding the network name you can try the following:</p>
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/intro.html
View File

@ -291,7 +291,7 @@ Its recommended to attach the device to power when you have it in <cite>configur
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/license.html
View File

@ -250,7 +250,7 @@ SOFTWARE.</p>
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

48
docs/q_and_a.html
View File

@ -203,6 +203,19 @@
<article role="main"> <article role="main">
<div class="section" id="q-a"> <div class="section" id="q-a">
<h1>Q &amp; A<a class="headerlink" href="#q-a" title="Permalink to this headline"></a></h1> <h1>Q &amp; A<a class="headerlink" href="#q-a" title="Permalink to this headline"></a></h1>
<div class="section" id="user-interface-does-not-render-correctly">
<h2>User interface does not render correctly<a class="headerlink" href="#user-interface-does-not-render-correctly" title="Permalink to this headline"></a></h2>
<p>Since the user interface is built using bootstrap v5 the device requires access to the internet
to download required javascript and css files. Due to size it would not be possible to store these
on the device. Make sure the device can access: <a class="reference external" href="https://cdn.jsdelivr.net/npm/bootstrap">https://cdn.jsdelivr.net/npm/bootstrap</a></p>
</div>
<div class="section" id="data-is-not-populated-in-the-fields">
<h2>Data is not populated in the fields<a class="headerlink" href="#data-is-not-populated-in-the-fields" title="Permalink to this headline"></a></h2>
<p>The user interface uses JQuery to fetch data from the device. This javascript library needs to be downloaded
from the internet. Due to size it would not be possible to store these on the device. Make sure the
device can access: <a class="reference external" href="https://code.jquery.com">https://code.jquery.com</a></p>
<p>Also ensure that any security tools does not block the execution of these features.</p>
</div>
<div class="section" id="my-device-is-no-going-in-to-sleep-after-fully-charged"> <div class="section" id="my-device-is-no-going-in-to-sleep-after-fully-charged">
<h2>My device is no going in to sleep after fully charged<a class="headerlink" href="#my-device-is-no-going-in-to-sleep-after-fully-charged" title="Permalink to this headline"></a></h2> <h2>My device is no going in to sleep after fully charged<a class="headerlink" href="#my-device-is-no-going-in-to-sleep-after-fully-charged" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
@ -216,7 +229,7 @@
<h2>My device reports a temperature of -273C or -491F<a class="headerlink" href="#my-device-reports-a-temperature-of-273c-or-491f" title="Permalink to this headline"></a></h2> <h2>My device reports a temperature of -273C or -491F<a class="headerlink" href="#my-device-reports-a-temperature-of-273c-or-491f" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>The DS18B20 temperature sensor cannot be found and this is the default value reported in this case.</p></li> <li><p>The DS18B20 temperature sensor cannot be found and this is the default value reported in this case.</p></li>
<li><p>Check the orientation of the sensor and soldering.</p></li> <li><p>Check the orientation of the sensor and the soldering.</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="calibration-error-unable-to-find-a-valid-formula"> <div class="section" id="calibration-error-unable-to-find-a-valid-formula">
@ -231,18 +244,22 @@
</ul> </ul>
<p>In the case above this parameter 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> <p>In the case above this parameter 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>
<div class="section" id="user-interface-does-not-render-correctly"> <div class="section" id="how-can-i-filter-data-on-influxdb-without-needing-to-know-the-time-range">
<h2>User interface does not render correctly<a class="headerlink" href="#user-interface-does-not-render-correctly" title="Permalink to this headline"></a></h2> <h2>How can I filter data on influxdb without needing to know the time range<a class="headerlink" href="#how-can-i-filter-data-on-influxdb-without-needing-to-know-the-time-range" title="Permalink to this headline"></a></h2>
<p>Since the user interface is built using bootstrap v5 the device requires access to the internet <p>You can use any of the available fields to enter your custom data. An option is to use the token fields to
to download required javascript and css files. Due to size it would not be possible to store these add some custom information to identify your brew. This can then be used to filter your data in influxdb.</p>
on the device. Make sure the device can access: <a class="reference external" href="https://cdn.jsdelivr.net/npm/bootstrap">https://cdn.jsdelivr.net/npm/bootstrap</a></p> <p>When you switch brews you need to go in and change the token to identify the brewing session.</p>
<p>Change the format template for the influx target to include the token field. Now you will have an
field called event that you can filter on in influx.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>gravity-format=${gravity-unit} gravity=${gravity},corr-gravity=${corr-gravity},
angle=${angle},temp=${temp},battery=${battery},rssi=${rssi}
</pre></div>
</div>
<p>to</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>gravity-format=${gravity-unit} gravity=${gravity},corr-gravity=${corr-gravity},
angle=${angle},temp=${temp},battery=${battery},rssi=${rssi},event=${token}
</pre></div>
</div> </div>
<div class="section" id="data-is-not-populated-in-the-fields">
<h2>Data is not populated in the fields<a class="headerlink" href="#data-is-not-populated-in-the-fields" title="Permalink to this headline"></a></h2>
<p>The user interface uses JQuery to fetch data from the device. This javascript library needs to be downloaded
from the internet. Due to size it would not be possible to store these on the device. Make sure the
device can access: <a class="reference external" href="https://code.jquery.com">https://code.jquery.com</a></p>
<p>Also ensure that any security tools does not block the execution of these features.</p>
</div> </div>
</div> </div>
@ -266,7 +283,7 @@ device can access: <a class="reference external" href="https://code.jquery.com">
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>
@ -286,11 +303,12 @@ device can access: <a class="reference external" href="https://code.jquery.com">
<div class="toc-tree"> <div class="toc-tree">
<ul> <ul>
<li><a class="reference internal" href="#">Q &amp; A</a><ul> <li><a class="reference internal" href="#">Q &amp; A</a><ul>
<li><a class="reference internal" href="#user-interface-does-not-render-correctly">User interface does not render correctly</a></li>
<li><a class="reference internal" href="#data-is-not-populated-in-the-fields">Data is not populated in the fields</a></li>
<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-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="#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> <li><a class="reference internal" href="#calibration-error-unable-to-find-a-valid-formula">Calibration error (unable to find a valid formula)</a></li>
<li><a class="reference internal" href="#user-interface-does-not-render-correctly">User interface does not render correctly</a></li> <li><a class="reference internal" href="#how-can-i-filter-data-on-influxdb-without-needing-to-know-the-time-range">How can I filter data on influxdb without needing to know the time range</a></li>
<li><a class="reference internal" href="#data-is-not-populated-in-the-fields">Data is not populated in the fields</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>

64
docs/releases.html
View File

@ -217,6 +217,13 @@
<li><p>Update tinyexpr library to latest baseline. For forumula evaluation.</p></li> <li><p>Update tinyexpr library to latest baseline. For forumula evaluation.</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="documentation">
<h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Minor updates and corrections to the documetation.</p></li>
<li><p>Updated Q&amp;A section</p></li>
</ul>
</div>
</div> </div>
<div class="section" id="v1-2-0"> <div class="section" id="v1-2-0">
<h2>v1.2.0<a class="headerlink" href="#v1-2-0" title="Permalink to this headline"></a></h2> <h2>v1.2.0<a class="headerlink" href="#v1-2-0" title="Permalink to this headline"></a></h2>
@ -233,8 +240,8 @@
<li><p>Added option to download firmware updates from <a class="reference external" href="https://www.gravitymon.com">https://www.gravitymon.com</a></p></li> <li><p>Added option to download firmware updates from <a class="reference external" href="https://www.gravitymon.com">https://www.gravitymon.com</a></p></li>
</ul> </ul>
</div> </div>
<div class="section" id="documentation"> <div class="section" id="id2">
<h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h3> <h3>Documentation<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Added section about the Floaty hardware</p></li> <li><p>Added section about the Floaty hardware</p></li>
<li><p>Fixed schema errors in hardware section and linked PCB options</p></li> <li><p>Fixed schema errors in hardware section and linked PCB options</p></li>
@ -242,8 +249,8 @@
<li><p>Updated installation instructions.</p></li> <li><p>Updated installation instructions.</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id2"> <div class="section" id="id3">
<h3>Issues adressed<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3> <h3>Issues adressed<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>BUG: The first portion of a format template was lost when doing conversion.</p></li> <li><p>BUG: The first portion of a format template was lost when doing conversion.</p></li>
</ul> </ul>
@ -257,8 +264,8 @@
</div> </div>
<div class="section" id="v1-1-0"> <div class="section" id="v1-1-0">
<h2>v1.1.0<a class="headerlink" href="#v1-1-0" title="Permalink to this headline"></a></h2> <h2>v1.1.0<a class="headerlink" href="#v1-1-0" title="Permalink to this headline"></a></h2>
<div class="section" id="id3"> <div class="section" id="id4">
<h3>Features<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3> <h3>Features<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Added information to error log about abnormal resets (for instance crashes) to detect and fix those</p></li> <li><p>Added information to error log about abnormal resets (for instance crashes) to detect and fix those</p></li>
<li><p>Changed storage mode so that the device will go into deep sleep until reset (sleep forever)</p></li> <li><p>Changed storage mode so that the device will go into deep sleep until reset (sleep forever)</p></li>
@ -308,8 +315,8 @@
<li><p>User can now edit the voltage level that forces the device into config mode (device detects charging)</p></li> <li><p>User can now edit the voltage level that forces the device into config mode (device detects charging)</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id4"> <div class="section" id="id5">
<h3>Documentation<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3> <h3>Documentation<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Added documentation for Brewpiless as target</p></li> <li><p>Added documentation for Brewpiless as target</p></li>
<li><p>Added documentation for BVrewblox as target</p></li> <li><p>Added documentation for BVrewblox as target</p></li>
@ -321,8 +328,8 @@
<li><p>Added q&amp;a on formula creation and value deviation</p></li> <li><p>Added q&amp;a on formula creation and value deviation</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id5"> <div class="section" id="id6">
<h3>Other<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3> <h3>Other<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Upgraded framework for ESP8266 to v5.0.0</p></li> <li><p>Upgraded framework for ESP8266 to v5.0.0</p></li>
<li><p>Upgraded framework for ESP32 to v2.0.2</p></li> <li><p>Upgraded framework for ESP32 to v2.0.2</p></li>
@ -333,8 +340,8 @@
</div> </div>
<div class="section" id="v1-0-0"> <div class="section" id="v1-0-0">
<h2>v1.0.0<a class="headerlink" href="#v1-0-0" title="Permalink to this headline"></a></h2> <h2>v1.0.0<a class="headerlink" href="#v1-0-0" title="Permalink to this headline"></a></h2>
<div class="section" id="id6"> <div class="section" id="id7">
<h3>Documentation<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3> <h3>Documentation<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Update documentation to match v1.0</p></li> <li><p>Update documentation to match v1.0</p></li>
<li><p>Installation instructions updated on how to find the device after wifi has been configured.</p></li> <li><p>Installation instructions updated on how to find the device after wifi has been configured.</p></li>
@ -343,8 +350,8 @@
<li><p>Added additional http error codes to troubleshooting documentation</p></li> <li><p>Added additional http error codes to troubleshooting documentation</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id7"> <div class="section" id="id8">
<h3>User interface<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3> <h3>User interface<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Upgraded to bootstrap v5.1 for web pages.</p></li> <li><p>Upgraded to bootstrap v5.1 for web pages.</p></li>
<li><p>Added button on index page to direct to github issues.</p></li> <li><p>Added button on index page to direct to github issues.</p></li>
@ -355,8 +362,8 @@
<li><p>Added function on format page so that it’s easy to copy a format template from the docs (simplify service integration).</p></li> <li><p>Added function on format page so that it’s easy to copy a format template from the docs (simplify service integration).</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id8"> <div class="section" id="id9">
<h3>Features<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3> <h3>Features<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Added advanced setting to ignore angles that are lower than water. This is disabled by default.</p></li> <li><p>Added advanced setting to ignore angles that are lower than water. This is disabled by default.</p></li>
<li><p>Added support for MPU6500 (standard is MPU6050).</p></li> <li><p>Added support for MPU6500 (standard is MPU6050).</p></li>
@ -373,8 +380,8 @@
<li><p>Advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing battery life</p></li> <li><p>Advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing battery life</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="id9"> <div class="section" id="id10">
<h3>Issues addressed<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3> <h3>Issues addressed<a class="headerlink" href="#id10" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>BUG: Fixed issue in formula calculation in case there were a gap in the data series</p></li> <li><p>BUG: Fixed issue in formula calculation in case there were a gap in the data series</p></li>
<li><p>BUG: Field name for wifi strength changed from “rssi” to “RSSI”</p></li> <li><p>BUG: Field name for wifi strength changed from “rssi” to “RSSI”</p></li>
@ -531,7 +538,7 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>
@ -554,29 +561,30 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
<li><a class="reference internal" href="#v1-2-1">v1.2.1</a><ul> <li><a class="reference internal" href="#v1-2-1">v1.2.1</a><ul>
<li><a class="reference internal" href="#issues-adressed">Issues adressed</a></li> <li><a class="reference internal" href="#issues-adressed">Issues adressed</a></li>
<li><a class="reference internal" href="#other">Other</a></li> <li><a class="reference internal" href="#other">Other</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#v1-2-0">v1.2.0</a><ul> <li><a class="reference internal" href="#v1-2-0">v1.2.0</a><ul>
<li><a class="reference internal" href="#features">Features</a></li> <li><a class="reference internal" href="#features">Features</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li> <li><a class="reference internal" href="#id2">Documentation</a></li>
<li><a class="reference internal" href="#id2">Issues adressed</a></li> <li><a class="reference internal" href="#id3">Issues adressed</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#v1-1-1">v1.1.1</a></li> <li><a class="reference internal" href="#v1-1-1">v1.1.1</a></li>
<li><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul> <li><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul>
<li><a class="reference internal" href="#id3">Features</a></li> <li><a class="reference internal" href="#id4">Features</a></li>
<li><a class="reference internal" href="#known-issues-not-yet-fixed">Known issues, not yet fixed</a></li> <li><a class="reference internal" href="#known-issues-not-yet-fixed">Known issues, not yet fixed</a></li>
<li><a class="reference internal" href="#issues-addressed">Issues addressed</a></li> <li><a class="reference internal" href="#issues-addressed">Issues addressed</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li> <li><a class="reference internal" href="#user-interface">User interface</a></li>
<li><a class="reference internal" href="#id4">Documentation</a></li> <li><a class="reference internal" href="#id5">Documentation</a></li>
<li><a class="reference internal" href="#id5">Other</a></li> <li><a class="reference internal" href="#id6">Other</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul> <li><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
<li><a class="reference internal" href="#id6">Documentation</a></li> <li><a class="reference internal" href="#id7">Documentation</a></li>
<li><a class="reference internal" href="#id7">User interface</a></li> <li><a class="reference internal" href="#id8">User interface</a></li>
<li><a class="reference internal" href="#id8">Features</a></li> <li><a class="reference internal" href="#id9">Features</a></li>
<li><a class="reference internal" href="#id9">Issues addressed</a></li> <li><a class="reference internal" href="#id10">Issues addressed</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#v0-9-0">v0.9.0</a></li> <li><a class="reference internal" href="#v0-9-0">v0.9.0</a></li>

2
docs/search.html
View File

@ -221,7 +221,7 @@
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
docs/services.html
View File

@ -474,7 +474,7 @@ in the json document if you need other values as well.</p>
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>

2
docs/troubleshooting.html
View File

@ -294,7 +294,7 @@ to memory leaks.</p>
</div> </div>
<div class="related-information"> <div class="related-information">
Copyright &#169; 2021-2022, Magnus Persson | Copyright &#169; 2021-2023, Magnus Persson |
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo theme</a>. <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
</div> </div>