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

Updated docs for v1.1 beta 2

Browse Source
This commit is contained in:
Magnus Persson 2022-07-23 08:58:48 +02:00
parent bedbda4662
commit 77d2c15e39
7 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
html/config.htm
View File

@ -107,7 +107,7 @@
<div class="row mb-3">
<label for="mdns" class="col-sm-2 col-form-label">Device name</label>
<div class="col-sm-3">
<input type="text" maxlength="12" class="form-control" name="mdns" id="mdns" placeholder="gravmon" data-bs-toggle="tooltip" title="Name of the device. Will be used for identifying the device when pushing data and on the local network.">
<input type="text" maxlength="63" class="form-control" name="mdns" id="mdns" placeholder="gravmon" data-bs-toggle="tooltip" title="Name of the device. Will be used for identifying the device when pushing data and on the local network.">
</div>
</div>

2
html/config.min.htm
View File

File diff suppressed because one or more lines are too long

3
src_docs/source/configuration.rst
View File

@ -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 (<name>.local)
This is unique name for the device. It will be used in pushing data as well as mDNS name on the network (<name>.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:**

2
src_docs/source/index.rst
View File

@ -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 <https://mp-se.github.io/gravitymon/v1.0/index.html>`_
* Docs for: `v0.9 <https://mp-se.github.io/gravitymon/v0.9/index.html>`_

6
src_docs/source/intro.rst
View File

@ -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
----------------------

16
src_docs/source/q_and_a.rst
View File

@ -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.

4
src_docs/source/releases.rst
View File

@ -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
+++++