.

param-docs/concat-parameter-pages.py

@@ -32,25 +32,26 @@ if os.path.exists(parameterOverviewFile):
 folders = sorted( filter( os.path.isdir, glob.glob(parameterDocsFolder + '/*') ) )
 
 """
-Create Table of Content
+Create Overview Page (parameters.md)
 """
 toc = ""
 for folder in folders:
     folder = folder.split("/")[-1]
 
-    toc += "\n\n[%s](#%s)\n\n" % (folder, folder.lower())
-
-    files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
-    for file in files:
-        section = folder
-        parameter = file.split("/")[-1].replace(".md", "")
-        parameter = parameter.replace("<", "").replace(">", "")
-        toc += " - [`%s`](#%s-%s)\n" % (parameter, section, parameter)
-
     with open(parameterOverviewTemplateFile, 'r') as overviewFileHandle:
         overviewFileContent = overviewFileHandle.read()
 
-    overviewFileContent = overviewFileContent.replace("$TOC", toc)
+    # # Create TOC
+    # toc += "\n\n[%s](#%s)\n\n" % (folder, folder.lower())
+    #
+    # files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
+    # for file in files:
+    #     section = folder
+    #     parameter = file.split("/")[-1].replace(".md", "")
+    #     parameter = parameter.replace("<", "").replace(">", "")
+    #     toc += " - [`%s`](#%s-%s)\n" % (parameter, section, parameter)
+    #
+    # overviewFileContent = overviewFileContent.replace("$TOC", toc)
 
     with open(parameterOverviewFile, 'w') as overviewFileHandle:
         overviewFileHandle.write(overviewFileContent)

param-docs/parameter-pages/AutoTimer/AutoStart.md

@@ -8,4 +8,5 @@ Automatically start the Flow (Digitization Rounds) immediately after power up.
 
 !!! Note
     Typically this is set to `true`.
-    The only reason to set it to `false` is debugging or if you want to trigger it manually using the [REST API](../REST-API) or [MQTT-API](../MQTT-API).
+    The main reasons to set it to `false` is when you want to trigger it manually using the
+    [REST API](../REST-API) or [MQTT-API](../MQTT-API) or for debugging.

param-docs/parameter-pages/GPIO/LEDColor.md

@@ -1,4 +1,5 @@
 # Parameter `LEDColor`
 Default Value: `150 150 150`
-Color of the attached LEDs to GPIO12 in (R)ed, (G)reen (B)lue from `0` (full off) .. `255` (full on). 
+
+Color of the attached LEDs to GPIO12 in **R**ed, **G**reen **B**lue from `0` (full off) .. `255` (full on) 
 (See `IO12` parameter).

param-docs/parameter-pages/GPIO/LEDNumbers.md

@@ -1,3 +1,4 @@
 # Parameter `LEDNumbers`
 Default Value: `2`
+
 Number of LEDs on the external LED-stripe attached to GPIO12 (See `IO12` parameter).

param-docs/parameter-pages/InfluxDB/Database.md

@@ -1,3 +1,7 @@
 # Parameter `Database`
 Default Value: `''`
-Name of the Database into which to publish the values.
+
+Name of the InfluxDB v1 Database into which to publish the values.
+
+!!! Note
+    See section `InfluxDBv2` for InfluxDB v2 support! 

param-docs/parameter-pages/InfluxDB/Measurement.md

@@ -1,3 +1,7 @@
 # Parameter `Measurement`
 Default Value: `undefined`
-Name of the Measurement to use to publish the value.
+
+Name of the InfluxDB v1 Measurement to use to publish the value.
+
+!!! Note
+    See section `InfluxDBv2` for InfluxDB v2 support! 

param-docs/parameter-pages/InfluxDB/Uri.md

@@ -1,6 +1,7 @@
 # Parameter `Uri`
 Default Value: `undefined`
+
 URI of the HTTP interface to InfluxDB v1, without trailing slash, e.g. `http://192.168.1.1:8086`.
 
 !!! Note
-    Currently only InfluxDB v1 is supported!
+    See section `InfluxDBv2` for InfluxDB v2 support! 

param-docs/parameter-pages/InfluxDB/password.md

@@ -1,5 +1,7 @@
 # Parameter `password`
 Default Value: `undefined`
+
 Password for the InfluxDB v1 authentication.
+
 !!! Note
-    Currently only InfluxDB v1 is supported!
+    See section `InfluxDBv2` for InfluxDB v2 support! 

param-docs/parameter-pages/InfluxDB/user.md

@@ -1,6 +1,7 @@
 # Parameter `user`
 Default Value: `undefined`
+
 Username for the InfluxDB v1 authentication.
 
 !!! Note
-    Currently only InfluxDB v1 is supported!
+    See section `InfluxDBv2` for InfluxDB v2 support! 

param-docs/parameter-pages/InfluxDBv2/Database.md

@@ -0,0 +1,4 @@
+# Parameter `Database`
+Default Value: `''`
+
+Name of the InfluxDB v2 Database into which to publish the values.

param-docs/parameter-pages/InfluxDBv2/Measurement.md

@@ -0,0 +1,4 @@
+# Parameter `Measurement`
+Default Value: `undefined`
+
+Name of the InfluxDB v2 Measurement to use to publish the value.

param-docs/parameter-pages/InfluxDBv2/NUMBER.fieldname.md

@@ -0,0 +1,4 @@
+# Parameter `<NUMBER>.fieldname`
+Default Value: `undefined`
+
+Fieldname for InfluxDB v2 to use for saving.

param-docs/parameter-pages/InfluxDBv2/Org.md

@@ -0,0 +1,4 @@
+# Parameter `Org`
+Default Value: `undefined`
+
+Organisation (Org) for InfluxDB v2 authentication

param-docs/parameter-pages/InfluxDBv2/Uri.md

@@ -0,0 +1,4 @@
+# Parameter `Uri`
+Default Value: `undefined`
+
+URI of the HTTP interface to InfluxDB v2, without trailing slash, e.g. `http://192.168.1.1:8086`.

param-docs/parameter-pages/InfluxDBv2/token.md

@@ -0,0 +1,4 @@
+# Parameter `token`
+Default Value: `undefined`
+
+Token for InfluxDB v2 authentication

param-docs/parameter-pages/MQTT/ClientID.md

@@ -1,4 +1,5 @@
 # Parameter `ClientID`
 Default Value: `watermeter`
-ClientID to connect to the MQTT broker.
+
+Client ID used to connect to the MQTT broker.
 If disabled, the `hostname` will be used.

param-docs/parameter-pages/MQTT/HomeassistantDiscovery.md

@@ -1,4 +1,5 @@
 # Parameter `HomeassistantDiscovery`
 Default Value: `true`
+
 Enable or disable the Homeassistant Discovery.
 See [here](../Integration-Home-Assistant) for details about the discovery.

param-docs/parameter-pages/MQTT/MainTopic.md

@@ -1,12 +1,15 @@
 # Parameter `MainTopic`
 Default Value: `watermeter`
+
 MQTT main topic, under which the counters are published.
 
-The single value will be published with the following key: `MAINTOPIC/NUMBER/RESULT_TOPIC` where:
+The single value will be published with the following key: `MAINTOPIC/NUMBER/RESULT_TOPIC`
 
-- `NUMBER` is the name of the value (a meter might have more than one value). 
+With:
+
+- `NUMBER`: The name of the value (a meter might have more than one value). 
   The names get defined in the analog and digital ROI configuration (defaults to `main`).
-- `RESULT_TOPIC` can be one of `value`, `rate`, `timestamp`, `error`, ....
+- `RESULT_TOPIC`: Automatically filled with the right name, eg. `value`, `rate`, `timestamp`, `error`, ....
 
 The general connection status can be found in `MAINTOPIC/CONNECTION`. 
 See [MQTT Result Topics](../MQTT-API#result) for a full list of topics.

param-docs/parameter-pages/MQTT/MeterType.md

@@ -1,5 +1,6 @@
 # Parameter `MeterType`
 Default Value: `other`
+
 Select the Meter Type so the sensors have the right units in Homeassistant.
 
 !!! Note

param-docs/parameter-pages/MQTT/RetainMessages.md

@@ -1,3 +1,4 @@
 # Parameter `RetainMessages`
 Default Value: `true`
+
 Enable or disable the [Retain Flag](https://www.hivemq.com/blog/mqtt-essentials-part-8-retained-messages/) for all MQTT entries.

param-docs/parameter-pages/MQTT/Uri.md

@@ -1,3 +1,4 @@
 # Parameter `Uri`
 Default Value: `mqtt://IP-ADRESS:1883`
+
 URI to the MQTT broker including the port. E.g. `mqtt://192.168.1.1:1883`.

param-docs/parameter-pages/MQTT/password.md

@@ -1,3 +1,4 @@
 # Parameter `password`
 Default Value: `PASSWORD`
+
 Password for MQTT authentication.

param-docs/parameter-pages/MQTT/user.md

@@ -1,3 +1,4 @@
 # Parameter `user`
 Default Value: `USERNAME`
+
 Username for MQTT authentication.

param-docs/parameter-pages/PostProcessing/NUMBER.AllowNegativeRates.md

@@ -1,5 +1,6 @@
 # Parameter `<NUMBERS>.AllowNegativeRates`
 Default Value: `false`
+
 Allow a meter to count backwards (decreasing values).
 
 !!! Note

param-docs/parameter-pages/PostProcessing/NUMBER.AnalogDigitalTransitionStart.md

@@ -1,5 +1,6 @@
 # Parameter `<NUMBER>.AnalogDigitalTransitionStart`
 Default Value: `9.2`
+
 This can be used if you have wrong values, but the recognition of the individual ROIs are correct.
 Look for the start of changing of the first digit and note the analog pointer value behind.
 Set it here. Only used on combination of digits and analog pointers.

param-docs/parameter-pages/PostProcessing/NUMBER.DecimalShift.md

@@ -1,4 +1,5 @@
 # Parameter `<NUMBER>.DecimalShift`
 Default Value: `0`
+
 Shift the decimal separator (positiv or negativ).
-Eg. to move from 'm³' to 'liter' (1 m³ equals 1000 liters), you need to set it to +3.
+Eg. to move from `m³` to `liter` (`1 m³` equals `1000 liters`), you need to set it to `+3`.

param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md

@@ -1,5 +1,6 @@
 # Parameter `<NUMBER>.ExtendedResolution`
 Default Value: `false`
+
 Use the decimal place of the last analog counter for increased accuracy.
 
 !!! Note

param-docs/parameter-pages/PostProcessing/NUMBER.IgnoreLeadingNaN.md

@@ -1,5 +1,6 @@
 # Parameter `<NUMBER>.IgnoreLeadingNaN`
 Default Value: `true`
+
 Leading `N`'s will be deleted before further processing.
 This is only relevant for models which use `N`!
 See [here](../Choosing-the-Model) for details.

param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateType.md

@@ -1,4 +1,5 @@
 # Parameter `<NUMBER>.MaxRateType`
 Default Value: `AbsoluteChange`
+
 Defines if the **Change Rate** compared to the previous value is calculated as absolute change (`AbsoluteChange`) or
 as rate normalized to the interval (`RateChange` = change/minute).

param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateValue.md

@@ -1,4 +1,5 @@
 # Parameter `<NUMBER>.MaxRateValue`
 Default Value: `0.05`
+
 Maximum change of a reading.
 Depending on the settings of `<NUMBER>.MaxRateType` it is either treated  as `absolute` or `relative`!

param-docs/parameter-pages/PostProcessing/PreValueUse.md

@@ -1,4 +1,5 @@
 # Parameter `PreValueUse`
 Default Value: `true`
+
 Use the previous value (value from previous round) for consistency checks.
 This also works through a reboot of the device!

param-docs/parameter-pages/System/RSSIThreshold.md

@@ -1,5 +1,8 @@
 # Parameter `RSSIThreshold`
 Default Value: `''`
+
 WLAN Mesh Parameter: Threshold for the RSSI value to check for start switching access point in a mesh system.
-Possible values: `-100` .. `0`, `0` = disabled.
+
+Possible values: `-100` .. `0` (`0` = disabled).
+
 It gets automatically transferred to `/wlan.ini` on the SD-Card at next startup.

param-docs/parameter-pages/System/TimeZone.md

@@ -1,4 +1,5 @@
 # Parameter `TimeZone`
 Default Value: `CET-1CEST,M3.5.0,M10.5.0/3`
+
 Time zone in POSIX syntax (Europe/Berlin = `CET-1CEST,M3.5.0,M10.5.0/3` - incl. daylight saving)
 Check the table on `http://<DEVICE IP>/timezones.html` to find the settings for your region.

param-docs/templates/overview-old.md

@@ -0,0 +1,13 @@
+# Parameters
+This page lists all available [Configuration](../Configuration) Parameters.
+If a parameter or section has a tick box on its left side, you can disable it.
+In such case the functionality gets disabled respectively the default values will be used.
+
+!!! Note
+    This is an auto-generated page! See the [README](https://github.com/jomjol/AI-on-the-edge-device-docs/blob/main/README.md) for details!
+
+## List of all Parameters
+
+$TOC
+
+<hr style="border:2px solid">

param-docs/templates/overview.md

@@ -1,13 +1,9 @@
 # Parameters
 This page lists all available [Configuration](../Configuration) Parameters.
-If a parameter or section has a tick box on its left side, you can disable it.
+If a **parameter** or **section** has a tick box on its left side, you can disable it.
 In such case the functionality gets disabled respectively the default values will be used.
 
 !!! Note
     This is an auto-generated page! See the [README](https://github.com/jomjol/AI-on-the-edge-device-docs/blob/main/README.md) for details!
 
-## List of all Parameters
-
-$TOC
-
 <hr style="border:2px solid">