Updated docs

This commit is contained in:
Magnus Persson 2022-02-01 11:27:46 +01:00
parent 2615debe35
commit e459ceb2fa
5 changed files with 30 additions and 1 deletions

View File

@ -59,6 +59,12 @@ URL: (http://gravmon.local/device)
This is unique identifier for the device (ESP8266 id), this is required when using the API as an API Key to safeguard
against faulty requests. This is the ESP8266 chip ID, so it should be unique.
* **Average runtime:**
This shows the average time a gravity measurement takes. Under optimal setting this should be
around 1.5 - 2.0 seconds. If this is higher than 2 seconds this is most likley connected to slow wifi
connection. It will show 0 if data has not been collected yet.
Configuration
=============
@ -125,6 +131,11 @@ Push Settings
If you add the prefix `https://` then the device will use SSL when sending data.
* **Token:**
The token is included in the iSpindle JSON format and will be used for both HTTP targets. If you
need to have 2 different tokens please use the :ref:`format-editor` to customize the data format.
* **Brewfather URL:**
Endpoint to send data via http to brewfather. Format used :ref:`data-formats-brewfather`
@ -260,5 +271,6 @@ Hardware Settings
.. code-block::
http://192.168.1.1/firmware/gravmon/
https://192.168.1.1/firmware/gravmon/

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

@ -6,8 +6,13 @@ Releases
v0.8.0
------
* Added option to set http headers (2 per http endpoint)
* Added option to set http headers (2 per http endpoint), these can be used for
other formats and authentication with services.
* Added possibility to view last 10 errors on device page.
* Added possibility to define token parameter used in iSpindle format.
* Added instructions for how to configure integration with Brewspy
* Logging the runtime, how long a measurement take (last 10 are stored). This can be
used to check how good the wifi connection is and estimate the lifetime when on battery.
v0.7.1
------

View File

@ -155,3 +155,15 @@ format for the endpoint. Just add you API key after token.
"battery": ${battery},
"rssi": ${rssi}
}
Brewspy
+++++++
BrewSpy is a service that can show the history and manage the brew.
You need to enter the Token found in brewspy into the UI under Token and enter the following URL under http.
.. code-block::
http://brew-spy.com/api/ispindel