From 77d2c15e39031890df1cf1d5cf71c62f3aece837 Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Sat, 23 Jul 2022 08:58:48 +0200 Subject: [PATCH] Updated docs for v1.1 beta 2 --- html/config.htm | 2 +- html/config.min.htm | 2 +- src_docs/source/configuration.rst | 3 ++- src_docs/source/index.rst | 2 +- src_docs/source/intro.rst | 6 ++++++ src_docs/source/q_and_a.rst | 16 ++++++++++++++++ src_docs/source/releases.rst | 4 ++-- 7 files changed, 29 insertions(+), 6 deletions(-) diff --git a/html/config.htm b/html/config.htm index 5c95a67..0acbdbf 100644 --- a/html/config.htm +++ b/html/config.htm @@ -107,7 +107,7 @@
- +
diff --git a/html/config.min.htm b/html/config.min.htm index 58c1aed..4bd685c 100644 --- a/html/config.min.htm +++ b/html/config.min.htm @@ -1 +1 @@ -Beer Gravity Monitor

Temperature Format

(10-100) - default 50
(50-1000) - default 500
(1 - 10) - default 1.6 SG
(0 - 100) - default 20C/68F
(9 - 12) - default 9 bits
(1 - 60) - default 20 s
(10 - 240) - default 120 s
(0 - 5) - default 0
(0 - 5) - default 0
(0 - 5) - default 0
(0 - 5) - default 0
(0 - 5) - default 0
(C) Copyright 2021-22 Magnus Persson
\ No newline at end of file +Beer Gravity Monitor

Temperature Format

(10-100) - default 50
(50-1000) - default 500
(1 - 10) - default 1.6 SG
(0 - 100) - default 20C/68F
(9 - 12) - default 9 bits
(1 - 60) - default 20 s
(10 - 240) - default 120 s
(0 - 5) - default 0
(0 - 5) - default 0
(0 - 5) - default 0
(0 - 5) - default 0
(0 - 5) - default 0
(C) Copyright 2021-22 Magnus Persson
\ No newline at end of file diff --git a/src_docs/source/configuration.rst b/src_docs/source/configuration.rst index 3bc76f1..9bae328 100644 --- a/src_docs/source/configuration.rst +++ b/src_docs/source/configuration.rst @@ -55,7 +55,8 @@ Device Setting * **Device name:** -This is unique name for the device. It will be used in pushing data as well as mDNS name on the network (.local) +This is unique name for the device. It will be used in pushing data as well as mDNS name on the network (.local). +The limitation is 63 chars but using long names might break endpoints that data is sent to if they have other limitations. * **Temperature format:** diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index 2f0dc54..789bd8e 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -7,7 +7,7 @@ Welcome to GravityMon's documentation! ###################################### .. note:: - This documentation reflects **v1.1 BETA 1**. Last updated 2022-07-06 + This documentation reflects **v1.1 BETA 2**. Last updated 2022-07-23 * Docs for: `v1.0 `_ * Docs for: `v0.9 `_ diff --git a/src_docs/source/intro.rst b/src_docs/source/intro.rst index 972f094..c287ef5 100644 --- a/src_docs/source/intro.rst +++ b/src_docs/source/intro.rst @@ -19,6 +19,12 @@ Step 2 - Setup WIFI When the device starts up the first time it will first start an WIFI access point so that the WIFI Settings can be configured. The instructions for that can be found here :ref:`setup_wifi` +.. note:: + Since the user interface is built using modern frameworks the device requires access to the internet + for the UI to render and data to be populated. The sites that are needed are; https://cdn.jsdelivr.net/npm/bootstrap + and https://code.jquery.com + + Step 3 - Configuration ---------------------- diff --git a/src_docs/source/q_and_a.rst b/src_docs/source/q_and_a.rst index ff9cc54..21d8dff 100644 --- a/src_docs/source/q_and_a.rst +++ b/src_docs/source/q_and_a.rst @@ -29,3 +29,19 @@ To fix these this you can; - change the advanced setting (Formula max deviation) to a higher value and save the values again. In the case above this paramater 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 +---------------------------------------- + +Since the user interface is built using bootstrap v5 the device requires access to the internet +to download required javascripts 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 popoulated 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. diff --git a/src_docs/source/releases.rst b/src_docs/source/releases.rst index 85de381..917f321 100644 --- a/src_docs/source/releases.rst +++ b/src_docs/source/releases.rst @@ -20,11 +20,11 @@ User interface * Added brewblox as format under format options. * User can now edit the voltage level that forces the device into config mode (charging) * (beta2) Calibration temperature (for temp adjustment) can now be set under advanced settings. +* (beta2) Changes length of device name from 12 to 63 chars. 63 is the max limit according to mdns. Features ++++++++ -* 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 sleep for the max allowed time. +* 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 sleep for the max allowed time. Other +++++