Minor updates to docs
This commit is contained in:
Magnus
parent
cd1ada6744
commit
433502e7a0
@ -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
|
||||
|
||||
@ -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 ---------------------------------------------------
|
||||
|
||||
@ -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:**
|
||||
|
||||
|
||||
@ -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?
|
||||
--------------------
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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
|
||||
======
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user