Update documentation

This commit is contained in:
GitHub Action
2022-05-08 07:25:00 +00:00
parent 4613c1de6c
commit aa5e2b738c
66 changed files with 24995 additions and 24623 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 37 KiB

BIN
docs/_images/config5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 MiB

After

Width:  |  Height:  |  Size: 7.4 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 73 KiB

View File

@ -19,6 +19,10 @@ To reduce the need for adding custom endpoints for various services there is an
You enter the format data in the text field and the test button will show an example on what the output would look like. If the data cannot be formatted in json it will just be displayed as a long string. You enter the format data in the text field and the test button will show an example on what the output would look like. If the data cannot be formatted in json it will just be displayed as a long string.
The save button will save the current formla and reload the data from the device. The save button will save the current formla and reload the data from the device.
You can also select a template from the list and copy that to the current endpoint.
Saving an empty formula will reset it to the default value.
.. tip:: .. tip::
If you save a blank string the default template will be loaded. If you save a blank string the default template will be loaded.

View File

@ -24,7 +24,6 @@ Other parameters are the same as in the configuration guide.
"ota-url": "http://192.168.1.50:80/firmware/gravmon/", "ota-url": "http://192.168.1.50:80/firmware/gravmon/",
"temp-format": "C", "temp-format": "C",
"ble": "color", "ble": "color",
"brewfather-push": "http://log.brewfather.net/stream?id=Qwerty",
"token": "token", "token": "token",
"token2": "token2", "token2": "token2",
"http-push": "http://192.168.1.50:9090/api/v1/Qwerty/telemetry", "http-push": "http://192.168.1.50:9090/api/v1/Qwerty/telemetry",
@ -59,15 +58,9 @@ Other parameters are the same as in the configuration guide.
}, },
"formula-calculation-data": { "formula-calculation-data": {
"a1":25, "a1":25,
"a2":30, "a10":0,
"a3":35,
"a4":40,
"a5":45,
"g1":1, "g1":1,
"g2":1.01, "g10":1
"g3":1.02,
"g4":1.03,
"g5":1.04
}, },
"angle": 90.93, "angle": 90.93,
"gravity": 1.105, "gravity": 1.105,
@ -102,6 +95,7 @@ Other parameters are the same as in the configuration guide.
"temp-c": 0, "temp-c": 0,
"temp-f": 32, "temp-f": 32,
"battery": 0, "battery": 0,
"wifi-ssid": "connected SSID",
"temp-format": "C", "temp-format": "C",
"sleep-mode": false, "sleep-mode": false,
"token": "token", "token": "token",
@ -120,8 +114,8 @@ GET: /api/config/formula
Retrive the data used for formula calculation data via an HTTP GET command. Payload is in JSON format. Retrive the data used for formula calculation data via an HTTP GET command. Payload is in JSON format.
* ``a1``-``a4`` are the angles/tilt readings (up to 5 are currently supported) * ``a1``-``a10`` are the angles/tilt readings (up to 10 are currently supported)
* ``g1``-``g4`` are the corresponding gravity reaadings in SG or Plato depending on the device-format. * ``g1``-``g10`` are the corresponding gravity reaadings in SG or Plato depending on the device-format.
.. code-block:: json .. code-block:: json
@ -132,16 +126,61 @@ Retrive the data used for formula calculation data via an HTTP GET command. Payl
"a3": 58, "a3": 58,
"a4": 0, "a4": 0,
"a5": 0, "a5": 0,
"a6": 0,
"a7": 0,
"a8": 0,
"a9": 0,
"a10": 0,
"g1": 1.000, "g1": 1.000,
"g2": 1.053, "g2": 1.053,
"g3": 1.062, "g3": 1.062,
"g4": 1, "g4": 1,
"g5": 1, "g5": 1,
"g6": 1,
"g7": 1,
"g8": 1,
"g9": 1,
"g10": 1,
"error": "Potential error message",
"gravity-format": "G", "gravity-format": "G",
"gravity-formula": "0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436" "gravity-formula": "0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436"
} }
GET: /api/config/advanced
=========================
Used for adjusting some internal constants and other advanced settings. Should be used with caution.
.. code-block:: json
{
"gyro-read-count": 50,
"tempsensor-resolution": 9,
"gyro-moving-threashold": 500,
"formula-max-deviation": 1.6,
"wifi-portal-timeout": 120,
"wifi-connect-timeout": 20,
"formula-calibration-temp": 20,
"ignore-low-angles": false,
"int-http1": 0,
"int-http2": 0,
"int-http3": 0,
"int-influx": 0,
"int-mqtt": 0
}
POST: /api/config/advanced
==========================
Same parameters as above.
Payload should be in standard format used for posting a form.
.. note::
``ignore-low-angles`` is defined as "on" or "off" when posting since this is the output values
from a checkbox, when reading data it's sent as boolean (true,false).
GET: /api/clearwifi GET: /api/clearwifi
=================== ===================
@ -173,7 +212,7 @@ Trigger a push on one of the targets, used to validate the configuration from th
Requires to parameters to function /api/test/push?id=<deviceid>&format=<format> Requires to parameters to function /api/test/push?id=<deviceid>&format=<format>
* ``format`` defines which endpoint to test, valid values are; http-1, http-2, brewfather, influxdb, mqtt * ``format`` defines which endpoint to test, valid values are; http-1, http-2, http-3, influxdb, mqtt
The response is an json message with the following values. The response is an json message with the following values.
@ -223,7 +262,6 @@ Payload should be in standard format used for posting a form. Such as as: `id=va
http-push-h2= http-push-h2=
http-push2-h1= http-push2-h1=
http-push2-h2= http-push2-h2=
brewfather-push=
influxdb2-push=http://192.168.1.50:8086 influxdb2-push=http://192.168.1.50:8086
influxdb2-org= influxdb2-org=
influxdb2-bucket= influxdb2-bucket=
@ -282,8 +320,8 @@ POST: /api/config/formula
Used to update formula calculation data via an HTTP POST command. Payload is in JSON format. Used to update formula calculation data via an HTTP POST command. Payload is in JSON format.
* ``a1``-``a4`` are the angles/tilt readings (up to 5 are currently supported) * ``a1``-``a10`` are the angles/tilt readings (up to 10 are currently supported)
* ``g1``-``g4`` are the corresponding gravity reaadings (in SG) * ``g1``-``g10`` are the corresponding gravity reaadings (in SG)
Payload should be in standard format used for posting a form. Such as as: `id=value&mdns=value` etc. Key value pairs are shown below. Payload should be in standard format used for posting a form. Such as as: `id=value&mdns=value` etc. Key value pairs are shown below.
@ -295,11 +333,21 @@ Payload should be in standard format used for posting a form. Such as as: `id=va
a3=58 a3=58
a4=0 a4=0
a5=0 a5=0
a6=0
a7=0
a8=0
a9=0
a19=0
g1=1.000 g1=1.000
g2=1.053 g2=1.053
g3=1.062 g3=1.062
g4=1 g4=1
g5=1 g5=1
g6=1
g7=1
g8=1
g9=1
g10=1
Calling the API's from Python Calling the API's from Python
@ -346,7 +394,6 @@ The requests package converts the json to standard form post format.
"http-push-h2": "", "http-push-h2": "",
"http-push2-h1": "" "http-push2-h1": ""
"http-push2-h2": "", "http-push2-h2": "",
"brewfather-push": "",
"influxdb2-push": "", "influxdb2-push": "",
"influxdb2-org": "", "influxdb2-org": "",
"influxdb2-bucket": "", "influxdb2-bucket": "",
@ -383,10 +430,20 @@ The requests package converts the json to standard form post format.
"a3": 58, "a3": 58,
"a4": 0, "a4": 0,
"a5": 0, "a5": 0,
"a6": 0,
"a7": 0,
"a8": 0,
"a9": 0,
"a10": 0,
"g1": 1.000, "g1": 1.000,
"g2": 1.053, "g2": 1.053,
"g3": 1.062, "g3": 1.062,
"g4": 1, "g4": 1,
"g5": 1 "g5": 1,
"g6": 1,
"g7": 1,
"g8": 1,
"g9": 1,
"g10": 1
} }
set_config( url, json ) set_config( url, json )

View File

@ -29,8 +29,9 @@ In the platformio config there are 3 targets defined
* gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled. * gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.
* gravity-release; Standard release * gravity-release; Standard release
* gravity-perf; Standard release but contains code for measuring performance * gravity-perf; Standard release but contains code for measuring performance.
* gravity32-perf: Experimental version for ESP32. * gravity32-release: Version for ESP32.
* gravity32-perf: Version for ESP32 but contains code for measuring performance.
.. note:: .. note::
There is an experimental ESP32 target but since platformio only supports SDK 1.0.6 and the WIFI connection is really slow compared to ESP8266, There is an experimental ESP32 target but since platformio only supports SDK 1.0.6 and the WIFI connection is really slow compared to ESP8266,
@ -68,8 +69,6 @@ Source structure
- Source code for software - Source code for software
* - /src_docs * - /src_docs
- Source code for documentation - Source code for documentation
* - /stl
- 3d models
* - /test * - /test
- Test data for developing html files - Test data for developing html files

View File

@ -121,12 +121,6 @@ If you add the prefix `https://` then the device will use SSL when sending data.
The token is included in the default format for the HTTP GET url but can be used for any of the formats. For HTTP GET use can use this for an authorization token with for instance ubidots or blynk http api. The token is included in the default format for the HTTP GET url but can be used for any of the formats. For HTTP GET use can use this for an authorization token with for instance ubidots or blynk http api.
* **Brewfather URL:**
Endpoint to send data via http to brewfather. Format used :ref:`data-formats-brewfather`
SSL is not supported for this target.
* **HTTP Headers** * **HTTP Headers**
.. image:: images/config-popup1.png .. image:: images/config-popup1.png
@ -281,3 +275,52 @@ This option gives you the possibility to install an new version of the firmware
:alt: Update firmware :alt: Update firmware
Advanded Settings
+++++++++++++++++
.. image:: images/config5.png
:width: 800
:alt: Advanced Settings
.. warning::
Changeing these parameters with caution. The wrong values might cause the device to become unresponsive.
* **Gyro reads:**
This defines how many gyro reads will be done before an angle is calculated. More reads will give better accuracy and also allow detection of
movement. Too many reads will take time and affecte batterylife. 50 takes about 800 ms to execute.
* **Gyro moving threashold:**
This is the max amount of deviation allowed for a stable reading.
* **Formula deviation:**
This is the maximum devation on the formlula allowed for it to be accepted. Once the formula has been derived it will be validated against the supplied
data and of the deviation on any point is bigger the formula will be rejected.
* **Ignore angles below water:**
If this option is checked any angles below that of SG 1 will be discarded as invalid and never sent to any server. Default = off.
* **DS18B20 Resolution:**
Define the resolution used on the temp sensor. 9 bits is default and will give an accuracy of 0.5C, 12 bits will give an accuracy of 0.0625C but will also
take longer time to measure..
* **Wifi connect timeout:**
This is the amount of time allowed for a wifi connect.
* **Wifi portal timeout:**
If the wifi portal is triggered (can be triggerd by reset) then this is the amount of time allowed before it exists again.
* **Skip Interval (...):**
These options allow the user to have variable push intervals for the diffrent endpoints. 0 means that every wakeup will send data to that endpoint. If you enter another number then that defines how many sleep cycles will be skipped.
If the sleep interval is 300s and MQTT is set to 0 and HTTP1 is set to 2 then MQTT will be sent every 300s while HTTP1 would be sent 900s. This is great if you want to send data to a local mqtt server often but brewfather will only
accept data every 15 min.

View File

@ -26,7 +26,7 @@ This is the format used for standard http posts.
"gravity": 1.0050, "gravity": 1.0050,
"angle": 45.34, "angle": 45.34,
"battery": 3.67, "battery": 3.67,
"rssi": -12, "RSSI": -12,
"corr-gravity": 1.0050, "corr-gravity": 1.0050,
"gravity-unit": "G", "gravity-unit": "G",
@ -47,32 +47,13 @@ This is the format template used to create the json above.
"gravity": ${gravity}, "gravity": ${gravity},
"angle": ${angle}, "angle": ${angle},
"battery": ${battery}, "battery": ${battery},
"rssi": ${rssi}, "RSSI": ${rssi},
"corr-gravity": ${corr-gravity}, "corr-gravity": ${corr-gravity},
"gravity-unit": "${gravity-unit}", "gravity-unit": "${gravity-unit}",
"run-time": ${run-time} "run-time": ${run-time}
} }
.. _data-formats-brewfather:
Brewfather format
=================
This is the format for Brewfather. See: `Brewfather API docs <https://docs.brewfather.app/integrations/custom-stream>`_
.. code-block:: json
{
"name" : "gravmon",
"temp": 20.5,
"temp_unit": "C",
"battery": 3.67,
"gravity": 1.0050,
"gravity_unit": "G",
}
.. _data-formats-influxdb2: .. _data-formats-influxdb2:
HTTP Get HTTP Get

View File

@ -7,7 +7,7 @@ Create formula
:width: 800 :width: 800
:alt: Formula data :alt: Formula data
Here you can enter up to 5 values (angles + gravity) that is then used to create the formula. Angles equal to zero will be regarded as empty even if there is a gravity reading. Here you can enter up to 10 values (angles + gravity) that is then used to create the formula. Angles equal to zero will be regarded as empty even if there is a gravity reading.
.. image:: images/formula2.png .. image:: images/formula2.png
:width: 800 :width: 800

View File

@ -33,10 +33,10 @@ The main features
Currently the device supports the following endpoints. Currently the device supports the following endpoints.
* http or https * http (ssl optional)
* influxdb v2 * influxdb v2 (ssl optional)
* MQTT (ssl optional)
* Brewfather * Brewfather
* MQTT
* Home Assistant * Home Assistant
* Brew Spy * Brew Spy
* Brewers Friend * Brewers Friend
@ -65,11 +65,9 @@ The main features
Another big difference is that this software can create the gravity formula in the device, just enter the Another big difference is that this software can create the gravity formula in the device, just enter the
angle/gravity data that you have collected. You will also see a graph simulating how the formula would work. angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.
Currently the device can handle 5 data points which should be enough to get a accurate formula. At least 3 data points Currently the device can handle 10 data points which should be enough to get a accurate formula. At least 3 data points
is needed to get an accurate formula. is needed to get an accurate formula.
If there is a need for more data points, raise a comment on github.
* **Customize the data format beeing sent to push targets** * **Customize the data format beeing sent to push targets**
In order to make it easier to support more targets there is a built in format editor that can be used to In order to make it easier to support more targets there is a built in format editor that can be used to
@ -86,7 +84,8 @@ The main features
* **OTA support from webserver** * **OTA support from webserver**
When starting up in configuration mode the device will check for a software update from a webserver. This is an easily When starting up in configuration mode the device will check for a software update from a webserver. This is an easily
way to keep the software up to date. In the future I might add a hosted endpoint for providing updates. way to keep the software up to date. In the future I might add a hosted endpoint for providing updates. OTA can also be
done over a SSL connection.
* **DS18B20 temperature adjustments** * **DS18B20 temperature adjustments**
@ -95,13 +94,14 @@ The main features
* **Gyro Movement** * **Gyro Movement**
The software will detect if the gyro is moving and if this is the case it will go back to sleep for 60seconds. The software will detect if the gyro is moving and if this is the case it will go back to sleep for 60 seconds.
This way we should avoid faulty measurements and peaks in the graphs. This way we should avoid faulty measurements and peaks in the graphs.
* **WIFI connection issues** * **WIFI connection issues**
The software will not wait indefiently for a wifi connection. If it takes longer than 20 seconds to connect then The software will not wait indefiently for a wifi connection. If it takes longer than 20 seconds to connect then
the device will go into deep sleep for 60 seoncds and then retry later. This to conserve batter as much as possible. the device will try the seconday wifi configuration, and that also failes it will go into deep sleep for 60 seconds and then
retry later. This to conserve batter as much as possible.
* **Use gyro temperature sensor** * **Use gyro temperature sensor**

View File

@ -24,3 +24,22 @@ need to adjust the voltage factor so the battery reading is correct.
:width: 500 :width: 500
:alt: Mounting esp32 :alt: Mounting esp32
Schema for esp8266 build
------------------------
.. image:: images/schema_esp8266.png
:width: 700
:alt: Schema esp8266
Schema for esp32 build
----------------------
.. note::
This schema assumes that an ESP32 D1 Mini (pin compatible with ESP8266 D1 Mini is used)
The ESP32 has two rows of pins but only the inner row is used. The main difference is the added resistor R3 so we
get a voltage divider for measuring battery. The ESP8266 has a built in resistor thats not visible on the schema.
.. image:: images/schema_esp32.png
:width: 700
:alt: Schema esp32

View File

@ -7,7 +7,10 @@ Welcome to GravityMon's documentation!
###################################### ######################################
.. note:: .. note::
This documentation reflects **v0.9**. Last updated 2022-04-23 This documentation reflects **v1.0**. Last updated 2022-05-06
* Docs for: `v0.8 <https://mp-se.github.io/gravitymon/v0.8index.html>`_
* Docs for: `v0.9 <https://mp-se.github.io/gravitymon/v0.9/index.html>`_
.. image:: images/gravitymon.gif .. image:: images/gravitymon.gif
:width: 800 :width: 800

View File

@ -13,7 +13,8 @@ Brewflasher
=========== ===========
The prefered option for flashing GravityMon is using BrewFlasher, its a tools that support many brewing related firmwares for ESP8266 and ESP32. This works The prefered option for flashing GravityMon is using BrewFlasher, its a tools that support many brewing related firmwares for ESP8266 and ESP32. This works
on both Windows and Mac. You can download the latest version from here: `Brewflasher <https://www.brewflasher.com/>`_ on both Windows and Mac. You can download the latest version from here: `Brewflasher <https://www.brewflasher.com/>`_ there is also a web based version
available here `Brewflasher WEB <https://web.brewflasher.com/>`_.
.. image:: images/brewflasher.png .. image:: images/brewflasher.png
:width: 600 :width: 600
@ -34,7 +35,8 @@ In the /bin directory you will find 3 different firmware builds;
* **firmware32.bin** * **firmware32.bin**
This is the standard release build for an ESP32 variant This is the standard release build for an ESP32 variant. When flashing an ESP32 you also need the **partition32.bin** file that outlines the flash memory structure. Due to
the size of the firmware we are using a custom partition setup.
In these versions all the html files are embedded in the binaries. The file system is currently only used for storing In these versions all the html files are embedded in the binaries. The file system is currently only used for storing
the configuration file. the configuration file.
@ -90,7 +92,6 @@ browser and select the firmware.bin file that corresponds to the version you wan
``http://<device_name>/firmware.htm`` ``http://<device_name>/firmware.htm``
.. _serial_monitoring: .. _serial_monitoring:
Serial Monitoring Serial Monitoring
@ -120,6 +121,9 @@ in the browser: **http://192.168.4.1**
Before pressing save on the network infomration, make a note of the devicename that is shown on the screen, this will be the name that is used Before pressing save on the network infomration, make a note of the devicename that is shown on the screen, this will be the name that is used
in the next step to access the configuration pages. The link would look like this: **http://gravitymon56EA34.local** in the next step to access the configuration pages. The link would look like this: **http://gravitymon56EA34.local**
Under wifi settings you can define a primary and seconday wifi SSID. The seconday will be used in case the primary fails. If the seconday is
successful then it will be used as primary. *The second wifi setting is optional and not needed.*
.. image:: images/wifi.png .. image:: images/wifi.png
:width: 200 :width: 200
:alt: Wifi page :alt: Wifi page

View File

@ -3,7 +3,46 @@
Releases Releases
######## ########
v1.0.0-beta3
------------
* Added circuit diagram for esp8266 and esp32
* Update documentation to match new version
v1.0.0-beta2
------------
* Moved applying temp sensor resolution in loop so there is no need to reboot.
* Advanced software settings is only disabled if settings contain default values.
* Added button on indexpage to direct to github issues.
* Added button to extract important information for support requests.
* Updated docs with information from beta1.
* First point in gravity formula is now reserved for water gravity, this to allow detection of angles below water that can be filtered out.
* Added advanced setting to ignore angles that are lower than water. This is disabled by default.
* Added experimental support for MPU6500 (allowing that deviceID), waiting for confirmation on function.
* Changed layout on index page with measured data on top.
* BUG: Fixed error in html page for calibration so that that feature works again (REST API was working)
v1.0.0-beta1
------------
* Upgraded to bootstrap v5.1 for web pages.
* Added tooltips to all fields in user interface
* Removed brewfather option (can use standard HTTP options), the old apporach can still be used via changing format template.
* Added 5 more points for formula creation, so a total of 10 angles/gravity values can be stored.
* Added function on format page so that it's easy to copy a format template from the docs (simplify service integration).
* Added https support for Influxdb
* Added possibility to have variable push intervals for different endpoints so that different frequency can be used, for example; 5min mqtt, 15min brewfather.
* Added advanced settings: Changes how many times the gyro is read (less reads, quicker but less accurate)
* Added advanced settings: Set amount of gyro movement is allowed for a accurate read.
* Added advanced settings: What deviation is acceptable for creating formula deviation
* Added advanced settings: Various timeouts, wifi connect, wifi portal, http connects.
* Added advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing batterylife
* Added additional http error codes to troubleshooting documentation
* Added possibility to set 2 wifi ssid where the second acts as a fallback in case it fails to connect. If succesful the seconday becomes the new primary.
* SSL connections are skipped on ESP8266 when in config mode since there is a high probability it will crash due to low memory.
* Installation instructions updated on how to find the device after wifi has been configured. * Installation instructions updated on how to find the device after wifi has been configured.
* Documentation on brewfather has been updated to adress SG/Plato conversion
* BUG: Fixed issue in formula calculation in case there were a gap in the data series
* BUG: Field name for wifi strength changed from "rssi" to "RSSI"
* BUG: Fixed issue with probing MFLN on non standard ports
v0.9.0 v0.9.0
------ ------

View File

@ -10,14 +10,26 @@ Brewfather
Brewfather is an all in one service that allows you to manage you recepies and brews. Brewfather is an all in one service that allows you to manage you recepies and brews.
.. tip:: **Option 1** - iSpindle Endpoint
The integration named Brewfather is uses the custom stream endpoint in brewfather not the standard iSpindle This opion makes use of the standard http (1 or 2) endpoints in the push section. If you are using SG then the device name needs to end with [SG] or brewfather will assume
endpoint. You can use the iSpindle endpoint as well. In that case just use the http-1 or http-2 fields. that the data is in plato. You can also modify the format template using the following options:
**Option 1** - Custom Stream Update the following part `"gravity": ${gravity-plato},` or `"name" : "${mdns}[SG]",``
This option makes use of the push endpoint called Brewfather in the UI. Just enter the http stream adress found This makes use of the standard format template, no changes needed.
.. code-block::
http://log.brewfather.net/ispindel?id=<yourid>
Documentation on this can be found under `Brewfather iSpindle Endpoint <https://docs.brewfather.app/integrations/ispindel>`_
**Option 2** - Custom Stream
This option makes use of the http push endpoint with a custom format template. Just enter the http stream adress found
on brewfather, not other settings are needed. The stream endpoint URL has the following format: on brewfather, not other settings are needed. The stream endpoint URL has the following format:
.. code-block:: .. code-block::
@ -48,18 +60,6 @@ The implementation is basically a http request with the following format templat
} }
**Option 2** - iSpindle Endpoint
This opion makes use of the standard http (1 or 2) endpoints in the push section. If you are using SG then the device name needs to end with [SG] or brewfather will assume
that the data is in plato. The brewfather iSpindle endpoint has the following format:
.. code-block::
http://log.brewfather.net/ispindel?id=<yourid>
Documentation on this can be found under `Brewfather iSpindle Endpoint <https://docs.brewfather.app/integrations/ispindel>`_
Fermentrack Fermentrack
+++++++++++ +++++++++++
@ -120,7 +120,7 @@ format template that can be used. For information on customizing the format see
"gravity": ${gravity}, "gravity": ${gravity},
"angle": ${angle}, "angle": ${angle},
"battery": ${battery}, "battery": ${battery},
"rssi": ${rssi} "RSSI": ${rssi}
} }
@ -146,7 +146,10 @@ device is named `gravmon2`
state_topic: "gravmon/gravmon2/battery" state_topic: "gravmon/gravmon2/battery"
- platform: mqtt - platform: mqtt
name: "gravmon2_rssi" name: "gravmon2_rssi"
state_topic: "gravmon/gravmon2/rssi" state_topic: "gravmon/gravmon2/RSSI"
- platform: mqtt
name: "gravmon2_temp"
state_topic: "gravmon/gravmon2/temp"
Enter the name of the MQTT server in Home Assistant in the URL. You might need to install that option Enter the name of the MQTT server in Home Assistant in the URL. You might need to install that option
@ -155,9 +158,10 @@ many sensors / topics as you want.
:: ::
gravmon/${mdns}/tilt:${angle}| gravmon/${mdns}/gravity:${gravity}|
gravmon/${mdns}/temperature:${temp}| gravmon/${mdns}/battery:${battery}|
gravmon/${mdns}/temp_units:${temp-unit}| gravmon/${mdns}/RSSI:${rssi}|
gravmon/${mdns}/temp:${temp}|
Brewer's Friend Brewer's Friend
@ -194,7 +198,7 @@ format for the endpoint. Just add you API key after token.
"gravity": ${gravity}, "gravity": ${gravity},
"angle": ${angle}, "angle": ${angle},
"battery": ${battery}, "battery": ${battery},
"rssi": ${rssi} "RSSI": ${rssi}
} }
@ -260,4 +264,3 @@ starting with a ``?``. This string will be added to the URL above when doing the
.. code-block:: .. code-block::
?token=${token2}&v1=${temp}&v2=${gravity}&v3=${angle} ?token=${token2}&v1=${temp}&v2=${gravity}&v3=${angle}

View File

@ -31,7 +31,6 @@ Log errors
Check the format for your custom header. This means it has not a correct format. Check the format for your custom header. This means it has not a correct format.
* Influxdb push failed response * Influxdb push failed response
* Brewfather push failed response
* HTTP push failed response * HTTP push failed response
All these errors are standard http error codes. This are the commone ones; All these errors are standard http error codes. This are the commone ones;
@ -41,8 +40,28 @@ Log errors
* 403 - Forbidden. Could be an issue with token or URL. * 403 - Forbidden. Could be an issue with token or URL.
* 404 - Not found. Probably a wrong URL. * 404 - Not found. Probably a wrong URL.
In some cases there can be negative error codes which have the following meaning:
* -1 - Connection refused
* -2 - Send header failed
* -3 - Send payload failed
* -4 - Not connected
* -5 - Connection lost
* -6 - No stream
* -7 - No HTTP server
* -8 - Too little RAM available
* -9 - Error encoding
* -10 - Error writing to stream
* -11 - Read timeout
* -100 - Endpoint skipped since its SSL and the device is in gravity mode
* MQTT push on <topic> failed error * MQTT push on <topic> failed error
* -1 - Buffer to short
* -2 - Overflow
* -3 - Network failed connected * -3 - Network failed connected
* -4 - Network timeout
* -5 - Network read failed
* -6 - Network write failed
* -10 - Connection denied * -10 - Connection denied
* -11 - Failed subscription

View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.9.0', VERSION: '1.0.0',
LANGUAGE: 'None', LANGUAGE: 'None',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
BUILDER: 'html', BUILDER: 'html',

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="REST API" href="api.html" /><link rel="prev" title="Service Integration" href="services.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="REST API" href="api.html" /><link rel="prev" title="Service Integration" href="services.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Advanced Configuration - GravityMon 0.9.0 documentation</title> <title>Advanced Configuration - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -215,6 +215,8 @@
<a class="reference internal image-reference" href="_images/format.png"><img alt="Format editor" src="_images/format.png" style="width: 800px;"/></a> <a class="reference internal image-reference" href="_images/format.png"><img alt="Format editor" src="_images/format.png" style="width: 800px;"/></a>
<p>You enter the format data in the text field and the test button will show an example on what the output would look like. If the data cannot be formatted in json it will just be displayed as a long string. <p>You enter the format data in the text field and the test button will show an example on what the output would look like. If the data cannot be formatted in json it will just be displayed as a long string.
The save button will save the current formla and reload the data from the device.</p> The save button will save the current formla and reload the data from the device.</p>
<p>You can also select a template from the list and copy that to the current endpoint.</p>
<p>Saving an empty formula will reset it to the default value.</p>
<div class="admonition tip"> <div class="admonition tip">
<p class="admonition-title">Tip</p> <p class="admonition-title">Tip</p>
<p>If you save a blank string the default template will be loaded.</p> <p>If you save a blank string the default template will be loaded.</p>

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Data Formats" href="data.html" /><link rel="prev" title="Advanced Configuration" href="advanced.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Data Formats" href="data.html" /><link rel="prev" title="Advanced Configuration" href="advanced.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>REST API - GravityMon 0.9.0 documentation</title> <title>REST API - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -221,7 +221,6 @@
<span class="w"> </span><span class="nt">"ota-url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://192.168.1.50:80/firmware/gravmon/"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"ota-url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://192.168.1.50:80/firmware/gravmon/"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"temp-format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"C"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"temp-format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"C"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"ble"</span><span class="p">:</span><span class="w"> </span><span class="s2">"color"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"ble"</span><span class="p">:</span><span class="w"> </span><span class="s2">"color"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"brewfather-push"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://log.brewfather.net/stream?id=Qwerty"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"token"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"token"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"token2"</span><span class="p">:</span><span class="w"> </span><span class="s2">"token2"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"token2"</span><span class="p">:</span><span class="w"> </span><span class="s2">"token2"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"http-push"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://192.168.1.50:9090/api/v1/Qwerty/telemetry"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"http-push"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://192.168.1.50:9090/api/v1/Qwerty/telemetry"</span><span class="p">,</span><span class="w"></span>
@ -256,15 +255,9 @@
<span class="w"> </span><span class="p">},</span><span class="w"></span> <span class="w"> </span><span class="p">},</span><span class="w"></span>
<span class="w"> </span><span class="nt">"formula-calculation-data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span> <span class="w"> </span><span class="nt">"formula-calculation-data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a1"</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"a1"</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a2"</span><span class="p">:</span><span class="mi">30</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"a10"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a3"</span><span class="p">:</span><span class="mi">35</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a4"</span><span class="p">:</span><span class="mi">40</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a5"</span><span class="p">:</span><span class="mi">45</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g1"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"g1"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g2"</span><span class="p">:</span><span class="mf">1.01</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"g10"</span><span class="p">:</span><span class="mi">1</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g3"</span><span class="p">:</span><span class="mf">1.02</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g4"</span><span class="p">:</span><span class="mf">1.03</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g5"</span><span class="p">:</span><span class="mf">1.04</span><span class="w"></span>
<span class="w"> </span><span class="p">},</span><span class="w"></span> <span class="w"> </span><span class="p">},</span><span class="w"></span>
<span class="w"> </span><span class="nt">"angle"</span><span class="p">:</span><span class="w"> </span><span class="mf">90.93</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"angle"</span><span class="p">:</span><span class="w"> </span><span class="mf">90.93</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"gravity"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.105</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"gravity"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.105</span><span class="p">,</span><span class="w"></span>
@ -294,6 +287,7 @@
<span class="w"> </span><span class="nt">"temp-c"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"temp-c"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"temp-f"</span><span class="p">:</span><span class="w"> </span><span class="mi">32</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"temp-f"</span><span class="p">:</span><span class="w"> </span><span class="mi">32</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"battery"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"battery"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"wifi-ssid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"connected SSID"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"temp-format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"C"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"temp-format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"C"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"sleep-mode"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"sleep-mode"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"token"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"token"</span><span class="p">,</span><span class="w"></span>
@ -312,8 +306,8 @@
<h2>GET: /api/config/formula<a class="headerlink" href="#get-api-config-formula" title="Permalink to this headline">#</a></h2> <h2>GET: /api/config/formula<a class="headerlink" href="#get-api-config-formula" title="Permalink to this headline">#</a></h2>
<p>Retrive the data used for formula calculation data via an HTTP GET command. Payload is in JSON format.</p> <p>Retrive the data used for formula calculation data via an HTTP GET command. Payload is in JSON format.</p>
<ul class="simple"> <ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">a1</span></code>-<code class="docutils literal notranslate"><span class="pre">a4</span></code> are the angles/tilt readings (up to 5 are currently supported)</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">a1</span></code>-<code class="docutils literal notranslate"><span class="pre">a10</span></code> are the angles/tilt readings (up to 10 are currently supported)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">g1</span></code>-<code class="docutils literal notranslate"><span class="pre">g4</span></code> are the corresponding gravity reaadings in SG or Plato depending on the device-format.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">g1</span></code>-<code class="docutils literal notranslate"><span class="pre">g10</span></code> are the corresponding gravity reaadings in SG or Plato depending on the device-format.</p></li>
</ul> </ul>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span> <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ee1bfc"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ee1bfc"</span><span class="p">,</span><span class="w"></span>
@ -322,17 +316,59 @@
<span class="w"> </span><span class="nt">"a3"</span><span class="p">:</span><span class="w"> </span><span class="mi">58</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"a3"</span><span class="p">:</span><span class="w"> </span><span class="mi">58</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a4"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"a4"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a5"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"a5"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a6"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a7"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a8"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a9"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"a10"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g1"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.000</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"g1"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.000</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g2"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.053</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"g2"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.053</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g3"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.062</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"g3"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.062</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g4"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"g4"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g5"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"g5"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g6"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g7"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g8"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g9"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"g10"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"error"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Potential error message"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"gravity-format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"G"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"gravity-format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"G"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"gravity-formula"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436"</span><span class="w"></span> <span class="w"> </span><span class="nt">"gravity-formula"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.0*tilt^3+0.0*tilt^2+0.0017978*tilt+0.9436"</span><span class="w"></span>
<span class="p">}</span><span class="w"></span> <span class="p">}</span><span class="w"></span>
</pre></div> </pre></div>
</div> </div>
</div> </div>
<div class="section" id="get-api-config-advanced">
<h2>GET: /api/config/advanced<a class="headerlink" href="#get-api-config-advanced" title="Permalink to this headline">#</a></h2>
<p>Used for adjusting some internal constants and other advanced settings. Should be used with caution.</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="nt">"gyro-read-count"</span><span class="p">:</span><span class="w"> </span><span class="mi">50</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"tempsensor-resolution"</span><span class="p">:</span><span class="w"> </span><span class="mi">9</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"gyro-moving-threashold"</span><span class="p">:</span><span class="w"> </span><span class="mi">500</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"formula-max-deviation"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.6</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"wifi-portal-timeout"</span><span class="p">:</span><span class="w"> </span><span class="mi">120</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"wifi-connect-timeout"</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"formula-calibration-temp"</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"ignore-low-angles"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"int-http1"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"int-http2"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"int-http3"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"int-influx"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"int-mqtt"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
</div>
<div class="section" id="post-api-config-advanced">
<h2>POST: /api/config/advanced<a class="headerlink" href="#post-api-config-advanced" title="Permalink to this headline">#</a></h2>
<p>Same parameters as above.</p>
<p>Payload should be in standard format used for posting a form.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><code class="docutils literal notranslate"><span class="pre">ignore-low-angles</span></code> is defined as “on” or “off” when posting since this is the output values
from a checkbox, when reading data its sent as boolean (true,false).</p>
</div>
</div>
<div class="section" id="get-api-clearwifi"> <div class="section" id="get-api-clearwifi">
<h2>GET: /api/clearwifi<a class="headerlink" href="#get-api-clearwifi" title="Permalink to this headline">#</a></h2> <h2>GET: /api/clearwifi<a class="headerlink" href="#get-api-clearwifi" title="Permalink to this headline">#</a></h2>
<p>Will reset the wifi settings both in the configuration file and eeprom, leaving the rest of the configuration.</p> <p>Will reset the wifi settings both in the configuration file and eeprom, leaving the rest of the configuration.</p>
@ -354,7 +390,7 @@
<p>Trigger a push on one of the targets, used to validate the configuration from the UI.</p> <p>Trigger a push on one of the targets, used to validate the configuration from the UI.</p>
<p>Requires to parameters to function /api/test/push?id=&lt;deviceid&gt;&amp;format=&lt;format&gt;</p> <p>Requires to parameters to function /api/test/push?id=&lt;deviceid&gt;&amp;format=&lt;format&gt;</p>
<ul class="simple"> <ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">format</span></code> defines which endpoint to test, valid values are; http-1, http-2, brewfather, influxdb, mqtt</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">format</span></code> defines which endpoint to test, valid values are; http-1, http-2, http-3, influxdb, mqtt</p></li>
</ul> </ul>
<p>The response is an json message with the following values.</p> <p>The response is an json message with the following values.</p>
<ul class="simple"> <ul class="simple">
@ -396,7 +432,6 @@
<span class="n">http</span><span class="o">-</span><span class="n">push</span><span class="o">-</span><span class="n">h2</span><span class="o">=</span> <span class="n">http</span><span class="o">-</span><span class="n">push</span><span class="o">-</span><span class="n">h2</span><span class="o">=</span>
<span class="n">http</span><span class="o">-</span><span class="n">push2</span><span class="o">-</span><span class="n">h1</span><span class="o">=</span> <span class="n">http</span><span class="o">-</span><span class="n">push2</span><span class="o">-</span><span class="n">h1</span><span class="o">=</span>
<span class="n">http</span><span class="o">-</span><span class="n">push2</span><span class="o">-</span><span class="n">h2</span><span class="o">=</span> <span class="n">http</span><span class="o">-</span><span class="n">push2</span><span class="o">-</span><span class="n">h2</span><span class="o">=</span>
<span class="n">brewfather</span><span class="o">-</span><span class="n">push</span><span class="o">=</span>
<span class="n">influxdb2</span><span class="o">-</span><span class="n">push</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">192.168.1.50</span><span class="p">:</span><span class="mi">8086</span> <span class="n">influxdb2</span><span class="o">-</span><span class="n">push</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">192.168.1.50</span><span class="p">:</span><span class="mi">8086</span>
<span class="n">influxdb2</span><span class="o">-</span><span class="n">org</span><span class="o">=</span> <span class="n">influxdb2</span><span class="o">-</span><span class="n">org</span><span class="o">=</span>
<span class="n">influxdb2</span><span class="o">-</span><span class="n">bucket</span><span class="o">=</span> <span class="n">influxdb2</span><span class="o">-</span><span class="n">bucket</span><span class="o">=</span>
@ -450,8 +485,8 @@ reading data its sent as boolean (true,false).</p>
<h2>POST: /api/config/formula<a class="headerlink" href="#post-api-config-formula" title="Permalink to this headline">#</a></h2> <h2>POST: /api/config/formula<a class="headerlink" href="#post-api-config-formula" title="Permalink to this headline">#</a></h2>
<p>Used to update formula calculation data via an HTTP POST command. Payload is in JSON format.</p> <p>Used to update formula calculation data via an HTTP POST command. Payload is in JSON format.</p>
<ul class="simple"> <ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">a1</span></code>-<code class="docutils literal notranslate"><span class="pre">a4</span></code> are the angles/tilt readings (up to 5 are currently supported)</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">a1</span></code>-<code class="docutils literal notranslate"><span class="pre">a10</span></code> are the angles/tilt readings (up to 10 are currently supported)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">g1</span></code>-<code class="docutils literal notranslate"><span class="pre">g4</span></code> are the corresponding gravity reaadings (in SG)</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">g1</span></code>-<code class="docutils literal notranslate"><span class="pre">g10</span></code> are the corresponding gravity reaadings (in SG)</p></li>
</ul> </ul>
<p>Payload should be in standard format used for posting a form. Such as as: <cite>id=value&amp;mdns=value</cite> etc. Key value pairs are shown below.</p> <p>Payload should be in standard format used for posting a form. Such as as: <cite>id=value&amp;mdns=value</cite> etc. Key value pairs are shown below.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">id</span><span class="o">=</span><span class="n">ee1bfc</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">id</span><span class="o">=</span><span class="n">ee1bfc</span>
@ -460,11 +495,21 @@ reading data its sent as boolean (true,false).</p>
<span class="n">a3</span><span class="o">=</span><span class="mi">58</span> <span class="n">a3</span><span class="o">=</span><span class="mi">58</span>
<span class="n">a4</span><span class="o">=</span><span class="mi">0</span> <span class="n">a4</span><span class="o">=</span><span class="mi">0</span>
<span class="n">a5</span><span class="o">=</span><span class="mi">0</span> <span class="n">a5</span><span class="o">=</span><span class="mi">0</span>
<span class="n">a6</span><span class="o">=</span><span class="mi">0</span>
<span class="n">a7</span><span class="o">=</span><span class="mi">0</span>
<span class="n">a8</span><span class="o">=</span><span class="mi">0</span>
<span class="n">a9</span><span class="o">=</span><span class="mi">0</span>
<span class="n">a19</span><span class="o">=</span><span class="mi">0</span>
<span class="n">g1</span><span class="o">=</span><span class="mf">1.000</span> <span class="n">g1</span><span class="o">=</span><span class="mf">1.000</span>
<span class="n">g2</span><span class="o">=</span><span class="mf">1.053</span> <span class="n">g2</span><span class="o">=</span><span class="mf">1.053</span>
<span class="n">g3</span><span class="o">=</span><span class="mf">1.062</span> <span class="n">g3</span><span class="o">=</span><span class="mf">1.062</span>
<span class="n">g4</span><span class="o">=</span><span class="mi">1</span> <span class="n">g4</span><span class="o">=</span><span class="mi">1</span>
<span class="n">g5</span><span class="o">=</span><span class="mi">1</span> <span class="n">g5</span><span class="o">=</span><span class="mi">1</span>
<span class="n">g6</span><span class="o">=</span><span class="mi">1</span>
<span class="n">g7</span><span class="o">=</span><span class="mi">1</span>
<span class="n">g8</span><span class="o">=</span><span class="mi">1</span>
<span class="n">g9</span><span class="o">=</span><span class="mi">1</span>
<span class="n">g10</span><span class="o">=</span><span class="mi">1</span>
</pre></div> </pre></div>
</div> </div>
</div> </div>
@ -507,7 +552,6 @@ present or the API call will fail.</p>
<span class="s2">"http-push-h2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"http-push-h2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"http-push2-h1"</span><span class="p">:</span> <span class="s2">""</span> <span class="s2">"http-push2-h1"</span><span class="p">:</span> <span class="s2">""</span>
<span class="s2">"http-push2-h2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"http-push2-h2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"brewfather-push"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"influxdb2-push"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"influxdb2-push"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"influxdb2-org"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"influxdb2-org"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
<span class="s2">"influxdb2-bucket"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"influxdb2-bucket"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
@ -544,11 +588,21 @@ present or the API call will fail.</p>
<span class="s2">"a3"</span><span class="p">:</span> <span class="mi">58</span><span class="p">,</span> <span class="s2">"a3"</span><span class="p">:</span> <span class="mi">58</span><span class="p">,</span>
<span class="s2">"a4"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"a4"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"a5"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"a5"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"a6"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"a7"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"a8"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"a9"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"a10"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"g1"</span><span class="p">:</span> <span class="mf">1.000</span><span class="p">,</span> <span class="s2">"g1"</span><span class="p">:</span> <span class="mf">1.000</span><span class="p">,</span>
<span class="s2">"g2"</span><span class="p">:</span> <span class="mf">1.053</span><span class="p">,</span> <span class="s2">"g2"</span><span class="p">:</span> <span class="mf">1.053</span><span class="p">,</span>
<span class="s2">"g3"</span><span class="p">:</span> <span class="mf">1.062</span><span class="p">,</span> <span class="s2">"g3"</span><span class="p">:</span> <span class="mf">1.062</span><span class="p">,</span>
<span class="s2">"g4"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"g4"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"g5"</span><span class="p">:</span> <span class="mi">1</span> <span class="s2">"g5"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"g6"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"g7"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"g8"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"g9"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"g10"</span><span class="p">:</span> <span class="mi">1</span>
<span class="p">}</span> <span class="p">}</span>
<span class="n">set_config</span><span class="p">(</span> <span class="n">url</span><span class="p">,</span> <span class="n">json</span> <span class="p">)</span> <span class="n">set_config</span><span class="p">(</span> <span class="n">url</span><span class="p">,</span> <span class="n">json</span> <span class="p">)</span>
</pre></div> </pre></div>
@ -618,6 +672,8 @@ present or the API call will fail.</p>
<li><a class="reference internal" href="#get-api-device">GET: /api/device</a></li> <li><a class="reference internal" href="#get-api-device">GET: /api/device</a></li>
<li><a class="reference internal" href="#get-api-status">GET: /api/status</a></li> <li><a class="reference internal" href="#get-api-status">GET: /api/status</a></li>
<li><a class="reference internal" href="#get-api-config-formula">GET: /api/config/formula</a></li> <li><a class="reference internal" href="#get-api-config-formula">GET: /api/config/formula</a></li>
<li><a class="reference internal" href="#get-api-config-advanced">GET: /api/config/advanced</a></li>
<li><a class="reference internal" href="#post-api-config-advanced">POST: /api/config/advanced</a></li>
<li><a class="reference internal" href="#get-api-clearwifi">GET: /api/clearwifi</a></li> <li><a class="reference internal" href="#get-api-clearwifi">GET: /api/clearwifi</a></li>
<li><a class="reference internal" href="#get-api-factory">GET: /api/factory</a></li> <li><a class="reference internal" href="#get-api-factory">GET: /api/factory</a></li>
<li><a class="reference internal" href="#get-api-test-push">GET: /api/test/push</a></li> <li><a class="reference internal" href="#get-api-test-push">GET: /api/test/push</a></li>

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contributing" href="contributing.html" /><link rel="prev" title="Data Formats" href="data.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contributing" href="contributing.html" /><link rel="prev" title="Data Formats" href="data.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Compiling the software - GravityMon 0.9.0 documentation</title> <title>Compiling the software - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -230,8 +230,9 @@
<ul class="simple"> <ul class="simple">
<li><p>gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.</p></li> <li><p>gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.</p></li>
<li><p>gravity-release; Standard release</p></li> <li><p>gravity-release; Standard release</p></li>
<li><p>gravity-perf; Standard release but contains code for measuring performance</p></li> <li><p>gravity-perf; Standard release but contains code for measuring performance.</p></li>
<li><p>gravity32-perf: Experimental version for ESP32.</p></li> <li><p>gravity32-release: Version for ESP32.</p></li>
<li><p>gravity32-perf: Version for ESP32 but contains code for measuring performance.</p></li>
</ul> </ul>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
@ -286,10 +287,7 @@ So only enable enough debugging to troubleshoot your changes.</p>
<tr class="row-even"><td><p>/src_docs</p></td> <tr class="row-even"><td><p>/src_docs</p></td>
<td><p>Source code for documentation</p></td> <td><p>Source code for documentation</p></td>
</tr> </tr>
<tr class="row-odd"><td><p>/stl</p></td> <tr class="row-odd"><td><p>/test</p></td>
<td><p>3d models</p></td>
</tr>
<tr class="row-even"><td><p>/test</p></td>
<td><p>Test data for developing html files</p></td> <td><p>Test data for developing html files</p></td>
</tr> </tr>
</tbody> </tbody>

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Troubleshooting" href="troubleshooting.html" /><link rel="prev" title="Installation" href="installation.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Troubleshooting" href="troubleshooting.html" /><link rel="prev" title="Installation" href="installation.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Configuration - GravityMon 0.9.0 documentation</title> <title>Configuration - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -300,11 +300,6 @@ need to have 2 different tokens please use the <a class="reference internal" hre
</ul> </ul>
<p>The token is included in the default format for the HTTP GET url but can be used for any of the formats. For HTTP GET use can use this for an authorization token with for instance ubidots or blynk http api.</p> <p>The token is included in the default format for the HTTP GET url but can be used for any of the formats. For HTTP GET use can use this for an authorization token with for instance ubidots or blynk http api.</p>
<ul class="simple"> <ul class="simple">
<li><p><strong>Brewfather URL:</strong></p></li>
</ul>
<p>Endpoint to send data via http to brewfather. Format used <a class="reference internal" href="data.html#data-formats-brewfather"><span class="std std-ref">Brewfather format</span></a></p>
<p>SSL is not supported for this target.</p>
<ul class="simple">
<li><p><strong>HTTP Headers</strong></p></li> <li><p><strong>HTTP Headers</strong></p></li>
</ul> </ul>
<a class="reference internal image-reference" href="_images/config-popup1.png"><img alt="HTTP Headers" src="_images/config-popup1.png" style="width: 300px;"/></a> <a class="reference internal image-reference" href="_images/config-popup1.png"><img alt="HTTP Headers" src="_images/config-popup1.png" style="width: 300px;"/></a>
@ -426,6 +421,51 @@ code the update will be done during startup.</p>
<p>This option gives you the possibility to install an new version of the firmware (or any firmware that uses the standard flash layout).</p> <p>This option gives you the possibility to install an new version of the firmware (or any firmware that uses the standard flash layout).</p>
<a class="reference internal image-reference" href="_images/firmware.png"><img alt="Update firmware" src="_images/firmware.png" style="width: 600px;"/></a> <a class="reference internal image-reference" href="_images/firmware.png"><img alt="Update firmware" src="_images/firmware.png" style="width: 600px;"/></a>
</div> </div>
<div class="section" id="advanded-settings">
<h3>Advanded Settings<a class="headerlink" href="#advanded-settings" title="Permalink to this headline">#</a></h3>
<a class="reference internal image-reference" href="_images/config5.png"><img alt="Advanced Settings" src="_images/config5.png" style="width: 800px;"/></a>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Changeing these parameters with caution. The wrong values might cause the device to become unresponsive.</p>
</div>
<ul class="simple">
<li><p><strong>Gyro reads:</strong></p></li>
</ul>
<p>This defines how many gyro reads will be done before an angle is calculated. More reads will give better accuracy and also allow detection of
movement. Too many reads will take time and affecte batterylife. 50 takes about 800 ms to execute.</p>
<ul class="simple">
<li><p><strong>Gyro moving threashold:</strong></p></li>
</ul>
<p>This is the max amount of deviation allowed for a stable reading.</p>
<ul class="simple">
<li><p><strong>Formula deviation:</strong></p></li>
</ul>
<p>This is the maximum devation on the formlula allowed for it to be accepted. Once the formula has been derived it will be validated against the supplied
data and of the deviation on any point is bigger the formula will be rejected.</p>
<ul class="simple">
<li><p><strong>Ignore angles below water:</strong></p></li>
</ul>
<p>If this option is checked any angles below that of SG 1 will be discarded as invalid and never sent to any server. Default = off.</p>
<ul class="simple">
<li><p><strong>DS18B20 Resolution:</strong></p></li>
</ul>
<p>Define the resolution used on the temp sensor. 9 bits is default and will give an accuracy of 0.5C, 12 bits will give an accuracy of 0.0625C but will also
take longer time to measure..</p>
<ul class="simple">
<li><p><strong>Wifi connect timeout:</strong></p></li>
</ul>
<p>This is the amount of time allowed for a wifi connect.</p>
<ul class="simple">
<li><p><strong>Wifi portal timeout:</strong></p></li>
</ul>
<p>If the wifi portal is triggered (can be triggerd by reset) then this is the amount of time allowed before it exists again.</p>
<ul class="simple">
<li><p><strong>Skip Interval (…):</strong></p></li>
</ul>
<p>These options allow the user to have variable push intervals for the diffrent endpoints. 0 means that every wakeup will send data to that endpoint. If you enter another number then that defines how many sleep cycles will be skipped.</p>
<p>If the sleep interval is 300s and MQTT is set to 0 and HTTP1 is set to 2 then MQTT will be sent every 300s while HTTP1 would be sent 900s. This is great if you want to send data to a local mqtt server often but brewfather will only
accept data every 15 min.</p>
</div>
</div> </div>
</div> </div>
@ -494,6 +534,7 @@ code the update will be done during startup.</p>
<li><a class="reference internal" href="#push-settings-2">Push Settings (2)</a></li> <li><a class="reference internal" href="#push-settings-2">Push Settings (2)</a></li>
<li><a class="reference internal" href="#gravity-settings">Gravity Settings</a></li> <li><a class="reference internal" href="#gravity-settings">Gravity Settings</a></li>
<li><a class="reference internal" href="#hardware-settings">Hardware Settings</a></li> <li><a class="reference internal" href="#hardware-settings">Hardware Settings</a></li>
<li><a class="reference internal" href="#advanded-settings">Advanded Settings</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Hardware" href="hardware.html" /><link rel="prev" title="Compiling the software" href="compiling.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Hardware" href="hardware.html" /><link rel="prev" title="Compiling the software" href="compiling.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Contributing - GravityMon 0.9.0 documentation</title> <title>Contributing - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Compiling the software" href="compiling.html" /><link rel="prev" title="REST API" href="api.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Compiling the software" href="compiling.html" /><link rel="prev" title="REST API" href="api.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Data Formats - GravityMon 0.9.0 documentation</title> <title>Data Formats - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -223,7 +223,7 @@
<span class="w"> </span><span class="nt">"gravity"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.0050</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"gravity"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.0050</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"angle"</span><span class="p">:</span><span class="w"> </span><span class="mf">45.34</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"angle"</span><span class="p">:</span><span class="w"> </span><span class="mf">45.34</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"battery"</span><span class="p">:</span><span class="w"> </span><span class="mf">3.67</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"battery"</span><span class="p">:</span><span class="w"> </span><span class="mf">3.67</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"rssi"</span><span class="p">:</span><span class="w"> </span><span class="mi">-12</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"RSSI"</span><span class="p">:</span><span class="w"> </span><span class="mi">-12</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"corr-gravity"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.0050</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"corr-gravity"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.0050</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"gravity-unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"G"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="nt">"gravity-unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"G"</span><span class="p">,</span><span class="w"></span>
@ -242,7 +242,7 @@
"gravity": ${gravity}, "gravity": ${gravity},
"angle": ${angle}, "angle": ${angle},
"battery": ${battery}, "battery": ${battery},
"rssi": ${rssi}, "RSSI": ${rssi},
"corr-gravity": ${corr-gravity}, "corr-gravity": ${corr-gravity},
"gravity-unit": "${gravity-unit}", "gravity-unit": "${gravity-unit}",
"run-time": ${run-time} "run-time": ${run-time}
@ -250,20 +250,6 @@
</pre></div> </pre></div>
</div> </div>
</div> </div>
<div class="section" id="brewfather-format">
<span id="data-formats-brewfather"></span><h2>Brewfather format<a class="headerlink" href="#brewfather-format" title="Permalink to this headline">#</a></h2>
<p>This is the format for Brewfather. See: <a class="reference external" href="https://docs.brewfather.app/integrations/custom-stream">Brewfather API docs</a></p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="nt">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"gravmon"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"temp"</span><span class="p">:</span><span class="w"> </span><span class="mf">20.5</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"temp_unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"C"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"battery"</span><span class="p">:</span><span class="w"> </span><span class="mf">3.67</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"gravity"</span><span class="p">:</span><span class="w"> </span><span class="mf">1.0050</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nt">"gravity_unit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"G"</span><span class="p">,</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
</div>
<div class="section" id="http-get"> <div class="section" id="http-get">
<span id="data-formats-influxdb2"></span><h2>HTTP Get<a class="headerlink" href="#http-get" title="Permalink to this headline">#</a></h2> <span id="data-formats-influxdb2"></span><h2>HTTP Get<a class="headerlink" href="#http-get" title="Permalink to this headline">#</a></h2>
<p>This is the format added to the URL when using HTTP get</p> <p>This is the format added to the URL when using HTTP get</p>
@ -407,7 +393,6 @@ they can be uploaded manually afterwards.</p>
<ul> <ul>
<li><a class="reference internal" href="#">Data Formats</a><ul> <li><a class="reference internal" href="#">Data Formats</a><ul>
<li><a class="reference internal" href="#http-post-ispindle-format">HTTP Post, iSpindle format</a></li> <li><a class="reference internal" href="#http-post-ispindle-format">HTTP Post, iSpindle format</a></li>
<li><a class="reference internal" href="#brewfather-format">Brewfather format</a></li>
<li><a class="reference internal" href="#http-get">HTTP Get</a></li> <li><a class="reference internal" href="#http-get">HTTP Get</a></li>
<li><a class="reference internal" href="#influx-db-v2">Influx DB v2</a></li> <li><a class="reference internal" href="#influx-db-v2">Influx DB v2</a></li>
<li><a class="reference internal" href="#mqtt">MQTT</a></li> <li><a class="reference internal" href="#mqtt">MQTT</a></li>

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Service Integration" href="services.html" /><link rel="prev" title="Q &amp; A" href="q_and_a.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Service Integration" href="services.html" /><link rel="prev" title="Q &amp; A" href="q_and_a.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Create formula - GravityMon 0.9.0 documentation</title> <title>Create formula - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -206,7 +206,7 @@
<div class="section" id="create-formula"> <div class="section" id="create-formula">
<span id="id1"></span><h1>Create formula<a class="headerlink" href="#create-formula" title="Permalink to this headline">#</a></h1> <span id="id1"></span><h1>Create formula<a class="headerlink" href="#create-formula" title="Permalink to this headline">#</a></h1>
<a class="reference internal image-reference" href="_images/formula1.png"><img alt="Formula data" src="_images/formula1.png" style="width: 800px;"/></a> <a class="reference internal image-reference" href="_images/formula1.png"><img alt="Formula data" src="_images/formula1.png" style="width: 800px;"/></a>
<p>Here you can enter up to 5 values (angles + gravity) that is then used to create the formula. Angles equal to zero will be regarded as empty even if there is a gravity reading.</p> <p>Here you can enter up to 10 values (angles + gravity) that is then used to create the formula. Angles equal to zero will be regarded as empty even if there is a gravity reading.</p>
<a class="reference internal image-reference" href="_images/formula2.png"><img alt="Formula graph" src="_images/formula2.png" style="width: 800px;"/></a> <a class="reference internal image-reference" href="_images/formula2.png"><img alt="Formula graph" src="_images/formula2.png" style="width: 800px;"/></a>
<p>Once the formula is created a graph over the entered values and a simulation of the formula will give you a nice overview on how the formula will work.</p> <p>Once the formula is created a graph over the entered values and a simulation of the formula will give you a nice overview on how the formula will work.</p>
</div> </div>

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Installation" href="installation.html" /><link rel="prev" title="Releases" href="releases.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Installation" href="installation.html" /><link rel="prev" title="Releases" href="releases.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Functionallity - GravityMon 0.9.0 documentation</title> <title>Functionallity - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -226,10 +226,10 @@ in theory you can use them all. However this will consume more battery power so
more efficient to have the endpoints on your local network than on the internet.</p> more efficient to have the endpoints on your local network than on the internet.</p>
<p>Currently the device supports the following endpoints.</p> <p>Currently the device supports the following endpoints.</p>
<ul class="simple"> <ul class="simple">
<li><p>http or https</p></li> <li><p>http (ssl optional)</p></li>
<li><p>influxdb v2</p></li> <li><p>influxdb v2 (ssl optional)</p></li>
<li><p>MQTT (ssl optional)</p></li>
<li><p>Brewfather</p></li> <li><p>Brewfather</p></li>
<li><p>MQTT</p></li>
<li><p>Home Assistant</p></li> <li><p>Home Assistant</p></li>
<li><p>Brew Spy</p></li> <li><p>Brew Spy</p></li>
<li><p>Brewers Friend</p></li> <li><p>Brewers Friend</p></li>
@ -255,9 +255,8 @@ to minimize the needed RAM but the remote service might not support that feature
<li><p><strong>Create gravity formulas on the device</strong></p> <li><p><strong>Create gravity formulas on the device</strong></p>
<p>Another big difference is that this software can create the gravity formula in the device, just enter the <p>Another big difference is that this software can create the gravity formula in the device, just enter the
angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.</p> angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.</p>
<p>Currently the device can handle 5 data points which should be enough to get a accurate formula. At least 3 data points <p>Currently the device can handle 10 data points which should be enough to get a accurate formula. At least 3 data points
is needed to get an accurate formula.</p> is needed to get an accurate formula.</p>
<p>If there is a need for more data points, raise a comment on github.</p>
</li> </li>
<li><p><strong>Customize the data format beeing sent to push targets</strong></p> <li><p><strong>Customize the data format beeing sent to push targets</strong></p>
<p>In order to make it easier to support more targets there is a built in format editor that can be used to <p>In order to make it easier to support more targets there is a built in format editor that can be used to
@ -272,19 +271,21 @@ feature that can correct the gravity as a second step making this independant of
</li> </li>
<li><p><strong>OTA support from webserver</strong></p> <li><p><strong>OTA support from webserver</strong></p>
<p>When starting up in configuration mode the device will check for a software update from a webserver. This is an easily <p>When starting up in configuration mode the device will check for a software update from a webserver. This is an easily
way to keep the software up to date. In the future I might add a hosted endpoint for providing updates.</p> way to keep the software up to date. In the future I might add a hosted endpoint for providing updates. OTA can also be
done over a SSL connection.</p>
</li> </li>
<li><p><strong>DS18B20 temperature adjustments</strong></p> <li><p><strong>DS18B20 temperature adjustments</strong></p>
<p>You can adjust the temperature reading of the temperature sensor. In normal cases this should not be needed since <p>You can adjust the temperature reading of the temperature sensor. In normal cases this should not be needed since
the sensors should be calibrated.</p> the sensors should be calibrated.</p>
</li> </li>
<li><p><strong>Gyro Movement</strong></p> <li><p><strong>Gyro Movement</strong></p>
<p>The software will detect if the gyro is moving and if this is the case it will go back to sleep for 60seconds. <p>The software will detect if the gyro is moving and if this is the case it will go back to sleep for 60 seconds.
This way we should avoid faulty measurements and peaks in the graphs.</p> This way we should avoid faulty measurements and peaks in the graphs.</p>
</li> </li>
<li><p><strong>WIFI connection issues</strong></p> <li><p><strong>WIFI connection issues</strong></p>
<p>The software will not wait indefiently for a wifi connection. If it takes longer than 20 seconds to connect then <p>The software will not wait indefiently for a wifi connection. If it takes longer than 20 seconds to connect then
the device will go into deep sleep for 60 seoncds and then retry later. This to conserve batter as much as possible.</p> the device will try the seconday wifi configuration, and that also failes it will go into deep sleep for 60 seconds and then
retry later. This to conserve batter as much as possible.</p>
</li> </li>
<li><p><strong>Use gyro temperature sensor</strong></p> <li><p><strong>Use gyro temperature sensor</strong></p>
<p>This works fine when the device has time to cool down between measurements and it saves up to 400 ms. <p>This works fine when the device has time to cool down between measurements and it saves up to 400 ms.

View File

@ -4,7 +4,7 @@
<meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/><title>Index - GravityMon 0.9.0 documentation</title> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/><title>Index - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -121,7 +121,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -144,7 +144,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Licence" href="license.html" /><link rel="prev" title="Contributing" href="contributing.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Licence" href="license.html" /><link rel="prev" title="Contributing" href="contributing.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Hardware - GravityMon 0.9.0 documentation</title> <title>Hardware - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -133,7 +133,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button> </button>
</div> </div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc"> <label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div> <div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i> <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label> </label>
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -197,7 +197,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button> </button>
</div> </div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc"> <label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div> <div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i> <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label> </label>
@ -215,6 +215,20 @@ mount it really close to the PCB in order for it to fit in the PET tube/containe
the esp32 does not have. So in order to get a valid voltage (less than 3.2V) on the A0 pin this is needed. Once the modification is done you might the esp32 does not have. So in order to get a valid voltage (less than 3.2V) on the A0 pin this is needed. Once the modification is done you might
need to adjust the voltage factor so the battery reading is correct.</p> need to adjust the voltage factor so the battery reading is correct.</p>
<a class="reference internal image-reference" href="_images/esp32.jpg"><img alt="Mounting esp32" src="_images/esp32.jpg" style="width: 500px;"/></a> <a class="reference internal image-reference" href="_images/esp32.jpg"><img alt="Mounting esp32" src="_images/esp32.jpg" style="width: 500px;"/></a>
<div class="section" id="schema-for-esp8266-build">
<h2>Schema for esp8266 build<a class="headerlink" href="#schema-for-esp8266-build" title="Permalink to this headline">#</a></h2>
<a class="reference internal image-reference" href="_images/schema_esp8266.png"><img alt="Schema esp8266" src="_images/schema_esp8266.png" style="width: 700px;"/></a>
</div>
<div class="section" id="schema-for-esp32-build">
<h2>Schema for esp32 build<a class="headerlink" href="#schema-for-esp32-build" title="Permalink to this headline">#</a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This schema assumes that an ESP32 D1 Mini (pin compatible with ESP8266 D1 Mini is used)
The ESP32 has two rows of pins but only the inner row is used. The main difference is the added resistor R3 so we
get a voltage divider for measuring battery. The ESP8266 has a built in resistor thats not visible on the schema.</p>
</div>
<a class="reference internal image-reference" href="_images/schema_esp32.png"><img alt="Schema esp32" src="_images/schema_esp32.png" style="width: 700px;"/></a>
</div>
</div> </div>
</article> </article>
@ -262,9 +276,29 @@ need to adjust the voltage factor so the battery reading is correct.</p>
</footer> </footer>
</div> </div>
<aside class="toc-drawer no-toc"> <aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
Contents
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Hardware</a><ul>
<li><a class="reference internal" href="#schema-for-esp8266-build">Schema for esp8266 build</a></li>
<li><a class="reference internal" href="#schema-for-esp32-build">Schema for esp32 build</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside> </aside>
</div> </div>

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Getting started" href="intro.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Getting started" href="intro.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>GravityMon 0.9.0 documentation</title> <title>GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="#"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="#"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="#"> <div class="sidebar-sticky"><a class="sidebar-brand" href="#">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -207,8 +207,12 @@
<h1>Welcome to GravityMons documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline">#</a></h1> <h1>Welcome to GravityMons documentation!<a class="headerlink" href="#welcome-to-gravitymon-s-documentation" title="Permalink to this headline">#</a></h1>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
<p>This documentation reflects <strong>v0.9</strong>. Last updated 2022-04-23</p> <p>This documentation reflects <strong>v1.0</strong>. Last updated 2022-05-06</p>
</div> </div>
<ul class="simple">
<li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v0.8index.html">v0.8</a></p></li>
<li><p>Docs for: <a class="reference external" href="https://mp-se.github.io/gravitymon/v0.9/index.html">v0.9</a></p></li>
</ul>
<a class="reference internal image-reference" href="_images/gravitymon.gif"><img alt="User Inteface Walkthrough" src="_images/gravitymon.gif" style="width: 800px;"/></a> <a class="reference internal image-reference" href="_images/gravitymon.gif"><img alt="User Inteface Walkthrough" src="_images/gravitymon.gif" style="width: 800px;"/></a>
<p>GravityMon is used to measure gravity and temperature during fermentation of beer and report the progress. The graph below is <p>GravityMon is used to measure gravity and temperature during fermentation of beer and report the progress. The graph below is
an example on how the fermentation process can be tracked. This is from my last brew that was over on a few days. The graph is rendered using an example on how the fermentation process can be tracked. This is from my last brew that was over on a few days. The graph is rendered using
@ -319,6 +323,9 @@ the following libraries and without these this would have been much more difficu
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a><ul> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-0-0-beta3">v1.0.0-beta3</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-0-0-beta2">v1.0.0-beta2</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-0-0-beta1">v1.0.0-beta1</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-9-0">v0.9.0</a></li> <li class="toctree-l2"><a class="reference internal" href="releases.html#v0-9-0">v0.9.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-8-0">v0.8.0</a></li> <li class="toctree-l2"><a class="reference internal" href="releases.html#v0-8-0">v0.8.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v0-7-1">v0.7.1</a></li> <li class="toctree-l2"><a class="reference internal" href="releases.html#v0-7-1">v0.7.1</a></li>
@ -379,6 +386,8 @@ the following libraries and without these this would have been much more difficu
<li class="toctree-l2"><a class="reference internal" href="api.html#get-api-device">GET: /api/device</a></li> <li class="toctree-l2"><a class="reference internal" href="api.html#get-api-device">GET: /api/device</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#get-api-status">GET: /api/status</a></li> <li class="toctree-l2"><a class="reference internal" href="api.html#get-api-status">GET: /api/status</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#get-api-config-formula">GET: /api/config/formula</a></li> <li class="toctree-l2"><a class="reference internal" href="api.html#get-api-config-formula">GET: /api/config/formula</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#get-api-config-advanced">GET: /api/config/advanced</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#post-api-config-advanced">POST: /api/config/advanced</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#get-api-clearwifi">GET: /api/clearwifi</a></li> <li class="toctree-l2"><a class="reference internal" href="api.html#get-api-clearwifi">GET: /api/clearwifi</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#get-api-factory">GET: /api/factory</a></li> <li class="toctree-l2"><a class="reference internal" href="api.html#get-api-factory">GET: /api/factory</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#get-api-test-push">GET: /api/test/push</a></li> <li class="toctree-l2"><a class="reference internal" href="api.html#get-api-test-push">GET: /api/test/push</a></li>
@ -392,7 +401,6 @@ the following libraries and without these this would have been much more difficu
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</a><ul> <li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</a><ul>
<li class="toctree-l2"><a class="reference internal" href="data.html#http-post-ispindle-format">HTTP Post, iSpindle format</a></li> <li class="toctree-l2"><a class="reference internal" href="data.html#http-post-ispindle-format">HTTP Post, iSpindle format</a></li>
<li class="toctree-l2"><a class="reference internal" href="data.html#brewfather-format">Brewfather format</a></li>
<li class="toctree-l2"><a class="reference internal" href="data.html#http-get">HTTP Get</a></li> <li class="toctree-l2"><a class="reference internal" href="data.html#http-get">HTTP Get</a></li>
<li class="toctree-l2"><a class="reference internal" href="data.html#influx-db-v2">Influx DB v2</a></li> <li class="toctree-l2"><a class="reference internal" href="data.html#influx-db-v2">Influx DB v2</a></li>
<li class="toctree-l2"><a class="reference internal" href="data.html#mqtt">MQTT</a></li> <li class="toctree-l2"><a class="reference internal" href="data.html#mqtt">MQTT</a></li>
@ -408,7 +416,11 @@ the following libraries and without these this would have been much more difficu
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a></li> <li class="toctree-l1"><a class="reference internal" href="hardware.html">Hardware</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hardware.html#schema-for-esp8266-build">Schema for esp8266 build</a></li>
<li class="toctree-l2"><a class="reference internal" href="hardware.html#schema-for-esp32-build">Schema for esp32 build</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li> <li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
</ul> </ul>
</div> </div>

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Configuration" href="configuration.html" /><link rel="prev" title="Functionallity" href="functionallity.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Configuration" href="configuration.html" /><link rel="prev" title="Functionallity" href="functionallity.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Installation - GravityMon 0.9.0 documentation</title> <title>Installation - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -214,7 +214,8 @@
<div class="section" id="brewflasher"> <div class="section" id="brewflasher">
<h2>Brewflasher<a class="headerlink" href="#brewflasher" title="Permalink to this headline">#</a></h2> <h2>Brewflasher<a class="headerlink" href="#brewflasher" title="Permalink to this headline">#</a></h2>
<p>The prefered option for flashing GravityMon is using BrewFlasher, its a tools that support many brewing related firmwares for ESP8266 and ESP32. This works <p>The prefered option for flashing GravityMon is using BrewFlasher, its a tools that support many brewing related firmwares for ESP8266 and ESP32. This works
on both Windows and Mac. You can download the latest version from here: <a class="reference external" href="https://www.brewflasher.com/">Brewflasher</a></p> on both Windows and Mac. You can download the latest version from here: <a class="reference external" href="https://www.brewflasher.com/">Brewflasher</a> there is also a web based version
available here <a class="reference external" href="https://web.brewflasher.com/">Brewflasher WEB</a>.</p>
<a class="reference internal image-reference" href="_images/brewflasher.png"><img alt="Serial output" src="_images/brewflasher.png" style="width: 600px;"/></a> <a class="reference internal image-reference" href="_images/brewflasher.png"><img alt="Serial output" src="_images/brewflasher.png" style="width: 600px;"/></a>
<div class="section" id="binaries"> <div class="section" id="binaries">
<h3>Binaries<a class="headerlink" href="#binaries" title="Permalink to this headline">#</a></h3> <h3>Binaries<a class="headerlink" href="#binaries" title="Permalink to this headline">#</a></h3>
@ -227,7 +228,8 @@ on both Windows and Mac. You can download the latest version from here: <a class
<p>This version also submits performance data to an influx database with detailed execution times.</p> <p>This version also submits performance data to an influx database with detailed execution times.</p>
</li> </li>
<li><p><strong>firmware32.bin</strong></p> <li><p><strong>firmware32.bin</strong></p>
<p>This is the standard release build for an ESP32 variant</p> <p>This is the standard release build for an ESP32 variant. When flashing an ESP32 you also need the <strong>partition32.bin</strong> file that outlines the flash memory structure. Due to
the size of the firmware we are using a custom partition setup.</p>
</li> </li>
</ul> </ul>
<p>In these versions all the html files are embedded in the binaries. The file system is currently only used for storing <p>In these versions all the html files are embedded in the binaries. The file system is currently only used for storing
@ -285,6 +287,8 @@ the device its possible that wifi settings already exist.</p>
in the browser: <strong>http://192.168.4.1</strong></p> in the browser: <strong>http://192.168.4.1</strong></p>
<p>Before pressing save on the network infomration, make a note of the devicename that is shown on the screen, this will be the name that is used <p>Before pressing save on the network infomration, make a note of the devicename that is shown on the screen, this will be the name that is used
in the next step to access the configuration pages. The link would look like this: <strong>http://gravitymon56EA34.local</strong></p> in the next step to access the configuration pages. The link would look like this: <strong>http://gravitymon56EA34.local</strong></p>
<p>Under wifi settings you can define a primary and seconday wifi SSID. The seconday will be used in case the primary fails. If the seconday is
successful then it will be used as primary. <em>The second wifi setting is optional and not needed.</em></p>
<a class="reference internal image-reference" href="_images/wifi.png"><img alt="Wifi page" src="_images/wifi.png" style="width: 200px;"/></a> <a class="reference internal image-reference" href="_images/wifi.png"><img alt="Wifi page" src="_images/wifi.png" style="width: 200px;"/></a>
</div> </div>
<div class="section" id="finding-the-device-adress"> <div class="section" id="finding-the-device-adress">

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Releases" href="releases.html" /><link rel="prev" title="Welcome to GravityMons documentation!" href="index.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Releases" href="releases.html" /><link rel="prev" title="Welcome to GravityMons documentation!" href="index.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Getting started - GravityMon 0.9.0 documentation</title> <title>Getting started - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Hardware" href="hardware.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Hardware" href="hardware.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Licence - GravityMon 0.9.0 documentation</title> <title>Licence - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

Binary file not shown.

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Create formula" href="formula.html" /><link rel="prev" title="Troubleshooting" href="troubleshooting.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Create formula" href="formula.html" /><link rel="prev" title="Troubleshooting" href="troubleshooting.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Q &amp; A - GravityMon 0.9.0 documentation</title> <title>Q &amp; A - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Functionallity" href="functionallity.html" /><link rel="prev" title="Getting started" href="intro.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Functionallity" href="functionallity.html" /><link rel="prev" title="Getting started" href="intro.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Releases - GravityMon 0.9.0 documentation</title> <title>Releases - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -205,9 +205,53 @@
<article role="main"> <article role="main">
<div class="section" id="releases"> <div class="section" id="releases">
<span id="id1"></span><h1>Releases<a class="headerlink" href="#releases" title="Permalink to this headline">#</a></h1> <span id="id1"></span><h1>Releases<a class="headerlink" href="#releases" title="Permalink to this headline">#</a></h1>
<div class="section" id="v1-0-0-beta3">
<h2>v1.0.0-beta3<a class="headerlink" href="#v1-0-0-beta3" title="Permalink to this headline">#</a></h2>
<ul class="simple"> <ul class="simple">
<li><p>Installation instructions updated on how to find the device after wifi has been configured.</p></li> <li><p>Added circuit diagram for esp8266 and esp32</p></li>
<li><p>Update documentation to match new version</p></li>
</ul> </ul>
</div>
<div class="section" id="v1-0-0-beta2">
<h2>v1.0.0-beta2<a class="headerlink" href="#v1-0-0-beta2" title="Permalink to this headline">#</a></h2>
<ul class="simple">
<li><p>Moved applying temp sensor resolution in loop so there is no need to reboot.</p></li>
<li><p>Advanced software settings is only disabled if settings contain default values.</p></li>
<li><p>Added button on indexpage to direct to github issues.</p></li>
<li><p>Added button to extract important information for support requests.</p></li>
<li><p>Updated docs with information from beta1.</p></li>
<li><p>First point in gravity formula is now reserved for water gravity, this to allow detection of angles below water that can be filtered out.</p></li>
<li><p>Added advanced setting to ignore angles that are lower than water. This is disabled by default.</p></li>
<li><p>Added experimental support for MPU6500 (allowing that deviceID), waiting for confirmation on function.</p></li>
<li><p>Changed layout on index page with measured data on top.</p></li>
<li><p>BUG: Fixed error in html page for calibration so that that feature works again (REST API was working)</p></li>
</ul>
</div>
<div class="section" id="v1-0-0-beta1">
<h2>v1.0.0-beta1<a class="headerlink" href="#v1-0-0-beta1" title="Permalink to this headline">#</a></h2>
<ul class="simple">
<li><p>Upgraded to bootstrap v5.1 for web pages.</p></li>
<li><p>Added tooltips to all fields in user interface</p></li>
<li><p>Removed brewfather option (can use standard HTTP options), the old apporach can still be used via changing format template.</p></li>
<li><p>Added 5 more points for formula creation, so a total of 10 angles/gravity values can be stored.</p></li>
<li><p>Added function on format page so that its easy to copy a format template from the docs (simplify service integration).</p></li>
<li><p>Added https support for Influxdb</p></li>
<li><p>Added possibility to have variable push intervals for different endpoints so that different frequency can be used, for example; 5min mqtt, 15min brewfather.</p></li>
<li><p>Added advanced settings: Changes how many times the gyro is read (less reads, quicker but less accurate)</p></li>
<li><p>Added advanced settings: Set amount of gyro movement is allowed for a accurate read.</p></li>
<li><p>Added advanced settings: What deviation is acceptable for creating formula deviation</p></li>
<li><p>Added advanced settings: Various timeouts, wifi connect, wifi portal, http connects.</p></li>
<li><p>Added advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing batterylife</p></li>
<li><p>Added additional http error codes to troubleshooting documentation</p></li>
<li><p>Added possibility to set 2 wifi ssid where the second acts as a fallback in case it fails to connect. If succesful the seconday becomes the new primary.</p></li>
<li><p>SSL connections are skipped on ESP8266 when in config mode since there is a high probability it will crash due to low memory.</p></li>
<li><p>Installation instructions updated on how to find the device after wifi has been configured.</p></li>
<li><p>Documentation on brewfather has been updated to adress SG/Plato conversion</p></li>
<li><p>BUG: Fixed issue in formula calculation in case there were a gap in the data series</p></li>
<li><p>BUG: Field name for wifi strength changed from “rssi” to “RSSI”</p></li>
<li><p>BUG: Fixed issue with probing MFLN on non standard ports</p></li>
</ul>
</div>
<div class="section" id="v0-9-0"> <div class="section" id="v0-9-0">
<h2>v0.9.0<a class="headerlink" href="#v0-9-0" title="Permalink to this headline">#</a></h2> <h2>v0.9.0<a class="headerlink" href="#v0-9-0" title="Permalink to this headline">#</a></h2>
<ul class="simple"> <ul class="simple">
@ -389,6 +433,9 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
<div class="toc-tree"> <div class="toc-tree">
<ul> <ul>
<li><a class="reference internal" href="#">Releases</a><ul> <li><a class="reference internal" href="#">Releases</a><ul>
<li><a class="reference internal" href="#v1-0-0-beta3">v1.0.0-beta3</a></li>
<li><a class="reference internal" href="#v1-0-0-beta2">v1.0.0-beta2</a></li>
<li><a class="reference internal" href="#v1-0-0-beta1">v1.0.0-beta1</a></li>
<li><a class="reference internal" href="#v0-9-0">v0.9.0</a></li> <li><a class="reference internal" href="#v0-9-0">v0.9.0</a></li>
<li><a class="reference internal" href="#v0-8-0">v0.8.0</a></li> <li><a class="reference internal" href="#v0-8-0">v0.8.0</a></li>
<li><a class="reference internal" href="#v0-7-1">v0.7.1</a></li> <li><a class="reference internal" href="#v0-7-1">v0.7.1</a></li>

View File

@ -4,7 +4,7 @@
<meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="#" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="#" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/><title>Search - GravityMon 0.9.0 documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/><title>Search - GravityMon 1.0.0 documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -120,7 +120,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -143,7 +143,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="#" role="search"> </a><form class="sidebar-search-container" method="get" action="#" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

File diff suppressed because one or more lines are too long

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Advanced Configuration" href="advanced.html" /><link rel="prev" title="Create formula" href="formula.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Advanced Configuration" href="advanced.html" /><link rel="prev" title="Create formula" href="formula.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Service Integration - GravityMon 0.9.0 documentation</title> <title>Service Integration - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -209,13 +209,17 @@
<div class="section" id="brewfather"> <div class="section" id="brewfather">
<h2>Brewfather<a class="headerlink" href="#brewfather" title="Permalink to this headline">#</a></h2> <h2>Brewfather<a class="headerlink" href="#brewfather" title="Permalink to this headline">#</a></h2>
<p>Brewfather is an all in one service that allows you to manage you recepies and brews.</p> <p>Brewfather is an all in one service that allows you to manage you recepies and brews.</p>
<div class="admonition tip"> <p><strong>Option 1</strong> - iSpindle Endpoint</p>
<p class="admonition-title">Tip</p> <p>This opion makes use of the standard http (1 or 2) endpoints in the push section. If you are using SG then the device name needs to end with [SG] or brewfather will assume
<p>The integration named Brewfather is uses the custom stream endpoint in brewfather not the standard iSpindle that the data is in plato. You can also modify the format template using the following options:</p>
endpoint. You can use the iSpindle endpoint as well. In that case just use the http-1 or http-2 fields.</p> <p>Update the following part <cite>“gravity”: ${gravity-plato},</cite> or <cite>“name” : “${mdns}[SG]”,`</cite></p>
<p>This makes use of the standard format template, no changes needed.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>http://log.brewfather.net/ispindel?id=&lt;yourid&gt;
</pre></div>
</div> </div>
<p><strong>Option 1</strong> - Custom Stream</p> <p>Documentation on this can be found under <a class="reference external" href="https://docs.brewfather.app/integrations/ispindel">Brewfather iSpindle Endpoint</a></p>
<p>This option makes use of the push endpoint called Brewfather in the UI. Just enter the http stream adress found <p><strong>Option 2</strong> - Custom Stream</p>
<p>This option makes use of the http push endpoint with a custom format template. Just enter the http stream adress found
on brewfather, not other settings are needed. The stream endpoint URL has the following format:</p> on brewfather, not other settings are needed. The stream endpoint URL has the following format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>http://log.brewfather.net/stream?id=&lt;yourid&gt; <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>http://log.brewfather.net/stream?id=&lt;yourid&gt;
</pre></div> </pre></div>
@ -240,13 +244,6 @@ on brewfather, not other settings are needed. The stream endpoint URL has the fo
} }
</pre></div> </pre></div>
</div> </div>
<p><strong>Option 2</strong> - iSpindle Endpoint</p>
<p>This opion makes use of the standard http (1 or 2) endpoints in the push section. If you are using SG then the device name needs to end with [SG] or brewfather will assume
that the data is in plato. The brewfather iSpindle endpoint has the following format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>http://log.brewfather.net/ispindel?id=&lt;yourid&gt;
</pre></div>
</div>
<p>Documentation on this can be found under <a class="reference external" href="https://docs.brewfather.app/integrations/ispindel">Brewfather iSpindle Endpoint</a></p>
</div> </div>
<div class="section" id="fermentrack"> <div class="section" id="fermentrack">
<h2>Fermentrack<a class="headerlink" href="#fermentrack" title="Permalink to this headline">#</a></h2> <h2>Fermentrack<a class="headerlink" href="#fermentrack" title="Permalink to this headline">#</a></h2>
@ -285,7 +282,7 @@ format template that can be used. For information on customizing the format see
"gravity": ${gravity}, "gravity": ${gravity},
"angle": ${angle}, "angle": ${angle},
"battery": ${battery}, "battery": ${battery},
"rssi": ${rssi} "RSSI": ${rssi}
} }
</pre></div> </pre></div>
</div> </div>
@ -306,15 +303,19 @@ device is named <cite>gravmon2</cite></p>
<span class="n">state_topic</span><span class="p">:</span> <span class="s2">"gravmon/gravmon2/battery"</span> <span class="n">state_topic</span><span class="p">:</span> <span class="s2">"gravmon/gravmon2/battery"</span>
<span class="o">-</span> <span class="n">platform</span><span class="p">:</span> <span class="n">mqtt</span> <span class="o">-</span> <span class="n">platform</span><span class="p">:</span> <span class="n">mqtt</span>
<span class="n">name</span><span class="p">:</span> <span class="s2">"gravmon2_rssi"</span> <span class="n">name</span><span class="p">:</span> <span class="s2">"gravmon2_rssi"</span>
<span class="n">state_topic</span><span class="p">:</span> <span class="s2">"gravmon/gravmon2/rssi"</span> <span class="n">state_topic</span><span class="p">:</span> <span class="s2">"gravmon/gravmon2/RSSI"</span>
<span class="o">-</span> <span class="n">platform</span><span class="p">:</span> <span class="n">mqtt</span>
<span class="n">name</span><span class="p">:</span> <span class="s2">"gravmon2_temp"</span>
<span class="n">state_topic</span><span class="p">:</span> <span class="s2">"gravmon/gravmon2/temp"</span>
</pre></div> </pre></div>
</div> </div>
<p>Enter the name of the MQTT server in Home Assistant in the URL. You might need to install that option <p>Enter the name of the MQTT server in Home Assistant in the URL. You might need to install that option
first. This is the format needed to submit the data to the correct topics as needed above. You can add as first. This is the format needed to submit the data to the correct topics as needed above. You can add as
many sensors / topics as you want.</p> many sensors / topics as you want.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>gravmon/${mdns}/tilt:${angle}| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>gravmon/${mdns}/gravity:${gravity}|
gravmon/${mdns}/temperature:${temp}| gravmon/${mdns}/battery:${battery}|
gravmon/${mdns}/temp_units:${temp-unit}| gravmon/${mdns}/RSSI:${rssi}|
gravmon/${mdns}/temp:${temp}|
</pre></div> </pre></div>
</div> </div>
</div> </div>
@ -344,7 +345,7 @@ format for the endpoint. Just add you API key after token.</p>
"gravity": ${gravity}, "gravity": ${gravity},
"angle": ${angle}, "angle": ${angle},
"battery": ${battery}, "battery": ${battery},
"rssi": ${rssi} "RSSI": ${rssi}
} }
</pre></div> </pre></div>
</div> </div>

View File

@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Q &amp; A" href="q_and_a.html" /><link rel="prev" title="Configuration" href="configuration.html" /> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Q &amp; A" href="q_and_a.html" /><link rel="prev" title="Configuration" href="configuration.html" />
<meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/> <meta name="generator" content="sphinx-4.5.0, furo 2022.04.07"/>
<title>Troubleshooting - GravityMon 0.9.0 documentation</title> <title>Troubleshooting - GravityMon 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@ -122,7 +122,7 @@
</label> </label>
</div> </div>
<div class="header-center"> <div class="header-center">
<a href="index.html"><div class="brand">GravityMon 0.9.0 documentation</div></a> <a href="index.html"><div class="brand">GravityMon 1.0.0 documentation</div></a>
</div> </div>
<div class="header-right"> <div class="header-right">
<div class="theme-toggle-container theme-toggle-header"> <div class="theme-toggle-container theme-toggle-header">
@ -145,7 +145,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 0.9.0 documentation</span> <span class="sidebar-brand-text">GravityMon 1.0.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search"> </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -228,7 +228,6 @@ to memory leaks.</p>
<p>Check the format for your custom header. This means it has not a correct format.</p> <p>Check the format for your custom header. This means it has not a correct format.</p>
</li> </li>
<li><p>Influxdb push failed response</p></li> <li><p>Influxdb push failed response</p></li>
<li><p>Brewfather push failed response</p></li>
<li><p>HTTP push failed response</p> <li><p>HTTP push failed response</p>
<p>All these errors are standard http error codes. This are the commone ones;</p> <p>All these errors are standard http error codes. This are the commone ones;</p>
<ul class="simple"> <ul class="simple">
@ -237,11 +236,32 @@ to memory leaks.</p>
<li><p>403 - Forbidden. Could be an issue with token or URL.</p></li> <li><p>403 - Forbidden. Could be an issue with token or URL.</p></li>
<li><p>404 - Not found. Probably a wrong URL.</p></li> <li><p>404 - Not found. Probably a wrong URL.</p></li>
</ul> </ul>
<p>In some cases there can be negative error codes which have the following meaning:</p>
<ul class="simple">
<li><p>-1 - Connection refused</p></li>
<li><p>-2 - Send header failed</p></li>
<li><p>-3 - Send payload failed</p></li>
<li><p>-4 - Not connected</p></li>
<li><p>-5 - Connection lost</p></li>
<li><p>-6 - No stream</p></li>
<li><p>-7 - No HTTP server</p></li>
<li><p>-8 - Too little RAM available</p></li>
<li><p>-9 - Error encoding</p></li>
<li><p>-10 - Error writing to stream</p></li>
<li><p>-11 - Read timeout</p></li>
<li><p>-100 - Endpoint skipped since its SSL and the device is in gravity mode</p></li>
</ul>
</li> </li>
<li><p>MQTT push on &lt;topic&gt; failed error</p> <li><p>MQTT push on &lt;topic&gt; failed error</p>
<ul class="simple"> <ul class="simple">
<li><p>-1 - Buffer to short</p></li>
<li><p>-2 - Overflow</p></li>
<li><p>-3 - Network failed connected</p></li> <li><p>-3 - Network failed connected</p></li>
<li><p>-4 - Network timeout</p></li>
<li><p>-5 - Network read failed</p></li>
<li><p>-6 - Network write failed</p></li>
<li><p>-10 - Connection denied</p></li> <li><p>-10 - Connection denied</p></li>
<li><p>-11 - Failed subscription</p></li>
</ul> </ul>
</li> </li>
</ul> </ul>