Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs to 0.7

Browse Source
This commit is contained in:
Magnus Persson
2022-01-25 16:21:24 +01:00
parent 1d3cbbb3c2
commit 2474306acb
3 changed files with 31 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src_docs/source/conf.py
View File

@ -22,7 +22,7 @@ copyright = '2021-2022, Magnus Persson'
author = 'Magnus Persson' author = 'Magnus Persson'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = '0.6.0' release = '0.7.0'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------

35
src_docs/source/functionallity.rst
View File

@ -8,27 +8,32 @@ The main features
* **Operates in two modes gravity monitoring and configuration mode** * **Operates in two modes gravity monitoring and configuration mode**
In ``gravity monitoring`` mode it behaves just like the iSpindle, it wakes up at regular intervals, measures angle/tile, temperature, calculates gravity and pushes the data to defined endpoints. In ``gravity monitoring`` mode it behaves just like the iSpindle, it wakes up at regular intervals, measures
angle/tile, temperature, calculates gravity and pushes the data to defined endpoints.
In ``configuration mode`` the device is always active and the webserver is active. Here you can view the angle/tilt values, change configuration options and more. When in this mode you can also interact with the device In ``configuration mode`` the device is always active and the webserver is active. Here you can view the
angle/tilt values, change configuration options and more. When in this mode you can also interact with the device
via an REST API so data can be pushed to the device via scripts (see API section for more information). via an REST API so data can be pushed to the device via scripts (see API section for more information).
You can force the device into ``configuration mode`` while measuring gravity. This is useful when calibrating the device so you don't needs to wait for the device to wake up and push the data. The entire calibration You can force the device into ``configuration mode`` while measuring gravity. This is useful when calibrating
the device so you don't needs to wait for the device to wake up and push the data. The entire calibration
sequence can be handled via the web interface without need for additional software tools. sequence can be handled via the web interface without need for additional software tools.
See the :ref:`setting-up-device` section for more information on how to trigger the configuration mode. See the :ref:`setting-up-device` section for more information on how to trigger the configuration mode.
* **Can send data to multiple endpoints at once** * **Can send data to multiple endpoints at once**
The original iSpindle can only have one destination, this software will push data to all defined endpoints so in theory you can use them all. However this will consume a lot of battery power so use only as many as needed. The original iSpindle can only have one destination, this software will push data to all defined endpoints so
in theory you can use them all. However this will consume more battery power so use only as many as needed.
Currently the device supports the following endpoints: http (2 different), influxdb2 and Brewfather Currently the device supports the following endpoints: http (2 different), influxdb2, Brewfather and MQTT.
If you want additional targets please raise a feature request in the github repo. If you want additional targets please raise a feature request in the github repo.
* **Create gravity formulas on the device** * **Create gravity formulas on the device**
Another big difference is that this software can create the gravity formula in the device, just enter the angle/gravity data that you have collected. You will also see a graph simulating how the formula would work. Another big difference is that this software can create the gravity formula in the device, just enter the
angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.
.. note:: .. note::
@ -36,8 +41,10 @@ The main features
* **Customize the data format beeing sent to push targets** * **Customize the data format beeing sent to push targets**
In order to make it easier to support more targets there is a built in format editor that can be used to customize the data that is to be sent. This way you can easily adapt the software to new targets without coding. If you have In order to make it easier to support more targets there is a built in format editor that can be used to
a good template please share it on the girhub repository and I will add it to the documentation for other users to enjoy. See the :ref:`format-editor` for more information. customize the data that is to be sent. This way you can easily adapt the software to new targets without coding.
If you have a good template please share it on the girhub repository and I will add it to the documentation
for other users to enjoy. See the :ref:`format-editor` for more information.
.. note:: .. note::
@ -45,7 +52,8 @@ The main features
* **Automatic temperature adjustment of gravity reading** * **Automatic temperature adjustment of gravity reading**
If you want to correct gravity based on beer temperature you can do this in the formula but here is a nice feature that can correct the gravity as a second step making this independant of the formula. If you want to correct gravity based on beer temperature you can do this in the formula but here is a nice
feature that can correct the gravity as a second step making this independant of the formula.
.. note:: .. note::
@ -111,11 +119,16 @@ Experimental features
Battery life Battery life
------------ ------------
I'm currently measuring battery life of v0.5 but previous versions have been able to measure gravity for a 2-3 weeks without issues (Using 900 seconds as interval). I'm currently measuring battery life of v0.5 but previous versions have been able to measure gravity for
a 2-3 weeks without issues (Using 900 seconds as interval).
I had a device running with an sleep interval of only 30s with ok wifi connection. The device lasted
12 days which i think is excellent considering the short sleep interval. From what I have discovered
it's the WIFI connection that has the most impact on the battery life. In a perfect scenario it
can take around 400ms but can in some cases take up to 8 seconds.
*More on this topics once my tests are done* *More on this topics once my tests are done*
Performance Performance
----------- -----------

18
src_docs/source/releases.rst
View File

@ -6,25 +6,19 @@ Releases
v0.7.0 v0.7.0
------ ------
Development version (dev branch) Latest stable version. `Release v0.6 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.6.0>`_
* SSL support for HTTP targets * SSL support for HTTP targets
* SSL support for MQTT targets * SSL support for MQTT targets
* SSL support for OTA * SSL support for OTA
* 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 extreamly 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.
* Added check so that pushing data is not done if memory is low (this will make it crash) * Added check so that pushing data is not done if memory is low (this will make it crash)
* MQTT topic has been removed from config (handled via format templates) * MQTT topic has been removed from config (handled via format templates)
* MQTT port port number added. Port over 8000 will activate SSL. * MQTT port port number added. Port over 8000 will activate SSL.
* **Breaking change**: To simplify the internal structure the * **Breaking change**: To simplify the internal structure the
@ -38,7 +32,7 @@ Development version (dev branch)
v0.6.0 v0.6.0
------ ------
Latest stable version. `Release v0.6 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.6.0>`_
* Changed the wifi manager and refactored wifi.cpp * Changed the wifi manager and refactored wifi.cpp
* LED is now turned on when Wifi Portal is open * LED is now turned on when Wifi Portal is open
@ -51,11 +45,11 @@ Latest stable version.
* Added support for MQTT * Added support for MQTT
* Bug: MPU init sometimes caused crash during startup. * Bug: MPU init sometimes caused crash during startup.
`Release v0.6 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.6.0>`_
v0.5.0 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 * Added feature to calcuate 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
@ -63,9 +57,9 @@ v0.5.0
* Cleanup of code * Cleanup of code
* Refactor code from C to C++ * Refactor code from C to C++
`Release v0.5 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.5.0>`_
v0.4.0 v0.4.0
------ ------
`Release v0.4 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.4.0>`_ `Release v0.4 on Github <https://github.com/mp-se/gravitymon/releases/tag/v0.4.0>`_
* First release