diff --git a/param-docs/expert-params.txt b/param-docs/expert-params.txt deleted file mode 100644 index b3bd2a0..0000000 --- a/param-docs/expert-params.txt +++ /dev/null @@ -1,31 +0,0 @@ -demo -WaitBeforeTakingPicture -ImageQuality -ImageSize -LEDIntensity -Brightness -Contrast -Saturation -FixedExposure -SearchFieldX -SearchFieldY -AlignmentAlgo -InitialMirror -FlipImageSize -CNNGoodThreshold -PreValueAgeStartup -ErrorMessage -CheckDigitIncreaseConsistency -IO0 -IO1 -IO3 -IO4 -IO12 -IO13 -AutoStart -Hostname -RSSIThreshold -TimeServer -CACert -ClientCert -ClientKey diff --git a/param-docs/generate-template-param-doc-pages.py b/param-docs/generate-template-param-doc-pages.py deleted file mode 100644 index 73daa01..0000000 --- a/param-docs/generate-template-param-doc-pages.py +++ /dev/null @@ -1,95 +0,0 @@ -""" -For each parameter which can be found in the config file, -create a markdown file with a templated content if 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-pages" -parameterTemplateFile = "./templates/parameter.md" -expertParameterListFile = "./expert-params.txt" -hiddenInUiParameterListFile = "./hidden-in-ui.txt" - - -# Fetch default config file from URL -print("Fetching %r..." % configFileUrl) -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) - -# 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 -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() - - -print("For each section/parameter, check if there is already a documentation page in the folder %r..." % (os.getcwd() + "/" + parameterDocsFolder)) -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)) - - if "main." in parameter: - parameter = parameter.replace("main.", "NUMBER.") - - """ - 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 - print("%r does not exit yet, generating a templated file for it" % (os.getcwd() + "/" + parameterDocFile)) - with open(parameterDocFile, 'w') as paramFileHandle: - content = parameterTemplate - 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**! Only change it if you understand what it does!") # 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 deleted file mode 100644 index 05c3b67..0000000 --- a/param-docs/hidden-in-ui.txt +++ /dev/null @@ -1,4 +0,0 @@ -InitialRotate -MainTopicMQTT -AutoAdjustSummertime -SetupMode diff --git a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md b/param-docs/parameter-pages/Alignment/AlignmentAlgo.md deleted file mode 100644 index dc6d435..0000000 --- a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md +++ /dev/null @@ -1,14 +0,0 @@ -# Parameter `AlignmentAlgo` -Default Value: `Default` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Algorithm used for the alignment step. - -Available options: - -- `Default`: Use only red color channel -- `HighAccuracy`: Use all 3 color channels (3x slower) -- `Fast`: First time use `HighAccuracy`, then only check if the image is shifted -- `Off`: Disable alignment algorithm diff --git a/param-docs/parameter-pages/Alignment/FlipImageSize.md b/param-docs/parameter-pages/Alignment/FlipImageSize.md deleted file mode 100644 index b932b32..0000000 --- a/param-docs/parameter-pages/Alignment/FlipImageSize.md +++ /dev/null @@ -1,11 +0,0 @@ -# Parameter `FlipImageSize` -Default Value: `false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -!!! Note - This parameter can also be set on the Reference Image configuration. - -This parameter can be used to rotate the viewport together with the alignment rotation: -![](img/flipImageSize.png) diff --git a/param-docs/parameter-pages/Alignment/InitialMirror.md b/param-docs/parameter-pages/Alignment/InitialMirror.md deleted file mode 100644 index 8a18a49..0000000 --- a/param-docs/parameter-pages/Alignment/InitialMirror.md +++ /dev/null @@ -1,10 +0,0 @@ -# Parameter `InitialMirror` -Default Value: `false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -!!! Note - This parameter can also be set on the Reference Image configuration. - -Option for initially mirroring the image on the original x-axis. diff --git a/param-docs/parameter-pages/Alignment/InitialRotate.md b/param-docs/parameter-pages/Alignment/InitialRotate.md deleted file mode 100644 index 3cbc1af..0000000 --- a/param-docs/parameter-pages/Alignment/InitialRotate.md +++ /dev/null @@ -1,9 +0,0 @@ -# Parameter `InitialRotate` -Default Value: `179` - -Unit: Degrees - -Initial rotation of image before alignment in degree (0 .. 359) - -!!! Note - This parameter is accessible on the Reference Image Page but not on the Config page! diff --git a/param-docs/parameter-pages/Alignment/SearchFieldX.md b/param-docs/parameter-pages/Alignment/SearchFieldX.md deleted file mode 100644 index b829314..0000000 --- a/param-docs/parameter-pages/Alignment/SearchFieldX.md +++ /dev/null @@ -1,14 +0,0 @@ -# Parameter `SearchFieldX` -Default Value: `20` - -Unit: Pixels - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -X-size (width) in which the reference is searched. - -!!! Note - Since the alignment is one of the steps using a lot of computation time, - the search field should be as small as possible. - The calculation time goes quadratic with the search field size. \ No newline at end of file diff --git a/param-docs/parameter-pages/Alignment/SearchFieldY.md b/param-docs/parameter-pages/Alignment/SearchFieldY.md deleted file mode 100644 index 6b51b9a..0000000 --- a/param-docs/parameter-pages/Alignment/SearchFieldY.md +++ /dev/null @@ -1,14 +0,0 @@ -# Parameter `SearchFieldY` -Default Value: `20` - -Unit: Pixels - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Y-size (height) in which the reference is searched. - -!!! Note - Since the alignment is one of the steps using a lot of computation time, - the search field should be as small as possible. - The calculation time goes quadratic with the search field size. diff --git a/param-docs/parameter-pages/Analog/CNNGoodThreshold.md b/param-docs/parameter-pages/Analog/CNNGoodThreshold.md deleted file mode 100644 index acff4a5..0000000 --- a/param-docs/parameter-pages/Analog/CNNGoodThreshold.md +++ /dev/null @@ -1,10 +0,0 @@ -# Parameter `CNNGoodThreshold` -Default Value: `0.5` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Threshold above which the classification should be to accept the value (only meaningful for digits). - -!!! Warning - This is only supported for the `ana-class100` models! diff --git a/param-docs/parameter-pages/Analog/ExtendedResolution.md b/param-docs/parameter-pages/Analog/ExtendedResolution.md deleted file mode 100644 index 711fd4e..0000000 --- a/param-docs/parameter-pages/Analog/ExtendedResolution.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `ExtendedResolution` - -!!! Warning - This parameter is unused! - Use [`NUMBER.ExtendedResolution`](../Parameters/#PostProcessing-NUMBER.ExtendedResolution) instead! diff --git a/param-docs/parameter-pages/Analog/Model.md b/param-docs/parameter-pages/Analog/Model.md deleted file mode 100644 index 3481c2b..0000000 --- a/param-docs/parameter-pages/Analog/Model.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `Model` -Default Value: `/config/ana-cont_*.tflite` (See [/config/config.ini](https://github.com/jomjol/AI-on-the-edge-device/blob/master/sd-card/config/config.ini)) - -Path to CNN model file for image recognition. See [here](../Choosing-the-Model) for details. diff --git a/param-docs/parameter-pages/Analog/ROIImagesLocation.md b/param-docs/parameter-pages/Analog/ROIImagesLocation.md deleted file mode 100644 index a8aacec..0000000 --- a/param-docs/parameter-pages/Analog/ROIImagesLocation.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `ROIImagesLocation` -Default Value: `/log/analog` - -Location to store separated analog images on the SD-Card. - -!!! Warning - A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! diff --git a/param-docs/parameter-pages/Analog/ROIImagesRetention.md b/param-docs/parameter-pages/Analog/ROIImagesRetention.md deleted file mode 100644 index a36d06b..0000000 --- a/param-docs/parameter-pages/Analog/ROIImagesRetention.md +++ /dev/null @@ -1,6 +0,0 @@ -# Parameter `ROIImagesRetention` -Default Value: `3` - -Unit: Days - -Days to keep the separated analog images (`0` = forever). diff --git a/param-docs/parameter-pages/AutoTimer/AutoStart.md b/param-docs/parameter-pages/AutoTimer/AutoStart.md deleted file mode 100644 index 94a9313..0000000 --- a/param-docs/parameter-pages/AutoTimer/AutoStart.md +++ /dev/null @@ -1,12 +0,0 @@ -# Parameter `AutoStart` -Default Value: `true` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Automatically start the Flow (Digitization Rounds) immediately after power up. - -!!! Note - Typically this is set to `true`. - The main reasons to set it to `false` is when you want to trigger it manually using the - [REST API](../REST-API) or [MQTT-API](../MQTT-API) or for debugging. \ No newline at end of file diff --git a/param-docs/parameter-pages/AutoTimer/Interval.md b/param-docs/parameter-pages/AutoTimer/Interval.md deleted file mode 100644 index e0e58eb..0000000 --- a/param-docs/parameter-pages/AutoTimer/Interval.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `Interval` -Default Value: `5` - -Unit: Minutes - -Interval in which the Flow (Digitization Round) is run. -If a round takes longer than this interval, the next round gets postponed until the current round completes. diff --git a/param-docs/parameter-pages/DataLogging/DataFilesRetention.md b/param-docs/parameter-pages/DataLogging/DataFilesRetention.md deleted file mode 100644 index be6b9b9..0000000 --- a/param-docs/parameter-pages/DataLogging/DataFilesRetention.md +++ /dev/null @@ -1,6 +0,0 @@ -# Parameter `DataFilesRetention` -Default Value: `3` - -Unit: Days - -Number of days to keep the data files (`0` = forever). diff --git a/param-docs/parameter-pages/DataLogging/DataLogActive.md b/param-docs/parameter-pages/DataLogging/DataLogActive.md deleted file mode 100644 index 03e44ff..0000000 --- a/param-docs/parameter-pages/DataLogging/DataLogActive.md +++ /dev/null @@ -1,8 +0,0 @@ -# Parameter `DataLogActive` -Default Value: `true` -Activate data logging to the SD-Card. - -The files will be stored in `/log/data/data_YYYY-MM-DD.csv`. See [`Data Logging`](../data-logging) for details. - -!!! Warning - A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! diff --git a/param-docs/parameter-pages/Debug/LogLevel.md b/param-docs/parameter-pages/Debug/LogLevel.md deleted file mode 100644 index ac51856..0000000 --- a/param-docs/parameter-pages/Debug/LogLevel.md +++ /dev/null @@ -1,16 +0,0 @@ -# Parameter `LogLevel` -Default Value: `1` (`ERROR`) -Define the log level for the logging to the SD-Card. - -Available options: - -- `1`: `ERROR` -- `2`: `WARNING` -- `3`: `INFO` -- `4`: `DEBUG` - -As higher the level, as more log messages get written to the SD-Card. - -!!! Warning - `DEBUG` or `INFO` might damage the SD-Card if enabled long term due to excessive writes to the SD-Card! - A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! diff --git a/param-docs/parameter-pages/Debug/LogfilesRetention.md b/param-docs/parameter-pages/Debug/LogfilesRetention.md deleted file mode 100644 index e8adb03..0000000 --- a/param-docs/parameter-pages/Debug/LogfilesRetention.md +++ /dev/null @@ -1,6 +0,0 @@ -# Parameter `LogfilesRetention` -Default Value: `3` - -Unit: Days - -Number of days to keep the log files (`0` = forever). diff --git a/param-docs/parameter-pages/Digits/CNNGoodThreshold.md b/param-docs/parameter-pages/Digits/CNNGoodThreshold.md deleted file mode 100644 index 0485129..0000000 --- a/param-docs/parameter-pages/Digits/CNNGoodThreshold.md +++ /dev/null @@ -1,10 +0,0 @@ -# Parameter `CNNGoodThreshold` -Default Value: `0.5` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Threshold above which the classification should be to accept the value (only meaningful for digits). - -!!! Warning - This is only supported for the `dig-class100` models! diff --git a/param-docs/parameter-pages/Digits/Model.md b/param-docs/parameter-pages/Digits/Model.md deleted file mode 100644 index 73107f7..0000000 --- a/param-docs/parameter-pages/Digits/Model.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `Model` -Default Value: `/config/dig-cont_*.tflite` (See [/config/config.ini](https://github.com/jomjol/AI-on-the-edge-device/blob/master/sd-card/config/config.ini)) - -Path to CNN model file for image recognition. See [here](../Choosing-the-Model) for details. diff --git a/param-docs/parameter-pages/Digits/ROIImagesLocation.md b/param-docs/parameter-pages/Digits/ROIImagesLocation.md deleted file mode 100644 index 28d6b3a..0000000 --- a/param-docs/parameter-pages/Digits/ROIImagesLocation.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `ROIImagesLocation` -Default Value: `/log/digit` - -Location to store separated digit images on the SD-Card. - -!!! Warning - A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! diff --git a/param-docs/parameter-pages/Digits/ROIImagesRetention.md b/param-docs/parameter-pages/Digits/ROIImagesRetention.md deleted file mode 100644 index 2d6ca9e..0000000 --- a/param-docs/parameter-pages/Digits/ROIImagesRetention.md +++ /dev/null @@ -1,6 +0,0 @@ -# Parameter `ROIImagesRetention` -Default Value: `3` - -Unit: Days - -Days to keep the separated digit images (`0` = forever). diff --git a/param-docs/parameter-pages/GPIO/IO0.md b/param-docs/parameter-pages/GPIO/IO0.md deleted file mode 100644 index a9b180a..0000000 --- a/param-docs/parameter-pages/GPIO/IO0.md +++ /dev/null @@ -1,21 +0,0 @@ -# Parameter `IO0` -Default Value: `input disabled 10 false false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -This parameter can be used to configure the GPIO `IO0` pin. - -!!! Warning - This pin is only usable with restrictions! - It must be disabled when the camera is used. - Additionally, it is used to activate Bootloader mode and must therefore be HIGH after a reset! - -Parameters: - -- `GPIO 0 state`: One of `input`, `input pullup`, `input pulldown` or `output`. -- `GPIO 0 use interrupt`: Enable interrupt trigger -- `GPIO 0 PWM duty resolution`: LEDC PWM duty resolution in bit -- `GPIO 0 enable MQTT`: Enable MQTT publishing/subscribing -- `GPIO 0 enable HTTP`: Enable HTTP write/read -- `GPIO 0 name`: MQTT topic name (empty = `GPIO0`). Allowed characters: `a-z, A-Z, 0-9, _, -`. diff --git a/param-docs/parameter-pages/GPIO/IO1.md b/param-docs/parameter-pages/GPIO/IO1.md deleted file mode 100644 index 481a847..0000000 --- a/param-docs/parameter-pages/GPIO/IO1.md +++ /dev/null @@ -1,19 +0,0 @@ -# Parameter `IO1` -Default Value: `input disabled 10 false false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -This parameter can be used to configure the GPIO `IO1` pin. - -!!! Warning - This pin is by default used for the serial communication as TX pin (USB logging)! - -Parameters: - -- `GPIO 1 state`: One of `input`, `input pullup`, `input pulldown` or `output`. -- `GPIO 1 use interrupt`: Enable interrupt trigger -- `GPIO 1 PWM duty resolution`: LEDC PWM duty resolution in bit -- `GPIO 1 enable MQTT`: Enable MQTT publishing/subscribing -- `GPIO 1 enable HTTP`: Enable HTTP write/read -- `GPIO 1 name`: MQTT topic name (empty = `GPIO1`). Allowed characters: `a-z, A-Z, 0-9, _, -`. diff --git a/param-docs/parameter-pages/GPIO/IO12.md b/param-docs/parameter-pages/GPIO/IO12.md deleted file mode 100644 index f5f62b8..0000000 --- a/param-docs/parameter-pages/GPIO/IO12.md +++ /dev/null @@ -1,19 +0,0 @@ -# Parameter `IO12` -Default Value: `input-pullup disabled 10 false false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -This parameter can be used to configure the GPIO `IO12` pin. - -!!! Note - This pin is usable without known restrictions! - -Parameters: - -- `GPIO 12 state`: One of `external-flash-ws281x`, `input`, `input pullup`, `input pulldown` or `output`. -- `GPIO 12 use interrupt`: Enable interrupt trigger -- `GPIO 12 PWM duty resolution`: LEDC PWM duty resolution in bit -- `GPIO 12 enable MQTT`: Enable MQTT publishing/subscribing -- `GPIO 12 enable HTTP`: Enable HTTP write/read -- `GPIO 12 name`: MQTT topic name (empty = `GPIO12`). Allowed characters: `a-z, A-Z, 0-9, _, -`. diff --git a/param-docs/parameter-pages/GPIO/IO13.md b/param-docs/parameter-pages/GPIO/IO13.md deleted file mode 100644 index 64bd642..0000000 --- a/param-docs/parameter-pages/GPIO/IO13.md +++ /dev/null @@ -1,19 +0,0 @@ -# Parameter `IO13` -Default Value: `input-pullup disabled 10 false false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -This parameter can be used to configure the GPIO `IO13` pin. - -!!! Note - This pin is usable without known restrictions! - -Parameters: - -- `GPIO 13 state`: One of `input`, `input pullup`, `input pulldown` or `output`. -- `GPIO 13 use interrupt`: Enable interrupt trigger -- `GPIO 13 PWM duty resolution`: LEDC PWM duty resolution in bit -- `GPIO 13 enable MQTT`: Enable MQTT publishing/subscribing -- `GPIO 13 enable HTTP`: Enable HTTP write/read -- `GPIO 13 name`: MQTT topic name (empty = `GPIO13`). Allowed characters: `a-z, A-Z, 0-9, _, -`. diff --git a/param-docs/parameter-pages/GPIO/IO3.md b/param-docs/parameter-pages/GPIO/IO3.md deleted file mode 100644 index 7d00209..0000000 --- a/param-docs/parameter-pages/GPIO/IO3.md +++ /dev/null @@ -1,19 +0,0 @@ -# Parameter `IO3` -Default Value: `input disabled 10 false false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -This parameter can be used to configure the GPIO `IO3` pin. - -!!! Warning - This pin is by default used for the serial communication as RX pin (USB logging)! - -Parameters: - -- `GPIO 3 state`: One of `input`, `input pullup`, `input pulldown` or `output`. -- `GPIO 3 use interrupt`: Enable interrupt trigger -- `GPIO 3 PWM duty resolution`: LEDC PWM duty resolution in bit -- `GPIO 3 enable MQTT`: Enable MQTT publishing/subscribing -- `GPIO 3 enable HTTP`: Enable HTTP write/read -- `GPIO 3 name`: MQTT topic name (empty = `GPIO3`). Allowed characters: `a-z, A-Z, 0-9, _, -`. diff --git a/param-docs/parameter-pages/GPIO/IO4.md b/param-docs/parameter-pages/GPIO/IO4.md deleted file mode 100644 index f59883d..0000000 --- a/param-docs/parameter-pages/GPIO/IO4.md +++ /dev/null @@ -1,20 +0,0 @@ -# Parameter `IO4` -Default Value: `built-in-led disabled 10 false false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -This parameter can be used to configure the GPIO `IO4` pin. - -!!! Warning - This pin is only usable with restrictions! - By default, it is used for build-in flash light (onboard LED). - -Parameters: - -- `GPIO 4 state`: One of `built-in-led`, `input`, `input pullup`, `input pulldown` or `output`. -- `GPIO 4 use interrupt`: Enable interrupt trigger -- `GPIO 4 PWM duty resolution`: LEDC PWM duty resolution in bit -- `GPIO 4 enable MQTT`: Enable MQTT publishing/subscribing -- `GPIO 4 enable HTTP`: Enable HTTP write/read -- `GPIO 4 name`: MQTT topic name (empty = `GPIO4`). Allowed characters: `a-z, A-Z, 0-9, _, -`. diff --git a/param-docs/parameter-pages/GPIO/LEDColor.md b/param-docs/parameter-pages/GPIO/LEDColor.md deleted file mode 100644 index c7e0816..0000000 --- a/param-docs/parameter-pages/GPIO/LEDColor.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `LEDColor` -Default Value: `150 150 150` - -Color of the attached LEDs to GPIO12 in **R**ed, **G**reen **B**lue from `0` (full off) .. `255` (full on) -(See `IO12` parameter). diff --git a/param-docs/parameter-pages/GPIO/LEDNumbers.md b/param-docs/parameter-pages/GPIO/LEDNumbers.md deleted file mode 100644 index b151b24..0000000 --- a/param-docs/parameter-pages/GPIO/LEDNumbers.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `LEDNumbers` -Default Value: `2` - -Number of LEDs on the external LED-stripe attached to GPIO12 (See `IO12` parameter). diff --git a/param-docs/parameter-pages/GPIO/LEDType.md b/param-docs/parameter-pages/GPIO/LEDType.md deleted file mode 100644 index e57e68c..0000000 --- a/param-docs/parameter-pages/GPIO/LEDType.md +++ /dev/null @@ -1,3 +0,0 @@ -# Parameter `LEDType` -Default Value: `WS2812` -Type of the `WS2812x` which is connected to GPIO12 (See `IO12` parameter). diff --git a/param-docs/parameter-pages/GPIO/MainTopicMQTT.md b/param-docs/parameter-pages/GPIO/MainTopicMQTT.md deleted file mode 100644 index 19ce2b8..0000000 --- a/param-docs/parameter-pages/GPIO/MainTopicMQTT.md +++ /dev/null @@ -1,8 +0,0 @@ -# Parameter `MainTopicMQTT` -Default Value: `wasserzaehler/GPIO` - -!!! Note - This parameter is not accessible through the Web Interface Configuration Page! - -The GPIO Interface is prepared to report it's status and status changes as a MQTT topic. With this parameter you configure the MQTT main topic, under which the status is published. -As this parameter is still experimental it can only be set manually in the `config.ini` itself and has not been tested in detail so far. diff --git a/param-docs/parameter-pages/InfluxDB/Database.md b/param-docs/parameter-pages/InfluxDB/Database.md deleted file mode 100644 index 860a808..0000000 --- a/param-docs/parameter-pages/InfluxDB/Database.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `Database` -Default Value: `''` - -Name of the InfluxDB v1 Database into which to publish the values. - -!!! Note - See section `InfluxDBv2` for InfluxDB v2 support! diff --git a/param-docs/parameter-pages/InfluxDB/NUMBER.Field.md b/param-docs/parameter-pages/InfluxDB/NUMBER.Field.md deleted file mode 100644 index 8035ca6..0000000 --- a/param-docs/parameter-pages/InfluxDB/NUMBER.Field.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `.Field` -Default Value: `undefined` - -Dedicated definition of the field for InfluxDB use for saving in the Influx database (e.g.: "watermeter/value"). diff --git a/param-docs/parameter-pages/InfluxDB/NUMBER.Measurement.md b/param-docs/parameter-pages/InfluxDB/NUMBER.Measurement.md deleted file mode 100644 index cd6f69c..0000000 --- a/param-docs/parameter-pages/InfluxDB/NUMBER.Measurement.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `Measurement` -Default Value: `undefined` - -Name of the InfluxDB v1 Measurement to use to publish the value. - -!!! Note - See section `InfluxDBv2` for InfluxDB v2 support! diff --git a/param-docs/parameter-pages/InfluxDB/Uri.md b/param-docs/parameter-pages/InfluxDB/Uri.md deleted file mode 100644 index 16b22c7..0000000 --- a/param-docs/parameter-pages/InfluxDB/Uri.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `Uri` -Default Value: `undefined` - -URI of the HTTP interface to InfluxDB v1, without trailing slash, e.g. `http://192.168.1.1:8086`. - -!!! Note - See section `InfluxDBv2` for InfluxDB v2 support! diff --git a/param-docs/parameter-pages/InfluxDB/password.md b/param-docs/parameter-pages/InfluxDB/password.md deleted file mode 100644 index 97dcbcc..0000000 --- a/param-docs/parameter-pages/InfluxDB/password.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `password` -Default Value: `undefined` - -Password for the InfluxDB v1 authentication. - -!!! Note - See section `InfluxDBv2` for InfluxDB v2 support! diff --git a/param-docs/parameter-pages/InfluxDB/user.md b/param-docs/parameter-pages/InfluxDB/user.md deleted file mode 100644 index 3f989a4..0000000 --- a/param-docs/parameter-pages/InfluxDB/user.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `user` -Default Value: `undefined` - -Username for the InfluxDB v1 authentication. - -!!! Note - See section `InfluxDBv2` for InfluxDB v2 support! diff --git a/param-docs/parameter-pages/InfluxDBv2/Bucket.md b/param-docs/parameter-pages/InfluxDBv2/Bucket.md deleted file mode 100644 index 8dca664..0000000 --- a/param-docs/parameter-pages/InfluxDBv2/Bucket.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `Bucket` -Default Value: `''` - -Name of the InfluxDB v2 Bucket into which to publish the values. diff --git a/param-docs/parameter-pages/InfluxDBv2/Database.md b/param-docs/parameter-pages/InfluxDBv2/Database.md deleted file mode 100644 index 9fc9123..0000000 --- a/param-docs/parameter-pages/InfluxDBv2/Database.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `Database` - -!!! Warning - This parameter is unused! - Use [`Basket`](../Parameters/#InfluxDBv2-Basket) instead! diff --git a/param-docs/parameter-pages/InfluxDBv2/NUMBER.Field.md b/param-docs/parameter-pages/InfluxDBv2/NUMBER.Field.md deleted file mode 100644 index 58611ad..0000000 --- a/param-docs/parameter-pages/InfluxDBv2/NUMBER.Field.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `.Field` -Default Value: `undefined` - -Field for InfluxDB v2 to use for saving. diff --git a/param-docs/parameter-pages/InfluxDBv2/NUMBER.Measurement.md b/param-docs/parameter-pages/InfluxDBv2/NUMBER.Measurement.md deleted file mode 100644 index c79ea6d..0000000 --- a/param-docs/parameter-pages/InfluxDBv2/NUMBER.Measurement.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `Measurement` -Default Value: `undefined` - -Name of the InfluxDB v2 Measurement to use to publish the value. diff --git a/param-docs/parameter-pages/InfluxDBv2/Org.md b/param-docs/parameter-pages/InfluxDBv2/Org.md deleted file mode 100644 index 4731d7a..0000000 --- a/param-docs/parameter-pages/InfluxDBv2/Org.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `Org` -Default Value: `undefined` - -Organisation (Org) for InfluxDB v2 authentication diff --git a/param-docs/parameter-pages/InfluxDBv2/Token.md b/param-docs/parameter-pages/InfluxDBv2/Token.md deleted file mode 100644 index dc72360..0000000 --- a/param-docs/parameter-pages/InfluxDBv2/Token.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `Token` -Default Value: `undefined` - -Token for InfluxDB v2 authentication diff --git a/param-docs/parameter-pages/InfluxDBv2/Uri.md b/param-docs/parameter-pages/InfluxDBv2/Uri.md deleted file mode 100644 index c02c730..0000000 --- a/param-docs/parameter-pages/InfluxDBv2/Uri.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `Uri` -Default Value: `undefined` - -URI of the HTTP interface to InfluxDB v2, without trailing slash, e.g. `http://192.168.1.1:8086`. diff --git a/param-docs/parameter-pages/MQTT/CACert.md b/param-docs/parameter-pages/MQTT/CACert.md deleted file mode 100644 index 5ee45b4..0000000 --- a/param-docs/parameter-pages/MQTT/CACert.md +++ /dev/null @@ -1,18 +0,0 @@ -# Parameter `CACert` -Default Value: `""` - -Example: `/config/certs/RootCA.pem`. - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Path to the CA certificate file. - -This is part of the configuration to enable TLS for MQTT. -The CA Certificate is used by the client to validate the broker is who it claims to be. -It allows the client to authenticate the server, which is the first part of the MTLS handshake. - -Usually there is a common RootCA certificate for the MQTT broker - -!!! Note - This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`! diff --git a/param-docs/parameter-pages/MQTT/ClientCert.md b/param-docs/parameter-pages/MQTT/ClientCert.md deleted file mode 100644 index 9cb4924..0000000 --- a/param-docs/parameter-pages/MQTT/ClientCert.md +++ /dev/null @@ -1,19 +0,0 @@ -# Parameter `ClientCert` -Default Value: `""` - -Example: `/config/certs/client.pem.crt`. - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Path to the Client Certificate file. - -This is part of the configuration to enable TLS for MQTT. -The Client Certificate is used by the client to prove its identity to the server, in conjunction with the Client Key. -It is the second part of the MTLS handshake. - -Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker - -!!! Note - If set, `ClientKey` must be set too - This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`! diff --git a/param-docs/parameter-pages/MQTT/ClientID.md b/param-docs/parameter-pages/MQTT/ClientID.md deleted file mode 100644 index 6e5ec51..0000000 --- a/param-docs/parameter-pages/MQTT/ClientID.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `ClientID` -Default Value: `watermeter` - -Client ID used to connect to the MQTT broker. -If disabled, the `hostname` will be used. \ No newline at end of file diff --git a/param-docs/parameter-pages/MQTT/ClientKey.md b/param-docs/parameter-pages/MQTT/ClientKey.md deleted file mode 100644 index af862f0..0000000 --- a/param-docs/parameter-pages/MQTT/ClientKey.md +++ /dev/null @@ -1,19 +0,0 @@ -# Parameter `ClientKey` -Default Value: `""` - -Example: `/config/certs/client.pem.key`. - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Path to the Client Key file. - -This is part of the configuration to enable TLS for MQTT. -The Client Key is used by the client to prove its identity to the server, in conjunction with the Client Certificate. -It is the second part of the MTLS handshake. - -Usually there is a one pair of Client Certificate/Key for each client that connects to the MQTT broker - -!!! Note - If set, `ClientCert` must be set too - This also means that you might have to change the protocol and port in [uri](https://jomjol.github.io/AI-on-the-edge-device-docs/Parameters/#parameter-uri) to `mqtts://example.com:8883`! diff --git a/param-docs/parameter-pages/MQTT/HomeassistantDiscovery.md b/param-docs/parameter-pages/MQTT/HomeassistantDiscovery.md deleted file mode 100644 index 50e821f..0000000 --- a/param-docs/parameter-pages/MQTT/HomeassistantDiscovery.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `HomeassistantDiscovery` -Default Value: `true` - -Enable or disable the Homeassistant Discovery. -See [here](../Integration-Home-Assistant) for details about the discovery. diff --git a/param-docs/parameter-pages/MQTT/MainTopic.md b/param-docs/parameter-pages/MQTT/MainTopic.md deleted file mode 100644 index 3cf12ec..0000000 --- a/param-docs/parameter-pages/MQTT/MainTopic.md +++ /dev/null @@ -1,18 +0,0 @@ -# Parameter `MainTopic` -Default Value: `watermeter` - -MQTT main topic, under which the counters are published. - -The single value will be published with the following key: `MAINTOPIC/NUMBER/RESULT_TOPIC` - -With: - -- `NUMBER`: The name of the value (a meter might have more than one value). - The names get defined in the analog and digital ROI configuration (defaults to `main`). -- `RESULT_TOPIC`: Automatically filled with the right name, eg. `value`, `rate`, `timestamp`, `error`, .... - -The general connection status can be found in `MAINTOPIC/CONNECTION`. -See [MQTT Result Topics](../MQTT-API#result) for a full list of topics. - -!!! Note - The main topic is allowed to contain `/` which can be used to split it into multiple levels, eg. `/basement/meters/watermeter/1/` if you have multiple water meters in your basement. diff --git a/param-docs/parameter-pages/MQTT/MeterType.md b/param-docs/parameter-pages/MQTT/MeterType.md deleted file mode 100644 index a65bd03..0000000 --- a/param-docs/parameter-pages/MQTT/MeterType.md +++ /dev/null @@ -1,11 +0,0 @@ -# Parameter `MeterType` -Default Value: `other` - -Select the Meter Type so the sensors have the right units in Homeassistant. - -!!! Note - For `Watermeter` you need to have Homeassistant 2022.11 or newer! - -Please also make sure that the selected Meter Type matches the dimension of the value provided by the meter! -Eg. if your meter provides `m³`, you need to also set it to `m³`. -Alternatively you can set the parameter `DecimalShift` to `3` so the value is converted to `liters`! diff --git a/param-docs/parameter-pages/MQTT/RetainMessages.md b/param-docs/parameter-pages/MQTT/RetainMessages.md deleted file mode 100644 index 40a47d6..0000000 --- a/param-docs/parameter-pages/MQTT/RetainMessages.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `RetainMessages` -Default Value: `true` - -Enable or disable the [Retain Flag](https://www.hivemq.com/blog/mqtt-essentials-part-8-retained-messages/) for all MQTT entries. diff --git a/param-docs/parameter-pages/MQTT/Uri.md b/param-docs/parameter-pages/MQTT/Uri.md deleted file mode 100644 index e7f93ab..0000000 --- a/param-docs/parameter-pages/MQTT/Uri.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `Uri` -Default Value: `mqtt://example.com:1883` - -URI to the MQTT broker including the port. E.g. `mqtt://192.168.1.1:1883`. diff --git a/param-docs/parameter-pages/MQTT/password.md b/param-docs/parameter-pages/MQTT/password.md deleted file mode 100644 index 7a87224..0000000 --- a/param-docs/parameter-pages/MQTT/password.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `password` -Default Value: `PASSWORD` - -Password for MQTT authentication. diff --git a/param-docs/parameter-pages/MQTT/user.md b/param-docs/parameter-pages/MQTT/user.md deleted file mode 100644 index 7a4230a..0000000 --- a/param-docs/parameter-pages/MQTT/user.md +++ /dev/null @@ -1,4 +0,0 @@ -# Parameter `user` -Default Value: `USERNAME` - -Username for MQTT authentication. diff --git a/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md b/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md deleted file mode 100644 index 4290f8c..0000000 --- a/param-docs/parameter-pages/PostProcessing/AllowNegativeRates.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `AllowNegativeRates` - -!!! Warning - This parameter is unused! - Use [`NUMBER.AllowNegativeRates`](../Parameters/#PostProcessing-NUMBER.AllowNegativeRates) instead! diff --git a/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md b/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md deleted file mode 100644 index 8612cd1..0000000 --- a/param-docs/parameter-pages/PostProcessing/CheckDigitIncreaseConsistency.md +++ /dev/null @@ -1,8 +0,0 @@ -# Parameter `CheckDigitIncreaseConsistency` -Default Value: `false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -An additional consistency check. -It especially improves the zero crossing check between digits. diff --git a/param-docs/parameter-pages/PostProcessing/ErrorMessage.md b/param-docs/parameter-pages/PostProcessing/ErrorMessage.md deleted file mode 100644 index 2213efb..0000000 --- a/param-docs/parameter-pages/PostProcessing/ErrorMessage.md +++ /dev/null @@ -1,8 +0,0 @@ -# Parameter `ErrorMessage` -Default Value: `true` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Do not show error message in return value. -In an error case, the last valid number will be used for the various transmission protocols (MQTT, InfluxDB, REST, ...). diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.AllowNegativeRates.md b/param-docs/parameter-pages/PostProcessing/NUMBER.AllowNegativeRates.md deleted file mode 100644 index 3bb7342..0000000 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.AllowNegativeRates.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `.AllowNegativeRates` -Default Value: `false` - -Allow a meter to count backwards (decreasing values). - -!!! Note - This is unusual (it means there is a negative rate) and not wanted in most cases! diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.AnalogDigitalTransitionStart.md b/param-docs/parameter-pages/PostProcessing/NUMBER.AnalogDigitalTransitionStart.md deleted file mode 100644 index d04831a..0000000 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.AnalogDigitalTransitionStart.md +++ /dev/null @@ -1,9 +0,0 @@ -# Parameter `.AnalogDigitalTransitionStart` -Default Value: `9.2` - -This can be used if you have wrong values, but the recognition of the individual ROIs are correct. -Look for the start of changing of the first digit and note the analog pointer value behind. -Set it here. Only used on combination of digits and analog pointers. -See [here](../Watermeter-specific-analog---digital-transition) for details. - -Range: `6.0` .. `9.9`. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.DecimalShift.md b/param-docs/parameter-pages/PostProcessing/NUMBER.DecimalShift.md deleted file mode 100644 index 604bb02..0000000 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.DecimalShift.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `.DecimalShift` -Default Value: `0` - -Shift the decimal separator (positiv or negativ). -Eg. to move from `m³` to `liter` (`1 m³` equals `1000 liters`), you need to set it to `+3`. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md b/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md deleted file mode 100644 index 3689e6f..0000000 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.ExtendedResolution.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `.ExtendedResolution` -Default Value: `false` - -Use the decimal place of the last analog counter for increased accuracy. - -!!! Note - This parameter is only supported on the `*-class*` and `*-const` models! See [Choosing-the-Model](../Choosing-the-Model) for details. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.IgnoreLeadingNaN.md b/param-docs/parameter-pages/PostProcessing/NUMBER.IgnoreLeadingNaN.md deleted file mode 100644 index 5fa11ab..0000000 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.IgnoreLeadingNaN.md +++ /dev/null @@ -1,6 +0,0 @@ -# Parameter `.IgnoreLeadingNaN` -Default Value: `true` - -Leading `N`'s will be deleted before further processing. -This is only relevant for models which use `N`! -See [here](../Choosing-the-Model) for details. diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateType.md b/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateType.md deleted file mode 100644 index aab9d29..0000000 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateType.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `.MaxRateType` -Default Value: `AbsoluteChange` - -Defines if the **Change Rate** is calculated as the difference between the last two readings (`AbsoluteChange` = difference) or -as the difference normalized to the interval (`RateChange` = difference per minute). diff --git a/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateValue.md b/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateValue.md deleted file mode 100644 index 98bb0af..0000000 --- a/param-docs/parameter-pages/PostProcessing/NUMBER.MaxRateValue.md +++ /dev/null @@ -1,6 +0,0 @@ -# Parameter `.MaxRateValue` -Default Value: `0,05` - -Maximum allowed change between two readings, if exceeded the last reading will be rejected. Depending on the settings of `.MaxRateType` the `MaxRateValue` is either treated as the difference between the two measurements (`AbsoluteChange` = difference) not taking the set time interval into account or as the difference normalized to the interval (`RateChange` = difference per minute). - -If negative rate is disallowed and no maximum rate value is set, one false high reading will lead to a period of missing measurements until the measurement reaches the previous false high reading. E.g. if the counter is at `600,00` and it's read incorrectly as` 610,00`, all measurements will be skipped until the counter reaches `610,00`. Setting the MaxRateValue to `0,05` leads to a rejection of all readings with a difference `> 0,05`, in this case `610,00`. The rejection also applies to correct readings with a difference `> 0,05`! diff --git a/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md b/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md deleted file mode 100644 index 0c5987b..0000000 --- a/param-docs/parameter-pages/PostProcessing/PreValueAgeStartup.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `PreValueAgeStartup` -Default Value: `720` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Time in minutes, how long a previous read value is valid after reboot. diff --git a/param-docs/parameter-pages/PostProcessing/PreValueUse.md b/param-docs/parameter-pages/PostProcessing/PreValueUse.md deleted file mode 100644 index 58f7198..0000000 --- a/param-docs/parameter-pages/PostProcessing/PreValueUse.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `PreValueUse` -Default Value: `true` - -Use the previous value (value from previous round) for consistency checks. -This also works through a reboot of the device! diff --git a/param-docs/parameter-pages/System/CPUFrequency.md b/param-docs/parameter-pages/System/CPUFrequency.md deleted file mode 100644 index 9715279..0000000 --- a/param-docs/parameter-pages/System/CPUFrequency.md +++ /dev/null @@ -1,13 +0,0 @@ -# Parameter `CPUFrequency` -Default Value: `160` - -Set the CPU Frequency. - -!!! Warning - Setting it to 240 will lead to a faster device, but it will also require a stronger power supply! - Additionally, depending on the quality of your ESP32-CAM, it might run unstable! - -Possible values: - -- 160 -- 240 diff --git a/param-docs/parameter-pages/System/Hostname.md b/param-docs/parameter-pages/System/Hostname.md deleted file mode 100644 index 347ce76..0000000 --- a/param-docs/parameter-pages/System/Hostname.md +++ /dev/null @@ -1,8 +0,0 @@ -# Parameter `Hostname` -Default Value: `undefined` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Hostname for the device. -It gets automatically transferred to `/wlan.ini` on the SD-Card at the next startup. diff --git a/param-docs/parameter-pages/System/RSSIThreshold.md b/param-docs/parameter-pages/System/RSSIThreshold.md deleted file mode 100644 index a7f5ec5..0000000 --- a/param-docs/parameter-pages/System/RSSIThreshold.md +++ /dev/null @@ -1,19 +0,0 @@ -# Parameter `RSSIThreshold` -Default Value: `0` - -Possible values: `-100` .. `0` (`0` = disabled). - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - - -This parameter activates a client triggered AP switching functionality (simplified roaming). -If actual RSSI value is lower (more negative) than `RSSIThreshold`, all WIFI channels will be scanned for configured access point SSID. If an access point is in range which has better RSSI value (less negative) than actual RSSI value + 5 dBm, the device is trying to connect to this access point with the better RSSI value. - - -!!! Note - The RSSI check only gets initiated at the end of each round to avoid any disturbance of processing. - - -!!! Note - It gets automatically transferred to `/wlan.ini` on the SD-Card at next startup. diff --git a/param-docs/parameter-pages/System/SetupMode.md b/param-docs/parameter-pages/System/SetupMode.md deleted file mode 100644 index 18fcdaa..0000000 --- a/param-docs/parameter-pages/System/SetupMode.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `SetupMode` -Default Value: `true` - -!!! Note - This parameter is not accessible through the Web Interface Configuration Page! - -Set this parameter to `true` to stay in the Setup Mode after the next start of the device. diff --git a/param-docs/parameter-pages/System/TimeServer.md b/param-docs/parameter-pages/System/TimeServer.md deleted file mode 100644 index f10713d..0000000 --- a/param-docs/parameter-pages/System/TimeServer.md +++ /dev/null @@ -1,10 +0,0 @@ -# Parameter `TimeServer` -Default Value: `pool.ntp.org` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Time server to synchronize system time. If it is disabled or `undefined`, `pool.ntp.org` will be used. -You can also set it to the IP of your router. Many routers like Fritzboxes can act as a local NTP server. -To disable NTP, you need to activate it but set the TimeServer config to be empty (`""`). -In such case the time always starts at `01.01.1970` after each power cycle! diff --git a/param-docs/parameter-pages/System/TimeZone.md b/param-docs/parameter-pages/System/TimeZone.md deleted file mode 100644 index fb6dfea..0000000 --- a/param-docs/parameter-pages/System/TimeZone.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `TimeZone` -Default Value: `CET-1CEST,M3.5.0,M10.5.0/3` - -Time zone in POSIX syntax (Europe/Berlin = `CET-1CEST,M3.5.0,M10.5.0/3` - incl. daylight saving) -Check the table on `http:///timezones.html` to find the settings for your region. diff --git a/param-docs/parameter-pages/TakeImage/Brightness.md b/param-docs/parameter-pages/TakeImage/Brightness.md deleted file mode 100644 index b3cbd77..0000000 --- a/param-docs/parameter-pages/TakeImage/Brightness.md +++ /dev/null @@ -1,10 +0,0 @@ -# Parameter `Brightness` -Default Value: `0` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -!!! Note - This parameter can also be set on the Reference Image configuration. - -Image Brightness (`-2` .. `2`) diff --git a/param-docs/parameter-pages/TakeImage/Contrast.md b/param-docs/parameter-pages/TakeImage/Contrast.md deleted file mode 100644 index 6aa07ca..0000000 --- a/param-docs/parameter-pages/TakeImage/Contrast.md +++ /dev/null @@ -1,11 +0,0 @@ -# Parameter `Contrast` -Default Value: `0` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -!!! Note - This parameter can also be set on the Reference Image configuration. - -Image Contrast (`-2` .. `2`) - diff --git a/param-docs/parameter-pages/TakeImage/Demo.md b/param-docs/parameter-pages/TakeImage/Demo.md deleted file mode 100644 index 985b683..0000000 --- a/param-docs/parameter-pages/TakeImage/Demo.md +++ /dev/null @@ -1,6 +0,0 @@ -# Parameter `Demo` -Default Value: `false` - -Enable to use demo images instead of the real camera images. -Make sure to have a `/demo` folder on your SD-Card and it contains the expected files! -Check [here](../Demo-Mode) for details. diff --git a/param-docs/parameter-pages/TakeImage/FixedExposure.md b/param-docs/parameter-pages/TakeImage/FixedExposure.md deleted file mode 100644 index 2491e06..0000000 --- a/param-docs/parameter-pages/TakeImage/FixedExposure.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `FixedExposure` -Default Value: `false` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Fixes the illumination setting of camera at the startup and uses this later -> Individual round is faster. diff --git a/param-docs/parameter-pages/TakeImage/ImageQuality.md b/param-docs/parameter-pages/TakeImage/ImageQuality.md deleted file mode 100644 index 7f5c4c0..0000000 --- a/param-docs/parameter-pages/TakeImage/ImageQuality.md +++ /dev/null @@ -1,10 +0,0 @@ -# Parameter `ImageQuality` -Default Value: `12` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Quality index for pictures: `8` (highest quality) ... `63` (lowest quality) - -!!! Warning - Value below 12 could result in system instabilities! diff --git a/param-docs/parameter-pages/TakeImage/ImageSize.md b/param-docs/parameter-pages/TakeImage/ImageSize.md deleted file mode 100644 index 73531f3..0000000 --- a/param-docs/parameter-pages/TakeImage/ImageSize.md +++ /dev/null @@ -1,12 +0,0 @@ -# Parameter `ImageSize` -Default Value: `VGA` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Size of the camera picture. - -Available options: - -- `VGA` (640 x 480 pixel) -- `QVGA` (320 x 240 pixel) diff --git a/param-docs/parameter-pages/TakeImage/LEDIntensity.md b/param-docs/parameter-pages/TakeImage/LEDIntensity.md deleted file mode 100644 index 19bfadc..0000000 --- a/param-docs/parameter-pages/TakeImage/LEDIntensity.md +++ /dev/null @@ -1,8 +0,0 @@ -# Parameter `LEDIntensity` -Default Value: `50` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - This parameter can also be set on the Reference Image configuration. - -Set the Flash LED Intensity: (`0` .. `100`) diff --git a/param-docs/parameter-pages/TakeImage/RawImagesLocation.md b/param-docs/parameter-pages/TakeImage/RawImagesLocation.md deleted file mode 100644 index 0b53a93..0000000 --- a/param-docs/parameter-pages/TakeImage/RawImagesLocation.md +++ /dev/null @@ -1,7 +0,0 @@ -# Parameter `RawImagesLocation` -Default Value: `/log/source` - -Location on the SD-Card to store the raw images. - -!!! Warning - A SD-Card has limited write cycles. Since the device does not do [Wear Leveling](https://en.wikipedia.org/wiki/Wear_leveling), this can wear out your SD-Card! diff --git a/param-docs/parameter-pages/TakeImage/RawImagesRetention.md b/param-docs/parameter-pages/TakeImage/RawImagesRetention.md deleted file mode 100644 index e14e79b..0000000 --- a/param-docs/parameter-pages/TakeImage/RawImagesRetention.md +++ /dev/null @@ -1,6 +0,0 @@ -# Parameter `RawImagesRetention` -Default Value: `15` - -Unit: Days - -Number of days to keep the raw images (`0` = forever) diff --git a/param-docs/parameter-pages/TakeImage/Saturation.md b/param-docs/parameter-pages/TakeImage/Saturation.md deleted file mode 100644 index 1fc2193..0000000 --- a/param-docs/parameter-pages/TakeImage/Saturation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Parameter `Saturation` -Default Value: `0` - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -!!! Note - This parameter can also be set on the Reference Image configuration. - -Image Saturation (`-2` .. `2`) - diff --git a/param-docs/parameter-pages/TakeImage/WaitBeforeTakingPicture.md b/param-docs/parameter-pages/TakeImage/WaitBeforeTakingPicture.md deleted file mode 100644 index f657751..0000000 --- a/param-docs/parameter-pages/TakeImage/WaitBeforeTakingPicture.md +++ /dev/null @@ -1,9 +0,0 @@ -# Parameter `WaitBeforeTakingPicture` -Default Value: `5` - -Unit: seconds - -!!! Warning - This is an **Expert Parameter**! Only change it if you understand what it does! - -Waiting time between switching the flash light (onboard LED) on and taking the picture. diff --git a/param-docs/parameter-pages/img/flipImageSize.png b/param-docs/parameter-pages/img/flipImageSize.png deleted file mode 100644 index dd761aa..0000000 Binary files a/param-docs/parameter-pages/img/flipImageSize.png and /dev/null differ diff --git a/param-docs/templates/overview-old.md b/param-docs/templates/overview-old.md deleted file mode 100644 index 512b7b6..0000000 --- a/param-docs/templates/overview-old.md +++ /dev/null @@ -1,13 +0,0 @@ -# Parameters -This page lists all available [Configuration](../Configuration) Parameters. -If a parameter or section has a tick box on its left side, you can disable it. -In such case the functionality gets disabled respectively the default values will be used. - -!!! Note - This is an auto-generated page! See the [README](https://github.com/jomjol/AI-on-the-edge-device-docs/blob/main/README.md) for details! - -## List of all Parameters - -$TOC - -
\ No newline at end of file diff --git a/param-docs/templates/overview.md b/param-docs/templates/overview.md deleted file mode 100644 index b34eafe..0000000 --- a/param-docs/templates/overview.md +++ /dev/null @@ -1,9 +0,0 @@ -# Parameters -This page lists all available [Configuration](../Configuration) Parameters. -If a **parameter** or **section** has a tick box on its left side, you can disable it. -In such case the functionality gets disabled respectively the default values will be used. - -!!! Note - This is an auto-generated page! See the [README](https://github.com/jomjol/AI-on-the-edge-device-docs/blob/main/README.md) for details! - -
\ No newline at end of file diff --git a/param-docs/templates/parameter.md b/param-docs/templates/parameter.md deleted file mode 100644 index 7ea165f..0000000 --- a/param-docs/templates/parameter.md +++ /dev/null @@ -1,5 +0,0 @@ -# Parameter `$NAME` -Default Value: `$DEFAULT` -$EXPERT_PARAMETER -$HIDDEN_IN_UI -Please fill me with an explanation and useful links.