mark expert parameters and non-ui-parameters

param-docs/expert-params.txt

@@ -0,0 +1,26 @@
+demo
+WaitBeforeTakingPicture
+ImageQuality
+ImageSize
+LEDIntensity
+Brightness
+Contrast
+Saturation
+FixedExposure
+SearchFieldX
+SearchFieldY
+AlignmentAlgo
+CNNGoodThreshold
+PreValueAgeStartup
+ErrorMessage
+CheckDigitIncreaseConsistency
+IO0
+IO1
+IO3
+IO4
+IO12
+IO13
+AutoStart
+AutoStart
+Hostname
+RSSIThreashold

param-docs/generate-param-doc-pages.py

@@ -13,6 +13,9 @@ configFileUrl = "https://raw.githubusercontent.com/jomjol/AI-on-the-edge-device/
 
 parameterDocsFolder = "parameter-pages"
 parameterTemplateFile = "./templates/parameter.md"
+expertParameterListFile = "./expert-params.txt"
+hiddenInUiParameterListFile = "./hidden-in-ui.txt"
+
 
 # Fetch default config file from URL
 print("Fetching %r..." % configFileUrl)
@@ -28,6 +31,14 @@ for l in range(len(lines)):
 
 content = "".join(lines)
 
+# Fetch list of expert parameters
+with open(expertParameterListFile) as f:
+    expertParameters = f.read().splitlines()
+
+# Fetch list of parameters not available through the UI
+with open(hiddenInUiParameterListFile) as f:
+    hiddenInUiParameters = f.read().splitlines()
+
 
 config = configparser.ConfigParser(allow_no_value=True)
 config.optionxform = str # Make it case-insensitive
@@ -56,6 +67,9 @@ for section in config:
                 value = config[section][parameter]
                 #print("  %s = %s" % (parameter, value))
 
+                if "main." in parameter:
+                    parameter = parameter.replace("main.", "<NUMBER>.")
+
                 """
                 For each config line, create a markdown file
                 """
@@ -68,4 +82,14 @@ for section in config:
                         content = content.replace("$NAME", parameter)
                         content = content.replace("$DEFAULT", value)
 
+                        if parameter in expertParameters:
+                            content = content.replace("$EXPERT_PARAMETER", "!!! Warning\n    This is an expert parameter!") # Note: Needs a 4 whitespace Intent!
+                        else:
+                            content = content.replace("$EXPERT_PARAMETER", "")
+
+                        if parameter in hiddenInUiParameters:
+                            content = content.replace("$HIDDEN_IN_UI", "!!! Note\n    This parameter is not accessible through the Web Interface Configuration Page!") # Note: Needs a 4 whitespace Intent!
+                        else:
+                            content = content.replace("$HIDDEN_IN_UI", "")
+
                         paramFileHandle.write(content)

param-docs/hidden-in-ui.txt

@@ -0,0 +1,6 @@
+InitialRotate
+InitialMirror
+FlipImageSize
+MainTopicMQTT
+AutoAdjustSummertime
+SetupMode

param-docs/parameter-pages/Alignment/AlignmentAlgo.md

@@ -1,6 +1,11 @@
 # Parameter `AlignmentAlgo`
 Default Value: `Default`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Alignment/FlipImageSize.md

@@ -1,6 +1,11 @@
 # Parameter `FlipImageSize`
 Default Value: `false`
 
+
+
+!!! Note
+    This parameter is not accessible through the Web Interface Configuration Page!
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Alignment/InitialMirror.md

@@ -1,6 +1,11 @@
 # Parameter `InitialMirror`
 Default Value: `false`
 
+
+
+!!! Note
+    This parameter is not accessible through the Web Interface Configuration Page!
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Alignment/InitialRotate.md

@@ -1,6 +1,11 @@
 # Parameter `InitialRotate`
 Default Value: `179`
 
+
+
+!!! Note
+    This parameter is not accessible through the Web Interface Configuration Page!
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Alignment/SearchFieldX.md

@@ -1,6 +1,11 @@
 # Parameter `SearchFieldX`
 Default Value: `20`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Alignment/SearchFieldY.md

@@ -1,6 +1,11 @@
 # Parameter `SearchFieldY`
 Default Value: `20`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Analog/CNNGoodThreshold.md

@@ -1,6 +1,11 @@
 # Parameter `CNNGoodThreshold`
 Default Value: `0.5`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Analog/ExtendedResolution.md

@@ -1,6 +1,10 @@
 # Parameter `ExtendedResolution`
 Default Value: `true`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Analog/LogImageLocation.md

@@ -1,6 +1,10 @@
 # Parameter `LogImageLocation`
 Default Value: `/log/analog`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Analog/LogfileRetentionInDays.md

@@ -1,6 +1,10 @@
 # Parameter `LogfileRetentionInDays`
 Default Value: `3`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Analog/Model.md

@@ -1,6 +1,10 @@
 # Parameter `Model`
 Default Value: `/config/ana-cont_11.3.1_s2.tflite`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `AutoStart`
 Default Value: `true`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `Intervall`
 Default Value: `5`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/DataLogging/DataLogActive.md

@@ -1,6 +1,10 @@
 # Parameter `DataLogActive`
 Default Value: `true`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/DataLogging/DataLogRetentionInDays.md

@@ -1,6 +1,10 @@
 # Parameter `DataLogRetentionInDays`
 Default Value: `3`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Debug/Logfile.md

@@ -1,6 +1,10 @@
 # Parameter `Logfile`
 Default Value: `1`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Debug/LogfileRetentionInDays.md

@@ -1,6 +1,10 @@
 # Parameter `LogfileRetentionInDays`
 Default Value: `3`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Digits/CNNGoodThreshold.md

@@ -1,6 +1,11 @@
 # Parameter `CNNGoodThreshold`
 Default Value: `0.5`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Digits/LogImageLocation.md

@@ -1,6 +1,10 @@
 # Parameter `LogImageLocation`
 Default Value: `/log/digit`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Digits/LogfileRetentionInDays.md

@@ -1,6 +1,10 @@
 # Parameter `LogfileRetentionInDays`
 Default Value: `3`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/Digits/Model.md

@@ -1,6 +1,10 @@
 # Parameter `Model`
 Default Value: `/config/dig-cont_0600_s3.tflite`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `IO0`
 Default Value: `input disabled 10 false false`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `IO1`
 Default Value: `input disabled 10 false false`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `IO12`
 Default Value: `input-pullup disabled 10 false false`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `IO13`
 Default Value: `input-pullup disabled 10 false false`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `IO3`
 Default Value: `input disabled 10 false false`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `IO4`
 Default Value: `built-in-led disabled 10 false false`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `LEDColor`
 Default Value: `150 150 150`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `LEDNumbers`
 Default Value: `2`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `LEDType`
 Default Value: `WS2812`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `MainTopicMQTT`
 Default Value: `wasserzaehler/GPIO`
 
+
+
+!!! Note
+    This parameter is not accessible through the Web Interface Configuration Page!
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `Database`
 Default Value: ``
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `Measurement`
 Default Value: `undefined`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `Uri`
 Default Value: `undefined`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `password`
 Default Value: `undefined`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `user`
 Default Value: `undefined`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `ClientID`
 Default Value: `watermeter`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `HomeassistantDiscovery`
 Default Value: `true`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `MainTopic`
 Default Value: `watermeter`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `MeterType`
 Default Value: `other`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `SetRetainFlag`
 Default Value: `true`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `Uri`
 Default Value: `mqtt://IP-ADRESS:1883`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `password`
 Default Value: `PASSWORD`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `user`
 Default Value: `USERNAME`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/Brightness.md

@@ -1,6 +1,11 @@
 # Parameter `Brightness`
 Default Value: `0`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/Contrast.md

@@ -1,6 +1,11 @@
 # Parameter `Contrast`
 Default Value: `0`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/Demo.md

@@ -1,6 +1,10 @@
 # Parameter `Demo`
 Default Value: `true`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/FixedExposure.md

@@ -1,6 +1,11 @@
 # Parameter `FixedExposure`
 Default Value: `false`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/ImageQuality.md

@@ -1,6 +1,11 @@
 # Parameter `ImageQuality`
 Default Value: `12`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/ImageSize.md

@@ -1,6 +1,11 @@
 # Parameter `ImageSize`
 Default Value: `VGA`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/LEDIntensity.md

@@ -1,6 +1,11 @@
 # Parameter `LEDIntensity`
 Default Value: `50`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/LogImageLocation.md

@@ -1,6 +1,10 @@
 # Parameter `LogImageLocation`
 Default Value: `/log/source`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md

@@ -1,6 +1,10 @@
 # Parameter `LogfileRetentionInDays`
 Default Value: `15`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/Saturation.md

@@ -1,6 +1,11 @@
 # Parameter `Saturation`
 Default Value: `0`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/parameter-pages/MakeImage/WaitBeforeTakingPicture.md

@@ -1,6 +1,11 @@
 # Parameter `WaitBeforeTakingPicture`
 Default Value: `5`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
-# Parameter `main.AnalogDigitalTransitionStart`
+# Parameter `<NUMBER>.AnalogDigitalTransitionStart`
 Default Value: `9.2`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
-# Parameter `main.DecimalShift`
+# Parameter `<NUMBER>.DecimalShift`
 Default Value: `0`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
-# Parameter `main.ExtendedResolution`
+# Parameter `<NUMBER>.ExtendedResolution`
 Default Value: `false`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
-# Parameter `main.IgnoreLeadingNaN`
+# Parameter `<NUMBER>.IgnoreLeadingNaN`
 Default Value: `true`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
-# Parameter `main.MaxRateType`
+# Parameter `<NUMBER>.MaxRateType`
 Default Value: `AbsoluteChange`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
-# Parameter `main.MaxRateValue`
+# Parameter `<NUMBER>.MaxRateValue`
 Default Value: `0.05`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `AllowNegativeRates`
 Default Value: `false`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `CheckDigitIncreaseConsistency`
 Default Value: `false`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `ErrorMessage`
 Default Value: `true`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `PreValueAgeStartup`
 Default Value: `720`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `PreValueUse`
 Default Value: `true`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `AutoAdjustSummertime`
 Default Value: `false`
 
+
+
+!!! Note
+    This parameter is not accessible through the Web Interface Configuration Page!
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `Hostname`
 Default Value: `undefined`
 
+!!! Warning
+    This is an expert parameter!
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,11 @@
 # Parameter `SetupMode`
 Default Value: `true`
 
+
+
+!!! Note
+    This parameter is not accessible through the Web Interface Configuration Page!
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `TimeServer`
 Default Value: `pool.ntp.org`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

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

@@ -1,6 +1,10 @@
 # Parameter `TimeZone`
 Default Value: `CET-1CEST,M3.5.0,M10.5.0/3`
 
+
+
+
+
 ## Description
 Please fill me with an explanation and useful links
 

param-docs/templates/parameter.md

@@ -1,6 +1,10 @@
 # Parameter `$NAME`
 Default Value: `$DEFAULT`
 
+$EXPERT_PARAMETER
+
+$HIDDEN_IN_UI
+
 ## Description
 Please fill me with an explanation and useful links