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-05-10 16:44:10 +00:00
parent 030c0d8ad6
commit ae5ac9e0a5
4 changed files with 99 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,49 +3,52 @@
Releases
########
v1.0.0-beta3
------------
* Added circuit diagram for esp8266 and esp32
* Update documentation to match new version
v1.0.0
======
v1.0.0-beta2
------------
* Moved applying temp sensor resolution in loop so there is no need to reboot.
* Advanced software settings is only disabled if settings contain default values.
* Added button on indexpage to direct to github issues.
* Added button to extract important information for support requests.
* Updated docs with information from beta1.
* First point in gravity formula is now reserved for water gravity, this to allow detection of angles below water that can be filtered out.
* Added advanced setting to ignore angles that are lower than water. This is disabled by default.
* Added experimental support for MPU6500 (allowing that deviceID), waiting for confirmation on function.
* Changed layout on index page with measured data on top.
* BUG: Fixed error in html page for calibration so that that feature works again (REST API was working)
v1.0.0-beta1
------------
* Upgraded to bootstrap v5.1 for web pages.
* Added tooltips to all fields in user interface
* Removed brewfather option (can use standard HTTP options), the old apporach can still be used via changing format template.
* Added 5 more points for formula creation, so a total of 10 angles/gravity values can be stored.
* Added function on format page so that it's easy to copy a format template from the docs (simplify service integration).
* Added https support for Influxdb
* Added possibility to have variable push intervals for different endpoints so that different frequency can be used, for example; 5min mqtt, 15min brewfather.
* Added advanced settings: Changes how many times the gyro is read (less reads, quicker but less accurate)
* Added advanced settings: Set amount of gyro movement is allowed for a accurate read.
* Added advanced settings: What deviation is acceptable for creating formula deviation
* Added advanced settings: Various timeouts, wifi connect, wifi portal, http connects.
* Added advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing batterylife
* Added additional http error codes to troubleshooting documentation
* Added possibility to set 2 wifi ssid where the second acts as a fallback in case it fails to connect. If succesful the seconday becomes the new primary.
* SSL connections are skipped on ESP8266 when in config mode since there is a high probability it will crash due to low memory.
Documentation
+++++++++++++
* Update documentation to match v1.0
* Installation instructions updated on how to find the device after wifi has been configured.
* Documentation on brewfather has been updated to adress SG/Plato conversion
* Added circuit diagram for esp8266 and esp32
* Added additional http error codes to troubleshooting documentation
User interface
++++++++++++++
* Upgraded to bootstrap v5.1 for web pages.
* Added button on indexpage to direct to github issues.
* Added button to extract important information for support requests.
* First point in gravity formula is now reserved for water gravity, this to allow detection of angles below water that can be filtered out.
* Changed layout on index page with measured data on top.
* Added tooltips to all fields in user interface
* Added function on format page so that it's easy to copy a format template from the docs (simplify service integration).
Features
++++++++
* Added advanced setting to ignore angles that are lower than water. This is disabled by default.
* Added support for MPU6500 (standard is MPU6050).
* Removed brewfather option (can use standard HTTP options), the old apporach can still be used via changing format template.
* Added 5 more points for formula creation, so a total of 10 angles/gravity values can be stored.
* Added https support for Influxdb v2
* Added possibility to set 2 wifi ssid where the second acts as a fallback in case it fails to connect. If succesful the seconday becomes the new primary.
* SSL connections are skipped on ESP8266 when in config mode since there is a high probability it will crash due to low memory.
* Advanced settings: Added possibility to have variable push intervals for different endpoints so that different frequency can be used, for example; 5min mqtt, 15min brewfather.
* Advanced settings: Changes how many times the gyro is read (less reads, quicker but less accurate)
* Advanced settings: Set amount of gyro movement is allowed for a accurate read.
* Advanced settings: What deviation is acceptable for creating formula deviation
* Advanced settings: Various timeouts, wifi connect, wifi portal, http connects.
* Advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing batterylife
Issues adressed
++++++++++++++++
* BUG: Fixed issue in formula calculation in case there were a gap in the data series
* BUG: Field name for wifi strength changed from "rssi" to "RSSI"
* BUG: Fixed issue with probing MFLN on non standard ports
* BUG: Changed http connection to keep-alive so that server does not close port before the client has had a chance to read the response.
v0.9.0
------
======
* Added one http push target that uses HTTP GET. This can be used with ubidots or blynk api's.
* Added function to test push targets from configuration page. It will send data and show the return code as a first step.
* Added documetation on how to integrate with Blynk.io using http get.
@ -70,8 +73,7 @@ v0.9.0
* BUG: Entering wifi setup and a timeout occured the wifi settings could be deleted.
v0.8.0
------
======
* Added option to set http headers (2 per http endpoint), these can be used for
other http formats than json (default) and for adding authentication headers.
* Added possibility to view last 10 errors on device page.
@ -91,8 +93,7 @@ v0.8.0
* Tested batterylife, 47 days using an update frequency of 5 min
v0.7.1
------
======
* Added instructions for how to configure integration with Fermentrack
* Added instructions for how to configure integration with Ubidots
* Added instructions for how to configure integration with HomeAssistant
@ -102,8 +103,7 @@ v0.7.1
* BUG: Fixed issue with default template so it now includes the device name correctly.
v0.7.0
------
======
Latest stable version. `Release v0.7 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.7.0>`_
* SSL support for HTTP targets
@ -129,10 +129,7 @@ Latest stable version. `Release v0.7 on Github <https://github.com/mp-se/gravity
the behaviour in v0.6 is wanted this can be done via the format editor.
v0.6.0
------
`Release v0.6 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.6.0>`_
======
* Changed the wifi manager and refactored wifi.cpp
* LED is now turned on when Wifi Portal is open
* Refactored main.cpp to make it easier to read
@ -145,10 +142,7 @@ v0.6.0
* Bug: MPU init sometimes caused crash during startup.
v0.5.0
------
`Release v0.5 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.5.0>`_
======
* Added feature to calcuate formula on device
* Total rewrite of documentation
* WIFI settings are now stored in config file
@ -157,8 +151,5 @@ v0.5.0
* Refactor code from C to C++
v0.4.0
------
`Release v0.4 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.4.0>`_
* First release
======
* First public release

4
docs/index.html
View File

@ -323,9 +323,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-0-0-beta3">v1.0.0-beta3</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-0-0-beta2">v1.0.0-beta2</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-0-0-beta1">v1.0.0-beta1</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-0-0">v1.0.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-9-0">v0.9.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-8-0">v0.8.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-7-1">v0.7.1</a></li>

98
docs/releases.html
View File

@ -205,53 +205,58 @@
<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-0-0-beta3">
<h2>v1.0.0-beta3<a class="headerlink" href="#v1-0-0-beta3" title="Permalink to this headline">#</a></h2>
<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="documentation">
<h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">#</a></h3>
<ul class="simple">
<li><p>Added circuit diagram for esp8266 and esp32</p></li>
<li><p>Update documentation to match new version</p></li>
</ul>
</div>
<div class="section" id="v1-0-0-beta2">
<h2>v1.0.0-beta2<a class="headerlink" href="#v1-0-0-beta2" title="Permalink to this headline">#</a></h2>
<ul class="simple">
<li><p>Moved applying temp sensor resolution in loop so there is no need to reboot.</p></li>
<li><p>Advanced software settings is only disabled if settings contain default values.</p></li>
<li><p>Added button on indexpage to direct to github issues.</p></li>
<li><p>Added button to extract important information for support requests.</p></li>
<li><p>Updated docs with information from beta1.</p></li>
<li><p>First point in gravity formula is now reserved for water gravity, this to allow detection of angles below water that can be filtered out.</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 experimental support for MPU6500 (allowing that deviceID), waiting for confirmation on function.</p></li>
<li><p>Changed layout on index page with measured data on top.</p></li>
<li><p>BUG: Fixed error in html page for calibration so that that feature works again (REST API was working)</p></li>
</ul>
</div>
<div class="section" id="v1-0-0-beta1">
<h2>v1.0.0-beta1<a class="headerlink" href="#v1-0-0-beta1" title="Permalink to this headline">#</a></h2>
<ul class="simple">
<li><p>Upgraded to bootstrap v5.1 for web pages.</p></li>
<li><p>Added tooltips to all fields in user interface</p></li>
<li><p>Removed brewfather option (can use standard HTTP options), the old apporach can still be used via changing format template.</p></li>
<li><p>Added 5 more points for formula creation, so a total of 10 angles/gravity values can be stored.</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>
<li><p>Added https support for Influxdb</p></li>
<li><p>Added possibility to have variable push intervals for different endpoints so that different frequency can be used, for example; 5min mqtt, 15min brewfather.</p></li>
<li><p>Added advanced settings: Changes how many times the gyro is read (less reads, quicker but less accurate)</p></li>
<li><p>Added advanced settings: Set amount of gyro movement is allowed for a accurate read.</p></li>
<li><p>Added advanced settings: What deviation is acceptable for creating formula deviation</p></li>
<li><p>Added advanced settings: Various timeouts, wifi connect, wifi portal, http connects.</p></li>
<li><p>Added advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing batterylife</p></li>
<li><p>Added additional http error codes to troubleshooting documentation</p></li>
<li><p>Added possibility to set 2 wifi ssid where the second acts as a fallback in case it fails to connect. If succesful the seconday becomes the new primary.</p></li>
<li><p>SSL connections are skipped on ESP8266 when in config mode since there is a high probability it will crash due to low memory.</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>Documentation on brewfather has been updated to adress SG/Plato conversion</p></li>
<li><p>Added circuit diagram for esp8266 and esp32</p></li>
<li><p>Added additional http error codes to troubleshooting documentation</p></li>
</ul>
</div>
<div class="section" id="user-interface">
<h3>User interface<a class="headerlink" href="#user-interface" 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 indexpage to direct to github issues.</p></li>
<li><p>Added button to extract important information for support requests.</p></li>
<li><p>First point in gravity formula is now reserved for water gravity, this to allow detection of angles below water that can be filtered out.</p></li>
<li><p>Changed layout on index page with measured data on top.</p></li>
<li><p>Added tooltips to all fields in user interface</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>
</div>
<div class="section" id="features">
<h3>Features<a class="headerlink" href="#features" 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>
<li><p>Removed brewfather option (can use standard HTTP options), the old apporach can still be used via changing format template.</p></li>
<li><p>Added 5 more points for formula creation, so a total of 10 angles/gravity values can be stored.</p></li>
<li><p>Added https support for Influxdb v2</p></li>
<li><p>Added possibility to set 2 wifi ssid where the second acts as a fallback in case it fails to connect. If succesful the seconday becomes the new primary.</p></li>
<li><p>SSL connections are skipped on ESP8266 when in config mode since there is a high probability it will crash due to low memory.</p></li>
<li><p>Advanced settings: Added possibility to have variable push intervals for different endpoints so that different frequency can be used, for example; 5min mqtt, 15min brewfather.</p></li>
<li><p>Advanced settings: Changes how many times the gyro is read (less reads, quicker but less accurate)</p></li>
<li><p>Advanced settings: Set amount of gyro movement is allowed for a accurate read.</p></li>
<li><p>Advanced settings: What deviation is acceptable for creating formula deviation</p></li>
<li><p>Advanced settings: Various timeouts, wifi connect, wifi portal, http connects.</p></li>
<li><p>Advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing batterylife</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>
<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>
<li><p>BUG: Fixed issue with probing MFLN on non standard ports</p></li>
<li><p>BUG: Changed http connection to keep-alive so that server does not close port before the client has had a chance to read the response.</p></li>
</ul>
</div>
</div>
<div class="section" id="v0-9-0">
<h2>v0.9.0<a class="headerlink" href="#v0-9-0" title="Permalink to this headline">#</a></h2>
<ul class="simple">
@ -340,7 +345,6 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
</div>
<div class="section" id="v0-6-0">
<h2>v0.6.0<a class="headerlink" href="#v0-6-0" title="Permalink to this headline">#</a></h2>
<p><a class="reference external" href="https://github.com/mp-se/gravitymon/releases/tag/v0.6.0">Release v0.6 on Github</a></p>
<ul class="simple">
<li><p>Changed the wifi manager and refactored wifi.cpp</p></li>
<li><p>LED is now turned on when Wifi Portal is open</p></li>
@ -356,7 +360,6 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
</div>
<div class="section" id="v0-5-0">
<h2>v0.5.0<a class="headerlink" href="#v0-5-0" title="Permalink to this headline">#</a></h2>
<p><a class="reference external" href="https://github.com/mp-se/gravitymon/releases/tag/v0.5.0">Release v0.5 on Github</a></p>
<ul class="simple">
<li><p>Added feature to calcuate formula on device</p></li>
<li><p>Total rewrite of documentation</p></li>
@ -368,9 +371,8 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
</div>
<div class="section" id="v0-4-0">
<h2>v0.4.0<a class="headerlink" href="#v0-4-0" title="Permalink to this headline">#</a></h2>
<p><a class="reference external" href="https://github.com/mp-se/gravitymon/releases/tag/v0.4.0">Release v0.4 on Github</a></p>
<ul class="simple">
<li><p>First release</p></li>
<li><p>First public release</p></li>
</ul>
</div>
</div>
@ -433,9 +435,13 @@ 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-0-0-beta3">v1.0.0-beta3</a></li>
<li><a class="reference internal" href="#v1-0-0-beta2">v1.0.0-beta2</a></li>
<li><a class="reference internal" href="#v1-0-0-beta1">v1.0.0-beta1</a></li>
<li><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li>
<li><a class="reference internal" href="#features">Features</a></li>
<li><a class="reference internal" href="#issues-adressed">Issues adressed</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v0-9-0">v0.9.0</a></li>
<li><a class="reference internal" href="#v0-8-0">v0.8.0</a></li>
<li><a class="reference internal" href="#v0-7-1">v0.7.1</a></li>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long