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:15:20 +00:00
parent ef540ad265
commit 7682653588
4 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4,14 +4,14 @@ Q & A
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
- Check the angle/tilt. If the device is reporting 90 degress then its not going into sleep. Tilt the device and check if sleep works. - Check the angle/tilt. If the device is reporting 90 degrees then its not going into sleep. Tilt the device and check if sleep works.
- Check in reported voltage of the battery in the web interface. If this is higher than 4.15V the device belives its beeing charged. In that case adjust the voltage factor under hardware so the voltage drops below 4.15V. - Check in reported voltage of the battery in the web interface. If this is higher than 4.15V the device believes its being charged. In that case adjust the voltage factor under hardware so the voltage drops below 4.15V.
- Check if the `always on` option is activated in the web interface. - Check if the `always on` option is activated in the web interface.
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 orienation of the sensor and soldering. - Check the orientation of the sensor and soldering.
Calibration error (unable to find a valid formula) Calibration error (unable to find a valid formula)
-------------------------------------------------- --------------------------------------------------
@ -28,16 +28,16 @@ To fix these this you can;
- remove the value from the list (setting the angle to zero will do that) - 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. - 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. 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 User interface does not render correctly
---------------------------------------- ----------------------------------------
Since the user interface is built using bootstrap v5 the device requires access to the internet Since the user interface is built using bootstrap v5 the device requires access to the internet
to download required javascripts and css files. Due to size it would not be possible to store these 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 on the device. Make sure the device can access: https://cdn.jsdelivr.net/npm/bootstrap
Data is not popoulated in the fields 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 The user interface uses JQuery to fetch data from the device. This javascript library needs to be downloaded

2
docs/index.html
View File

@ -379,7 +379,7 @@ the following libraries and without these this would have been much more difficu
<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#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-popoulated-in-the-fields">Data is not popoulated in the fields</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>
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</a></li> <li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</a></li>

16
docs/q_and_a.html
View File

@ -203,8 +203,8 @@
<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">
<li><p>Calibrate the device in the web interface</p></li> <li><p>Calibrate the device in the web interface</p></li>
<li><p>Check the angle/tilt. If the device is reporting 90 degress then its not going into sleep. Tilt the device and check if sleep works.</p></li> <li><p>Check the angle/tilt. If the device is reporting 90 degrees then its not going into sleep. Tilt the device and check if sleep works.</p></li>
<li><p>Check in reported voltage of the battery in the web interface. If this is higher than 4.15V the device belives its beeing charged. In that case adjust the voltage factor under hardware so the voltage drops below 4.15V.</p></li> <li><p>Check in reported voltage of the battery in the web interface. If this is higher than 4.15V the device believes its being charged. In that case adjust the voltage factor under hardware so the voltage drops below 4.15V.</p></li>
<li><p>Check if the <cite>always on</cite> option is activated in the web interface.</p></li> <li><p>Check if the <cite>always on</cite> option is activated in the web interface.</p></li>
</ul> </ul>
</div> </div>
@ -212,7 +212,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 orienation of the sensor and soldering.</p></li> <li><p>Check the orientation of the sensor and 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">
@ -225,16 +225,16 @@
<li><p>remove the value from the list (setting the angle to zero will do that)</p></li> <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> <li><p>change the advanced setting (Formula max deviation) to a higher value and save the values again.</p></li>
</ul> </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> <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="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> <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 <p>Since the user interface is built using bootstrap v5 the device requires access to the internet
to download required javascripts and css files. Due to size it would not be possible to store these 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> 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>
<div class="section" id="data-is-not-popoulated-in-the-fields"> <div class="section" id="data-is-not-populated-in-the-fields">
<h2>Data is not popoulated in the fields<a class="headerlink" href="#data-is-not-popoulated-in-the-fields" title="Permalink to this headline"></a></h2> <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 <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 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> device can access: <a class="reference external" href="https://code.jquery.com">https://code.jquery.com</a></p>
@ -294,7 +294,7 @@ device can access: <a class="reference external" href="https://code.jquery.com">
<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="#user-interface-does-not-render-correctly">User interface does not render correctly</a></li>
<li><a class="reference internal" href="#data-is-not-popoulated-in-the-fields">Data is not popoulated in the fields</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>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long