diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index a909290..dc5b8dd 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -7,7 +7,7 @@ Welcome to GravityMon's documentation! ###################################### .. note:: - This documentation reflects **v1.0**. Last updated 2022-07-01 + This documentation reflects **v1.0**. Last updated 2022-07-02 * Docs for: `v0.8 `_ * Docs for: `v0.9 `_ diff --git a/src_docs/source/services.rst b/src_docs/source/services.rst index b0595d9..0208104 100644 --- a/src_docs/source/services.rst +++ b/src_docs/source/services.rst @@ -280,11 +280,13 @@ BrewBlox To send iSpindel data to brewblox over mqtt you need to modify the format template to match the expected format. Once you have configured the mqtt information you also need to update the format template for this target. -This format template will post the expected json document on the topic, dont forget the `|` character at the end of the line which is needed to parse the payload. The first to words are the topic name and after the first `:` this is the json playload. +This format template will post the expected json document on the topic, dont forget the `|` character at the end of the line which is needed to parse the payload. The first to words are the topic +name and after the first `:` this is the json playload. Text within the brackets will be used as the unit for the value and degC is displayed as °C. You can add other parameters under the data section +in the json document if you need other values as well. .. code-block:: - brewcast/history:{"key":"${mdns}","data":{"Temperature": ${temp-c},"Battery":${battery},"Tilt":${angle},"Rssi":${rssi},"Gravity":${gravity-sg}}}| + brewcast/history:{"key":"${mdns}","data":{"Temperature[degC]": ${temp-c},"Temperature[degF]": ${temp-f},"Battery[V]":${battery},"Tilt[deg]":${angle},"Rssi[dBm]":${rssi},"SG":${gravity-sg},"Plato":${gravity-plato}}}| The json message on the mqtt topic would look like this: @@ -292,12 +294,14 @@ The json message on the mqtt topic would look like this: .. code-block:: json { - "key": "gravitymon", - "data": { - "Temperature": 27, - "Battery": 4.99, - "Tilt": 88.86, - "Rssi": -51, - "Gravity": 1.1173 + "key": "gravitymon", + "data": { + "Temperature[degC]": 27, + "Temperature[degF]": 80, + "Battery[V]": 4.1, + "Tilt[deg]": 25, + "Rssi[dBm]": -78, + "SG": 1, + "Plato": 0 } }