Updated docs

src_docs/source/backlog.rst

@@ -15,4 +15,4 @@ Code
 - Support for plato
 - Use pre-commit for validating check-in
 - Show indicated battery life based on interval (check if its feasable)
-- Use brewflasher for flashing
+- Add possibility to add one certificate for proper SSL authentication.

src_docs/source/configuration.rst

@@ -106,13 +106,13 @@ Push Settings
 
 * **HTTP URL 1:**
 
-   Endpoint to send data via http. Format used Format used :ref:`data-formats-ispindle`
+   Endpoint to send data via http. Default format used Format used :ref:`data-formats-ispindle`. You can customize the format using :ref:`format-editor`.
 
    If you add the prefix `https://` then the device will use SSL when sending data.
 
 * **HTTP URL 2:**
 
-   Endpoint to send data via http. Format used :ref:`data-formats-ispindle`
+   Endpoint to send data via http. Default format used :ref:`data-formats-ispindle`. You can customize the format using :ref:`format-editor`.
 
    If you add the prefix `https://` then the device will use SSL when sending data. 
 
@@ -124,7 +124,7 @@ Push Settings
 
 * **Influx DB v2 URL:**
 
-   Endpoint to send data via http to InfluxDB. Format used :ref:`data-formats-influxdb2`
+   Endpoint to send data via http to InfluxDB. Format used :ref:`data-formats-influxdb2`. You can customize the format using :ref:`format-editor`.
 
    SSL is not supported for this target. Raise a issue on github if this is wanted.
 
@@ -142,7 +142,7 @@ Push Settings
 
 * **MQTT server:**
 
-   IP or name of server to send data to. Format used :ref:`data-formats-ispindle`
+   IP or name of server to send data to. Default format used :ref:`data-formats-mqtt`. You can customize the format using :ref:`format-editor`.
 
 * **MQTT Port:**
 
@@ -737,6 +737,9 @@ This is the format template used to create the json above.
 
   measurement,host=${mdns},device=${id},temp-format=${temp-unit},gravity-format=${gravity-unit} gravity=${gravity},corr-gravity=${corr-gravity},angle=${angle},temp=${temp},battery=${battery},rssi=${rssi}
 
+
+.. _data-formats-mqtt:
+
 MQTT
 ====
 
@@ -757,7 +760,7 @@ This is the format template used to create the json above.
 
 .. tip::
 
-   Each line in the format is treated as one topic. The `|` is used as separator between lines and `:` between topic and value. Each line is formatted as `<topic>:<value>`
+   Each line in the format is treated as one topic. The `|` is used as separator between lines and the first `:` is used as separator between topic and value. Each line is formatted as `<topic>:<value>`
 
 .. code-block::
 
@@ -769,6 +772,12 @@ This is the format template used to create the json above.
   ispindel/${mdns}/interval:${sleep-interval}|
   ispindel/${mdns}/RSSI:${rssi}|
 
+This is a format template that is compatible with v0.6.
+
+.. code-block::
+   
+   topic:{"name":"gravmon","ID":"${id}","token":"gravmon","interval": ${sleep-interval},"temperature": ${temp},"temp-units": "${temp-unit}","gravity":${gravity},"angle": ${angle},"battery":${battery},"rssi": ${rssi},"corr-gravity":${corr-gravity},"gravity-unit": "${gravity-unit}","run-time": ${run-time}}|
+
 
 version.json
 ============

src_docs/source/functionallity.rst

@@ -3,8 +3,8 @@
 Functionallity
 ==============
 
-The main differences
+The main features
---------------------
+-----------------
 
 * **Operates in two modes gravity monitoring and configuration mode**
 
@@ -26,10 +26,23 @@ The main differences
 
   If you want additional targets please raise a feature request in the github repo.
 
-* **Build in function to create gravity formulas, so no need for using other tools for this part**
+* **Create gravity formulas on the device**
 
   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. 
 
+.. note::
+
+  This feature needs more testing to be validated.
+
+* **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 customize the data that is to be sent. This way you can easily adapt the software to new targets without coding. If you have 
+  a good template please share it on the girhub repository and I will add it to the documentation for other users to enjoy. See the :ref:`format-editor` for more information.
+
+.. note::
+
+  This feature needs more testing to be validated.
+
 * **Automatic temperature adjustment of gravity reading**
 
   If you want to correct gravity based on beer temperature you can do this in the formula but here is a nice feature that can correct the gravity as a second step making this independant of the formula. 

src_docs/source/index.rst

@@ -7,11 +7,13 @@ Welcome to GravityMon's documentation!
 ######################################
 
 .. note::
-  This documentation reflects **v0.7**. Last updated 2022-01-18
+  This documentation reflects **v0.7**. Last updated 2022-01-23
   
 
 GravityMon is a replacement firmare for the iSpindle firmware, it uses the same hardware configuration so 
-you can easily switch between them. It's used to measure gravity in beer and show the progress of fermentation. 
+you can easily switch between them. 
+
+It's used to measure gravity in beer and show the progress of fermentation. 
 
 For more information on this topic and function please visit `iSpindel Homepage <https://www.ispindel.de>`_ .
 
@@ -44,6 +46,7 @@ The main differences:
 * Using the temperature sensor in gyro instead of DS18B20 (faster)
 * Built in performance measurements (used to optimise code)
 * SSL support in standard HTTP and MQTT connections.
+* Option to customize data posted to endpoints using template from the UI.
 
 For a complete breakdown see the :ref:`functionallity`
 

src_docs/source/releases.rst

@@ -11,20 +11,18 @@ Development version (dev branch)
 * SSL support for HTTP targets (no validation of CA)
 * SSL support for MQTT targets (no validation of CA)
 * SSL support for OTA (no validation of CA)
-* Breaking change: To simplify the internal structure the 
+* **Breaking change**: To simplify the internal structure the 
   temp sensor adjustment is now stored in C. So if you have 
   enabled this function using F you will need to go into 
   the configuration and update the factor again.
+* **Breaking change**: The MQTT push option has been changed to match the iSpindle behaviour. If 
+  the behaviour in v0.6 is wanted this can be done via the format editor.
 * Added error handling for calibration page.
 * Added experimental target ESP32 (using an ESP32 D1 Mini which is pin compatible with ESP8266)
 * Added experimental format editor so users can customize their data format used for pushing data. 
   This will reduce the need for custom push targets. As long as the service is supporting http 
   or https then the data format can be customized.
 
-TODO: 
-Update docs, MQTT ssl is enabled using :8883 at end, http targets enables using prefix https://
-Note! Brewfather don't support SSL.
-
 v0.6.0
 ------