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:14:19 +00:00
parent 749c1e4b99
commit ef540ad265
3 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -13,16 +13,16 @@ Features
* Updated sensor types in home assistant for auto registration of device * Updated sensor types in home assistant for auto registration of device
* Added ${app-ver} and ${app-build} to format template as new variables * Added ${app-ver} and ${app-build} to format template as new variables
* Improved error messages when creating formula so the troublesome measurement points can be identified * Improved error messages when creating formula so the troublesome measurement points can be identified
* Changed defaule validation threashold from 1.6 SG to 3.0 SG, this should allow for some more variance when creating formula * Changed default validation threshold from 1.6 SG to 3.0 SG, this should allow for some more variance when creating formula
* Updated format template for Home Assistant, aligned with new mqtt configuration format * Updated format template for Home Assistant, aligned with new mqtt configuration format
* Added format template for Home Assistant with automatic device registration * Added format template for Home Assistant with automatic device registration
* Added storage mode which is activated under hardware setting. When place on the cap (<5 degres tilt) the device will go into storage mode and deep sleep. * Added storage mode which is activated under hardware setting. When place on the cap (<5 degree tilt) the device will go into storage mode and deep sleep.
Known issues, not yet fixed Known issues, not yet fixed
+++++++++++++++++++++++++++ +++++++++++++++++++++++++++
* When updating firmware and the feature `deep sleep` is active the device will activate deep sleep if the gyro is not responding. FIX: Reboot device * When updating firmware and the feature `deep sleep` is active the device will activate deep sleep if the gyro is not responding. FIX: Reboot device
Issues adressed Issues addressed
++++++++++++++++ ++++++++++++++++
* Refactored error logging function to reduce memory usage and crashes. Max size of error log is 2 x 4 kb * Refactored error logging function to reduce memory usage and crashes. Max size of error log is 2 x 4 kb
* Refactored format template engine to reduce memory usage and crashes, can how handle slightly larger payloads than before. Increase from around 1100 chars to 1600 chars * Refactored format template engine to reduce memory usage and crashes, can how handle slightly larger payloads than before. Increase from around 1100 chars to 1600 chars
@ -44,7 +44,7 @@ User interface
* Added Assistant Device registration, this is only done when format template is saved, during normal operation only data values are posted on MQTT. If HA is restarted then the device will disappear * Added Assistant Device registration, this is only done when format template is saved, during normal operation only data values are posted on MQTT. If HA is restarted then the device will disappear
* Calibration temperature (for temp adjustment) can now be set under advanced settings, default is 20C * Calibration temperature (for temp adjustment) can now be set under advanced settings, default is 20C
* Changed length of device name from 12 to 63 chars. 63 is the max limit according to mdns. * Changed length of device name from 12 to 63 chars. 63 is the max limit according to mdns.
* Under format options its now possible to select brewfather ispindle format to avoid errors connected to using the wrong format template with the various brewfather endpoints * Under format options its now possible to select brewfather iSpindle format to avoid errors connected to using the wrong format template with the various brewfather endpoints
* Added brewblox as format under format options * Added brewblox as format under format options
* Added home assistant (with device registration) as format under format options * Added home assistant (with device registration) as format under format options
* User can now edit the voltage level that forces the device into config mode (device detects charging) * User can now edit the voltage level that forces the device into config mode (device detects charging)
@ -75,7 +75,7 @@ Documentation
+++++++++++++ +++++++++++++
* Update documentation to match v1.0 * Update documentation to match v1.0
* Installation instructions updated on how to find the device after wifi has been configured. * 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 * Documentation on brewfather has been updated to address SG/Plato conversion
* Added circuit diagram for esp8266 and esp32 * Added circuit diagram for esp8266 and esp32
* Added additional http error codes to troubleshooting documentation * Added additional http error codes to troubleshooting documentation
@ -93,10 +93,10 @@ Features
++++++++ ++++++++
* Added advanced setting to ignore angles that are lower than water. This is disabled by default. * Added advanced setting to ignore angles that are lower than water. This is disabled by default.
* Added support for MPU6500 (standard is MPU6050). * 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. * Removed brewfather option (can use standard HTTP options), the old approach 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 5 more points for formula creation, so a total of 10 angles/gravity values can be stored.
* Added https support for Influxdb v2 * 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. * Added possibility to set 2 wifi ssid where the second acts as a fallback in case it fails to connect. If successful the secondary 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. * 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: 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: Changes how many times the gyro is read (less reads, quicker but less accurate)
@ -105,7 +105,7 @@ Features
* Advanced settings: Various timeouts, wifi connect, wifi portal, http connects. * 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 battery life * Advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing battery life
Issues adressed Issues addressed
++++++++++++++++ ++++++++++++++++
* BUG: Fixed issue in formula calculation in case there were a gap in the data series * 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: Field name for wifi strength changed from "rssi" to "RSSI"
@ -116,7 +116,7 @@ v0.9.0
====== ======
* Added one http push target that uses HTTP GET. This can be used with ubidots or blynk api's. * 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 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. * Added documentation on how to integrate with Blynk.io using http get.
* Config page now shows the estimated runtime for the device (based on a full battery and previous average runtime) * Config page now shows the estimated runtime for the device (based on a full battery and previous average runtime)
* Experimental release of firmware using an esp32 instead of esp8266 * Experimental release of firmware using an esp32 instead of esp8266
* Merged index and device pages into one so that all the needed information is available on the index page. * Merged index and device pages into one so that all the needed information is available on the index page.
@ -133,9 +133,9 @@ v0.9.0
* BUG: Corrected PIN for voltage read on ESP32 * BUG: Corrected PIN for voltage read on ESP32
* BUG: If using plato and not gravity formula was defined the value was set to null. * BUG: If using plato and not gravity formula was defined the value was set to null.
* BUG: Temp format name was incorrect in iSpindle format causing receiver to incorrectly read temperature. * BUG: Temp format name was incorrect in iSpindle format causing receiver to incorrectly read temperature.
* BUG: Temperature sensor adjusmemnt value was not handled properly when using Farenheight. * BUG: Temperature sensor adjustment value was not handled properly when using Fahrenheit.
* BUG: If the ID was to low the device id could end up with a leading space causing errors in data post. Added leading zero to ID. * BUG: If the ID was to low the device id could end up with a leading space causing errors in data post. Added leading zero to ID.
* BUG: Entering wifi setup and a timeout occured the wifi settings could be deleted. * BUG: Entering wifi setup and a timeout occurred the wifi settings could be deleted.
v0.8.0 v0.8.0
====== ======
@ -177,7 +177,7 @@ Latest stable version. `Release v0.7 on Github <https://github.com/mp-se/gravity
* Added support for Plato * Added support for Plato
* Added error handling for calibration page. * Added error handling for calibration page.
* Added experimental target ESP32 (using an ESP32 D1 Mini which is pin compatible with ESP8266). Not * Added experimental target ESP32 (using an ESP32 D1 Mini which is pin compatible with ESP8266). Not
really usable since wifi connection is extreamly slow with current Arduino releases (3-8 seconds). really usable since wifi connection is extremely slow with current Arduino releases (3-8 seconds).
* Added experimental format editor so users can customize their data format used for pushing data. * Added experimental format editor so users can customize their data format used for pushing data.
This will reduce the need for custom push targets. As long as the service is supporting http This will reduce the need for custom push targets. As long as the service is supporting http
or https then the data format can be customized. or https then the data format can be customized.
@ -208,7 +208,7 @@ v0.6.0
v0.5.0 v0.5.0
====== ======
* Added feature to calcuate formula on device * Added feature to calculate formula on device
* Total rewrite of documentation * Total rewrite of documentation
* WIFI settings are now stored in config file * WIFI settings are now stored in config file
* Defined version numbers for all dependant libraries to avoid updates breaking build. * Defined version numbers for all dependant libraries to avoid updates breaking build.

32
docs/releases.html
View File

@ -209,10 +209,10 @@
<li><p>Updated sensor types in home assistant for auto registration of device</p></li> <li><p>Updated sensor types in home assistant for auto registration of device</p></li>
<li><p>Added ${app-ver} and ${app-build} to format template as new variables</p></li> <li><p>Added ${app-ver} and ${app-build} to format template as new variables</p></li>
<li><p>Improved error messages when creating formula so the troublesome measurement points can be identified</p></li> <li><p>Improved error messages when creating formula so the troublesome measurement points can be identified</p></li>
<li><p>Changed defaule validation threashold from 1.6 SG to 3.0 SG, this should allow for some more variance when creating formula</p></li> <li><p>Changed default validation threshold from 1.6 SG to 3.0 SG, this should allow for some more variance when creating formula</p></li>
<li><p>Updated format template for Home Assistant, aligned with new mqtt configuration format</p></li> <li><p>Updated format template for Home Assistant, aligned with new mqtt configuration format</p></li>
<li><p>Added format template for Home Assistant with automatic device registration</p></li> <li><p>Added format template for Home Assistant with automatic device registration</p></li>
<li><p>Added storage mode which is activated under hardware setting. When place on the cap (&lt;5 degres tilt) the device will go into storage mode and deep sleep.</p></li> <li><p>Added storage mode which is activated under hardware setting. When place on the cap (&lt;5 degree tilt) the device will go into storage mode and deep sleep.</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="known-issues-not-yet-fixed"> <div class="section" id="known-issues-not-yet-fixed">
@ -221,8 +221,8 @@
<li><p>When updating firmware and the feature <cite>deep sleep</cite> is active the device will activate deep sleep if the gyro is not responding. FIX: Reboot device</p></li> <li><p>When updating firmware and the feature <cite>deep sleep</cite> is active the device will activate deep sleep if the gyro is not responding. FIX: Reboot device</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="issues-adressed"> <div class="section" id="issues-addressed">
<h3>Issues adressed<a class="headerlink" href="#issues-adressed" title="Permalink to this headline"></a></h3> <h3>Issues addressed<a class="headerlink" href="#issues-addressed" title="Permalink to this headline"></a></h3>
<ul class="simple"> <ul class="simple">
<li><p>Refactored error logging function to reduce memory usage and crashes. Max size of error log is 2 x 4 kb</p></li> <li><p>Refactored error logging function to reduce memory usage and crashes. Max size of error log is 2 x 4 kb</p></li>
<li><p>Refactored format template engine to reduce memory usage and crashes, can how handle slightly larger payloads than before. Increase from around 1100 chars to 1600 chars</p></li> <li><p>Refactored format template engine to reduce memory usage and crashes, can how handle slightly larger payloads than before. Increase from around 1100 chars to 1600 chars</p></li>
@ -246,7 +246,7 @@
<li><p>Added Assistant Device registration, this is only done when format template is saved, during normal operation only data values are posted on MQTT. If HA is restarted then the device will disappear</p></li> <li><p>Added Assistant Device registration, this is only done when format template is saved, during normal operation only data values are posted on MQTT. If HA is restarted then the device will disappear</p></li>
<li><p>Calibration temperature (for temp adjustment) can now be set under advanced settings, default is 20C</p></li> <li><p>Calibration temperature (for temp adjustment) can now be set under advanced settings, default is 20C</p></li>
<li><p>Changed length of device name from 12 to 63 chars. 63 is the max limit according to mdns.</p></li> <li><p>Changed length of device name from 12 to 63 chars. 63 is the max limit according to mdns.</p></li>
<li><p>Under format options its now possible to select brewfather ispindle format to avoid errors connected to using the wrong format template with the various brewfather endpoints</p></li> <li><p>Under format options its now possible to select brewfather iSpindle format to avoid errors connected to using the wrong format template with the various brewfather endpoints</p></li>
<li><p>Added brewblox as format under format options</p></li> <li><p>Added brewblox as format under format options</p></li>
<li><p>Added home assistant (with device registration) as format under format options</p></li> <li><p>Added home assistant (with device registration) as format under format options</p></li>
<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>
@ -282,7 +282,7 @@
<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>
<li><p>Documentation on brewfather has been updated to adress SG/Plato conversion</p></li> <li><p>Documentation on brewfather has been updated to address SG/Plato conversion</p></li>
<li><p>Added circuit diagram for esp8266 and esp32</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> <li><p>Added additional http error codes to troubleshooting documentation</p></li>
</ul> </ul>
@ -304,10 +304,10 @@
<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>
<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>Removed brewfather option (can use standard HTTP options), the old approach 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 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 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>Added possibility to set 2 wifi ssid where the second acts as a fallback in case it fails to connect. If successful the secondary 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>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: 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: Changes how many times the gyro is read (less reads, quicker but less accurate)</p></li>
@ -318,7 +318,7 @@
</ul> </ul>
</div> </div>
<div class="section" id="id5"> <div class="section" id="id5">
<h3>Issues adressed<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3> <h3>Issues addressed<a class="headerlink" href="#id5" 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>
@ -332,7 +332,7 @@
<ul class="simple"> <ul class="simple">
<li><p>Added one http push target that uses HTTP GET. This can be used with ubidots or blynk api’s.</p></li> <li><p>Added one http push target that uses HTTP GET. This can be used with ubidots or blynk api’s.</p></li>
<li><p>Added function to test push targets from configuration page. It will send data and show the return code as a first step.</p></li> <li><p>Added function to test push targets from configuration page. It will send data and show the return code as a first step.</p></li>
<li><p>Added documetation on how to integrate with Blynk.io using http get.</p></li> <li><p>Added documentation on how to integrate with Blynk.io using http get.</p></li>
<li><p>Config page now shows the estimated runtime for the device (based on a full battery and previous average runtime)</p></li> <li><p>Config page now shows the estimated runtime for the device (based on a full battery and previous average runtime)</p></li>
<li><p>Experimental release of firmware using an esp32 instead of esp8266</p></li> <li><p>Experimental release of firmware using an esp32 instead of esp8266</p></li>
<li><p>Merged index and device pages into one so that all the needed information is available on the index page.</p></li> <li><p>Merged index and device pages into one so that all the needed information is available on the index page.</p></li>
@ -349,9 +349,9 @@
<li><p>BUG: Corrected PIN for voltage read on ESP32</p></li> <li><p>BUG: Corrected PIN for voltage read on ESP32</p></li>
<li><p>BUG: If using plato and not gravity formula was defined the value was set to null.</p></li> <li><p>BUG: If using plato and not gravity formula was defined the value was set to null.</p></li>
<li><p>BUG: Temp format name was incorrect in iSpindle format causing receiver to incorrectly read temperature.</p></li> <li><p>BUG: Temp format name was incorrect in iSpindle format causing receiver to incorrectly read temperature.</p></li>
<li><p>BUG: Temperature sensor adjusmemnt value was not handled properly when using Farenheight.</p></li> <li><p>BUG: Temperature sensor adjustment value was not handled properly when using Fahrenheit.</p></li>
<li><p>BUG: If the ID was to low the device id could end up with a leading space causing errors in data post. Added leading zero to ID.</p></li> <li><p>BUG: If the ID was to low the device id could end up with a leading space causing errors in data post. Added leading zero to ID.</p></li>
<li><p>BUG: Entering wifi setup and a timeout occured the wifi settings could be deleted.</p></li> <li><p>BUG: Entering wifi setup and a timeout occurred the wifi settings could be deleted.</p></li>
</ul> </ul>
</div> </div>
<div class="section" id="v0-8-0"> <div class="section" id="v0-8-0">
@ -398,7 +398,7 @@ servers might support this feature.</p></li>
<li><p>Added support for Plato</p></li> <li><p>Added support for Plato</p></li>
<li><p>Added error handling for calibration page.</p></li> <li><p>Added error handling for calibration page.</p></li>
<li><p>Added experimental target ESP32 (using an ESP32 D1 Mini which is pin compatible with ESP8266). Not <li><p>Added experimental target ESP32 (using an ESP32 D1 Mini which is pin compatible with ESP8266). Not
really usable since wifi connection is extreamly slow with current Arduino releases (3-8 seconds).</p></li> really usable since wifi connection is extremely slow with current Arduino releases (3-8 seconds).</p></li>
<li><p>Added experimental format editor so users can customize their data format used for pushing data. <li><p>Added experimental format editor so users can customize their data format used for pushing data.
This will reduce the need for custom push targets. As long as the service is supporting http This will reduce the need for custom push targets. As long as the service is supporting http
or https then the data format can be customized.</p></li> or https then the data format can be customized.</p></li>
@ -431,7 +431,7 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
<div class="section" id="v0-5-0"> <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> <h2>v0.5.0<a class="headerlink" href="#v0-5-0" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Added feature to calcuate formula on device</p></li> <li><p>Added feature to calculate formula on device</p></li>
<li><p>Total rewrite of documentation</p></li> <li><p>Total rewrite of documentation</p></li>
<li><p>WIFI settings are now stored in config file</p></li> <li><p>WIFI settings are now stored in config file</p></li>
<li><p>Defined version numbers for all dependant libraries to avoid updates breaking build.</p></li> <li><p>Defined version numbers for all dependant libraries to avoid updates breaking build.</p></li>
@ -498,7 +498,7 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></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="#features">Features</a></li> <li><a class="reference internal" href="#features">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-adressed">Issues adressed</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="#documentation">Documentation</a></li> <li><a class="reference internal" href="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#other">Other</a></li> <li><a class="reference internal" href="#other">Other</a></li>
@ -508,7 +508,7 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
<li><a class="reference internal" href="#id2">Documentation</a></li> <li><a class="reference internal" href="#id2">Documentation</a></li>
<li><a class="reference internal" href="#id3">User interface</a></li> <li><a class="reference internal" href="#id3">User interface</a></li>
<li><a class="reference internal" href="#id4">Features</a></li> <li><a class="reference internal" href="#id4">Features</a></li>
<li><a class="reference internal" href="#id5">Issues adressed</a></li> <li><a class="reference internal" href="#id5">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/searchindex.js
View File

File diff suppressed because one or more lines are too long