From 433502e7a0e53674d6da0ce9b04fe8a24a73e2c3 Mon Sep 17 00:00:00 2001 From: Magnus Date: Fri, 3 Feb 2023 11:05:44 +0100 Subject: [PATCH] Minor updates to docs --- src_docs/source/advanced.rst | 2 +- src_docs/source/conf.py | 4 +-- src_docs/source/configuration.rst | 2 +- src_docs/source/index.rst | 2 +- src_docs/source/q_and_a.rst | 48 +++++++++++++++++++++++-------- src_docs/source/releases.rst | 5 ++++ 6 files changed, 46 insertions(+), 17 deletions(-) diff --git a/src_docs/source/advanced.rst b/src_docs/source/advanced.rst index d079bda..f4dd33c 100644 --- a/src_docs/source/advanced.rst +++ b/src_docs/source/advanced.rst @@ -10,7 +10,7 @@ To reduce the need for adding custom endpoints for various services there is an .. warning:: - Since the format templates can be big this function can be quite slow on a small device such as the esp8266. + If format templates are large this feature can be slow on a small device such as the esp8266. .. image:: images/format.png :width: 800 diff --git a/src_docs/source/conf.py b/src_docs/source/conf.py index 472ea20..dfcdc0b 100644 --- a/src_docs/source/conf.py +++ b/src_docs/source/conf.py @@ -18,11 +18,11 @@ # -- Project information ----------------------------------------------------- project = 'GravityMon' -copyright = '2021-2022, Magnus Persson' +copyright = '2021-2023, Magnus Persson' author = 'Magnus Persson' # The full version, including alpha/beta/rc tags -release = '1.2.0' +release = '1.2.1' # -- General configuration --------------------------------------------------- diff --git a/src_docs/source/configuration.rst b/src_docs/source/configuration.rst index d6e391c..15a4128 100644 --- a/src_docs/source/configuration.rst +++ b/src_docs/source/configuration.rst @@ -165,7 +165,7 @@ Name of organisation in Influx. * **Influx DB v2 Bucket:** -Identifier for bucket. +Token for bucket. Don't use the bucket name. * **Influx DB v2 Token:** diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index 87a0f49..5008539 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -7,7 +7,7 @@ Welcome to GravityMon ##################### .. note:: - This documentation reflects **v1.2.1**. Last updated 2023-01-23 + This documentation reflects **v1.2.1**. Last updated 2023-02-03 What is GravityMon? -------------------- diff --git a/src_docs/source/q_and_a.rst b/src_docs/source/q_and_a.rst index 3ab5d2d..b2c2647 100644 --- a/src_docs/source/q_and_a.rst +++ b/src_docs/source/q_and_a.rst @@ -1,6 +1,22 @@ Q & A ##### +User interface does not render correctly +---------------------------------------- + +Since the user interface is built using bootstrap v5 the device requires access to the internet +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 + +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 +from the internet. Due to size it would not be possible to store these on the device. Make sure the +device can access: https://code.jquery.com + +Also ensure that any security tools does not block the execution of these features. + My device is no going in to sleep after fully charged ----------------------------------------------------- - Calibrate the device in the web interface @@ -11,7 +27,7 @@ My device is no going in to sleep after fully charged 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. -- Check the orientation of the sensor and soldering. +- Check the orientation of the sensor and the soldering. Calibration error (unable to find a valid formula) -------------------------------------------------- @@ -30,18 +46,26 @@ To fix these this you can; 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 ----------------------------------------- +How can I filter data on influxdb without needing to know the time range +------------------------------------------------------------------------ -Since the user interface is built using bootstrap v5 the device requires access to the internet -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 +You can use any of the available fields to enter your custom data. An option is to use the token fields to +add some custom information to identify your brew. This can then be used to filter your data in influxdb. -Data is not populated in the fields ------------------------------------- +When you switch brews you need to go in and change the token to identify the brewing session. -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 -device can access: https://code.jquery.com +Change the format template for the influx target to include the token field. Now you will have an +field called event that you can filter on in influx. + +.. code-block:: + + gravity-format=${gravity-unit} gravity=${gravity},corr-gravity=${corr-gravity}, + angle=${angle},temp=${temp},battery=${battery},rssi=${rssi} + +to + +.. code-block:: + + gravity-format=${gravity-unit} gravity=${gravity},corr-gravity=${corr-gravity}, + angle=${angle},temp=${temp},battery=${battery},rssi=${rssi},event=${token} -Also ensure that any security tools does not block the execution of these features. diff --git a/src_docs/source/releases.rst b/src_docs/source/releases.rst index 091adaf..b28b721 100644 --- a/src_docs/source/releases.rst +++ b/src_docs/source/releases.rst @@ -14,6 +14,11 @@ Other +++++ * Update tinyexpr library to latest baseline. For forumula evaluation. +Documentation ++++++++++++++ +* Minor updates and corrections to the documetation. +* Updated Q&A section + v1.2.0 ======