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-01-24 20:13:24 +00:00
parent 3e8cb04526
commit 3ac513ab85
5 changed files with 59 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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

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

@ -3,6 +3,17 @@
Releases
########
v1.2.1
======
Issues adressed
++++++++++++++++
* BUG: Under some circumstances the last part of the format template was omitted.
Other
+++++
* Update tinyexpr library to latest baseline. For forumula evaluation.
v1.2.0
======

3
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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This documentation reflects <strong>v1.2.0</strong>. Last updated 2022-12-06</p>
<p>This documentation reflects <strong>v1.2.1</strong>. Last updated 2023-01-23</p>
</div>
<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>
@ -329,6 +329,7 @@ the following libraries and without these this would have been much more difficu
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-2-1">v1.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-2-0">v1.2.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-1-1">v1.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-1-0">v1.1.0</a></li>

68
docs/releases.html
View File

@ -203,6 +203,21 @@
<article role="main">
<div class="section" id="releases">
<span id="id1"></span><h1>Releases<a class="headerlink" href="#releases" title="Permalink to this headline"></a></h1>
<div class="section" id="v1-2-1">
<h2>v1.2.1<a class="headerlink" href="#v1-2-1" title="Permalink to this headline"></a></h2>
<div class="section" id="issues-adressed">
<h3>Issues adressed<a class="headerlink" href="#issues-adressed" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>BUG: Under some circumstances the last part of the format template was omitted.</p></li>
</ul>
</div>
<div class="section" id="other">
<h3>Other<a class="headerlink" href="#other" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Update tinyexpr library to latest baseline. For forumula evaluation.</p></li>
</ul>
</div>
</div>
<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>
<div class="section" id="features">
@ -227,8 +242,8 @@
<li><p>Updated installation instructions.</p></li>
</ul>
</div>
<div class="section" id="issues-adressed">
<h3>Issues adressed<a class="headerlink" href="#issues-adressed" title="Permalink to this headline"></a></h3>
<div class="section" id="id2">
<h3>Issues adressed<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>BUG: The first portion of a format template was lost when doing conversion.</p></li>
</ul>
@ -242,8 +257,8 @@
</div>
<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>
<div class="section" id="id2">
<h3>Features<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="section" id="id3">
<h3>Features<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<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>Changed storage mode so that the device will go into deep sleep until reset (sleep forever)</p></li>
@ -293,8 +308,8 @@
<li><p>User can now edit the voltage level that forces the device into config mode (device detects charging)</p></li>
</ul>
</div>
<div class="section" id="id3">
<h3>Documentation<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<div class="section" id="id4">
<h3>Documentation<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Added documentation for Brewpiless as target</p></li>
<li><p>Added documentation for BVrewblox as target</p></li>
@ -306,8 +321,8 @@
<li><p>Added q&amp;a on formula creation and value deviation</p></li>
</ul>
</div>
<div class="section" id="other">
<h3>Other<a class="headerlink" href="#other" title="Permalink to this headline"></a></h3>
<div class="section" id="id5">
<h3>Other<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Upgraded framework for ESP8266 to v5.0.0</p></li>
<li><p>Upgraded framework for ESP32 to v2.0.2</p></li>
@ -318,8 +333,8 @@
</div>
<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>
<div class="section" id="id4">
<h3>Documentation<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<div class="section" id="id6">
<h3>Documentation<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<ul class="simple">
<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>
@ -328,8 +343,8 @@
<li><p>Added additional http error codes to troubleshooting documentation</p></li>
</ul>
</div>
<div class="section" id="id5">
<h3>User interface<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<div class="section" id="id7">
<h3>User interface<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<ul class="simple">
<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>
@ -340,8 +355,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>
</ul>
</div>
<div class="section" id="id6">
<h3>Features<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<div class="section" id="id8">
<h3>Features<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<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 support for MPU6500 (standard is MPU6050).</p></li>
@ -358,8 +373,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>
</ul>
</div>
<div class="section" id="id7">
<h3>Issues addressed<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<div class="section" id="id9">
<h3>Issues addressed<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<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: Field name for wifi strength changed from “rssi” to “RSSI”</p></li>
@ -536,27 +551,32 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Releases</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="#other">Other</a></li>
</ul>
</li>
<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="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#issues-adressed">Issues adressed</a></li>
<li><a class="reference internal" href="#id2">Issues adressed</a></li>
</ul>
</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="#id2">Features</a></li>
<li><a class="reference internal" href="#id3">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="#issues-addressed">Issues addressed</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li>
<li><a class="reference internal" href="#id3">Documentation</a></li>
<li><a class="reference internal" href="#other">Other</a></li>
<li><a class="reference internal" href="#id4">Documentation</a></li>
<li><a class="reference internal" href="#id5">Other</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
<li><a class="reference internal" href="#id4">Documentation</a></li>
<li><a class="reference internal" href="#id5">User interface</a></li>
<li><a class="reference internal" href="#id6">Features</a></li>
<li><a class="reference internal" href="#id7">Issues addressed</a></li>
<li><a class="reference internal" href="#id6">Documentation</a></li>
<li><a class="reference internal" href="#id7">User interface</a></li>
<li><a class="reference internal" href="#id8">Features</a></li>
<li><a class="reference internal" href="#id9">Issues addressed</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v0-9-0">v0.9.0</a></li>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long