From db2a3482df0b7d7840e3cbf57b9f6380e22b5204 Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Sat, 4 Feb 2023 00:39:20 +0100 Subject: [PATCH] Auto gen parameter doc (#14) * added script to generate parameter documentation * extended readme * added templated parameter pages * Update build-docs.yaml * . * . --------- Co-authored-by: CaCO3 --- .github/workflows/build-docs.yaml | 8 +++ .gitignore | 2 + README.md | 7 ++ docs/nav.yml | 1 + generate-param-docs/concat-parameter-pages.py | 48 +++++++++++++ .../generate-param-doc-pages.py | 68 +++++++++++++++++++ .../parameter-docs/Alignment/AlignmentAlgo.md | 6 ++ .../parameter-docs/Alignment/FlipImageSize.md | 6 ++ .../parameter-docs/Alignment/InitialMirror.md | 6 ++ .../parameter-docs/Alignment/InitialRotate.md | 6 ++ .../parameter-docs/Alignment/SearchFieldX.md | 6 ++ .../parameter-docs/Alignment/SearchFieldY.md | 6 ++ .../parameter-docs/Analog/CNNGoodThreshold.md | 6 ++ .../Analog/ExtendedResolution.md | 6 ++ .../parameter-docs/Analog/LogImageLocation.md | 6 ++ .../Analog/LogfileRetentionInDays.md | 6 ++ .../parameter-docs/Analog/Model.md | 6 ++ .../parameter-docs/AutoTimer/AutoStart.md | 6 ++ .../parameter-docs/AutoTimer/Intervall.md | 6 ++ .../DataLogging/DataLogActive.md | 6 ++ .../DataLogging/DataLogRetentionInDays.md | 6 ++ .../parameter-docs/Debug/Logfile.md | 6 ++ .../Debug/LogfileRetentionInDays.md | 6 ++ .../parameter-docs/Digits/CNNGoodThreshold.md | 6 ++ .../parameter-docs/Digits/LogImageLocation.md | 6 ++ .../Digits/LogfileRetentionInDays.md | 6 ++ .../parameter-docs/Digits/Model.md | 6 ++ .../parameter-docs/GPIO/IO0.md | 6 ++ .../parameter-docs/GPIO/IO1.md | 6 ++ .../parameter-docs/GPIO/IO12.md | 6 ++ .../parameter-docs/GPIO/IO13.md | 6 ++ .../parameter-docs/GPIO/IO3.md | 6 ++ .../parameter-docs/GPIO/IO4.md | 6 ++ .../parameter-docs/GPIO/LEDColor.md | 6 ++ .../parameter-docs/GPIO/LEDNumbers.md | 6 ++ .../parameter-docs/GPIO/LEDType.md | 6 ++ .../parameter-docs/GPIO/MainTopicMQTT.md | 6 ++ .../parameter-docs/InfluxDB/Database.md | 6 ++ .../parameter-docs/InfluxDB/Measurement.md | 6 ++ .../parameter-docs/InfluxDB/Uri.md | 6 ++ .../parameter-docs/InfluxDB/password.md | 6 ++ .../parameter-docs/InfluxDB/user.md | 6 ++ .../parameter-docs/MQTT/ClientID.md | 6 ++ .../MQTT/HomeassistantDiscovery.md | 6 ++ .../parameter-docs/MQTT/MainTopic.md | 6 ++ .../parameter-docs/MQTT/MeterType.md | 6 ++ .../parameter-docs/MQTT/SetRetainFlag.md | 6 ++ .../parameter-docs/MQTT/Uri.md | 6 ++ .../parameter-docs/MQTT/password.md | 6 ++ .../parameter-docs/MQTT/user.md | 6 ++ .../parameter-docs/MakeImage/Brightness.md | 6 ++ .../parameter-docs/MakeImage/Contrast.md | 6 ++ .../parameter-docs/MakeImage/Demo.md | 6 ++ .../parameter-docs/MakeImage/FixedExposure.md | 6 ++ .../parameter-docs/MakeImage/ImageQuality.md | 6 ++ .../parameter-docs/MakeImage/ImageSize.md | 6 ++ .../parameter-docs/MakeImage/LEDIntensity.md | 6 ++ .../MakeImage/LogImageLocation.md | 6 ++ .../MakeImage/LogfileRetentionInDays.md | 6 ++ .../parameter-docs/MakeImage/Saturation.md | 6 ++ .../MakeImage/WaitBeforeTakingPicture.md | 6 ++ .../PostProcessing/AllowNegativeRates.md | 6 ++ .../CheckDigitIncreaseConsistency.md | 6 ++ .../PostProcessing/ErrorMessage.md | 6 ++ .../PostProcessing/PreValueAgeStartup.md | 6 ++ .../PostProcessing/PreValueUse.md | 6 ++ .../main.AnalogDigitalTransitionStart.md | 6 ++ .../PostProcessing/main.DecimalShift.md | 6 ++ .../PostProcessing/main.ExtendedResolution.md | 6 ++ .../PostProcessing/main.IgnoreLeadingNaN.md | 6 ++ .../PostProcessing/main.MaxRateType.md | 6 ++ .../PostProcessing/main.MaxRateValue.md | 6 ++ .../System/AutoAdjustSummertime.md | 6 ++ .../parameter-docs/System/Hostname.md | 6 ++ .../parameter-docs/System/SetupMode.md | 6 ++ .../parameter-docs/System/TimeServer.md | 6 ++ .../parameter-docs/System/TimeZone.md | 6 ++ generate-param-docs/templates/overview.md | 7 ++ generate-param-docs/templates/parameter.md | 6 ++ 79 files changed, 573 insertions(+) create mode 100644 generate-param-docs/concat-parameter-pages.py create mode 100644 generate-param-docs/generate-param-doc-pages.py create mode 100644 generate-param-docs/parameter-docs/Alignment/AlignmentAlgo.md create mode 100644 generate-param-docs/parameter-docs/Alignment/FlipImageSize.md create mode 100644 generate-param-docs/parameter-docs/Alignment/InitialMirror.md create mode 100644 generate-param-docs/parameter-docs/Alignment/InitialRotate.md create mode 100644 generate-param-docs/parameter-docs/Alignment/SearchFieldX.md create mode 100644 generate-param-docs/parameter-docs/Alignment/SearchFieldY.md create mode 100644 generate-param-docs/parameter-docs/Analog/CNNGoodThreshold.md create mode 100644 generate-param-docs/parameter-docs/Analog/ExtendedResolution.md create mode 100644 generate-param-docs/parameter-docs/Analog/LogImageLocation.md create mode 100644 generate-param-docs/parameter-docs/Analog/LogfileRetentionInDays.md create mode 100644 generate-param-docs/parameter-docs/Analog/Model.md create mode 100644 generate-param-docs/parameter-docs/AutoTimer/AutoStart.md create mode 100644 generate-param-docs/parameter-docs/AutoTimer/Intervall.md create mode 100644 generate-param-docs/parameter-docs/DataLogging/DataLogActive.md create mode 100644 generate-param-docs/parameter-docs/DataLogging/DataLogRetentionInDays.md create mode 100644 generate-param-docs/parameter-docs/Debug/Logfile.md create mode 100644 generate-param-docs/parameter-docs/Debug/LogfileRetentionInDays.md create mode 100644 generate-param-docs/parameter-docs/Digits/CNNGoodThreshold.md create mode 100644 generate-param-docs/parameter-docs/Digits/LogImageLocation.md create mode 100644 generate-param-docs/parameter-docs/Digits/LogfileRetentionInDays.md create mode 100644 generate-param-docs/parameter-docs/Digits/Model.md create mode 100644 generate-param-docs/parameter-docs/GPIO/IO0.md create mode 100644 generate-param-docs/parameter-docs/GPIO/IO1.md create mode 100644 generate-param-docs/parameter-docs/GPIO/IO12.md create mode 100644 generate-param-docs/parameter-docs/GPIO/IO13.md create mode 100644 generate-param-docs/parameter-docs/GPIO/IO3.md create mode 100644 generate-param-docs/parameter-docs/GPIO/IO4.md create mode 100644 generate-param-docs/parameter-docs/GPIO/LEDColor.md create mode 100644 generate-param-docs/parameter-docs/GPIO/LEDNumbers.md create mode 100644 generate-param-docs/parameter-docs/GPIO/LEDType.md create mode 100644 generate-param-docs/parameter-docs/GPIO/MainTopicMQTT.md create mode 100644 generate-param-docs/parameter-docs/InfluxDB/Database.md create mode 100644 generate-param-docs/parameter-docs/InfluxDB/Measurement.md create mode 100644 generate-param-docs/parameter-docs/InfluxDB/Uri.md create mode 100644 generate-param-docs/parameter-docs/InfluxDB/password.md create mode 100644 generate-param-docs/parameter-docs/InfluxDB/user.md create mode 100644 generate-param-docs/parameter-docs/MQTT/ClientID.md create mode 100644 generate-param-docs/parameter-docs/MQTT/HomeassistantDiscovery.md create mode 100644 generate-param-docs/parameter-docs/MQTT/MainTopic.md create mode 100644 generate-param-docs/parameter-docs/MQTT/MeterType.md create mode 100644 generate-param-docs/parameter-docs/MQTT/SetRetainFlag.md create mode 100644 generate-param-docs/parameter-docs/MQTT/Uri.md create mode 100644 generate-param-docs/parameter-docs/MQTT/password.md create mode 100644 generate-param-docs/parameter-docs/MQTT/user.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/Brightness.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/Contrast.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/Demo.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/FixedExposure.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/ImageQuality.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/ImageSize.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/LEDIntensity.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/LogImageLocation.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/LogfileRetentionInDays.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/Saturation.md create mode 100644 generate-param-docs/parameter-docs/MakeImage/WaitBeforeTakingPicture.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/AllowNegativeRates.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/CheckDigitIncreaseConsistency.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/ErrorMessage.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/PreValueAgeStartup.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/PreValueUse.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/main.AnalogDigitalTransitionStart.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/main.DecimalShift.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/main.ExtendedResolution.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/main.IgnoreLeadingNaN.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/main.MaxRateType.md create mode 100644 generate-param-docs/parameter-docs/PostProcessing/main.MaxRateValue.md create mode 100644 generate-param-docs/parameter-docs/System/AutoAdjustSummertime.md create mode 100644 generate-param-docs/parameter-docs/System/Hostname.md create mode 100644 generate-param-docs/parameter-docs/System/SetupMode.md create mode 100644 generate-param-docs/parameter-docs/System/TimeServer.md create mode 100644 generate-param-docs/parameter-docs/System/TimeZone.md create mode 100644 generate-param-docs/templates/overview.md create mode 100644 generate-param-docs/templates/parameter.md diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml index 0777ea5..37a0426 100644 --- a/.github/workflows/build-docs.yaml +++ b/.github/workflows/build-docs.yaml @@ -11,6 +11,7 @@ on: push: branches: - 'main' + - 'auto-gen-parameter-doc' jobs: build-documentation: @@ -39,4 +40,11 @@ jobs: - name: Store docs in gh-pages branch run: | + # Update Parameter Documentation + cd generate-param-docs + python generate-param-doc-pages.py + python concat-parameter-pages.py + cd .. + + # Deploy it mkdocs gh-deploy diff --git a/.gitignore b/.gitignore index d97e100..dff8caf 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ +docs/Parameters.md +.idea site \ No newline at end of file diff --git a/README.md b/README.md index 3143b03..2045b4d 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,13 @@ Each page has a link on its top-right corner `Edit on GitHub` which brings you d 1. Add a new `*.md` document in the [docs](docs) folder. 1. Add the **filename** to the [docs/nav.yml](docs/nav.yml) at the wished position in the **Links** section. +## Parameter Docs Generator +The script `generate-param-docs/generate-param-doc-pages.py` should be run whenever the [configfile](https://github.com/jomjol/AI-on-the-edge-device/blob/rolling/sd-card/config/config.ini) in the main project repo changed. +It then checks if there is a markdown file for each of the contained parameters. if not, it generates a templated page. + +The script `generate-param-docs/concat-parameter-pages.py` should be run whenever one of the parameter documentation pages changed. +It then concatenates all parameter pages into a single `Parameters.md` which can be added to the documentation. + ## Local Test To test it locally: 1. Clone this repo diff --git a/docs/nav.yml b/docs/nav.yml index 4cb1812..17414e7 100644 --- a/docs/nav.yml +++ b/docs/nav.yml @@ -22,6 +22,7 @@ nav: - Choosing-the-Model.md - Neural-Network-Types.md - ota.md + - Parameters.md - Advanced: - Integration-Home-Assistant.md diff --git a/generate-param-docs/concat-parameter-pages.py b/generate-param-docs/concat-parameter-pages.py new file mode 100644 index 0000000..b20a7a8 --- /dev/null +++ b/generate-param-docs/concat-parameter-pages.py @@ -0,0 +1,48 @@ +""" +Grab all parameter files and concat them into a single file. +The header structure gets moved down 1 level +""" + +import os +import shutil +import glob + + +parameterDocsFolder = "parameter-docs" +parameterOverviewFile = "../docs/Parameters.md" +parameterOverviewTemplateFile = "./templates/overview.md" + +def appendParameterFile(folder, file): + print(folder, file) + + with open(file, 'r') as parameterFileHandle: + parameterDoc = parameterFileHandle.read() + parameterDoc = parameterDoc.replace("# ", "### ") # Move all headings 2 level down + + # Add parameter doc to overview page + with open(parameterOverviewFile, 'a') as overviewFileHandle: + overviewFileHandle.write(parameterDoc + "\n---\n\n") + + + +# Create templated overview markdown file +if os.path.exists(parameterOverviewFile): + os.remove(parameterOverviewFile) +shutil.copy(parameterOverviewTemplateFile, parameterOverviewFile) + +""" +Append all parameter pages in a sorted manner +""" +folders = sorted( filter( os.path.isdir, glob.glob(parameterDocsFolder + '/*') ) ) +for folder in folders: + folder = folder.split("/")[-1] +# print(folder) + + # Add section + with open(parameterOverviewFile, 'a') as overviewFileHandle: + overviewFileHandle.write("\n## [%s]\n\n" % folder) + + files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*'))) + for file in files: +# print(" %s" % file) + appendParameterFile(folder, file) diff --git a/generate-param-docs/generate-param-doc-pages.py b/generate-param-docs/generate-param-doc-pages.py new file mode 100644 index 0000000..6fa5f14 --- /dev/null +++ b/generate-param-docs/generate-param-doc-pages.py @@ -0,0 +1,68 @@ +""" +For each parameter which can be found in the config file, +create a markdown file with a templated contentf it does not exist yet. +The files are grouped in sub folders representing the config sections. +""" + +import os +import configparser +import urllib.request + +configFileUrl = "https://raw.githubusercontent.com/jomjol/AI-on-the-edge-device/rolling/sd-card/config/config.ini" + +parameterDocsFolder = "parameter-docs" +parameterTemplateFile = "./templates/parameter.md" + +# Fetch default config file from URL +with urllib.request.urlopen(configFileUrl) as response: + content = response.read().decode("utf-8") + +lines = str(content).split("\n") + +for l in range(len(lines)): + lines[l] = lines[l].strip() + "\n" + if lines[l][0] == ";": + lines[l] = lines[l][1:] # Remove comment + +content = "".join(lines) + + +config = configparser.ConfigParser(allow_no_value=True) +config.optionxform = str # Make it case-insensitive +config.read_string(content) + +#shutil.rmtree(parameterDocsFolder) +if not os.path.exists(parameterDocsFolder): + os.mkdir(parameterDocsFolder) + +with open(parameterTemplateFile, 'r') as parameterTemplateFileHandle: + parameterTemplate = parameterTemplateFileHandle.read() + + + +for section in config: + if section != "DEFAULT": + #print(section) + + subFolder = parameterDocsFolder + "/" + section + + if not os.path.exists(subFolder): + os.mkdir(subFolder) + + for parameter in config[section]: + if not " " in parameter: # Ignore parameters with whitespaces in them (special format, not part of editable config) + value = config[section][parameter] + #print(" %s = %s" % (parameter, value)) + + """ + For each config line, create a markdown file + """ + parameterDocFile = subFolder + '/' + parameter + ".md" + + if not os.path.exists(parameterDocFile): # File does not exist yet, generate template + with open(parameterDocFile, 'w') as paramFileHandle: + content = parameterTemplate + content = content.replace("$NAME", parameter) + content = content.replace("$DEFAULT", value) + + paramFileHandle.write(content) diff --git a/generate-param-docs/parameter-docs/Alignment/AlignmentAlgo.md b/generate-param-docs/parameter-docs/Alignment/AlignmentAlgo.md new file mode 100644 index 0000000..910a6c0 --- /dev/null +++ b/generate-param-docs/parameter-docs/Alignment/AlignmentAlgo.md @@ -0,0 +1,6 @@ +# Parameter `AlignmentAlgo` +Default Value: `Default` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/FlipImageSize.md b/generate-param-docs/parameter-docs/Alignment/FlipImageSize.md new file mode 100644 index 0000000..60cfee1 --- /dev/null +++ b/generate-param-docs/parameter-docs/Alignment/FlipImageSize.md @@ -0,0 +1,6 @@ +# Parameter `FlipImageSize` +Default Value: `false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/InitialMirror.md b/generate-param-docs/parameter-docs/Alignment/InitialMirror.md new file mode 100644 index 0000000..af6211a --- /dev/null +++ b/generate-param-docs/parameter-docs/Alignment/InitialMirror.md @@ -0,0 +1,6 @@ +# Parameter `InitialMirror` +Default Value: `false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/InitialRotate.md b/generate-param-docs/parameter-docs/Alignment/InitialRotate.md new file mode 100644 index 0000000..7185c02 --- /dev/null +++ b/generate-param-docs/parameter-docs/Alignment/InitialRotate.md @@ -0,0 +1,6 @@ +# Parameter `InitialRotate` +Default Value: `179` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/SearchFieldX.md b/generate-param-docs/parameter-docs/Alignment/SearchFieldX.md new file mode 100644 index 0000000..ff6714d --- /dev/null +++ b/generate-param-docs/parameter-docs/Alignment/SearchFieldX.md @@ -0,0 +1,6 @@ +# Parameter `SearchFieldX` +Default Value: `20` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Alignment/SearchFieldY.md b/generate-param-docs/parameter-docs/Alignment/SearchFieldY.md new file mode 100644 index 0000000..b0089fb --- /dev/null +++ b/generate-param-docs/parameter-docs/Alignment/SearchFieldY.md @@ -0,0 +1,6 @@ +# Parameter `SearchFieldY` +Default Value: `20` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/CNNGoodThreshold.md b/generate-param-docs/parameter-docs/Analog/CNNGoodThreshold.md new file mode 100644 index 0000000..2293653 --- /dev/null +++ b/generate-param-docs/parameter-docs/Analog/CNNGoodThreshold.md @@ -0,0 +1,6 @@ +# Parameter `CNNGoodThreshold` +Default Value: `0.5` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/ExtendedResolution.md b/generate-param-docs/parameter-docs/Analog/ExtendedResolution.md new file mode 100644 index 0000000..d56fdaa --- /dev/null +++ b/generate-param-docs/parameter-docs/Analog/ExtendedResolution.md @@ -0,0 +1,6 @@ +# Parameter `ExtendedResolution` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/LogImageLocation.md b/generate-param-docs/parameter-docs/Analog/LogImageLocation.md new file mode 100644 index 0000000..d452034 --- /dev/null +++ b/generate-param-docs/parameter-docs/Analog/LogImageLocation.md @@ -0,0 +1,6 @@ +# Parameter `LogImageLocation` +Default Value: `/log/analog` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/LogfileRetentionInDays.md b/generate-param-docs/parameter-docs/Analog/LogfileRetentionInDays.md new file mode 100644 index 0000000..84de177 --- /dev/null +++ b/generate-param-docs/parameter-docs/Analog/LogfileRetentionInDays.md @@ -0,0 +1,6 @@ +# Parameter `LogfileRetentionInDays` +Default Value: `3` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Analog/Model.md b/generate-param-docs/parameter-docs/Analog/Model.md new file mode 100644 index 0000000..861db58 --- /dev/null +++ b/generate-param-docs/parameter-docs/Analog/Model.md @@ -0,0 +1,6 @@ +# 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/generate-param-docs/parameter-docs/AutoTimer/AutoStart.md b/generate-param-docs/parameter-docs/AutoTimer/AutoStart.md new file mode 100644 index 0000000..40e662c --- /dev/null +++ b/generate-param-docs/parameter-docs/AutoTimer/AutoStart.md @@ -0,0 +1,6 @@ +# Parameter `AutoStart` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/AutoTimer/Intervall.md b/generate-param-docs/parameter-docs/AutoTimer/Intervall.md new file mode 100644 index 0000000..9a5afb8 --- /dev/null +++ b/generate-param-docs/parameter-docs/AutoTimer/Intervall.md @@ -0,0 +1,6 @@ +# Parameter `Intervall` +Default Value: `5` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/DataLogging/DataLogActive.md b/generate-param-docs/parameter-docs/DataLogging/DataLogActive.md new file mode 100644 index 0000000..2508627 --- /dev/null +++ b/generate-param-docs/parameter-docs/DataLogging/DataLogActive.md @@ -0,0 +1,6 @@ +# Parameter `DataLogActive` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/DataLogging/DataLogRetentionInDays.md b/generate-param-docs/parameter-docs/DataLogging/DataLogRetentionInDays.md new file mode 100644 index 0000000..c862e94 --- /dev/null +++ b/generate-param-docs/parameter-docs/DataLogging/DataLogRetentionInDays.md @@ -0,0 +1,6 @@ +# Parameter `DataLogRetentionInDays` +Default Value: `3` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Debug/Logfile.md b/generate-param-docs/parameter-docs/Debug/Logfile.md new file mode 100644 index 0000000..74e928f --- /dev/null +++ b/generate-param-docs/parameter-docs/Debug/Logfile.md @@ -0,0 +1,6 @@ +# Parameter `Logfile` +Default Value: `1` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Debug/LogfileRetentionInDays.md b/generate-param-docs/parameter-docs/Debug/LogfileRetentionInDays.md new file mode 100644 index 0000000..84de177 --- /dev/null +++ b/generate-param-docs/parameter-docs/Debug/LogfileRetentionInDays.md @@ -0,0 +1,6 @@ +# Parameter `LogfileRetentionInDays` +Default Value: `3` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Digits/CNNGoodThreshold.md b/generate-param-docs/parameter-docs/Digits/CNNGoodThreshold.md new file mode 100644 index 0000000..2293653 --- /dev/null +++ b/generate-param-docs/parameter-docs/Digits/CNNGoodThreshold.md @@ -0,0 +1,6 @@ +# Parameter `CNNGoodThreshold` +Default Value: `0.5` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Digits/LogImageLocation.md b/generate-param-docs/parameter-docs/Digits/LogImageLocation.md new file mode 100644 index 0000000..77ce82f --- /dev/null +++ b/generate-param-docs/parameter-docs/Digits/LogImageLocation.md @@ -0,0 +1,6 @@ +# Parameter `LogImageLocation` +Default Value: `/log/digit` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Digits/LogfileRetentionInDays.md b/generate-param-docs/parameter-docs/Digits/LogfileRetentionInDays.md new file mode 100644 index 0000000..84de177 --- /dev/null +++ b/generate-param-docs/parameter-docs/Digits/LogfileRetentionInDays.md @@ -0,0 +1,6 @@ +# Parameter `LogfileRetentionInDays` +Default Value: `3` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/Digits/Model.md b/generate-param-docs/parameter-docs/Digits/Model.md new file mode 100644 index 0000000..d1fcab2 --- /dev/null +++ b/generate-param-docs/parameter-docs/Digits/Model.md @@ -0,0 +1,6 @@ +# Parameter `Model` +Default Value: `/config/dig-cont_0600_s3.tflite` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO0.md b/generate-param-docs/parameter-docs/GPIO/IO0.md new file mode 100644 index 0000000..c323713 --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/IO0.md @@ -0,0 +1,6 @@ +# Parameter `IO0` +Default Value: `input disabled 10 false false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO1.md b/generate-param-docs/parameter-docs/GPIO/IO1.md new file mode 100644 index 0000000..a19739d --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/IO1.md @@ -0,0 +1,6 @@ +# Parameter `IO1` +Default Value: `input disabled 10 false false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO12.md b/generate-param-docs/parameter-docs/GPIO/IO12.md new file mode 100644 index 0000000..00e7fd1 --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/IO12.md @@ -0,0 +1,6 @@ +# Parameter `IO12` +Default Value: `input-pullup disabled 10 false false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO13.md b/generate-param-docs/parameter-docs/GPIO/IO13.md new file mode 100644 index 0000000..09f067d --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/IO13.md @@ -0,0 +1,6 @@ +# Parameter `IO13` +Default Value: `input-pullup disabled 10 false false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO3.md b/generate-param-docs/parameter-docs/GPIO/IO3.md new file mode 100644 index 0000000..d7af763 --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/IO3.md @@ -0,0 +1,6 @@ +# Parameter `IO3` +Default Value: `input disabled 10 false false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/IO4.md b/generate-param-docs/parameter-docs/GPIO/IO4.md new file mode 100644 index 0000000..a52fdf8 --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/IO4.md @@ -0,0 +1,6 @@ +# Parameter `IO4` +Default Value: `built-in-led disabled 10 false false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/LEDColor.md b/generate-param-docs/parameter-docs/GPIO/LEDColor.md new file mode 100644 index 0000000..d3d06dc --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/LEDColor.md @@ -0,0 +1,6 @@ +# Parameter `LEDColor` +Default Value: `150 150 150` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/LEDNumbers.md b/generate-param-docs/parameter-docs/GPIO/LEDNumbers.md new file mode 100644 index 0000000..dc06fef --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/LEDNumbers.md @@ -0,0 +1,6 @@ +# Parameter `LEDNumbers` +Default Value: `2` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/LEDType.md b/generate-param-docs/parameter-docs/GPIO/LEDType.md new file mode 100644 index 0000000..8901862 --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/LEDType.md @@ -0,0 +1,6 @@ +# Parameter `LEDType` +Default Value: `WS2812` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/GPIO/MainTopicMQTT.md b/generate-param-docs/parameter-docs/GPIO/MainTopicMQTT.md new file mode 100644 index 0000000..a1a9390 --- /dev/null +++ b/generate-param-docs/parameter-docs/GPIO/MainTopicMQTT.md @@ -0,0 +1,6 @@ +# Parameter `MainTopicMQTT` +Default Value: `wasserzaehler/GPIO` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/Database.md b/generate-param-docs/parameter-docs/InfluxDB/Database.md new file mode 100644 index 0000000..191f894 --- /dev/null +++ b/generate-param-docs/parameter-docs/InfluxDB/Database.md @@ -0,0 +1,6 @@ +# Parameter `Database` +Default Value: `` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/Measurement.md b/generate-param-docs/parameter-docs/InfluxDB/Measurement.md new file mode 100644 index 0000000..37e0666 --- /dev/null +++ b/generate-param-docs/parameter-docs/InfluxDB/Measurement.md @@ -0,0 +1,6 @@ +# Parameter `Measurement` +Default Value: `undefined` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/Uri.md b/generate-param-docs/parameter-docs/InfluxDB/Uri.md new file mode 100644 index 0000000..dbd59bb --- /dev/null +++ b/generate-param-docs/parameter-docs/InfluxDB/Uri.md @@ -0,0 +1,6 @@ +# Parameter `Uri` +Default Value: `undefined` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/password.md b/generate-param-docs/parameter-docs/InfluxDB/password.md new file mode 100644 index 0000000..0f6c10c --- /dev/null +++ b/generate-param-docs/parameter-docs/InfluxDB/password.md @@ -0,0 +1,6 @@ +# Parameter `password` +Default Value: `undefined` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/InfluxDB/user.md b/generate-param-docs/parameter-docs/InfluxDB/user.md new file mode 100644 index 0000000..71d70d6 --- /dev/null +++ b/generate-param-docs/parameter-docs/InfluxDB/user.md @@ -0,0 +1,6 @@ +# Parameter `user` +Default Value: `undefined` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/ClientID.md b/generate-param-docs/parameter-docs/MQTT/ClientID.md new file mode 100644 index 0000000..526dd4a --- /dev/null +++ b/generate-param-docs/parameter-docs/MQTT/ClientID.md @@ -0,0 +1,6 @@ +# Parameter `ClientID` +Default Value: `watermeter` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/HomeassistantDiscovery.md b/generate-param-docs/parameter-docs/MQTT/HomeassistantDiscovery.md new file mode 100644 index 0000000..35a2465 --- /dev/null +++ b/generate-param-docs/parameter-docs/MQTT/HomeassistantDiscovery.md @@ -0,0 +1,6 @@ +# Parameter `HomeassistantDiscovery` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/MainTopic.md b/generate-param-docs/parameter-docs/MQTT/MainTopic.md new file mode 100644 index 0000000..9af1294 --- /dev/null +++ b/generate-param-docs/parameter-docs/MQTT/MainTopic.md @@ -0,0 +1,6 @@ +# Parameter `MainTopic` +Default Value: `watermeter` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/MeterType.md b/generate-param-docs/parameter-docs/MQTT/MeterType.md new file mode 100644 index 0000000..1c0bcbb --- /dev/null +++ b/generate-param-docs/parameter-docs/MQTT/MeterType.md @@ -0,0 +1,6 @@ +# Parameter `MeterType` +Default Value: `other` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/SetRetainFlag.md b/generate-param-docs/parameter-docs/MQTT/SetRetainFlag.md new file mode 100644 index 0000000..d535fff --- /dev/null +++ b/generate-param-docs/parameter-docs/MQTT/SetRetainFlag.md @@ -0,0 +1,6 @@ +# Parameter `SetRetainFlag` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/Uri.md b/generate-param-docs/parameter-docs/MQTT/Uri.md new file mode 100644 index 0000000..c54fde4 --- /dev/null +++ b/generate-param-docs/parameter-docs/MQTT/Uri.md @@ -0,0 +1,6 @@ +# Parameter `Uri` +Default Value: `mqtt://IP-ADRESS:1883` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/password.md b/generate-param-docs/parameter-docs/MQTT/password.md new file mode 100644 index 0000000..e997146 --- /dev/null +++ b/generate-param-docs/parameter-docs/MQTT/password.md @@ -0,0 +1,6 @@ +# Parameter `password` +Default Value: `PASSWORD` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MQTT/user.md b/generate-param-docs/parameter-docs/MQTT/user.md new file mode 100644 index 0000000..3efded9 --- /dev/null +++ b/generate-param-docs/parameter-docs/MQTT/user.md @@ -0,0 +1,6 @@ +# Parameter `user` +Default Value: `USERNAME` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/Brightness.md b/generate-param-docs/parameter-docs/MakeImage/Brightness.md new file mode 100644 index 0000000..d796136 --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/Brightness.md @@ -0,0 +1,6 @@ +# Parameter `Brightness` +Default Value: `0` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/Contrast.md b/generate-param-docs/parameter-docs/MakeImage/Contrast.md new file mode 100644 index 0000000..185df70 --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/Contrast.md @@ -0,0 +1,6 @@ +# Parameter `Contrast` +Default Value: `0` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/Demo.md b/generate-param-docs/parameter-docs/MakeImage/Demo.md new file mode 100644 index 0000000..6b67f78 --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/Demo.md @@ -0,0 +1,6 @@ +# Parameter `Demo` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/FixedExposure.md b/generate-param-docs/parameter-docs/MakeImage/FixedExposure.md new file mode 100644 index 0000000..5c4095d --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/FixedExposure.md @@ -0,0 +1,6 @@ +# Parameter `FixedExposure` +Default Value: `false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/ImageQuality.md b/generate-param-docs/parameter-docs/MakeImage/ImageQuality.md new file mode 100644 index 0000000..0de391f --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/ImageQuality.md @@ -0,0 +1,6 @@ +# Parameter `ImageQuality` +Default Value: `12` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/ImageSize.md b/generate-param-docs/parameter-docs/MakeImage/ImageSize.md new file mode 100644 index 0000000..502644e --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/ImageSize.md @@ -0,0 +1,6 @@ +# Parameter `ImageSize` +Default Value: `VGA` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/LEDIntensity.md b/generate-param-docs/parameter-docs/MakeImage/LEDIntensity.md new file mode 100644 index 0000000..1e2c04d --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/LEDIntensity.md @@ -0,0 +1,6 @@ +# Parameter `LEDIntensity` +Default Value: `50` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/LogImageLocation.md b/generate-param-docs/parameter-docs/MakeImage/LogImageLocation.md new file mode 100644 index 0000000..cd97eb7 --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/LogImageLocation.md @@ -0,0 +1,6 @@ +# Parameter `LogImageLocation` +Default Value: `/log/source` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/LogfileRetentionInDays.md b/generate-param-docs/parameter-docs/MakeImage/LogfileRetentionInDays.md new file mode 100644 index 0000000..8fd1156 --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/LogfileRetentionInDays.md @@ -0,0 +1,6 @@ +# Parameter `LogfileRetentionInDays` +Default Value: `15` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/Saturation.md b/generate-param-docs/parameter-docs/MakeImage/Saturation.md new file mode 100644 index 0000000..62848c6 --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/Saturation.md @@ -0,0 +1,6 @@ +# Parameter `Saturation` +Default Value: `0` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/MakeImage/WaitBeforeTakingPicture.md b/generate-param-docs/parameter-docs/MakeImage/WaitBeforeTakingPicture.md new file mode 100644 index 0000000..5baa40b --- /dev/null +++ b/generate-param-docs/parameter-docs/MakeImage/WaitBeforeTakingPicture.md @@ -0,0 +1,6 @@ +# Parameter `WaitBeforeTakingPicture` +Default Value: `5` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/AllowNegativeRates.md b/generate-param-docs/parameter-docs/PostProcessing/AllowNegativeRates.md new file mode 100644 index 0000000..f7d95e1 --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/AllowNegativeRates.md @@ -0,0 +1,6 @@ +# Parameter `AllowNegativeRates` +Default Value: `false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/CheckDigitIncreaseConsistency.md b/generate-param-docs/parameter-docs/PostProcessing/CheckDigitIncreaseConsistency.md new file mode 100644 index 0000000..cfe1dd8 --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/CheckDigitIncreaseConsistency.md @@ -0,0 +1,6 @@ +# Parameter `CheckDigitIncreaseConsistency` +Default Value: `false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/ErrorMessage.md b/generate-param-docs/parameter-docs/PostProcessing/ErrorMessage.md new file mode 100644 index 0000000..ce1e5e5 --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/ErrorMessage.md @@ -0,0 +1,6 @@ +# Parameter `ErrorMessage` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/PreValueAgeStartup.md b/generate-param-docs/parameter-docs/PostProcessing/PreValueAgeStartup.md new file mode 100644 index 0000000..07f0291 --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/PreValueAgeStartup.md @@ -0,0 +1,6 @@ +# Parameter `PreValueAgeStartup` +Default Value: `720` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/PreValueUse.md b/generate-param-docs/parameter-docs/PostProcessing/PreValueUse.md new file mode 100644 index 0000000..83284be --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/PreValueUse.md @@ -0,0 +1,6 @@ +# Parameter `PreValueUse` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.AnalogDigitalTransitionStart.md b/generate-param-docs/parameter-docs/PostProcessing/main.AnalogDigitalTransitionStart.md new file mode 100644 index 0000000..451ea40 --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/main.AnalogDigitalTransitionStart.md @@ -0,0 +1,6 @@ +# Parameter `main.AnalogDigitalTransitionStart` +Default Value: `9.2` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.DecimalShift.md b/generate-param-docs/parameter-docs/PostProcessing/main.DecimalShift.md new file mode 100644 index 0000000..bc81943 --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/main.DecimalShift.md @@ -0,0 +1,6 @@ +# Parameter `main.DecimalShift` +Default Value: `0` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.ExtendedResolution.md b/generate-param-docs/parameter-docs/PostProcessing/main.ExtendedResolution.md new file mode 100644 index 0000000..70ffa8f --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/main.ExtendedResolution.md @@ -0,0 +1,6 @@ +# Parameter `main.ExtendedResolution` +Default Value: `false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.IgnoreLeadingNaN.md b/generate-param-docs/parameter-docs/PostProcessing/main.IgnoreLeadingNaN.md new file mode 100644 index 0000000..83dc58b --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/main.IgnoreLeadingNaN.md @@ -0,0 +1,6 @@ +# Parameter `main.IgnoreLeadingNaN` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateType.md b/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateType.md new file mode 100644 index 0000000..8d599d9 --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateType.md @@ -0,0 +1,6 @@ +# Parameter `main.MaxRateType` +Default Value: `AbsoluteChange` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateValue.md b/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateValue.md new file mode 100644 index 0000000..a6fd392 --- /dev/null +++ b/generate-param-docs/parameter-docs/PostProcessing/main.MaxRateValue.md @@ -0,0 +1,6 @@ +# Parameter `main.MaxRateValue` +Default Value: `0.05` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/AutoAdjustSummertime.md b/generate-param-docs/parameter-docs/System/AutoAdjustSummertime.md new file mode 100644 index 0000000..a41f0f9 --- /dev/null +++ b/generate-param-docs/parameter-docs/System/AutoAdjustSummertime.md @@ -0,0 +1,6 @@ +# Parameter `AutoAdjustSummertime` +Default Value: `false` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/Hostname.md b/generate-param-docs/parameter-docs/System/Hostname.md new file mode 100644 index 0000000..622c7de --- /dev/null +++ b/generate-param-docs/parameter-docs/System/Hostname.md @@ -0,0 +1,6 @@ +# Parameter `Hostname` +Default Value: `undefined` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/SetupMode.md b/generate-param-docs/parameter-docs/System/SetupMode.md new file mode 100644 index 0000000..938ca9c --- /dev/null +++ b/generate-param-docs/parameter-docs/System/SetupMode.md @@ -0,0 +1,6 @@ +# Parameter `SetupMode` +Default Value: `true` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/TimeServer.md b/generate-param-docs/parameter-docs/System/TimeServer.md new file mode 100644 index 0000000..729bf4d --- /dev/null +++ b/generate-param-docs/parameter-docs/System/TimeServer.md @@ -0,0 +1,6 @@ +# Parameter `TimeServer` +Default Value: `pool.ntp.org` + +## Description +Please fill me with an explanation and useful links + diff --git a/generate-param-docs/parameter-docs/System/TimeZone.md b/generate-param-docs/parameter-docs/System/TimeZone.md new file mode 100644 index 0000000..d5366ec --- /dev/null +++ b/generate-param-docs/parameter-docs/System/TimeZone.md @@ -0,0 +1,6 @@ +# 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/generate-param-docs/templates/overview.md b/generate-param-docs/templates/overview.md new file mode 100644 index 0000000..f1d575c --- /dev/null +++ b/generate-param-docs/templates/overview.md @@ -0,0 +1,7 @@ +# Parameters +This page lists all available [Configuration](../Configuration) Parameters. + +!!! 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! + +--- diff --git a/generate-param-docs/templates/parameter.md b/generate-param-docs/templates/parameter.md new file mode 100644 index 0000000..fafd0f8 --- /dev/null +++ b/generate-param-docs/templates/parameter.md @@ -0,0 +1,6 @@ +# Parameter `$NAME` +Default Value: `$DEFAULT` + +## Description +Please fill me with an explanation and useful links +