diff --git a/param-docs/expert-params.txt b/param-docs/expert-params.txt new file mode 100644 index 0000000..974b940 --- /dev/null +++ b/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 diff --git a/param-docs/generate-param-doc-pages.py b/param-docs/generate-param-doc-pages.py index 3fc44aa..b936912 100644 --- a/param-docs/generate-param-doc-pages.py +++ b/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.", ".") + """ 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) diff --git a/param-docs/hidden-in-ui.txt b/param-docs/hidden-in-ui.txt new file mode 100644 index 0000000..8abef61 --- /dev/null +++ b/param-docs/hidden-in-ui.txt @@ -0,0 +1,6 @@ +InitialRotate +InitialMirror +FlipImageSize +MainTopicMQTT +AutoAdjustSummertime +SetupMode diff --git a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md b/param-docs/parameter-pages/Alignment/AlignmentAlgo.md index 910a6c0..c66e035 100644 --- a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md +++ b/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 diff --git a/param-docs/parameter-pages/Alignment/FlipImageSize.md b/param-docs/parameter-pages/Alignment/FlipImageSize.md index 60cfee1..53afd93 100644 --- a/param-docs/parameter-pages/Alignment/FlipImageSize.md +++ b/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 diff --git a/param-docs/parameter-pages/Alignment/InitialMirror.md b/param-docs/parameter-pages/Alignment/InitialMirror.md index af6211a..ac0ab09 100644 --- a/param-docs/parameter-pages/Alignment/InitialMirror.md +++ b/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 diff --git a/param-docs/parameter-pages/Alignment/InitialRotate.md b/param-docs/parameter-pages/Alignment/InitialRotate.md index 7185c02..a99b3ea 100644 --- a/param-docs/parameter-pages/Alignment/InitialRotate.md +++ b/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 diff --git a/param-docs/parameter-pages/Alignment/SearchFieldX.md b/param-docs/parameter-pages/Alignment/SearchFieldX.md index ff6714d..6ffc029 100644 --- a/param-docs/parameter-pages/Alignment/SearchFieldX.md +++ b/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 diff --git a/param-docs/parameter-pages/Alignment/SearchFieldY.md b/param-docs/parameter-pages/Alignment/SearchFieldY.md index b0089fb..0301ae3 100644 --- a/param-docs/parameter-pages/Alignment/SearchFieldY.md +++ b/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 diff --git a/param-docs/parameter-pages/Analog/CNNGoodThreshold.md b/param-docs/parameter-pages/Analog/CNNGoodThreshold.md index 2293653..aa41390 100644 --- a/param-docs/parameter-pages/Analog/CNNGoodThreshold.md +++ b/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 diff --git a/param-docs/parameter-pages/Analog/ExtendedResolution.md b/param-docs/parameter-pages/Analog/ExtendedResolution.md index d56fdaa..332fe07 100644 --- a/param-docs/parameter-pages/Analog/ExtendedResolution.md +++ b/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 diff --git a/param-docs/parameter-pages/Analog/LogImageLocation.md b/param-docs/parameter-pages/Analog/LogImageLocation.md index d452034..48039d0 100644 --- a/param-docs/parameter-pages/Analog/LogImageLocation.md +++ b/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 diff --git a/param-docs/parameter-pages/Analog/LogfileRetentionInDays.md b/param-docs/parameter-pages/Analog/LogfileRetentionInDays.md index 84de177..e1a3ba5 100644 --- a/param-docs/parameter-pages/Analog/LogfileRetentionInDays.md +++ b/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 diff --git a/param-docs/parameter-pages/Analog/Model.md b/param-docs/parameter-pages/Analog/Model.md index 861db58..98ee24d 100644 --- a/param-docs/parameter-pages/Analog/Model.md +++ b/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 diff --git a/param-docs/parameter-pages/AutoTimer/AutoStart.md b/param-docs/parameter-pages/AutoTimer/AutoStart.md index 40e662c..c1bfec1 100644 --- a/param-docs/parameter-pages/AutoTimer/AutoStart.md +++ b/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 diff --git a/param-docs/parameter-pages/AutoTimer/Intervall.md b/param-docs/parameter-pages/AutoTimer/Intervall.md index 9a5afb8..20eaf30 100644 --- a/param-docs/parameter-pages/AutoTimer/Intervall.md +++ b/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 diff --git a/param-docs/parameter-pages/DataLogging/DataLogActive.md b/param-docs/parameter-pages/DataLogging/DataLogActive.md index 2508627..5872459 100644 --- a/param-docs/parameter-pages/DataLogging/DataLogActive.md +++ b/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 diff --git a/param-docs/parameter-pages/DataLogging/DataLogRetentionInDays.md b/param-docs/parameter-pages/DataLogging/DataLogRetentionInDays.md index c862e94..19c3ca8 100644 --- a/param-docs/parameter-pages/DataLogging/DataLogRetentionInDays.md +++ b/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 diff --git a/param-docs/parameter-pages/Debug/Logfile.md b/param-docs/parameter-pages/Debug/Logfile.md index 74e928f..28e2b33 100644 --- a/param-docs/parameter-pages/Debug/Logfile.md +++ b/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 diff --git a/param-docs/parameter-pages/Debug/LogfileRetentionInDays.md b/param-docs/parameter-pages/Debug/LogfileRetentionInDays.md index 84de177..e1a3ba5 100644 --- a/param-docs/parameter-pages/Debug/LogfileRetentionInDays.md +++ b/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 diff --git a/param-docs/parameter-pages/Digits/CNNGoodThreshold.md b/param-docs/parameter-pages/Digits/CNNGoodThreshold.md index 2293653..aa41390 100644 --- a/param-docs/parameter-pages/Digits/CNNGoodThreshold.md +++ b/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 diff --git a/param-docs/parameter-pages/Digits/LogImageLocation.md b/param-docs/parameter-pages/Digits/LogImageLocation.md index 77ce82f..2dfda72 100644 --- a/param-docs/parameter-pages/Digits/LogImageLocation.md +++ b/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 diff --git a/param-docs/parameter-pages/Digits/LogfileRetentionInDays.md b/param-docs/parameter-pages/Digits/LogfileRetentionInDays.md index 84de177..e1a3ba5 100644 --- a/param-docs/parameter-pages/Digits/LogfileRetentionInDays.md +++ b/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 diff --git a/param-docs/parameter-pages/Digits/Model.md b/param-docs/parameter-pages/Digits/Model.md index d1fcab2..442cf75 100644 --- a/param-docs/parameter-pages/Digits/Model.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/IO0.md b/param-docs/parameter-pages/GPIO/IO0.md index c323713..ff5d73d 100644 --- a/param-docs/parameter-pages/GPIO/IO0.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/IO1.md b/param-docs/parameter-pages/GPIO/IO1.md index a19739d..9dffdf5 100644 --- a/param-docs/parameter-pages/GPIO/IO1.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/IO12.md b/param-docs/parameter-pages/GPIO/IO12.md index 00e7fd1..1c1b080 100644 --- a/param-docs/parameter-pages/GPIO/IO12.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/IO13.md b/param-docs/parameter-pages/GPIO/IO13.md index 09f067d..751dcb9 100644 --- a/param-docs/parameter-pages/GPIO/IO13.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/IO3.md b/param-docs/parameter-pages/GPIO/IO3.md index d7af763..cd06e25 100644 --- a/param-docs/parameter-pages/GPIO/IO3.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/IO4.md b/param-docs/parameter-pages/GPIO/IO4.md index a52fdf8..e2abbd5 100644 --- a/param-docs/parameter-pages/GPIO/IO4.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/LEDColor.md b/param-docs/parameter-pages/GPIO/LEDColor.md index d3d06dc..af1226e 100644 --- a/param-docs/parameter-pages/GPIO/LEDColor.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/LEDNumbers.md b/param-docs/parameter-pages/GPIO/LEDNumbers.md index dc06fef..f9fc825 100644 --- a/param-docs/parameter-pages/GPIO/LEDNumbers.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/LEDType.md b/param-docs/parameter-pages/GPIO/LEDType.md index 8901862..e31eb02 100644 --- a/param-docs/parameter-pages/GPIO/LEDType.md +++ b/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 diff --git a/param-docs/parameter-pages/GPIO/MainTopicMQTT.md b/param-docs/parameter-pages/GPIO/MainTopicMQTT.md index a1a9390..f10734d 100644 --- a/param-docs/parameter-pages/GPIO/MainTopicMQTT.md +++ b/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 diff --git a/param-docs/parameter-pages/InfluxDB/Database.md b/param-docs/parameter-pages/InfluxDB/Database.md index 191f894..75dfe51 100644 --- a/param-docs/parameter-pages/InfluxDB/Database.md +++ b/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 diff --git a/param-docs/parameter-pages/InfluxDB/Measurement.md b/param-docs/parameter-pages/InfluxDB/Measurement.md index 37e0666..340a274 100644 --- a/param-docs/parameter-pages/InfluxDB/Measurement.md +++ b/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 diff --git a/param-docs/parameter-pages/InfluxDB/Uri.md b/param-docs/parameter-pages/InfluxDB/Uri.md index dbd59bb..c4229af 100644 --- a/param-docs/parameter-pages/InfluxDB/Uri.md +++ b/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 diff --git a/param-docs/parameter-pages/InfluxDB/password.md b/param-docs/parameter-pages/InfluxDB/password.md index 0f6c10c..763e9fd 100644 --- a/param-docs/parameter-pages/InfluxDB/password.md +++ b/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 diff --git a/param-docs/parameter-pages/InfluxDB/user.md b/param-docs/parameter-pages/InfluxDB/user.md index 71d70d6..850680e 100644 --- a/param-docs/parameter-pages/InfluxDB/user.md +++ b/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 diff --git a/param-docs/parameter-pages/MQTT/ClientID.md b/param-docs/parameter-pages/MQTT/ClientID.md index 526dd4a..ded8c91 100644 --- a/param-docs/parameter-pages/MQTT/ClientID.md +++ b/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 diff --git a/param-docs/parameter-pages/MQTT/HomeassistantDiscovery.md b/param-docs/parameter-pages/MQTT/HomeassistantDiscovery.md index 35a2465..42b3f4a 100644 --- a/param-docs/parameter-pages/MQTT/HomeassistantDiscovery.md +++ b/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 diff --git a/param-docs/parameter-pages/MQTT/MainTopic.md b/param-docs/parameter-pages/MQTT/MainTopic.md index 9af1294..0b998f9 100644 --- a/param-docs/parameter-pages/MQTT/MainTopic.md +++ b/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 diff --git a/param-docs/parameter-pages/MQTT/MeterType.md b/param-docs/parameter-pages/MQTT/MeterType.md index 1c0bcbb..f5a40b3 100644 --- a/param-docs/parameter-pages/MQTT/MeterType.md +++ b/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 diff --git a/param-docs/parameter-pages/MQTT/SetRetainFlag.md b/param-docs/parameter-pages/MQTT/SetRetainFlag.md index d535fff..be3ef77 100644 --- a/param-docs/parameter-pages/MQTT/SetRetainFlag.md +++ b/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 diff --git a/param-docs/parameter-pages/MQTT/Uri.md b/param-docs/parameter-pages/MQTT/Uri.md index c54fde4..fe321df 100644 --- a/param-docs/parameter-pages/MQTT/Uri.md +++ b/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 diff --git a/param-docs/parameter-pages/MQTT/password.md b/param-docs/parameter-pages/MQTT/password.md index e997146..50889d0 100644 --- a/param-docs/parameter-pages/MQTT/password.md +++ b/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 diff --git a/param-docs/parameter-pages/MQTT/user.md b/param-docs/parameter-pages/MQTT/user.md index 3efded9..6b20015 100644 --- a/param-docs/parameter-pages/MQTT/user.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/Brightness.md b/param-docs/parameter-pages/MakeImage/Brightness.md index d796136..58b5fe0 100644 --- a/param-docs/parameter-pages/MakeImage/Brightness.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/Contrast.md b/param-docs/parameter-pages/MakeImage/Contrast.md index 185df70..dfb736a 100644 --- a/param-docs/parameter-pages/MakeImage/Contrast.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/Demo.md b/param-docs/parameter-pages/MakeImage/Demo.md index 6b67f78..ceea6b7 100644 --- a/param-docs/parameter-pages/MakeImage/Demo.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/FixedExposure.md b/param-docs/parameter-pages/MakeImage/FixedExposure.md index 5c4095d..a85593f 100644 --- a/param-docs/parameter-pages/MakeImage/FixedExposure.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/ImageQuality.md b/param-docs/parameter-pages/MakeImage/ImageQuality.md index 0de391f..75855b9 100644 --- a/param-docs/parameter-pages/MakeImage/ImageQuality.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/ImageSize.md b/param-docs/parameter-pages/MakeImage/ImageSize.md index 502644e..65c3579 100644 --- a/param-docs/parameter-pages/MakeImage/ImageSize.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/LEDIntensity.md b/param-docs/parameter-pages/MakeImage/LEDIntensity.md index 1e2c04d..43b684b 100644 --- a/param-docs/parameter-pages/MakeImage/LEDIntensity.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/LogImageLocation.md b/param-docs/parameter-pages/MakeImage/LogImageLocation.md index cd97eb7..71a3e95 100644 --- a/param-docs/parameter-pages/MakeImage/LogImageLocation.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md b/param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md index 8fd1156..9a64b83 100644 --- a/param-docs/parameter-pages/MakeImage/LogfileRetentionInDays.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/Saturation.md b/param-docs/parameter-pages/MakeImage/Saturation.md index 62848c6..15e6f12 100644 --- a/param-docs/parameter-pages/MakeImage/Saturation.md +++ b/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 diff --git a/param-docs/parameter-pages/MakeImage/WaitBeforeTakingPicture.md b/param-docs/parameter-pages/MakeImage/WaitBeforeTakingPicture.md index 5baa40b..2c357b7 100644 --- a/param-docs/parameter-pages/MakeImage/WaitBeforeTakingPicture.md +++ b/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 diff --git a/param-docs/parameter-pages/PostProcessing/main.AnalogDigitalTransitionStart.md b/param-docs/parameter-pages/PostProcessing/.AnalogDigitalTransitionStart.md similarity index 61% rename from param-docs/parameter-pages/PostProcessing/main.AnalogDigitalTransitionStart.md rename to param-docs/parameter-pages/PostProcessing/.AnalogDigitalTransitionStart.md index 451ea40..cbc5a63 100644 --- a/param-docs/parameter-pages/PostProcessing/main.AnalogDigitalTransitionStart.md +++ b/param-docs/parameter-pages/PostProcessing/.AnalogDigitalTransitionStart.md @@ -1,6 +1,10 @@ -# Parameter `main.AnalogDigitalTransitionStart` +# Parameter `.AnalogDigitalTransitionStart` Default Value: `9.2` + + + + ## Description Please fill me with an explanation and useful links diff --git a/param-docs/parameter-pages/PostProcessing/main.DecimalShift.md b/param-docs/parameter-pages/PostProcessing/.DecimalShift.md similarity index 68% rename from param-docs/parameter-pages/PostProcessing/main.DecimalShift.md rename to param-docs/parameter-pages/PostProcessing/.DecimalShift.md index bc81943..80de13e 100644 --- a/param-docs/parameter-pages/PostProcessing/main.DecimalShift.md +++ b/param-docs/parameter-pages/PostProcessing/.DecimalShift.md @@ -1,6 +1,10 @@ -# Parameter `main.DecimalShift` +# Parameter `.DecimalShift` Default Value: `0` + + + + ## Description Please fill me with an explanation and useful links diff --git a/param-docs/parameter-pages/PostProcessing/main.ExtendedResolution.md b/param-docs/parameter-pages/PostProcessing/.ExtendedResolution.md similarity index 66% rename from param-docs/parameter-pages/PostProcessing/main.ExtendedResolution.md rename to param-docs/parameter-pages/PostProcessing/.ExtendedResolution.md index 70ffa8f..6039c2f 100644 --- a/param-docs/parameter-pages/PostProcessing/main.ExtendedResolution.md +++ b/param-docs/parameter-pages/PostProcessing/.ExtendedResolution.md @@ -1,6 +1,10 @@ -# Parameter `main.ExtendedResolution` +# Parameter `.ExtendedResolution` Default Value: `false` + + + + ## Description Please fill me with an explanation and useful links diff --git a/param-docs/parameter-pages/PostProcessing/main.IgnoreLeadingNaN.md b/param-docs/parameter-pages/PostProcessing/.IgnoreLeadingNaN.md similarity index 67% rename from param-docs/parameter-pages/PostProcessing/main.IgnoreLeadingNaN.md rename to param-docs/parameter-pages/PostProcessing/.IgnoreLeadingNaN.md index 83dc58b..9dbcba4 100644 --- a/param-docs/parameter-pages/PostProcessing/main.IgnoreLeadingNaN.md +++ b/param-docs/parameter-pages/PostProcessing/.IgnoreLeadingNaN.md @@ -1,6 +1,10 @@ -# Parameter `main.IgnoreLeadingNaN` +# Parameter `.IgnoreLeadingNaN` Default Value: `true` + + + + ## Description Please fill me with an explanation and useful links diff --git a/param-docs/parameter-pages/PostProcessing/main.MaxRateType.md b/param-docs/parameter-pages/PostProcessing/.MaxRateType.md similarity index 72% rename from param-docs/parameter-pages/PostProcessing/main.MaxRateType.md rename to param-docs/parameter-pages/PostProcessing/.MaxRateType.md index 8d599d9..6604f94 100644 --- a/param-docs/parameter-pages/PostProcessing/main.MaxRateType.md +++ b/param-docs/parameter-pages/PostProcessing/.MaxRateType.md @@ -1,6 +1,10 @@ -# Parameter `main.MaxRateType` +# Parameter `.MaxRateType` Default Value: `AbsoluteChange` + + + + ## Description Please fill me with an explanation and useful links diff --git a/param-docs/parameter-pages/PostProcessing/main.MaxRateValue.md b/param-docs/parameter-pages/PostProcessing/.MaxRateValue.md similarity index 69% rename from param-docs/parameter-pages/PostProcessing/main.MaxRateValue.md rename to param-docs/parameter-pages/PostProcessing/.MaxRateValue.md index a6fd392..c94d8ee 100644 --- a/param-docs/parameter-pages/PostProcessing/main.MaxRateValue.md +++ b/param-docs/parameter-pages/PostProcessing/.MaxRateValue.md @@ -1,6 +1,10 @@ -# Parameter `main.MaxRateValue` +# Parameter `.MaxRateValue` Default Value: `0.05` + + + + ## Description Please fill me with an explanation and useful links diff --git a/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md b/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md index f7d95e1..fbad940 100644 --- a/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md +++ b/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 diff --git a/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md b/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md index cfe1dd8..d45f679 100644 --- a/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md +++ b/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 diff --git a/param-docs/parameter-pages/PostProcessing/ErrorMessage.md b/param-docs/parameter-pages/PostProcessing/ErrorMessage.md index ce1e5e5..c097fd4 100644 --- a/param-docs/parameter-pages/PostProcessing/ErrorMessage.md +++ b/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 diff --git a/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md b/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md index 07f0291..e284a06 100644 --- a/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md +++ b/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 diff --git a/param-docs/parameter-pages/PostProcessing/PreValueUse.md b/param-docs/parameter-pages/PostProcessing/PreValueUse.md index 83284be..51f2b7d 100644 --- a/param-docs/parameter-pages/PostProcessing/PreValueUse.md +++ b/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 diff --git a/param-docs/parameter-pages/System/AutoAdjustSummertime.md b/param-docs/parameter-pages/System/AutoAdjustSummertime.md index a41f0f9..eeed5a2 100644 --- a/param-docs/parameter-pages/System/AutoAdjustSummertime.md +++ b/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 diff --git a/param-docs/parameter-pages/System/Hostname.md b/param-docs/parameter-pages/System/Hostname.md index 622c7de..45e149b 100644 --- a/param-docs/parameter-pages/System/Hostname.md +++ b/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 diff --git a/param-docs/parameter-pages/System/SetupMode.md b/param-docs/parameter-pages/System/SetupMode.md index 938ca9c..d84b06d 100644 --- a/param-docs/parameter-pages/System/SetupMode.md +++ b/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 diff --git a/param-docs/parameter-pages/System/TimeServer.md b/param-docs/parameter-pages/System/TimeServer.md index 729bf4d..bd938da 100644 --- a/param-docs/parameter-pages/System/TimeServer.md +++ b/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 diff --git a/param-docs/parameter-pages/System/TimeZone.md b/param-docs/parameter-pages/System/TimeZone.md index d5366ec..c0fb089 100644 --- a/param-docs/parameter-pages/System/TimeZone.md +++ b/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 diff --git a/param-docs/templates/parameter.md b/param-docs/templates/parameter.md index fafd0f8..ead20fd 100644 --- a/param-docs/templates/parameter.md +++ b/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