added an overlay to the WebUI and some ConnectionHandling

Software/.gitignore

@@ -1,7 +1,5 @@
 data/
 .pio
-.vscode/.browse.c_cpp.db*
+.vscode
-.vscode/c_cpp_properties.json
+wifi_credentials.ini
-.vscode/launch.json
+__pycache__
-.vscode/ipch
-wifi_credentials.ini

Software/.vscode/extensions.json

@@ -1,10 +0,0 @@
-{
-    // See http://go.microsoft.com/fwlink/?LinkId=827846
-    // for the documentation about the extensions.json format
-    "recommendations": [
-        "platformio.platformio-ide"
-    ],
-    "unwantedRecommendations": [
-        "ms-vscode.cpptools-extension-pack"
-    ]
-}

Software/codegen/dtcs.py

@@ -0,0 +1,145 @@
+import os
+import time
+from jinja2 import Environment, FileSystemLoader
+import json
+import sys
+
+import filechecksum as fcs
+
+def build_dtcs():
+    # Pfad zur Eingabedatei und Ausgabedatei
+    input_file = "src/dtc_defs.txt"
+    output_file = "include/dtc_defs.h"
+    json_output_file = "data_src/static/dtc_table.json"
+    
+    # Überprüfen, ob das Verzeichnis existiert, andernfalls erstellen
+    json_output_dir = os.path.dirname(json_output_file)
+    if not os.path.exists(json_output_dir):
+        os.makedirs(json_output_dir)
+    
+    # Mehrdimensionales Array zum Speichern der Zeilen aus der Eingabedatei
+    dtc_lines = []
+    
+    # Lesen und analysieren der Eingabedatei
+    with open(input_file, "r", encoding="utf-8") as f:
+        for line in f:
+            line = line.strip()
+            if not line or line.startswith("#"):
+                continue
+    
+            parts = line.split(";")
+            if len(parts) == 5:
+                num, dtc_name, dtc_severity, title, description = [part.strip() for part in parts]
+                dtc_lines.append([int(num), dtc_name, dtc_severity, title, description])
+    
+    # Überprüfen auf Duplikate in den DTC-Nummern und DTC-Namen
+    num_set = set()
+    dtc_name_set = set()
+    duplicates = []
+    
+    for line in dtc_lines:
+        num, dtc_name, _, _, _ = line
+        if num in num_set:
+            duplicates.append(f"DTC-Nummer {num} ist ein Duplikat.")
+        else:
+            num_set.add(num)
+    
+        if dtc_name in dtc_name_set:
+            duplicates.append(f"DTC-Name '{dtc_name}' ist ein Duplikat.")
+        else:
+            dtc_name_set.add(dtc_name)
+    
+    if duplicates:
+        for duplicate in duplicates:
+            print(f"Fehler: {duplicate}")
+        raise ValueError("Duplicate DTC Data detected")
+    
+    # Suchen nach DTC_NO_DTC und DTC_LAST_DTC
+    dtc_no_dtc_added = False
+    dtc_last_dtc_line = None
+    
+    for line in dtc_lines:
+        _, dtc_name, _, _, _ = line
+        if dtc_name == "DTC_NO_DTC":
+            dtc_no_dtc_added = True
+        elif dtc_name == "DTC_LAST_DTC":
+            dtc_last_dtc_line = line
+    
+    # Einen DTC für DTC_NO_DTC hinzufügen (wenn nicht vorhanden)
+    if not dtc_no_dtc_added:
+        dtc_lines.insert(0, [0, "DTC_NO_DTC", "DTC_NONE", "No Error", "No Error"])
+    
+    # Falls DTC_LAST_DTC existiert, lösche es
+    if dtc_last_dtc_line:
+        dtc_lines.remove(dtc_last_dtc_line)
+    
+    # Einen DTC für DTC_LAST_DTC hinzufügen (mit der höchsten Nummer)
+    if dtc_lines:
+        highest_num = max([line[0] for line in dtc_lines])
+    else:
+        highest_num = 0
+    
+    dtc_lines.append([highest_num + 1, "DTC_LAST_DTC", "DTC_NONE", "Last Error", "Last Error"])
+    
+    # Sortieren der Zeilen nach der Nummer aufsteigend
+    dtc_lines.sort(key=lambda x: x[0])
+    
+    checksum = fcs.calculate_checksum(dtc_lines)
+    timestamp = int(time.time())
+    
+    if fcs.read_and_compare_checksum(output_file, checksum):
+        print("Keine Änderungen im DTC-Headerfile erforderlich.")
+    else:
+        # DTC_NAME_CONSTANT-Makros initialisieren
+        dtc_macros = []
+        dtc_structs = []
+    
+        # Verarbeiten der sortierten Zeilen
+        for i, line in enumerate(dtc_lines):
+            num, dtc_name, dtc_severity, title, description = line
+            dtc_macros.append(f"#define {dtc_name:<30} {num}")
+            comma = "," if i < len(dtc_lines) - 1 else " "
+            dtc_structs.append(f"    {{ {dtc_name:<30}, {dtc_severity:<12} }}{comma} // {description}")
+    
+        env = Environment(loader=FileSystemLoader('codegen/templates', encoding='utf-8'))
+        # Lade das Jinja2-Template aus der Datei
+        template = env.get_template('dtc_defs.h.j2')
+    
+        # Erstelle ein Context-Dictionary mit den erforderlichen Daten
+        context = {
+            'timestamp_unix': timestamp,
+            'timestamp' : time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(timestamp)),
+            'date' : time.strftime('%d.%m.%Y', time.localtime(timestamp)),
+            'dtc_macros': dtc_macros,  # Übergebe die dtc_macros-Liste direkt
+            'dtc_structs': dtc_structs,  # Übergebe die dtc_structs-Liste direkt
+            'checksum' : checksum
+        }
+   
+        # Rendere das Template mit den Werten und erhalte den Header-Text
+        header_text = template.render(context)
+    
+        # Schreibe den generierten Header-Text in die Header-Datei
+        with open(output_file, "w", encoding='utf-8') as f:
+            f.write(header_text)
+    
+        print(f"Header-Datei wurde erstellt: {output_file}")
+    
+    if fcs.read_and_compare_json_checksum(json_output_file, checksum):
+        print("Keine Änderungen im DTC-JSON-file erforderlich.")
+    else:
+        dtc_info = {
+            "codegenerator_checksum": checksum,
+            'timestamp' : time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(timestamp)),
+            "dtc_table_data": []
+        }
+    
+        # Verarbeiten der sortierten Zeilen
+        for i, line in enumerate(dtc_lines):
+            num, dtc_name, dtc_severity, title, description = line
+            dtc_info["dtc_table_data"].append({"num": num, "title": title, "description": description})
+
+        # JSON-Datei mit UTF-8-Zeichencodierung erstellen
+        with open(json_output_file, 'w', encoding='utf-8') as json_f:
+            json.dump(dtc_info, json_f, ensure_ascii=False, indent=4, separators=(',', ': '))
+    
+        print(f"JSON-Datei wurde erstellt: {json_output_file}")

Software/codegen/filechecksum.py

@@ -0,0 +1,45 @@
+
+import hashlib
+import json
+
+# Funktion zum Berechnen der SHA-256-Checksumme
+def calculate_checksum(data):
+    sha256 = hashlib.sha256()
+    sha256.update(str(data).encode('utf-8'))
+    return sha256.hexdigest()
+
+# Funktion zum Lesen und Vergleichen der Checksumme in einer Datei
+def read_and_compare_checksum(file_path, expected_checksum):
+    try:
+        with open(file_path, 'r') as file:
+            content = file.read()
+            # Suche nach der Zeile mit der Checksumme
+            checksum_line_start = content.find("// CODEGENERATOR_CHECKSUM:")
+            if checksum_line_start != -1:
+                # Extrahiere die Checksumme aus der Zeile
+                existing_checksum = content[checksum_line_start + len("// CODEGENERATOR_CHECKSUM:"):].strip()
+                # Vergleiche die Checksummen
+                if existing_checksum == expected_checksum:
+                    return True
+    except FileNotFoundError:
+        pass  # Datei existiert nicht, was nicht schlimm ist
+
+    return False
+
+def read_and_compare_json_checksum(json_file_path, expected_checksum):
+    try:
+        with open(json_file_path, 'r') as json_file:
+            # Lade das JSON aus der Datei
+            data = json.load(json_file)
+            
+            # Überprüfe, ob "codegenerator_checksum" im JSON vorhanden ist
+            if "codegenerator_checksum" in data:
+                existing_checksum = data["codegenerator_checksum"]
+                
+                # Vergleiche die Checksummen
+                if existing_checksum == expected_checksum:
+                    return True
+    except FileNotFoundError:
+        pass  # Datei existiert nicht, was nicht schlimm ist
+
+    return False

Software/codegen/prepare_littlefs.py

@@ -6,9 +6,59 @@ import glob
 import shutil
 import gzip
 import os
+import subprocess
 Import("env")
 Import("projenv")
 
+# Setze die Pfade zu den Tools als Variablen
+html_minifier_path = os.path.join(os.getenv("APPDATA"), "npm", "html-minifier.cmd")
+uglifyjs_path = os.path.join(os.getenv("APPDATA"), "npm", "uglifyjs.cmd")
+terser_path = os.path.join(os.getenv("APPDATA"), "npm", "terser.cmd")
+cssnano_path = os.path.join(os.getenv("APPDATA"), "npm", "cssnano.cmd")
+
+
+def minify_html(input_path, output_path):
+    subprocess.run([html_minifier_path, '--collapse-whitespace', '--remove-comments', input_path, '-o', output_path])
+
+def minify_js(input_path, output_path):
+    subprocess.run([terser_path, input_path, '-o', output_path, '-c', '-m'])
+
+def minify_css(input_path, output_path):
+    subprocess.run([cssnano_path, '--no-discardUnused', input_path, output_path])
+
+def process_file(src_path, dest_path):
+    _, file_extension = os.path.splitext(src_path)
+
+    # Extrahiere den Ordnerpfad im Zielverzeichnis
+    dest_dir = os.path.dirname(dest_path)
+
+    # Erstelle den Ordner und alle dazugehörigen Unterordner, falls sie nicht existieren
+    os.makedirs(dest_dir, exist_ok=True)
+
+    if file_extension.lower() == '.js':
+        minify_js(src_path, dest_path)
+    elif file_extension.lower() == '.css':
+        minify_css(src_path, dest_path)
+    elif file_extension.lower() in ['.html', '.htm']:
+        minify_html(src_path, dest_path)
+    else:
+        # Kopiere nicht bearbeitbare Dateien direkt in den Zielordner
+        shutil.copy2(src_path, dest_path)
+
+def strip_files(src_dir, dest_dir):
+    # Erstelle den Zielordner und alle dazugehörigen Unterordner, falls sie nicht existieren
+    os.makedirs(dest_dir, exist_ok=True)
+
+    # Durchlaufe alle Dateien und Unterverzeichnisse im Quellordner
+    for root, _, files in os.walk(src_dir):
+        for filename in files:
+            src_path = os.path.join(root, filename)
+            dest_path = os.path.relpath(src_path, src_dir)
+            dest_path = os.path.join(dest_dir, dest_path)
+
+            # Verarbeite nur Dateien (keine Unterverzeichnisse)
+            process_file(src_path, dest_path)
+
 
 def gzip_file(src_path, dst_path):
 
@@ -47,14 +97,16 @@ def gzip_webfiles(source, target, env):
     filetypes_to_gzip = ['.css', '.png', '.js', '.ico', '.woff2', '.json']
     print('\nGZIP: Starting gzip-Process for LittleFS-Image...\n')
     data_src_dir_path = os.path.join(env.get('PROJECT_DIR'), 'data_src')
+    data_temp_dir_path = os.path.join(env.get('PROJECT_DIR'), 'data_stripped')
+    strip_files(data_src_dir_path, data_temp_dir_path)
     data_dir_path = env.get('PROJECT_DATA_DIR')
     # check if data and datasrc exist. If the first exists and not the second, it renames it
-    if(os.path.exists(data_dir_path) and not os.path.exists(data_src_dir_path)):
+    if(os.path.exists(data_dir_path) and not os.path.exists(data_temp_dir_path)):
         print('GZIP: Directory "'+data_dir_path +
-              '" exists, "'+data_src_dir_path+'" is not found.')
+              '" exists, "'+data_temp_dir_path+'" is not found.')
         print('GZIP: Renaming "' + data_dir_path +
-              '" to "' + data_src_dir_path + '"')
+              '" to "' + data_temp_dir_path + '"')
-        os.rename(data_dir_path, data_src_dir_path)
+        os.rename(data_dir_path, data_temp_dir_path)
     # Delete the 'data' directory
     if(os.path.exists(data_dir_path)):
         print('GZIP: Deleting the "data" directory ' + data_dir_path)
@@ -67,27 +119,27 @@ def gzip_webfiles(source, target, env):
     files_to_copy = []
     files_to_gzip = []
 
-    all_data_src = getListOfFiles(data_src_dir_path)
+    all_data_src = getListOfFiles(data_temp_dir_path)
     for file in all_data_src:
         file_name, file_extension = os.path.splitext(file)
         print(file_name + " has filetype " + file_extension)
         if file_extension in filetypes_to_gzip:
             files_to_gzip.append(file)
         else:
-            filename_subdir = remove_prefix(file, data_src_dir_path)
+            filename_subdir = remove_prefix(file, data_temp_dir_path)
             files_to_copy.append(filename_subdir)
 
     for file in files_to_copy:
-        print('GZIP: Copying file from: ' + data_src_dir_path + file + ' to: ' + data_dir_path + file)
+        print('GZIP: Copying file from: ' + data_temp_dir_path + file + ' to: ' + data_dir_path + file)
         os.makedirs(os.path.dirname(data_dir_path + file), exist_ok=True)
-        shutil.copy(data_src_dir_path + file, data_dir_path + file)
+        shutil.copy(data_temp_dir_path + file, data_dir_path + file)
     # Compress and move files
     
     was_error = False
     try:
         for source_file_path in files_to_gzip:
             print('GZIP: compressing... ' + source_file_path)
-            filename_subdir = remove_prefix(source_file_path, data_src_dir_path)
+            filename_subdir = remove_prefix(source_file_path, data_temp_dir_path)
             target_file_path = data_dir_path + filename_subdir
             os.makedirs(os.path.dirname(target_file_path), exist_ok=True)
             print('GZIP: Compressed... ' + target_file_path)
@@ -100,6 +152,7 @@ def gzip_webfiles(source, target, env):
         print('GZIP: Failure/Incomplete.\n')
     else:
         print('GZIP: Compressed correctly.\n')
+        shutil.rmtree(data_temp_dir_path)
 
     return
  

Software/codegen/run_pre.py

@@ -0,0 +1,9 @@
+Import("env")  # pylint: disable=undefined-variable
+env.Execute("\"$PYTHONEXE\" -m pip install jinja2")
+env.Replace(PROGNAME="firmware_pcb_1.%s.fw" % env.GetProjectOption("custom_pcb_revision"))
+
+import struct2json
+import dtcs
+
+struct2json.struct2json()
+dtcs.build_dtcs()

Software/codegen/struct2json.py

@@ -0,0 +1,108 @@
+import os
+import time
+from jinja2 import Environment, FileSystemLoader
+import re
+
+import filechecksum as fcs
+
+# Pfad zur Eingabedatei und Ausgabedatei
+input_file = "include/config.h"
+output_sourcefile = "src/struct2json.cpp"
+output_headerfile = "include/struct2json.h"
+# Liste der zu suchenden Variablen/Structs
+variable_names = ['LubeConfig', 'PersistenceData']
+
+def get_types(file_content, variable_names):
+    result = {}
+    
+    # Entferne Kommentare, um unerwünschte Störungen zu vermeiden
+    file_content = re.sub(r'\/\*.*?\*\/', '', file_content, flags=re.DOTALL)
+    file_content = re.sub(r'\/\/.*', '', file_content)
+    
+    for var_name in variable_names:
+        # Erstelle ein reguläres Ausdrucksmuster, um den Typ der Variable zu extrahieren
+        pattern = re.compile(r'\b(?:extern\s+)?(\w+)\s+' + re.escape(var_name) + r'\s*;')
+        match = pattern.search(file_content)
+        
+        if match:
+            # Extrahiere den Typ aus dem Treffer
+            type_match = match.group(1)
+            result[var_name] = type_match
+
+    return result
+
+def extract_struct_fields(file_content, variable_types):
+    result = {}
+
+    # Entferne Kommentare, um unerwünschte Störungen zu vermeiden
+    file_content = re.sub(r'\/\*.*?\*\/', '', file_content, flags=re.DOTALL)
+    file_content = re.sub(r'\/\/.*', '', file_content)
+
+    for var_name, var_type in variable_types.items():
+        # Erstelle ein reguläres Ausdrucksmuster, um das Strukturfeld zu extrahieren
+        pattern = re.compile(r'typedef\s+struct\s*{([^}]*)}\s*' + re.escape(var_type) + r'\s*;')
+        match = pattern.search(file_content)
+
+        if match:
+            # Extrahiere die Felder aus dem Treffer
+            fields_match = re.findall(r'\b(\w+)\s+(\w+)\s*;', match.group(1))
+            if fields_match:
+                result[var_name] = {'type': var_type, 'fields': {field_name: field_type for field_type, field_name in fields_match}}
+
+    return result
+
+def struct2json():
+    # Überprüfen, ob die Verzeichnisse existieren, andernfalls erstellen
+    output_dir_source = os.path.dirname(output_sourcefile)
+    if not os.path.exists(output_dir_source):
+        os.makedirs(output_dir_source)
+    output_dir_header = os.path.dirname(output_headerfile)
+    if not os.path.exists(output_dir_header):
+        os.makedirs(output_dir_header)
+
+    # Unix-Zeitstempel hinzufügen
+    timestamp = int(time.time())
+
+    # Parse structs
+    with open(input_file, 'r') as file:
+        content = file.read()
+
+    variable_types = get_types(content, variable_names)
+    structs = extract_struct_fields(content, variable_types)
+    checksum = fcs.calculate_checksum(structs)
+
+    env = Environment(loader=FileSystemLoader('codegen/templates', encoding='utf-8'))
+    # Lade das Jinja2-Template aus der Datei
+    template_c = env.get_template('struct2json.cpp.j2')
+    template_h = env.get_template('struct2json.h.j2')
+
+    # Erstelle ein Context-Dictionary mit den erforderlichen Daten
+    context = {
+        'timestamp_unix': timestamp,
+        'timestamp' : time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(timestamp)),
+        'date' : time.strftime('%d.%m.%Y', time.localtime(timestamp)),
+        'structs': structs,
+        'checksum': checksum
+    }
+
+    # Überprüfe, ob die Checksummen übereinstimmen
+    if fcs.read_and_compare_checksum(output_sourcefile, checksum):
+        print("Keine Änderungen in der Source-Datei erforderlich.")
+    else:
+        # Rendere das Template mit den Werten und erhalte den Source-Text
+        source_text = template_c.render(context)
+        # Schreibe den generierten Source-Text in die Source-Datei
+        with open(output_sourcefile, "w", encoding='utf-8') as f:
+            f.write(source_text)
+        print(f"Source-Datei wurde erstellt: {output_sourcefile}")
+
+    # Überprüfe, ob die Checksummen übereinstimmen
+    if fcs.read_and_compare_checksum(output_headerfile, checksum):
+        print("Keine Änderungen in der Header-Datei erforderlich.")
+    else:
+        # Rendere das Template mit den Werten und erhalte den Header-Text
+        header_text = template_h.render(context)
+        # Schreibe den generierten Header-Text in die Header-Datei
+        with open(output_headerfile, "w", encoding='utf-8') as f:
+            f.write(header_text)
+        print(f"Header-Datei wurde erstellt: {output_headerfile}")

Software/codegen/templates/dtc_defs.h.j2

@@ -0,0 +1,54 @@
+/**
+ * @file dtc_defs.h
+ *
+ * @brief Header file for Diagnostic Trouble Code (DTC) definitions in the ChainLube application.
+ *
+ * This file contains definitions for Diagnostic Trouble Codes (DTC) in the ChainLube project.
+ * It includes enums for DTC active status, severity levels, and specific DTC codes.
+ * The file also defines an array of DTC definitions and a timestamp indicating the generation time.
+ *
+ * @note This file is auto-generated by a script on {{ timestamp }}.
+ *
+ * @author Marcel Peterkau
+ * @date   {{ date }}
+ */
+
+#ifndef DTC_DEFS_H
+#define DTC_DEFS_H
+
+#include <stdint.h>
+
+typedef uint32_t DTCNum_t;
+
+typedef enum
+{
+  DTC_INACTIVE,
+  DTC_ACTIVE,
+  DTC_PREVIOUS
+} DTCActive_t;
+
+typedef enum
+{
+  DTC_NONE,
+  DTC_INFO,
+  DTC_WARN,
+  DTC_CRITICAL
+} DTCSeverity_t;
+
+typedef struct {
+  DTCNum_t code;
+  DTCSeverity_t severity;
+} DTC_t;
+
+{% for dtc in dtc_macros -%}
+{{ dtc }}
+{% endfor %}
+const DTC_t dtc_definitions[] = {
+{% for struct in dtc_structs -%}
+{{ struct }}
+{% endfor -%}
+};
+
+#endif // DTC_DEFS_H
+
+// CODEGENERATOR_CHECKSUM: {{ checksum }}

Software/codegen/templates/struct2json.cpp.j2

@@ -0,0 +1,25 @@
+/**
+ * @file struct2json.cpp
+ *
+ * @brief Implementation file for converting structs to JSON objects.
+ *
+ * @note This file is auto-generated by a script on {{ timestamp }}.
+ *
+ * @author Marcel Peterkau
+ * @date   {{ date }}
+ */
+
+
+#include "struct2json.h"
+
+{% for var_name, var_info in structs.items() -%}
+void generateJsonObject_{{ var_name }}(JsonObject& data)
+{
+    {% for field_name, field_type in var_info['fields'].items() -%}
+    data["{{ field_name }}"] = {{ var_name }}.{{ field_name }};
+    {% endfor -%}
+}
+
+{% endfor %}
+
+// CODEGENERATOR_CHECKSUM: {{ checksum }}

Software/codegen/templates/struct2json.h.j2

@@ -0,0 +1,26 @@
+/**
+ * @file struct2json.h
+ *
+ * @brief Header file for converting structs to JSON objects.
+ *
+ * @note This file is auto-generated by a script on {{ timestamp }}.
+ *
+ * @author Marcel Peterkau
+ * @date   {{ date }}
+ */
+
+#ifndef _STRUCT2JSON_H_
+#define _STRUCT2JSON_H_
+
+#include <Arduino.h>
+#include <ArduinoJson.h>
+
+#include "config.h"
+
+{% for var_name, var_info in structs.items() -%}
+void generateJsonObject_{{ var_name }}(JsonObject& data);
+{% endfor %}
+
+#endif /* _STRUCT2JSON_H_ */
+
+// CODEGENERATOR_CHECKSUM: {{ checksum }}

Software/data_src/index.htm

@@ -11,6 +11,8 @@
   <script src="static/js/jquery.min.js"></script>
   <script src="static/js/bootstrap.min.js"></script>
   <script src="static/js/websocket.js"></script>
+  <script src="static/js/dtc_table.js"></script>
+  <script src="static/js/script.js"></script>
   <link rel="apple-touch-icon" sizes="180x180" href="static/img/apple-touch-icon.png">
   <link rel="icon" type="image/png" sizes="32x32" href="static/img/favicon-32x32.png">
   <link rel="icon" type="image/png" sizes="16x16" href="static/img/favicon-16x16.png">
@@ -18,7 +20,14 @@
 </head>
 
 <body>
-
+  <!-- Connection-Overlay -->
+  <div id="overlay">
+    <div class="overlay-content">
+      <p>Verbinde...</p>
+      <!-- Hier können Sie eine einfache Animation hinzufügen -->
+    </div>
+  </div>
+  <!-- Connection-Overlay -->
   <nav class="navbar fixed-top navbar-dark bg-primary" id="navbar1">
     <a class="navbar-brand" href="#">
       <img src="static/img/logo.png" width="30" height="30" class="d-inline-block align-top mr-1" alt="">
@@ -33,10 +42,8 @@
       <ul class="navbar-nav nav mr-auto mt-2 mt-lg-0">
 
         <li class="nav-item"><a class="nav-link active" role="tab" data-toggle="tab" href="#tab_home">Home</a></li>
-        <li class="nav-item"><a class="nav-link" role="tab" data-toggle="tab" href="#tab_source">Wegstrecke</a></li>
-        <li class="nav-item"><a class="nav-link" role="tab" data-toggle="tab" href="#tab_lube">Schmierung</a></li>
         <li class="nav-item"><a class="nav-link" role="tab" data-toggle="tab" href="#tab_maintenance">Wartung</a></li>
-        <li class="nav-item"><a class="nav-link" role="tab" data-toggle="tab" href="#tab_sysinfo">Systeminfo</a></li>
+        <li class="nav-item"><a class="nav-link" role="tab" data-toggle="tab" href="#tab_source">Einstellungen</a></li>
         <li class="nav-item"><a class="nav-link" role="tab" data-toggle="tab" href="#tab_fwupdate">Update</a></li>
 
       </ul>
@@ -55,26 +62,31 @@
             <h3 class="pt-3">KTM CAN Chain Lube</h3>
           </div>
         </div>
+        <!-- Div Group Tank remain -->
         <hr />
         <p>
         <h4>Tankinhalt verbleibend</h4>
         <div class="progress">
-          <div class="progress-bar text-light" role="progressbar" aria-valuenow="%TANK_REMAIN_CAPACITY%"
+          <div id="tankremain" class="data-tankremain progress-bar text-light" role="progressbar" aria-valuenow="0"
-            aria-valuemin="0" aria-valuemax="100" style="width: %TANK_REMAIN_CAPACITY%&#37;">
+            aria-valuemin="0" aria-valuemax="100" style="width: 0%">
-            %TANK_REMAIN_CAPACITY%&#37;
+            0
           </div>
         </div>
         </p>
+        <!-- Div Group Tank remain -->
+        <!-- Div Group current Mode -->
         <hr />
         <p>
         <h4>aktueller Modus</h4>
-        <input class="form-control" type="text" placeholder="%SYSTEM_STATUS%" readonly>
+        <input class="data-systemstatus form-control" type="text" id="sysstatus" readonly>
         </p>
-        <hr />
+        <!-- Div Group current Mode -->
-        <div %SHOW_DTC_TABLE%>
+        <!-- Div Group DTC Table -->
+        <div id="dtc_container" hidden>
+          <hr />
           <p>
           <h4>Fehlercodes</h4>
-          <table class="table">
+          <table class="table" id="dtc_table">
             <tbody>
               <tr>
                 <th class="col-6" scope="col">Zeitstempel</th>
@@ -82,26 +94,129 @@
                 <th class="col-2" scope="col">Schwere</th>
                 <th class="col-2" scope="col">Aktiv</th>
               </tr>
-              %DTC_TABLE%
             </tbody>
           </table>
           </p>
-          <hr />
         </div>
+        <!-- Div Group DTC Table -->
       </div>
       <!-- Div Tab Home-->
-      <!-- Div Tab Source Settings-->
+
+      <!-- Div Tab Maintenance -->
+      <div id="tab_maintenance" class="tab-pane fade" role="tabpanel">
+        <h3>Wartung</h3>
+        <!-- Div Group Tank remain -->
+        <hr />
+        <p>
+        <h4>&Ouml;lvorrat</h4>
+          <div class="form-group row">
+            <label for="tankremain_maint" class="control-label col-4">Tankinhalt verbleibend</label>
+            <div class="col-8">
+              <div class="progress">
+                <div id="tankremain_maint" class="data-tankremain progress-bar text-light" role="progressbar"
+                  aria-valuenow="0" aria-valuemin="0" aria-valuemax="100"
+                  style="width: 0%">0%
+                </div>
+              </div>
+            </div>
+          </div>
+          <div class="form-group row">
+            <div class="col text-center">
+              <button id="resettank" class="btn-wsevent btn btn-outline-primary ml-2">Tank zurücksetzen</button>
+            </div>
+          </div>
+        </p>
+        <!-- Div Group Tank remain -->
+        <!-- Div Group Purging -->
+        <hr />
+        <p>
+        <h4>Entl&uuml;ftung</h4>
+          <div class="form-group row">
+            <label for="bleedingpulses" class="control-label col-4">Entl&uuml;ftung Dosierung</label>
+            <div class="col-8">
+              <div class="input-group">
+                <input id="bleedingpulses" value="0" type="text" class="set-wsevent data-bleedingpulses form-control">
+                <div class="input-group-append">
+                  <span class="input-group-text">Pulse</span>
+                </div>
+              </div>
+            </div>
+          </div>
+          <div class="form-group row">
+            <div class="col text-center">
+              <button id="purgenow" class="btn-wsevent btn btn-outline-primary ml-2">Entlüftung starten</button>
+            </div>
+          </div>
+        </p>
+        <!-- Div Group Purging -->
+        <!-- Div Group Measure -->
+        <div %SHOW_IMPULSE_SETTINGS%>
+          <hr />
+          <p>
+          <h4>Einmessen</h4>
+            <div class="form-group row">
+              <label for="measuredpulses" class="control-label col-4">erfasste Pulse</label>
+              <div class="col-8">
+                <div class="input-group">
+                  <input id="measuredpulses" name="measuredpulses" value="0" type="text" readonly class="form-control">
+                  <div class="input-group-append">
+                    <span class="input-group-text">Pulse</span>
+                  </div>
+                </div>
+              </div>
+            </div>
+            <div class="form-group row">
+              <div class="col text-center">
+                <button id="measurestartstop" class="btn-wsevent btn btn-outline-primary">Start</button>
+                <button id="measurereset" class="btn-wsevent btn btn-outline-primary ml-2">Reset</button>
+              </div>
+            </div>
+          </p>
+        </div>
+        <!-- Div Group Purging -->
+        <!-- Div Group LiveDebug -->
+        <hr />
+        <p>
+        <h4>Live Debug</h4>
+        <div class="form-group row">
+          <textarea class="form-control" spellcheck="false" id="livedebug-out" rows="3" readonly></textarea>
+        </div>
+        <div class="form-group row">
+          <div class="col text-center">
+            <button id="debugstart" class="btn-wsevent btn btn-outline-primary ml-2">Start</button>
+            <button id="debugstop" class="btn-wsevent btn btn-outline-primary ml-2">Stop</button>
+          </div>
+        </div>
+        </p>
+        <!-- Div Group LiveDebug -->
+        <!-- Div Group Device Reboot -->
+        <hr />
+        <p>
+        <h4>Ger&auml;t neustarten</h4>
+          <div class="form-group row">
+            <div class="col text-center">
+              <button id="reboot" class="btn-wsevent btn btn-outline-primary">Reboot</button>
+            </div>
+          </div>
+        </p>
+        <!-- Div Group Device Reboot -->
+      </div>
+      <!-- Div Tab Maintenance -->
+
+      <!-- Div Tab Settings-->
       <div id="tab_source" class="tab-pane fade" role="tabpanel">
-        <h3>Wegstreckenerfassung</h3>
+        <h3>Einstellungen</h3>
+        <!-- Div Group Signal Source -->
         <hr />
         <p>
         <h4>Signalquelle</h4>
-        <form action="post.htm" method="POST" class="form-horizontal">
           <div class="form-group row">
-            <label for="sourceselect" class="control-label col-4">Schnittstelle</label>
+            <label for="speedsource" class="control-label col-4">Schnittstelle</label>
             <div class="col-8">
-              <select id="sourceselect" name="sourceselect" class="select form-control">
+              <select id="speedsource" class="set-wsevent data-speedsource select form-control"> 
-                %SOURCE_SELECT_OPTIONS%
+                <option value="Impuls">Impuls</option>
+                <option value="GPS">GPS</option>
+                <option value="CAN-Bus">CAN-Bus</option>               
               </select>
             </div>
           </div>
@@ -115,24 +230,21 @@
           </div>
           <div class="form-group row">
             <div class="col text-center">
-              <button name="sourcesave" type="submit" class="btn btn-outline-primary">&Uuml;bernehmen</button>
+              <button id="sourcesave" class="btn-wsevent btn btn-outline-primary">&Uuml;bernehmen</button>
             </div>
           </div>
-        </form>
         </p>
-        <!-- Div Source:Impulse Settings-->
+        <!-- Div Group Signal Source -->
-        <div %SHOW_IMPULSE_SETTINGS%>
+        <!-- Div Group Source:Impulse Settings-->
+        <div id="showimpulse" class="data-showimpulse hideable">
           <hr />
           <p>
           <h4>Einstellungen Impulseingang</h4>
-          <form action="post.htm" method="POST" class="form-horizontal">
-
             <div class="form-group row">
               <label for="tirewidth" class="control-label col-4">Reifenbreite</label>
               <div class="col-8">
                 <div class="input-group">
-                  <input id="tirewidth" name="tirewidth" type="text" required="required" class="form-control"
+                  <input id="tirewidth" type="text" required="required" class="set-wsevent data-tirewidth form-control">
-                    value="%TIRE_WIDTH_MM%">
                   <div class="input-group-append">
                     <span class="input-group-text">mm</span>
                   </div>
@@ -144,8 +256,7 @@
               <label for="tireratio" class="control-label col-4">Höhe/Breite-Verhältniss</label>
               <div class="col-8">
                 <div class="input-group">
-                  <input id="tireratio" name="tireratio" type="text" required="required" class="form-control"
+                  <input id="tireratio" type="text" required="required" class="set-wsevent data-tireratio form-control">
-                    value="%TIRE_RATIO%">
                   <div class="input-group-append">
                     <span class="input-group-text">mm</span>
                   </div>
@@ -156,8 +267,7 @@
               <label for="tiredia" class="control-label col-4">Felgendurchmesser</label>
               <div class="col-8">
                 <div class="input-group">
-                  <input id="tiredia" name="tiredia" type="text" required="required" class="form-control"
+                  <input id="tiredia" type="text" required="required" class="set-wsevent data-tiredia form-control">
-                    value="%RIM_DIAMETER%">
                   <div class="input-group-append">
                     <span class="input-group-text">"</span>
                   </div>
@@ -168,85 +278,61 @@
               <label for="pulserev" class="control-label col-4">Pulse pro Umdrehung</label>
               <div class="col-8">
                 <div class="input-group">
-                  <input id="pulserev" name="pulserev" type="text" required="required" class="form-control"
+                  <input id="pulserev" type="text" required="required" class="set-wsevent data-pulserev form-control">
-                    value="%PULSE_PER_REV%">
                   <div class="input-group-addon"></div>
                 </div>
               </div>
             </div>
-            <div class="form-group row">
-              <div class="col text-center">
-                <button name="pulsesave" type="submit" class="btn btn-outline-primary">Speichern</button>
-              </div>
-            </div>
-          </form>
           </p>
-          <hr />
         </div>
-        <!-- Div Source:Impulse Settings-->
+        <!-- Div Group Source:Impulse Settings-->
-        <!-- Div Source:CAN Settings-->
+        <!-- Div Group Source:CAN Settings-->
-        <div %SHOW_CAN_SETTINGS%>
+        <div id="showcan" class="data-showcan hideable">
           <hr />
           <p>
           <h4>Einstellungen CAN-Bus</h4>
-          <form action="post.htm" method="POST" class="form-horizontal">
             <div class="form-group row">
               <label for="cansource" class="control-label col-4">Model</label>
               <div class="col-8">
-                <select id="cansource" name="cansource" class="select form-control">
+                <select id="cansource" class="set-wsevent data-cansource select form-control">
-                  %CANSOURCE_SELECT_OPTIONS%
+                  <option value="KTM 890 Adventure R (2021)">KTM 890 Adventure R (2021)</option>
+                  <option value="KTM 1290 Superduke R (2023)">KTM 1290 Superduke R (2023)</option> 
                 </select>
               </div>
             </div>
-            <div class="form-group row">
-              <div class="col text-center">
-                <button name="cansave" type="submit" class="btn btn-outline-primary">Speichern</button>
-              </div>
-            </div>
-          </form>
           </p>
-          <hr />
         </div>
-        <!-- Div Source:CAN Settings-->
+        <!-- Div Group Source:CAN Settings-->
-        <!-- Div Source:GPS Settings-->
+        <!-- Div Group Source:GPS Settings-->
-        <div %SHOW_GPS_SETTINGS%>
+        <div id="showgps" class="data-showgps hideable">
           <hr />
           <p>
           <h4>Einstellungen GPS</h4>
-          <form action="post.htm" method="POST" class="form-horizontal">
             <div class="form-group row">
               <label for="gpsbaud" class="control-label col-4">Baudrate</label>
               <div class="col-8">
-                <select id="gpsbaud" name="gpsbaud" class="select form-control">
+                <select id="gpsbaud" class="set-wsevent data-gpsbaud select form-control">
-                  %GPSBAUD_SELECT_OPTIONS%
                 </select>
               </div>
             </div>
             <div class="form-group row">
               <div class="col text-center">
-                <button name="gpssave" type="submit" class="btn btn-outline-primary">Speichern</button>
+                <button id="gpssave" class="btn-wsevent btn btn-outline-primary">Speichern</button>
               </div>
             </div>
-          </form>
           </p>
-          <hr />
         </div>
-        <!-- Div Source:GPS Settings-->
+        <!-- Div Group Source:GPS Settings-->
-      </div>
+        <!-- Div Group Lube Settings-->
-      <!-- Div Tab Source Settings-->
-      <!-- Div Tab Lube -->
-      <div id="tab_lube" class="tab-pane fade" role="tabpanel">
-        <h3>Schmierung</h3>
         <hr />
         <p>
         <h4>Dosierung</h4>
-        <form action="post.htm" method="POST" class="form-horizontal">
           <div class="form-group row">
             <label for="lubedistancenormal" class="control-label col-4">Normal (gr&uuml;n)</label>
             <div class="col-8">
               <div class="input-group">
-                <input id="lubedistancenormal" name="lubedistancenormal" value="%LUBE_DISTANCE_NORMAL%" type="text"
+                <input id="lubedistancenormal" type="text"
-                  class="form-control" required="required">
+                  class="set-wsevent data-lubedistancenormal form-control" required="required">
                 <div class="input-group-append">
                   <span class="input-group-text">m</span>
                 </div>
@@ -257,36 +343,25 @@
             <label for="lubedistancerain" class="control-label col-4">Regen (blau)</label>
             <div class="col-8">
               <div class="input-group">
-                <input id="lubedistancerain" name="lubedistancerain" value="%LUBE_DISTANCE_RAIN%" type="text"
+                <input id="lubedistancerain" type="text"
-                  class="form-control" required="required">
+                  class="set-wsevent data-lubedistancerain form-control" required="required">
                 <div class="input-group-append">
                   <span class="input-group-text">m</span>
                 </div>
               </div>
             </div>
           </div>
-          <div class="form-group row">
-            <div class="col text-center">
-              <button name="oilsave" type="submit" class="btn btn-outline-primary">Speichern</button>
-            </div>
-          </div>
-        </form>
         </p>
-        <hr />
+        <!-- Div Group Lube Settings-->
-      </div>
+        <!-- Div Group Oiltank Settings -->
-      <!-- Div Tab Lube -->
-      <!-- Div Tab Maintenance -->
-      <div id="tab_maintenance" class="tab-pane fade" role="tabpanel">
-        <h3>Wartung</h3>
         <hr />
         <p>
-        <h4>&Ouml;lvorrat</h4>
+        <h4>&Ouml;ltank</h4>
-        <form action="post.htm" method="POST" class="form-horizontal">
           <div class="form-group row">
             <label for="tankcap" class="control-label col-4">Tankkapazität</label>
             <div class="col-8">
               <div class="input-group">
-                <input id="tankcap" name="tankcap" value="%TANK_CAPACITY%" type="text" class="form-control"
+                <input id="tankcap" type="text" class="set-wsevent data-tankcap form-control"
                   required="required">
                 <div class="input-group-append">
                   <span class="input-group-text">ml</span>
@@ -298,7 +373,7 @@
             <label for="tankwarn" class="control-label col-4">Leer-Warnung</label>
             <div class="col-8">
               <div class="input-group">
-                <input id="tankwarn" name="tankwarn" value="%TANK_REMIND%" type="text" class="form-control"
+                <input id="tankwarn" type="text" class="set-wsevent data-tankwarn form-control"
                   required="required">
                 <div class="input-group-append">
                   <span class="input-group-text">&#37;</span>
@@ -310,7 +385,7 @@
             <label for="pumppulse" class="control-label col-4">Menge pro Puls</label>
             <div class="col-8">
               <div class="input-group">
-                <input id="pumppulse" name="pumppulse" value="%AMOUNT_PER_DOSE%" type="text" class="form-control"
+                <input id="pumppulse" type="text" class="set-wsevent data-pumppulse form-control"
                   required="required">
                 <div class="input-group-append">
                   <span class="input-group-text">µl</span>
@@ -318,230 +393,57 @@
               </div>
             </div>
           </div>
+        </p>
+        <!-- Div Group Oiltank Settings -->
+        <!-- Div Group LED Settings-->
+        <hr />
+        <p>
+        <h4>LED Einstellungen</h4>
           <div class="form-group row">
-            <label for="tankremain_maint" class="control-label col-4">Tankinhalt verbleibend</label>
+            <label for="ledmodeflash" class="control-label col-4">LED Modus blinken</label>
             <div class="col-8">
-              <div class="progress">
+              <div class="form-check">
-                <div id="tankremain_maint" class="progress-bar text-light" role="progressbar"
+                <input class="set-wsevent data-ledmodeflash form-check-input" type="checkbox" id="ledmodeflash">
-                  aria-valuenow="%TANK_REMAIN_CAPACITY%" aria-valuemin="0" aria-valuemax="100"
+                <label class="form-check-label" for="ledmodeflash">
-                  style="width: %TANK_REMAIN_CAPACITY%&#37;">
+                  LED blinken
-                  %TANK_REMAIN_CAPACITY%&#37;
+                </label>
-                </div>
               </div>
             </div>
           </div>
           <div class="form-group row">
-            <div class="col text-center">
+            <label for="ledmaxbrightness" class="control-label col-4">Max Helligkeit</label>
-              <button name="oilsave" type="submit" class="btn btn-outline-primary">Speichern</button>
-              <button name="resettank" type="submit" class="btn btn-outline-primary ml-2">Tank zurücksetzen</button>
-            </div>
-          </div>
-        </form>
-        </p>
-        <hr />
-        <p>
-        <h4>Entl&uuml;ftung</h4>
-        <form action="post.htm" method="POST" class="form-horizontal">
-          <div class="form-group row">
-            <label for="purgepulse" class="control-label col-4">Entl&uuml;ftung Dosierung</label>
             <div class="col-8">
               <div class="input-group">
-                <input id="purgepulse" name="purgepulse" value="%BLEEDING_PULSES%" type="text" class="form-control">
+                <input id="ledmaxbrightness" type="text" class="set-wsevent data-ledmaxbrightness form-control" required="required">
-                <div class="input-group-append">
-                  <span class="input-group-text">Pulse</span>
-                </div>
               </div>
             </div>
           </div>
           <div class="form-group row">
-            <div class="col text-center">
+            <label for="ledminbrightness" class="control-label col-4">Min Helligkeit</label>
-              <button name="maintsave" type="submit" class="btn btn-outline-primary">Speichern</button>
+            <div class="col-8">
-              <button name="purgenow" type="submit" class="btn btn-outline-primary ml-2">Entlüftung starten</button>
+              <div class="input-group">
+                <input id="ledminbrightness" type="text" class="set-wsevent data-ledminbrightness form-control" required="required">
+              </div>
             </div>
           </div>
-        </form>
         </p>
+        <!-- Div Group Lube Settings-->
+        <!-- Div Group Save Button-->
         <hr />
         <p>
-        <h4>EEPROM formatieren</h4>
-        <div class="alert alert-primary alert-dismissable show fade" role="alert">
-          <button type="button" class="close" data-dismiss="alert" aria-label="Close">
-            <span aria-hidden="true">×</span>
-          </button>
-          <strong>Achtung!</strong><br>
-          Das Formatieren der EEPROM-Bereiche sollte nur ausgeführt werden wenn es unbedingt erforderlich ist!
-          Hierdurch werden alle Einstellungen zurück gesetzt bzw. alle Betriebsdaten gehen verloren.
-          Folgende Situationen erfordern unter anderem eine Formatierung:
-          - Erstinitialisierung (bei neu aufgebautem Gerät)
-          - Firmware-Update (nur wenn es die Release-Notes fordern)
-        </div>
-        <form action="post.htm" method="POST" class="form-horizontal">
-          <div class="form-group row">
-            <div class="offset-4 col-8">
-              <div class="form-check">
-                <input class="form-check-input" type="checkbox" name="reset_ee_cfg" id="reset_ee_cfg">
-                <label class="form-check-label" for="reset_ee_cfg">
-                  Bereich "CFG"
-                </label>
-              </div>
-              <div class="form-check">
-                <input class="form-check-input" type="checkbox" name="reset_ee_pds" id="reset_ee_pds">
-                <label class="form-check-label" for="reset_ee_pds">
-                  Bereich "PDS"
-                </label>
-              </div>
-            </div>
-          </div>
           <div class="form-group row">
             <div class="col text-center">
-              <button name="reset_ee_btn" type="submit" class="btn btn-outline-primary">EEPROM formatieren</button>
+              <button id="settingssave" class="btn-wsevent btn btn-outline-primary">Speichern</button>
             </div>
           </div>
-        </form>
         </p>
-        <hr />
-        <p>
-        <h4>Ger&auml;t neustarten</h4>
-        <form action="post.htm" method="POST" class="form-horizontal">
-          <div class="form-group row">
-            <div class="col text-center">
-              <button name="reboot" type="submit" class="btn btn-outline-primary">Reboot</button>
-            </div>
-          </div>
-        </form>
-        </p>
-        <hr />
       </div>
-      <!-- Div Tab Maintenance -->
+      <!-- Div Tab Settings -->
-      <!-- Div Tab SystemInfo -->
+
-      <div id="tab_sysinfo" class="tab-pane fade" role="tabpanel">
-        <h3>Systeminfo</h3>
-        <hr />
-        <p>
-        <h4>Einstellungen</h4>
-        <table class="table">
-          <tbody>
-            <tr>
-              <th class="col-7" scope="col">Parameter</td>
-              <th class="col-5" scope="col">Value</td>
-            </tr>
-            <tr>
-              <td>DistancePerLube_Default</td>
-              <td>%LUBE_DISTANCE_NORMAL%</td>
-            </tr>
-            <tr>
-              <td>DistancePerLube_Rain</td>
-              <td>%LUBE_DISTANCE_RAIN%</td>
-            </tr>
-            <tr>
-              <td>tankCapacity_ml</td>
-              <td>%TANK_CAPACITY%</td>
-            </tr>
-            <tr>
-              <td>amountPerDose_&micro;l</td>
-              <td>%AMOUNT_PER_DOSE%</td>
-            </tr>
-            <tr>
-              <td>TankRemindAtPercentage</td>
-              <td>%TANK_REMIND%</td>
-            </tr>
-            <tr>
-              <td>PulsePerRevolution</td>
-              <td>%PULSE_PER_REV%</td>
-            </tr>
-            <tr>
-              <td>TireWidth_mm</td>
-              <td>%TIRE_WIDTH_MM%</td>
-            </tr>
-            <tr>
-              <td>TireWidthHeight_Ratio</td>
-              <td>%TIRE_RATIO%</td>
-            </tr>
-            <tr>
-              <td>RimDiameter_Inch</td>
-              <td>%RIM_DIAMETER%</td>
-            </tr>
-            <tr>
-              <td>DistancePerRevolution_mm</td>
-              <td>%DISTANCE_PER_REV%</td>
-            </tr>
-            <tr>
-              <td>BleedingPulses</td>
-              <td>%BLEEDING_PULSES%</td>
-            </tr>
-            <tr>
-              <td>SpeedSource</td>
-              <td>%SPEED_SOURCE%</td>
-            </tr>
-            <tr>
-              <td>GPSBaudRate</td>
-              <td>%GPS_BAUD%</td>
-            </tr>
-            <tr>
-              <td>CANSource</td>
-              <td>%CAN_SOURCE%</td>
-            </tr>
-            <tr>
-              <td>Checksum</td>
-              <td>%CONFIG_CHECKSUM%</td>
-            </tr>
-          </tbody>
-        </table>
-        </p>
-        <hr />
-        <p>
-        <h4>Betriebsdaten</h4>
-        <table class="table">
-          <tbody>
-            <tr>
-              <th class="col-7" scope="col">Parameter</td>
-              <th class="col-5" scope="col">Value</td>
-            </tr>
-            <tr>
-              <td>writeCycleCounter</td>
-              <td>%WRITE_CYCLE_COUNT%</td>
-            </tr>
-            <tr>
-              <td>PersistenceMarker</td>
-              <td>%PERSISTENCE_MARKER%</td>
-            </tr>
-            <tr>
-              <td>tankRemain_µl</td>
-              <td>%TANK_REMAIN_UL%</td>
-            </tr>
-            <tr>
-              <td>TravelDistance_highRes</td>
-              <td>%TRAVEL_DISTANCE_HIGHRES%</td>
-            </tr>
-            <tr>
-              <td>Odometer</td>
-              <td>%ODOMETER%,%ODOMETER_M%</td>
-            </tr>
-            <tr>
-              <td>checksum</td>
-              <td>%PERSISTANCE_CHECKSUM%</td>
-            </tr>
-        </table>
-        </p>
-        <hr />
-        <p>
-          <h4>Live Debug</h4>
-            <div class="form-group row">
-              <textarea class="form-control" spellcheck="false" id="livedebug-out" rows="3" readonly></textarea>
-            </div>
-            <div class="form-group row">
-              <div class="col text-center">
-                <button id="btn-ws-start" class="btn btn-outline-primary">Start</button>
-                <button id="btn-ws-stop" class="btn btn-outline-primary ml-2">Stop</button>
-              </div>
-            </div>
-          </p>
-          <hr />
-      </div>
-      <!-- Div Tab SystemInfo -->
       <!-- Div Tab Firmware Update-->
       <div id="tab_fwupdate" class="tab-pane fade" role="tabpanel">
         <h3>Firmware</h3>
+        <!-- Div Group VersionInfo -->
         <hr />
         <p>
         <h4>Version-Info</h4>
@@ -559,8 +461,14 @@
               <td>Flash Version</td>
               <td>%FS_VERSION%</td>
             </tr>
+            <tr>
+              <td>Git Revision</td>
+              <td>%GIT_REV%</td>
+            </tr>
         </table>
         </p>
+        <!-- Div Group VersionInfo -->
+        <!-- Div Group EEPROM Backup -->
         <hr />
         <p>
         <h4>EEPROM-Backup</h4>
@@ -570,6 +478,8 @@
           </div>
         </div>
         </p>
+        <!-- Div Group EEPROM Backup -->
+        <!-- Div Group EEPROM Restore -->
         <hr />
         <p>
         <h4>EEPROM-Restore</h4>
@@ -588,6 +498,8 @@
           </div>
         </form>
         </p>
+        <!-- Div Group EEPROM Restore -->
+        <!-- Div Group Firmware Update -->
         <hr />
         <p>
         <h4>Firmware-Update</h4>
@@ -606,7 +518,7 @@
           </div>
         </form>
         </p>
-        <hr />
+        <!-- Div Group Firmware Update -->
       </div>
       <!-- Div Tab Firmware Update-->
     </div>
@@ -618,7 +530,7 @@
   <footer class="page-footer navbar-dark bg-primary font-small fixed-bottom">
     <div class="container-fluid text-center">
       <div class="footer-copyright text-center py-3">
-        <span class="text-muted">© 2022 -
+        <span class="text-muted">© 2023 -
           <a class="text-reset fw-bold" href="https://eventronics.de/">Marcel Peterkau</a></span>
       </div>
     </div>
@@ -650,47 +562,8 @@
 
   <!-- Modal Dialog -->
 
-  <script>
-    $('.navbar-nav>li>a').on('click', function () {
-      $('.navbar-collapse').collapse('hide');
-    });
-
-    document.querySelector('.custom-file-input').addEventListener('change', function (e) {
-      var fileName = document.getElementById("fw-update-file").files[0].name;
-      var nextSibling = e.target.nextElementSibling
-      nextSibling.innerText = fileName
-    });
-
-    $(document).ready(function () {
-      $("tr[data-dtc]").each(function (i) {
-        $(this).attr('data-toggle', "modal");
-        $(this).attr('data-target', "#dtcModal");
-      });
-    });
-
-    $('#dtcModal').on('show.bs.modal', function (event) {
-      var dtctr = $(event.relatedTarget)
-      var dtc = dtctr.data('dtc')
-      var debugval = dtctr.data('debugval')
-      var modal = $(this)
-      $.getJSON('static/tt_dtc/dtc_' + dtc + '.json', function (data) {
-        modal.find('.modal-title').text(data.title)
-        modal.find('.dtc-desc').text(data.description)
-        if (debugval > 0) {
-          modal.find('.dtc-debugval').text("Debugvalue: " + debugval)
-        }
-        else {
-          modal.find('.dtc-debugval').remove()
-        }
-      }).fail(function () {
-        console.log("An error has occurred.");
-        modal.find('.modal-title').text("Fehler")
-        modal.find('.dtc-desc').text("DTC-Beschreibung konnte nicht geladen werden")
-      });
-    });
-
-  </script>
 
+ 
 </body>
 
 </html>

Software/data_src/static/css/tweaks.css

@@ -25,3 +25,20 @@ hr {
     padding: 10px;
 }
 
+#overlay {
+    display: none;
+    position: fixed;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    background: rgba(0, 0, 0, 0.8); /* Dunkler Hintergrund mit Transparenz */
+    color: white; /* Textfarbe */
+    justify-content: center;
+    align-items: center;
+    z-index: 9999; /* Stellen Sie sicher, dass es über anderen Elementen liegt */
+}
+
+.overlay-content {
+    text-align: center;
+}

Software/data_src/static/dtc_table.json

@@ -0,0 +1,96 @@
+{
+    "codegenerator_checksum": "23dff82a4745f67041012080b05ec367c2dd44c6bb02974143b227ba49682b6f",
+    "timestamp": "2024-01-10 19:06:30",
+    "dtc_table_data": [
+        {
+            "num": 0,
+            "title": "No Error",
+            "description": "No Error"
+        },
+        {
+            "num": 1,
+            "title": "Ölvorrat leer",
+            "description": "Ölvorrat ist komplett leer. Den Ölvorrat auffüllen und im Menu 'Wartung' zurück setzen"
+        },
+        {
+            "num": 2,
+            "title": "Ölvorrat niedrig",
+            "description": "Ölvorrat ist unter der Warnschwelle. Den Ölvorrat demnächst auffüllen und im Menu 'Wartung' zurück setzen"
+        },
+        {
+            "num": 3,
+            "title": "kein EEPROM erkannt",
+            "description": "Es wurde kein EEPROM gefunden. Dies lässt einen Hardware-Defekt vermuten."
+        },
+        {
+            "num": 4,
+            "title": "EEPROM CFG Checksumme",
+            "description": "Die Checksumme der Config-Partition des EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'CFG' im Menu 'Wartung' zurück"
+        },
+        {
+            "num": 5,
+            "title": "EEPROM PDS Checksumme",
+            "description": "Die Checksumme der Betriebsdaten-Partition des EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'PDS' im Menu 'Wartung' zurück"
+        },
+        {
+            "num": 6,
+            "title": "EEPROM PDS Adresse",
+            "description": "Die Adresse der Betriebsdaten-Partition im EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'PDS' im Menu 'Wartung' zurück"
+        },
+        {
+            "num": 7,
+            "title": "EEPROM Version falsch",
+            "description": "Die Layout-Version des EEPROM stimmt nicht mit der Firmware-Version überein. Setzen sie den EEPROM-Bereich 'CFG' im Menu 'Wartung' zurück"
+        },
+        {
+            "num": 8,
+            "title": "Flashspeicher Fehler",
+            "description": "Der Flashspeicher konnte nicht initialisiert werden. Aktualisieren sie Flash & Firmware"
+        },
+        {
+            "num": 9,
+            "title": "Flashversion falsch",
+            "description": "Die Version des Flashspeicher stimmt nicht mit der Firmware-Version überein. Aktualisieren sie den Flash mit der passenden Update-Datei"
+        },
+        {
+            "num": 10,
+            "title": "Keine GPS-Verbindung",
+            "description": "Es wurde kein GPS-Signal über die serielle Schnittstelle empfangen, Prüfen sie die Verbindung und das GPS-Modul"
+        },
+        {
+            "num": 11,
+            "title": "CAN-Transceiver Error",
+            "description": "Es konnte keine Verbindung zum CAN-Transceiver hergestellt werden. Prüfen Sie die Hardware auf Defekte"
+        },
+        {
+            "num": 12,
+            "title": "Keine CAN-Verbindung",
+            "description": "Es konnte kein CAN-Signal empfangen werden. Prüfen sie die Verbindung und die Einstellungen"
+        },
+        {
+            "num": 13,
+            "title": "Config-Validierung",
+            "description": "Ein oder mehrer Einstellungswerte sind ausserhalb plausibler Werte. Prüfen Sie Ihre Einstellungen"
+        },
+        {
+            "num": 14,
+            "title": "Dummy-DTC Info",
+            "description": "Ein Dummy-DTC der Schwere \"Info\" für Debugging-Zwecke"
+        },
+        {
+            "num": 15,
+            "title": "Dummy-DTC Warnung",
+            "description": "Ein Dummy-DTC der Schwere \"Warnung\" für Debugging-Zwecke"
+        },
+        {
+            "num": 16,
+            "title": "Dummy-DTC Kritisch",
+            "description": "Ein Dummy-DTC der Schwere \"Kritisch\" für Debugging-Zwecke"
+        },
+        {
+            "num": 17,
+            "title": "Last Error",
+            "description": "Last Error"
+        }
+    ]
+}

Software/data_src/static/js/dtc_table.js

@@ -0,0 +1,227 @@
+const jsonFilePath = "static/dtc_table.json";
+
+var dtcState = {};
+
+function processDTCNotifications(dtcArray) {
+  for (var i = 0; i < dtcArray.length; i++) {
+    var dtcInfo = dtcArray[i].split(",");
+    var errorCode = dtcInfo[1];
+    var activity = parseInt(dtcInfo[3]);
+
+    if (dtcState[errorCode]) {
+      // Überprüfen, ob sich der Zustand von "previous" auf "active" geändert hat
+      if (activity !== dtcState[errorCode]) {
+        dtcState[errorCode] = activity;
+        if (activity === 1) showDTCNotification(errorCode);
+      }
+    } else {
+      // DTC ist neu, Zustand speichern und Benachrichtigung anzeigen
+      dtcState[errorCode] = activity;
+      showDTCNotification(errorCode);
+    }
+  }
+}
+
+function showDTCNotification(dtctext, severity) {
+  // Überprüfen, ob der Browser die Notification API unterstützt
+  if ("Notification" in window) {
+    // Überprüfen, ob der Benutzer bereits Berechtigungen erteilt hat
+    if (Notification.permission === "granted") {
+      // Benachrichtigung anzeigen
+      showNotification(dtctext, severity);
+    } else if (Notification.permission !== "denied") {
+      // Aufforderung zur Erlaubnis einholen
+      Notification.requestPermission().then(function (permission) {
+        if (permission === "granted") {
+          // Benachrichtigung anzeigen
+          showNotification(dtctext, severity);
+        } else {
+          // Der Benutzer hat die Berechtigung abgelehnt oder das Dialogfeld geschlossen
+          console.log("Benachrichtigungsberechtigung wurde verweigert.");
+        }
+      });
+    } else {
+      // Der Benutzer hat die Berechtigung bereits verweigert
+      console.log("Benachrichtigungsberechtigung wurde bereits verweigert.");
+    }
+  }
+}
+
+// Funktion zum Anzeigen der Benachrichtigung
+function showNotification(dtctext, severity) {
+  var severityIcon;
+  switch (severity) {
+    case 1:
+      severityIcon = "static/img/info.png";
+      break;
+    case 2:
+      severityIcon = "static/img/warn.png";
+      break;
+    case 3:
+      severityIcon = "static/img/critical.png";
+      break;
+    default:
+      severityIcon = "static/img/none.png";
+  }
+
+  var options = {
+    body: dtctext,
+    icon: severityIcon,
+  };
+
+  var notification = new Notification("KTM Chain Oiler DTC", options);
+
+  // Optional: Handle Click-Event
+  notification.onclick = function () {
+    console.log("Benachrichtigung wurde angeklickt.");
+  };
+}
+
+function getDescriptionForDTCNumber(number, callback) {
+  fetch(jsonFilePath)
+    .then((response) => response.json())
+    .then((data) => {
+      const dtcList = data.dtc_table_data;
+      const foundEntry = dtcList.find((entry) => entry.num === number);
+
+      if (foundEntry) {
+        const description = foundEntry.description;
+        const title = foundEntry.title;
+        callback(null, title, description);
+      } else {
+        // Wenn die Nummer nicht gefunden wurde, geben Sie einen Fehler zurück
+        callback(
+          `Beschreibung für Nummer ${number} nicht gefunden.`,
+          null,
+          null
+        );
+      }
+    })
+    .catch((error) => {
+      // Im Fehlerfall geben Sie den Fehler zurück
+      callback(error, null, null);
+    });
+}
+
+function showDTCModal(event) {
+  var dtc = parseInt(event.currentTarget.getAttribute("data-dtc"));
+  var debugval = event.currentTarget.getAttribute("data-debugval");
+  var modal = $("#dtcModal");
+
+  getDescriptionForDTCNumber(dtc, function (error, title, description) {
+    if (error) {
+      console.error("Fehler beim Abrufen der Beschreibung:", error);
+      modal.find(".modal-title").text("Fehler");
+      modal
+        .find(".dtc-desc")
+        .text("DTC-Beschreibung konnte nicht geladen werden");
+    } else {
+      modal.find(".modal-title").text(title);
+      modal.find(".dtc-desc").text(description);
+      if (debugval > 0) {
+        modal.find(".dtc-debugval").text("Debugvalue: " + debugval);
+      } else {
+        modal.find(".dtc-debugval").remove();
+      }
+    }
+  });
+  // Modal anzeigen
+  modal.modal("show");
+}
+
+function fillDTCTable(dtcArray) {
+  // Referenz auf das Tabellen-Element
+  var table = document.getElementById("dtc_table");
+  var tablediv = document.getElementById("dtc_container");
+
+  // Prüfen, ob DTC vorhanden sind
+  if (dtcArray.length === 0) {
+    // Verstecke das Tabellen-Div, wenn keine DTC vorhanden sind
+    tablediv.hidden = true;
+    return;
+  } else {
+    // Zeige das Tabellen-Div, wenn DTC vorhanden sind
+    tablediv.hidden = false;
+  }
+
+  // Tabelle leeren, bevor sie neu gefüllt wird
+  table.innerHTML = "";
+
+  // Überschriften für die Tabelle erstellen
+  var headerRow = table.insertRow(0);
+
+  // Definition der Klassen und Scopes für die Spalten
+  var columnDefinitions = [
+    { class: "col-6", scope: "Zeitstempel" },
+    { class: "col-2", scope: "Fehlercode" },
+    { class: "col-2", scope: "Schwere" },
+    { class: "col-2", scope: "Aktiv" },
+  ];
+
+  for (var i = 0; i < columnDefinitions.length; i++) {
+    var headerCell = headerRow.insertCell(i);
+    headerCell.className = `th ${columnDefinitions[i].class}`;
+    headerCell.scope = columnDefinitions[i].scope;
+    headerCell.innerHTML = columnDefinitions[i].scope;
+  }
+
+  // DTC-Daten in die Tabelle einfügen
+  for (var i = 0; i < dtcArray.length; i++) {
+    var dtcInfo = dtcArray[i].split(",");
+
+    var row = table.insertRow(i + 1); // +1 wegen der Überschriftenzeile
+
+    // Zeitstempel
+    var timestampCell = row.insertCell(0);
+    timestampCell.innerHTML = formatTimestamp(parseInt(dtcInfo[0]));
+
+    // Fehlercode
+    var errorCodeCell = row.insertCell(1);
+    errorCodeCell.innerHTML = dtcInfo[1];
+
+    // Schwere
+    var severityCell = row.insertCell(2);
+    var severity = parseInt(dtcInfo[2]);
+
+    // Schwere
+    switch (severity) {
+      case 1:
+        severityCell.innerHTML = '<img src="static/img/info.png" alt="Info" />';
+        break;
+      case 2:
+        severityCell.innerHTML =
+          '<img src="static/img/warn.png" alt="Warnung" />';
+        break;
+      case 3:
+        severityCell.innerHTML =
+          '<img src="static/img/critical.png" alt="Kritisch" />';
+        break;
+      default:
+        severityCell.innerHTML =
+          '<img src="static/img/none.png" alt="Unbekannt" />';
+    }
+
+    row.setAttribute("data-dtc", dtcInfo[1]);
+    row.setAttribute("data-debugval", dtcInfo[4]);
+    row.addEventListener("click", showDTCModal);
+
+    // Aktivität
+    var activityCell = row.insertCell(3);
+    activityCell.innerHTML = parseInt(dtcInfo[3]) === 1 ? "active" : "previous";
+  }
+}
+
+function formatTimestamp(milliseconds) {
+  const date = new Date(milliseconds);
+
+  const days = String(date.getUTCDate() - 1).padStart(2, "0");
+  const hours = String(date.getUTCHours()).padStart(2, "0");
+  const minutes = String(date.getUTCMinutes()).padStart(2, "0");
+  const seconds = String(date.getUTCSeconds()).padStart(2, "0");
+  const millisecondsFormatted = String(date.getUTCMilliseconds()).padStart(
+    3,
+    "0"
+  );
+
+  return `${days}-${hours}:${minutes}:${seconds}:${millisecondsFormatted}`;
+}

Software/data_src/static/js/script.js

@@ -0,0 +1,16 @@
+$(document).ready(function(){
+  $('.navbar-nav a').on('click', function(){
+    $('.navbar-collapse').collapse('hide');
+  });
+});
+
+document
+  .querySelector(".custom-file-input")
+  .addEventListener("change", function (e) {
+    var fileName = document.getElementById("fw-update-file").files[0].name;
+    var nextSibling = e.target.nextElementSibling;
+    nextSibling.innerText = fileName;
+  });
+
+
+

Software/data_src/static/js/websocket.js

@@ -1,7 +1,15 @@
 var gateway = `ws://${window.location.hostname}/ws`;
 var websocket;
 
-window.addEventListener("load", onLoad);
+var statusMapping;
+var staticMapping;
+var overlay;
+
+document.addEventListener("DOMContentLoaded", function () {
+  // Ihr JavaScript-Code hier, einschließlich der onLoad-Funktion
+  overlay = document.getElementById("overlay");
+  onLoad();
+});
 
 function initWebSocket() {
   console.log("Trying to open a WebSocket connection...");
@@ -12,12 +20,29 @@ function initWebSocket() {
 }
 
 function initButtons() {
-  document
+  var elements = document.getElementsByClassName("btn-wsevent");
-    .getElementById("btn-ws-stop")
+
-    .addEventListener("click", livedebug_stop);
+  if (elements.length > 0) {
-  document
+    for (var i = 0; i < elements.length; i++) {
-    .getElementById("btn-ws-start")
+      let element = elements[i];
-    .addEventListener("click", livedebug_start);
+      element.addEventListener("click", function () {
+        websocket_sendevent("btn-" + element.id, 0);
+      });
+    }
+  }
+}
+
+function initSettingInputs() {
+  var elements = document.getElementsByClassName("set-wsevent");
+
+  if (elements.length > 0) {
+    for (var i = 0; i < elements.length; i++) {
+      let element = elements[i];
+      element.addEventListener("change", function () {
+        websocket_sendevent("set-" + element.id, element.value);
+      });
+    }
+  }
 }
 
 function onOpen(event) {
@@ -26,28 +51,97 @@ function onOpen(event) {
 
 function onClose(event) {
   console.log("Connection closed");
-  setTimeout(initWebSocket, 2000);
+  setTimeout(initWebSocket, 1000);
+  overlay.style.display = "flex";
 }
 
 function onMessage(event) {
-  var livedebug_out = document.getElementById("livedebug-out");
+  var data = event.data;
-  var textarea_heigth = livedebug_out.scrollHeight;
+  console.log("ws_msg:" + event.data + "\n");
-  livedebug_out.value += event.data;
+
-  livedebug_out.scrollTop = livedebug_out.scrollHeight;
+  if (data.startsWith("DEBUG:")) {
-  do_resize(livedebug_out);
+    var addtext = data.slice(6);
+    var livedebug_out = document.getElementById("livedebug-out");
+    livedebug_out.value += addtext;
+    livedebug_out.scrollTop = livedebug_out.scrollHeight;
+    do_resize(livedebug_out);
+    return;
+  }
+
+  if (data.startsWith("DTC:")) {
+    const dtcs = data.slice(4);
+    const dtcArray = dtcs.trim() !== "" ? dtcs.split(";").filter(Boolean) : [];
+
+    if (dtcArray[0] != "0") {
+      processDTCNotifications(dtcArray);
+      fillDTCTable(dtcArray);
+    }
+    return;
+  }
+
+  if (data.startsWith("MAPPING_STATUS:")) {
+    const data_sliced = data.slice(15);
+    statusMapping = createMapping(data_sliced);
+  }
+
+  if (data.startsWith("MAPPING_STATIC:")) {
+    const data_sliced = data.slice(15);
+    staticMapping = createMapping(data_sliced);
+  }
+
+  if (data.startsWith("STATUS:")) {
+    const data_sliced = data.slice(7);
+    const result = processDataString(data_sliced, statusMapping);
+    console.log("STATUS:");
+    console.log(JSON.stringify(result, null, 2));
+    fillValuesToHTML(result);
+    return;
+  }
+
+  if (data.startsWith("STATIC:")) {
+    const data_sliced = data.slice(7);
+    const result = processDataString(data_sliced, staticMapping);
+    console.log("STATIC:");
+    console.log(JSON.stringify(result, null, 2));
+    fillValuesToHTML(result);
+    overlay.style.display = "none";
+    return;
+  }
+}
+
+function createMapping(mappingString) {
+  const mappingArray = mappingString.split(";");
+  const mapping = [];
+
+  mappingArray.forEach((variable) => {
+    if (variable !== null) mapping.push(variable.trim());
+  });
+  return mapping;
+}
+
+function processDataString(dataString, mapping) {
+  const valuesArray = dataString.split(";");
+  const dataObject = {};
+
+  valuesArray.forEach((value, index) => {
+    const variable = mapping[index];
+    if (variable) {
+      dataObject[variable] = value.trim();
+    }
+  });
+
+  return dataObject;
 }
 
 function onLoad(event) {
   initWebSocket();
   initButtons();
+  initSettingInputs();
+  overlay.style.display = "flex";
 }
 
-function livedebug_start() {
+function websocket_sendevent(element_id, element_value) {
-  websocket.send("start");
+  websocket.send(element_id + ":" + element_value);
-}
-
-function livedebug_stop() {
-  websocket.send("stop");
 }
 
 function do_resize(textbox) {
@@ -66,3 +160,54 @@ function do_resize(textbox) {
   else if (rows < minrows) textbox.rows = minrows;
   else textbox.rows = rows;
 }
+
+function fillValuesToHTML(dataset) {
+  for (var key in dataset) {
+    var key_prefixed = "data-" + key;
+    var elements = document.getElementsByClassName(key_prefixed);
+
+    if (elements.length > 0) {
+      for (var i = 0; i < elements.length; i++) {
+        var element = elements[i];
+
+        if (element.type === "checkbox") {
+          // Wenn das Element ein Kontrollkästchen ist
+          element.checked = dataset[key] == 1 ? true : false;
+        } else if (element.tagName === "SELECT") {
+          // Wenn das Element ein Dropdown ist
+          setDropdownValue(element, dataset[key]);
+        } else if (element.classList.contains("progress-bar")) {
+          // Wenn das Element eine Fortschrittsleiste ist
+          updateProgressBar(element, dataset[key]);
+        } else if (element.classList.contains("hideable")) {
+          // Wenn das Element ein Settingsabschnitt-div ist
+          if (dataset[key] == 0) element.style.display = "none";
+          else element.style.display = "";
+        } else {
+          // Standardmäßig für Textfelder und andere Elemente
+          element.value = dataset[key];
+        }
+      }
+    }
+  }
+}
+
+// Funktion zum Setzen des ausgewählten Werts für Dropdowns
+function setDropdownValue(selectElement, value) {
+  for (var i = 0; i < selectElement.options.length; i++) {
+    if (selectElement.options[i].value === value) {
+      selectElement.selectedIndex = i;
+      break;
+    }
+  }
+}
+
+// Funktion zum Aktualisieren der Fortschrittsleiste
+function updateProgressBar(progressBar, value) {
+  // Wert in das aria-valuenow-Attribut einfügen
+  progressBar.setAttribute("aria-valuenow", value);
+
+  // Breite des Fortschrittsbalkens und inneren Text aktualisieren
+  progressBar.style.width = value + "%";
+  progressBar.textContent = value + "%";
+}

Software/data_src/static/tt_dtc/dtc_1.json

@@ -1,4 +0,0 @@
-{
-    "title": "Ölvorrat leer",
-    "description": "Ölvorrat ist komplett leer. Den Ölvorrat auffüllen und im Menu 'Wartung' zurück setzen"
-}

Software/data_src/static/tt_dtc/dtc_10.json

@@ -1,4 +0,0 @@
-{
-    "title": "Keine GPS-Verbindung",
-    "description": "Es wurde kein GPS-Signal über die serielle Schnittstelle empfangen, Prüfen sie die Verbindung und das GPS-Modul"
-}

Software/data_src/static/tt_dtc/dtc_11.json

@@ -1,4 +0,0 @@
-{
-    "title": "CAN-Transceiver Error",
-    "description": "Es konnte keine Verbindung zum CAN-Transceiver hergestellt werden. Prüfen Sie die Hardware auf Defekte"
-}

Software/data_src/static/tt_dtc/dtc_12.json

@@ -1,4 +0,0 @@
-{
-    "title": "Keine CAN-Verbindung",
-    "description": "Es konnte kein CAN-Signal empfangen werden. Prüfen sie die Verbindung und die Einstellungen"
-}

Software/data_src/static/tt_dtc/dtc_13.json

@@ -1,4 +0,0 @@
-{
-    "title": "Config-Validierung",
-    "description": "Ein oder mehrer Einstellungswerte sind ausserhalb plausibler Werte. Prüfen Sie Ihre Einstellungen"
-}

Software/data_src/static/tt_dtc/dtc_2.json

@@ -1,4 +0,0 @@
-{
-    "title": "Ölvorrat niedrig",
-    "description": "Ölvorrat ist unter der Warnschwelle. Den Ölvorrat demnächst auffüllen und im Menu 'Wartung' zurück setzen"
-}

Software/data_src/static/tt_dtc/dtc_3.json

@@ -1,4 +0,0 @@
-{
-    "title": "kein EEPROM gefunden",
-    "description": "Es wurde kein EEPROM gefunden. Dies lässt einen Hardware-Defekt vermuten."
-}

Software/data_src/static/tt_dtc/dtc_4.json

@@ -1,4 +0,0 @@
-{
-    "title": "EEPROM CFG Checksumme",
-    "description": "Die Checksumme der Config-Partition des EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'CFG' im Menu 'Wartung' zurück"
-}

Software/data_src/static/tt_dtc/dtc_5.json

@@ -1,4 +0,0 @@
-{
-    "title": "EEPROM PDS Checksumme",
-    "description": "Die Checksumme der Betriebsdaten-Partition des EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'PDS' im Menu 'Wartung' zurück"
-}

Software/data_src/static/tt_dtc/dtc_6.json

@@ -1,4 +0,0 @@
-{
-    "title": "EEPROM PDS Adresse",
-    "description": "Die Adresse der Betriebsdaten-Partition im EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'PDS' im Menu 'Wartung' zurück"
-}

Software/data_src/static/tt_dtc/dtc_7.json

@@ -1,4 +0,0 @@
-{
-    "title": "EEPROM Version falsch",
-    "description": "Die Layout-Version des EEPROM stimmt nicht mit der Firmware-Version überein. Setzen sie den EEPROM-Bereich 'CFG' im Menu 'Wartung' zurück"
-}

Software/data_src/static/tt_dtc/dtc_8.json

@@ -1,4 +0,0 @@
-{
-    "title": "Flashstorage Fehler",
-    "description": "Der Flashstorage konnte nicht initialisiert werden. Aktualisieren sie Flash & Firmware"
-}

Software/data_src/static/tt_dtc/dtc_9.json

@@ -1,4 +0,0 @@
-{
-    "title": "Flashstorage Version falsch",
-    "description": "Die Version des Flashstorage stimmt nicht mit der Firmware-Version überein. Aktualisieren sie den Flash mit der passenden Update-Datei"
-}

Software/data_src/version

@@ -1 +1 @@
-1.3
+1.04

Software/include/can.h

@@ -0,0 +1,38 @@
+/**
+ * @file can.h
+ *
+ * @brief Header file for Controller Area Network (CAN) functionality in the ChainLube application.
+ *
+ * This file provides functions and structures related to Controller Area Network (CAN)
+ * communication for the ChainLube project. It includes functions for initializing CAN,
+ * processing CAN messages, and retrieving wheel speed from CAN data.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _CAN_H_
+#define _CAN_H_
+
+#include <Arduino.h>
+#include <mcp_can.h>
+#include <SPI.h>
+#include "common.h"
+#include "globals.h"
+#include "dtc.h"
+#include "debugger.h"
+
+// CAN frame structure definition
+struct can_frame
+{
+    unsigned long can_id;
+    uint8_t can_dlc;
+    uint8_t data[8] __attribute__((aligned(8)));
+};
+
+// Function prototypes
+void Init_CAN();
+void CAN_Process();
+uint32_t Process_CAN_WheelSpeed();
+
+#endif

Software/include/common.h

@@ -0,0 +1,123 @@
+/**
+ * @file common.h
+ *
+ * @brief Header file for common definitions and macros in the ChainLube application.
+ *
+ * This file defines common macros, GPIO configurations, and other shared constants
+ * for the ChainLube project. It includes definitions for GPIO pins, OTA delays, pulse lengths,
+ * and other common settings used across the project.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _COMMON_H_
+#define _COMMON_H_
+
+#include <stddef.h>
+
+#define Q(x) #x
+#define QUOTE(x) Q(x)
+#define SET_BIT(value, bitPosition) ((value) |= (1U << (bitPosition)))
+
+// Conditional compilation based on PCB revision
+#if PCB_REV == 1
+    #define GPIO_BUTTON D7
+    #define GPIO_LED D8
+    #define GPIO_TRIGGER D6
+    #define GPIO_PUMP D5
+#elif PCB_REV == 2
+    #define GPIO_BUTTON D7
+    #define GPIO_LED D8
+    #define GPIO_TRIGGER D6
+    #define GPIO_PUMP D5
+#elif PCB_REV == 3
+    #define GPIO_BUTTON D4
+    #define GPIO_LED D3
+    #define GPIO_TRIGGER D6
+    #define GPIO_PUMP D0
+    #define GPIO_CS_CAN D8
+#elif PCB_REV == 4
+    #define GPIO_BUTTON D4
+    #define GPIO_LED D3
+    #define GPIO_TRIGGER D6
+    #define GPIO_PUMP D0
+    #define GPIO_CS_CAN D8
+#endif
+
+#ifndef HOST_NAME
+#define HOST_NAME "ChainLube_%06X" // Use printf-Formatting - Chip-ID (uin32_t) will be added
+#endif
+
+#ifndef OTA_DELAY
+#define OTA_DELAY 50 // ticks -> 10ms / tick
+#endif
+
+#define LUBE_PULSE_LENGHT_MS 160
+#define LUBE_PULSE_PAUSE_MS 340
+
+// Pump pulse parameters
+// -> 2Hz PumpPulse
+// -> 49.7cc / h @ 2Hz
+// -> 49.7 ml / h @ 2Hz
+// -> 828.4µl / min @ 2Hz
+// -> 828.3µl / 60s
+// -> 13.81µl / 1s
+// ->  6.90µl / Pulse
+#define DEFAULT_PUMP_DOSE 7
+
+typedef enum eSystem_Status
+{
+  sysStat_Startup,
+  sysStat_Normal,
+  sysStat_Rain,
+  sysStat_Purge,
+  sysStat_Error,
+  sysStat_Shutdown
+} tSystem_Status;
+
+// Enum for different sources of speed input
+typedef enum SpeedSource_e
+{
+#ifdef FEATURE_ENABLE_TIMER
+  SOURCE_TIME,
+#endif
+  SOURCE_IMPULSE,
+  SOURCE_GPS,
+  SOURCE_CAN
+} SpeedSource_t;
+
+// String representation of SpeedSource enum
+extern const char *SpeedSourceString[];
+extern const size_t SpeedSourceString_Elements;
+
+// Enum for GPS baud rates
+typedef enum GPSBaudRate_e
+{
+  BAUD_4800,
+  BAUD_9600,
+  BAUD_19200,
+  BAUD_38400,
+  BAUD_57600,
+  BAUD_115200
+} GPSBaudRate_t;
+
+// String representation of GPSBaudRate enum
+extern const char *GPSBaudRateString[];
+extern const size_t GPSBaudRateString_Elements;
+
+// Enum for CAN bus sources
+typedef enum CANSource_e
+{
+  KTM_890_ADV_R_2021,
+  KTM_1290_SD_R_2023
+} CANSource_t;
+
+// String representation of CANSource enum
+extern const char *CANSourceString[];
+extern const size_t CANSourceString_Elements;
+
+#define STARTUP_DELAY 2500
+#define SHUTDOWN_DELAY_MS 2500
+
+#endif

Software/include/config.h

@@ -0,0 +1,105 @@
+/**
+ * @file config.h
+ *
+ * @brief Header file for configuration settings and EEPROM operations in the ChainLube application.
+ *
+ * This file defines configuration settings for the ChainLube project, including default values,
+ * EEPROM structures, and functions for EEPROM operations. It also defines enums for different sources
+ * of speed input, GPS baud rates, and CAN bus sources. Additionally, it includes functions for EEPROM handling
+ * such as storing, retrieving, and formatting configuration data.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _CONFIG_H_
+#define _CONFIG_H_
+
+#include <Arduino.h>
+#include <Wire.h>
+#include <I2C_eeprom.h>
+#include "dtc.h"
+#include "common.h"
+
+#if PCB_REV == 1 || PCB_REV == 2 || PCB_REV == 3
+#define EEPROM_SIZE_BYTES I2C_DEVICESIZE_24LC64
+#elif PCB_REV == 4
+#define EEPROM_SIZE_BYTES I2C_DEVICESIZE_24LC256
+#endif
+
+typedef enum EERequest_e
+{
+  EE_IDLE,
+  EE_CFG_SAVE,
+  EE_CFG_LOAD,
+  EE_CFG_FORMAT,
+  EE_PDS_SAVE,
+  EE_PDS_LOAD,
+  EE_PDS_FORMAT,
+  EE_FORMAT_ALL,
+  EE_ALL_SAVE
+
+} EERequest_t;
+
+// Structure for persistence data stored in EEPROM
+typedef struct
+{
+  uint16_t writeCycleCounter;
+  uint32_t tankRemain_microL;
+  uint32_t TravelDistance_highRes_mm;
+  uint32_t odometer_mm;
+  uint32_t odometer;
+  uint32_t checksum;
+} persistenceData_t;
+
+// Structure for configuration settings stored in EEPROM
+typedef struct
+{
+  uint8_t EEPROM_Version;
+  uint32_t DistancePerLube_Default;
+  uint32_t DistancePerLube_Rain;
+  uint32_t tankCapacity_ml;
+  uint32_t amountPerDose_microL;
+  uint8_t TankRemindAtPercentage;
+  uint8_t PulsePerRevolution;
+  uint32_t TireWidth_mm;
+  uint32_t TireWidthHeight_Ratio;
+  uint32_t RimDiameter_Inch;
+  uint32_t DistancePerRevolution_mm;
+  uint16_t BleedingPulses;
+  SpeedSource_t SpeedSource;
+  GPSBaudRate_t GPSBaudRate;
+  CANSource_t CANSource;
+  bool LED_Mode_Flash;
+  uint8_t LED_Max_Brightness;
+  uint8_t LED_Min_Brightness;
+  uint32_t checksum;
+} LubeConfig_t;
+
+// Default configuration settings
+const LubeConfig_t LubeConfig_defaults = {
+    0, 8000, 4000, 320, DEFAULT_PUMP_DOSE, 30, 1, 150, 70, 18, 2000, 25, SOURCE_IMPULSE,
+    BAUD_115200,
+    KTM_890_ADV_R_2021,
+    false,
+    255,
+    5,
+    0};
+
+void InitEEPROM();
+void EEPROM_Process();
+void StoreConfig_EEPROM();
+void GetConfig_EEPROM();
+void StorePersistence_EEPROM();
+void GetPersistence_EEPROM();
+void FormatConfig_EEPROM();
+void FormatPersistence_EEPROM();
+uint32_t Checksum_EEPROM(uint8_t const *data, size_t len);
+void dumpEEPROM(uint16_t memoryAddress, uint16_t length);
+void MovePersistencePage_EEPROM(boolean reset);
+uint32_t ConfigSanityCheck(bool autocorrect = false);
+
+extern LubeConfig_t LubeConfig;
+extern persistenceData_t PersistenceData;
+extern uint16_t eePersistenceMarker;
+#endif // _CONFIG_H_

Software/include/debugger.h

@@ -0,0 +1,58 @@
+/**
+ * @file debugger.h
+ *
+ * @brief Header file for debugging functions and status in the ChainLube application.
+ *
+ * This file declares functions and status definitions for debugging purposes in the ChainLube project.
+ * It includes functions to print system information, WiFi information, format EEPROM data,
+ * handle debug messages, and manage the status of different debug ports.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _DEBUGGER_H_
+#define _DEBUGGER_H_
+
+#include <Arduino.h>
+#include "webui.h"
+const char PROGMEM helpCmd[] = "sysinfo     - System Info\n"
+                               "netinfo     - WiFi Info\n"
+                               "formatPDS   - Format Persistence EEPROM Data\n"
+                               "formatCFG   - Format Configuration EEPROM Data\n"
+                               "checkEE     - Check EEPROM with checksum\n"
+                               "dumpEE1k    - dump the first 1kb of EEPROM to Serial\n"
+                               "dumpEE      - dump the whole EPPROM to Serial\n"
+                               "resetPageEE - Reset the PersistenceData Page\n"
+                               "dumpCFG     - print Config struct\n"
+                               "dumpPDS     - print PersistanceStruct\n"
+                               "saveEE      - save EE-Data\n"
+                               "showdtc     - Show all DTCs\n"
+                               "dumpGlobals - print globals\n";
+
+typedef enum DebugStatus_e
+{
+    disabled,
+    enabled
+} DebugStatus_t;
+
+typedef enum DebugPorts_e
+{
+    dbg_Serial,
+    dbg_Webui,
+    dbg_cntElements
+} DebugPorts_t;
+
+const char sDebugPorts[dbg_cntElements][7] = {
+    "Serial",
+    "WebUI"};
+
+extern DebugStatus_t DebuggerStatus[dbg_cntElements];
+
+void initDebugger();
+void pushCANDebug(uint32_t id, uint8_t dlc, uint8_t *data);
+void Debug_pushMessage(const char *format, ...);
+void SetDebugportStatus(DebugPorts_t port, DebugStatus_t status);
+void Debug_Process();
+
+#endif

Software/include/dtc.h

@@ -0,0 +1,39 @@
+/**
+ * @file dtc.h
+ *
+ * @brief Header file for handling Diagnostic Trouble Codes (DTC) in the ChainLube application.
+ *
+ * This file provides definitions and functions for handling Diagnostic Trouble Codes (DTC)
+ * in the ChainLube project. It includes structures for DTC entries, severity levels,
+ * and functions for DTC maintenance and processing. DTCs are used to track system errors and issues.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _DTC_H_
+#define _DTC_H_
+
+#include <Arduino.h>
+#include "dtc_defs.h"
+
+#define MAX_DTC_STORAGE 6
+
+typedef struct
+{
+  DTCNum_t Number;
+  uint32_t timestamp;
+  DTCActive_t active;
+  uint32_t debugVal;
+} DTCEntry_t;
+
+void MaintainDTC(DTCNum_t DTC_no, boolean active, uint32_t DebugValue = 0);
+void ClearDTC(DTCNum_t DTC_no);
+void ClearAllDTC();
+DTCNum_t getlastDTC(boolean only_active);
+DTCNum_t ActiveDTCseverity(DTCSeverity_t severity);
+DTCSeverity_t getSeverityForDTC(DTCNum_t targetCode);
+void DTC_Process();
+
+extern DTCEntry_t DTCStorage[MAX_DTC_STORAGE];
+#endif

Software/include/dtc_defs.h

@@ -0,0 +1,85 @@
+/**
+ * @file dtc_defs.h
+ *
+ * @brief Header file for Diagnostic Trouble Code (DTC) definitions in the ChainLube application.
+ *
+ * This file contains definitions for Diagnostic Trouble Codes (DTC) in the ChainLube project.
+ * It includes enums for DTC active status, severity levels, and specific DTC codes.
+ * The file also defines an array of DTC definitions and a timestamp indicating the generation time.
+ *
+ * @note This file is auto-generated by a script on 2024-01-10 18:37:05.
+ *
+ * @author Marcel Peterkau
+ * @date   10.01.2024
+ */
+
+#ifndef DTC_DEFS_H
+#define DTC_DEFS_H
+
+#include <stdint.h>
+
+typedef uint32_t DTCNum_t;
+
+typedef enum
+{
+  DTC_INACTIVE,
+  DTC_ACTIVE,
+  DTC_PREVIOUS
+} DTCActive_t;
+
+typedef enum
+{
+  DTC_NONE,
+  DTC_INFO,
+  DTC_WARN,
+  DTC_CRITICAL
+} DTCSeverity_t;
+
+typedef struct {
+  DTCNum_t code;
+  DTCSeverity_t severity;
+} DTC_t;
+
+#define DTC_NO_DTC                     0
+#define DTC_TANK_EMPTY                 1
+#define DTC_TANK_LOW                   2
+#define DTC_NO_EEPROM_FOUND            3
+#define DTC_EEPROM_CFG_BAD             4
+#define DTC_EEPROM_PDS_BAD             5
+#define DTC_EEPROM_PDSADRESS_BAD       6
+#define DTC_EEPROM_VERSION_BAD         7
+#define DTC_FLASHFS_ERROR              8
+#define DTC_FLASHFS_VERSION_ERROR      9
+#define DTC_NO_GPS_SERIAL              10
+#define DTC_CAN_TRANSCEIVER_FAILED     11
+#define DTC_NO_CAN_SIGNAL              12
+#define DTC_EEPROM_CFG_SANITY          13
+#define DTC_FAKE_DTC_INFO              14
+#define DTC_FAKE_DTC_WARN              15
+#define DTC_FAKE_DTC_CRIT              16
+#define DTC_LAST_DTC                   17
+
+const DTC_t dtc_definitions[] = {
+    { DTC_NO_DTC                    , DTC_NONE     }, // No Error
+    { DTC_TANK_EMPTY                , DTC_CRITICAL }, // Ölvorrat ist komplett leer. Den Ölvorrat auffüllen und im Menu 'Wartung' zurück setzen
+    { DTC_TANK_LOW                  , DTC_WARN     }, // Ölvorrat ist unter der Warnschwelle. Den Ölvorrat demnächst auffüllen und im Menu 'Wartung' zurück setzen
+    { DTC_NO_EEPROM_FOUND           , DTC_CRITICAL }, // Es wurde kein EEPROM gefunden. Dies lässt einen Hardware-Defekt vermuten.
+    { DTC_EEPROM_CFG_BAD            , DTC_CRITICAL }, // Die Checksumme der Config-Partition des EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'CFG' im Menu 'Wartung' zurück
+    { DTC_EEPROM_PDS_BAD            , DTC_CRITICAL }, // Die Checksumme der Betriebsdaten-Partition des EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'PDS' im Menu 'Wartung' zurück
+    { DTC_EEPROM_PDSADRESS_BAD      , DTC_CRITICAL }, // Die Adresse der Betriebsdaten-Partition im EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'PDS' im Menu 'Wartung' zurück
+    { DTC_EEPROM_VERSION_BAD        , DTC_CRITICAL }, // Die Layout-Version des EEPROM stimmt nicht mit der Firmware-Version überein. Setzen sie den EEPROM-Bereich 'CFG' im Menu 'Wartung' zurück
+    { DTC_FLASHFS_ERROR             , DTC_CRITICAL }, // Der Flashspeicher konnte nicht initialisiert werden. Aktualisieren sie Flash & Firmware
+    { DTC_FLASHFS_VERSION_ERROR     , DTC_CRITICAL }, // Die Version des Flashspeicher stimmt nicht mit der Firmware-Version überein. Aktualisieren sie den Flash mit der passenden Update-Datei
+    { DTC_NO_GPS_SERIAL             , DTC_CRITICAL }, // Es wurde kein GPS-Signal über die serielle Schnittstelle empfangen, Prüfen sie die Verbindung und das GPS-Modul
+    { DTC_CAN_TRANSCEIVER_FAILED    , DTC_CRITICAL }, // Es konnte keine Verbindung zum CAN-Transceiver hergestellt werden. Prüfen Sie die Hardware auf Defekte
+    { DTC_NO_CAN_SIGNAL             , DTC_WARN     }, // Es konnte kein CAN-Signal empfangen werden. Prüfen sie die Verbindung und die Einstellungen
+    { DTC_EEPROM_CFG_SANITY         , DTC_WARN     }, // Ein oder mehrer Einstellungswerte sind ausserhalb plausibler Werte. Prüfen Sie Ihre Einstellungen
+    { DTC_FAKE_DTC_INFO             , DTC_INFO     }, // Ein Dummy-DTC der Schwere "Info" für Debugging-Zwecke
+    { DTC_FAKE_DTC_WARN             , DTC_WARN     }, // Ein Dummy-DTC der Schwere "Warnung" für Debugging-Zwecke
+    { DTC_FAKE_DTC_CRIT             , DTC_CRITICAL }, // Ein Dummy-DTC der Schwere "Kritisch" für Debugging-Zwecke
+    { DTC_LAST_DTC                  , DTC_NONE     }  // Last Error
+};
+
+#endif // DTC_DEFS_H
+
+// CODEGENERATOR_CHECKSUM: 23dff82a4745f67041012080b05ec367c2dd44c6bb02974143b227ba49682b6f

Software/include/globals.h

@@ -0,0 +1,59 @@
+/**
+ * @file globals.h
+ *
+ * @brief Header file for global variables and enums in the ChainLube application.
+ *
+ * This file contains declarations for global variables and enums used in the ChainLube application.
+ * It includes enums for system status and EEPROM-related requests, as well as a struct for global variables.
+ * The file also defines a struct for constants and initializes it with firmware and required flash version information.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _GLOBALS_H_
+#define _GLOBALS_H_
+
+#include <Arduino.h>
+#include "config.h"
+#include "common.h"
+
+typedef struct Globals_s
+{
+  tSystem_Status systemStatus = sysStat_Startup;      /**< Current system status */
+  tSystem_Status resumeStatus = sysStat_Startup;      /**< Status to resume after rain mode */
+  char systemStatustxt[16] = "";                      /**< Text representation of system status */
+  uint16_t purgePulses = 0;                           /**< Number of purge pulses */
+  EERequest_t requestEEAction = EE_IDLE;;              /**< EEPROM-related request */
+  char DeviceName[33];                                /**< Device name */
+  char FlashVersion[10];                              /**< Flash version */
+  uint16_t eePersistanceAdress;                       /**< EEPROM persistence address */
+  uint8_t TankPercentage;                             /**< Tank percentage */
+  bool hasDTC;                                        /**< Flag indicating the presence of Diagnostic Trouble Codes (DTC) */
+  bool measurementActive;                             /**< Flag indicating active measurement */
+  uint32_t measuredPulses;                            /**< Number of measured pulses */
+} Globals_t;
+
+extern Globals_t globals;                             /**< Global variable struct */
+
+typedef struct Constants_s
+{
+  uint8_t FW_Version_major;          /**< Firmware version major number */
+  uint8_t FW_Version_minor;          /**< Firmware version minor number */
+  uint8_t Required_Flash_Version_major; /**< Required flash version major number */
+  uint8_t Required_Flash_Version_minor; /**< Required flash version minor number */
+  char GitHash[11];                 /**< Git hash string */
+} Constants_t;
+
+const Constants_t constants PROGMEM = {
+ 1,4,     // Firmware_Version
+ 1,4,     // Required Flash Version
+ GIT_REV  // Git-Hash-String
+};
+
+/**
+ * @brief Initializes global variables.
+ */
+void initGlobals();
+
+#endif // _GLOBALS_H_

Software/include/gps.h

@@ -0,0 +1,36 @@
+/**
+ * @file gps.h
+ *
+ * @brief Header file for GPS-related functions in the ChainLube application.
+ *
+ * This file contains declarations for functions related to GPS (Global Positioning System) functionality
+ * within the ChainLube application. It includes the initialization of the GPS module and processing of GPS
+ * data to calculate wheel speed. Additionally, it references other necessary header files for configuration,
+ * common definitions, diagnostics, and debugging.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _GPS_H_
+#define _GPS_H_
+
+#include <TinyGPSPlus.h>
+#include "config.h"
+#include "common.h"
+#include "dtc.h"
+#include "debugger.h"
+
+/**
+ * @brief Initializes the GPS module.
+ */
+void Init_GPS();
+
+/**
+ * @brief Processes GPS data to calculate wheel speed.
+ *
+ * @return Calculated wheel speed in millimeters per second.
+ */
+uint32_t Process_GPS_WheelSpeed();
+
+#endif // _GPS_H_

Software/include/led_colors.h

@@ -0,0 +1,45 @@
+/**
+ * @file led_colors.h
+ *
+ * @brief Header file defining color values for LEDs in the ChainLube application.
+ *
+ * This file contains color definitions in hexadecimal format for various states and events of LEDs
+ * used in the ChainLube application. It provides a convenient way to reference specific colors for
+ * different visual indications in the system.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _LED_COLORS_H_
+#define _LED_COLORS_H_
+
+#define COLOR_RED           0xFF0000
+#define COLOR_GREEN         0x00FF00
+#define COLOR_BLUE          0x0000FF
+#define COLOR_YELLOW        0xFF9600
+#define COLOR_ORANGE        0xFF2800
+#define COLOR_TEAL          0x00FF78
+#define COLOR_CYAN          0x00FFFF
+#define COLOR_PURPLE        0xB400FF
+#define COLOR_MAGENTA       0xFF0014
+#define COLOR_WHITE         0xFFFFFF
+#define COLOR_BLACK         0x000000
+#define COLOR_GOLD          0xFFDE1E
+#define COLOR_PINK          0xF25AFF
+#define COLOR_AQUA          0x32FFFF
+#define COLOR_JADE          0x00FF28
+#define COLOR_AMBER         0xFF6400
+#define COLOR_WARM_WHITE    0xFDF5E6
+
+#define LED_DEFAULT_COLOR       COLOR_WARM_WHITE
+#define LED_STARTUP_NORMAL      COLOR_WARM_WHITE
+#define LED_STARTUP_TANKWARN    COLOR_AMBER
+#define LED_NORMAL_COLOR        COLOR_GREEN
+#define LED_RAIN_COLOR          COLOR_BLUE
+#define LED_WIFI_BLINK          COLOR_YELLOW
+#define LED_PURGE_COLOR         COLOR_MAGENTA
+#define LED_ERROR_BLINK         COLOR_RED
+#define LED_SHUTDOWN_BLINK      COLOR_CYAN
+
+#endif /* _LED_COLORS_H_ */

Software/include/lubeapp.h

@@ -0,0 +1,27 @@
+/**
+ * @file lubeapp.h
+ *
+ * @brief Header file for the ChainLube application functions.
+ *
+ * This file contains function declarations related to the main functionality of the ChainLube
+ * application. It includes functions for running the application and generating lubrication pulses.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _LUBEAPP_H_
+#define _LUBEAPP_H_
+
+#include <Arduino.h>
+#include <stdlib.h>
+#include "config.h"
+#include "common.h"
+#include "globals.h"
+#include "dtc.h"
+#include "debugger.h"
+
+void RunLubeApp(uint32_t add_milimeters);
+void LubePulse();
+
+#endif /* _LUBEAPP_H_ */

Software/include/sanitycheck.h

@@ -1,3 +1,15 @@
+/**
+ * @file sanitycheck.h
+ *
+ * @brief Header file for sanity checks and configuration validation in the ChainLube application.
+ *
+ * This file contains checks and validations to ensure that the configuration and features of the
+ * ChainLube application are compatible with the selected PCB revision and defined parameters.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
 #ifndef _SANITYCHECK_H_
 #define _SANITYCHECK_H_
 
@@ -8,11 +20,11 @@
         #error "Unsupported PCB-Revision"
     #endif
 
-    #if PCB_REV < 4 && defined(FEATURE_ENABLE_CAN)
+    #if PCB_REV < 3 && defined(FEATURE_ENABLE_CAN)
         #error "CAN-Feature unsupported with this PCB-Rev"
     #endif
     #if PCB_REV < 4 && defined(DFEATURE_ENABLE_GPS)
-        #error "CAN-Feature unsupported with this PCB-Rev"
+        #error "GPS-Feature unsupported with this PCB-Rev"
     #endif
 #endif
 
@@ -34,4 +46,4 @@
 #error "You must define an WIFI_AP_PASSWORD for Standalone AP-Mode"
 #endif
 
-#endif //_SANITYCHECK_H_
+#endif // _SANITYCHECK_H_

Software/include/struct2json.h

@@ -0,0 +1,26 @@
+/**
+ * @file struct2json.h
+ *
+ * @brief Header file for converting structs to JSON objects.
+ *
+ * @note This file is auto-generated by a script on 2024-01-10 18:01:52.
+ *
+ * @author Marcel Peterkau
+ * @date   10.01.2024
+ */
+
+#ifndef _STRUCT2JSON_H_
+#define _STRUCT2JSON_H_
+
+#include <Arduino.h>
+#include <ArduinoJson.h>
+
+#include "config.h"
+
+void generateJsonObject_LubeConfig(JsonObject& data);
+void generateJsonObject_PersistenceData(JsonObject& data);
+
+
+#endif /* _STRUCT2JSON_H_ */
+
+// CODEGENERATOR_CHECKSUM: 9e8dd21170fd6ef8fbf8c4b156d9af751836a76081f811bf0e3ab2b1eb8ee48c

Software/include/webui.h

@@ -0,0 +1,40 @@
+/**
+ * @file webui.h
+ *
+ * @brief Header file for the web-based user interface (WebUI) in the ChainLube application.
+ *
+ * This file contains declarations for functions related to the initialization and processing of the
+ * web-based user interface (WebUI). It includes the necessary libraries and dependencies for handling
+ * web server functionality, asynchronous JSON operations, and live debugging through WebSockets.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _WEBUI_H_
+#define _WEBUI_H_
+
+#include <Arduino.h>
+#include <FS.h>
+#include <LittleFS.h>
+#include <ESPAsyncTCP.h>
+#include <ESPAsyncWebServer.h>
+#include <Updater.h>
+#include <ESP8266mDNS.h>
+#include <AsyncJson.h>
+#include <ArduinoJson.h>
+
+#include "config.h"
+#include "globals.h"
+#include "dtc.h"
+#include "common.h"
+#include "debugger.h"
+#include "struct2json.h"
+
+void initWebUI();
+void Webserver_Process();
+void Webserver_Shutdown();
+
+void Websocket_PushLiveDebug(String Message);
+
+#endif // _WEBUI_H_

Software/platformio.ini

@@ -11,51 +11,78 @@
 [platformio]
 extra_configs =
   wifi_credentials.ini
+default_envs = pcb_rev_1-3, pcb_rev_1-2
 
-[env:d1_mini]
+[env]
 platform = espressif8266
 board = d1_mini
 framework = arduino
 
-upload_protocol = esptool
+upload_speed = 921600 
-upload_speed = 921600
+
-;upload_port = ChainLube_DDEFB2
+upload_protocol = espota
-;upload_protocol = espota
+upload_port = 10.0.1.14
-;upload_flags =  
+upload_flags =
-;    --auth=${wifi_cred.admin_password}
+  --port=8266
+  --auth=${wifi_cred.admin_password}
+
 
 build_flags =
-  !python git_rev_macro.py
+  !python codegen/git_rev_macro.py
   -DWIFI_SSID_CLIENT=${wifi_cred.wifi_ssid_client}
   -DWIFI_PASSWORD_CLIENT=${wifi_cred.wifi_password_client}
   -DADMIN_PASSWORD=${wifi_cred.admin_password}
   -DWIFI_AP_PASSWORD=${wifi_cred.wifi_ap_password}
   -DWIFI_AP_IP_GW=10,0,0,1
   -DATOMIC_FS_UPDATE
-  -DFEATURE_ENABLE_WIFI_CLIENT
-  -DFEATURE_ENABLE_OLED
-  -DFEATURE_ENABLE_CAN
-  ;-DFEATURE_ENABLE_GPS
-  -DFEATURE_ENABLE_WEBSOCKETS
-  -DPCB_REV=4
-  ;-DNO_MODE_FLASH
-
-;build_type = debug
 
 board_build.filesystem = littlefs
-extra_scripts = post:prepare_littlefs.py
+extra_scripts = 
+  post:codegen/prepare_littlefs.py
+  pre:codegen/run_pre.py
 
 monitor_filters = esp8266_exception_decoder
 monitor_speed = 115200
 
-board_build.ldscript = eagle.flash.4m1m.ld
 lib_ldf_mode = deep
 lib_deps = 
-    olikraus/U8g2 @ ^2.28.8
+    olikraus/U8g2 @ ^2.35.9
-    https://github.com/FastLED/FastLED.git#3d2ab78 ;fastled/FastLED @ ^3.5.0
+    adafruit/Adafruit NeoPixel @ ^1.12.0
-    sstaub/Ticker @ ^4.2.0
+    sstaub/Ticker @ ^4.4.0
+    robtillaart/I2C_EEPROM @ ^1.8.2
+    esphome/ESPAsyncWebServer-esphome @ 3.1.0
+    bblanchon/ArduinoJson @ ^7.0.1
+
+[env:pcb_rev_1-3]
+;build_type = debug
+custom_pcb_revision = 3
+build_flags =
+  ${env.build_flags}
+  ;-DFEATURE_ENABLE_WIFI_CLIENT
+  ;-DFEATURE_ENABLE_TIMER
+  -DFEATURE_ENABLE_OLED
+  -DCAN_DEBUG_MESSAGE
+  -DPCB_REV=${this.custom_pcb_revision}
+
+board_build.ldscript = eagle.flash.4m1m.ld
+
+lib_deps = 
+    ${env.lib_deps}
     coryjfowler/mcp_can @ ^1.5.0
-    robtillaart/I2C_EEPROM @ ^1.5.2
     mikalhart/TinyGPSPlus @ ^1.0.3
-    me-no-dev/ESP Async WebServer @ ^1.2.3
+    
-    bblanchon/ArduinoJson @ ^6.19.4
+[env:pcb_rev_1-2]
+;build_type = debug
+custom_pcb_revision = 2
+build_flags =
+  ${env.build_flags}
+  ;-DFEATURE_ENABLE_WIFI_CLIENT
+  ;-DFEATURE_ENABLE_TIMER
+  -DFEATURE_ENABLE_OLED
+  -DFEATURE_ENABLE_WEBSOCKETS
+  -DPCB_REV=${this.custom_pcb_revision}
+
+board_build.ldscript = eagle.flash.4m1m.ld
+
+lib_deps = 
+    ${env.lib_deps}

Software/src/can.cpp

@@ -1,37 +1,108 @@
-#ifdef FEATURE_ENABLE_CAN
+/**
+ * @file can.cpp
+ *
+ * @brief Implementation file for CAN-related functions in the ChainLube application.
+ *
+ * This file contains the implementation of functions related to CAN (Controller Area Network)
+ * communication within the ChainLube application. It includes the initialization of the CAN module,
+ * setup of masks and filters, and processing of CAN messages. Additionally, a debug message function
+ * is included if CAN debugging is enabled.
+ *
+ * @author Your Name
+ * @date   Date
+ */
+
 #include "can.h"
 
 MCP_CAN CAN0(GPIO_CS_CAN);
+#ifdef CAN_DEBUG_MESSAGE
+#define MAX_DEBUG_RETRIES 100
+void sendCANDebugMessage();
+#endif
 
+/**
+ * @brief Initializes the CAN module, sets masks, and filters based on the configured CAN source.
+ *
+ * This function initializes the CAN module, sets masks and filters based on the configured CAN source
+ * in the application settings, and sets the CAN module in normal mode for communication.
+ */
 void Init_CAN()
 {
-
     if (CAN0.begin(MCP_STDEXT, CAN_500KBPS, MCP_16MHZ) != CAN_OK)
-        MaintainDTC(DTC_CAN_TRANSCEIVER_FAILED, DTC_CRITICAL, true);
+        MaintainDTC(DTC_CAN_TRANSCEIVER_FAILED, true);
 
     CAN0.init_Mask(0, 0, 0x07FF0000); // Init first mask...
     CAN0.init_Mask(1, 0, 0x07FF0000); // Init second mask...
-    CAN0.init_Filt(0, 0, 0x012D0000); // Init first filter...
+
+    switch (LubeConfig.CANSource)
+    {
+    case KTM_890_ADV_R_2021:
+        CAN0.init_Filt(0, 0, 0x012D0000); // Init first filter...
+        break;
+    case KTM_1290_SD_R_2023:
+        CAN0.init_Filt(0, 0, 0x012D0000); // Init first filter...
+        break;
+    default:
+        break;
+    }
 
     CAN0.setMode(MCP_NORMAL);
 }
 
+/**
+ * @brief Processes CAN messages and sends a CAN debug message periodically.
+ *
+ * This function processes CAN messages and sends a CAN debug message periodically based on a time interval.
+ */
+void CAN_Process()
+{
+    static uint32_t previousMillis = 0;
+
+    if (millis() - previousMillis >= 100)
+    {
+        sendCANDebugMessage();
+        previousMillis = millis();
+    }
+}
+/**
+ * @brief Processes CAN messages to determine the wheel speed based on the configured CAN source.
+ *
+ * This function reads incoming CAN messages and extracts the rear wheel speed information.
+ * The wheel speed is then converted to millimeters per second based on the configured CAN source.
+ * The function also monitors the CAN signal for potential issues and triggers diagnostic trouble codes (DTCs).
+ *
+ * @return The calculated distance traveled in millimeters since the last call.
+ */
 uint32_t Process_CAN_WheelSpeed()
 {
 #define FACTOR_RWP_KMH_890ADV 18 // Divider to convert Raw Data to km/h
-
+#define FACTOR_RWP_KMH_1290SD 18 // Divider to convert Raw Data to km/h
     can_frame canMsg;
     static uint32_t lastRecTimestamp = 0;
     uint16_t RearWheelSpeed_raw;
     uint32_t milimeters_to_add = 0;
+    uint32_t RWP_millimeter_per_second = 0;
 
     if (CAN0.readMsgBuf(&canMsg.can_id, &canMsg.can_dlc, canMsg.data) == CAN_OK)
     {
 
-        RearWheelSpeed_raw = (uint16_t)canMsg.data[5] << 8 | canMsg.data[6];
+        switch (LubeConfig.CANSource)
-        // raw / FACTOR_RWP_KMH_890ADV -> km/h * 100000 -> cm/h / 3600 -> cm/s
+        {
-        // raw * 500 -> cm/s
+        case KTM_890_ADV_R_2021:
-        uint32_t RWP_millimeter_per_second = (((uint32_t)RearWheelSpeed_raw * 1000000) / FACTOR_RWP_KMH_890ADV) / 3600;
+            // raw / FACTOR_RWP_KMH_890ADV -> km/h * 100000 -> cm/h / 3600 -> cm/s
+            // raw * 500 -> cm/s
+            RearWheelSpeed_raw = (uint16_t)canMsg.data[5] << 8 | canMsg.data[6];
+            RWP_millimeter_per_second = (((uint32_t)RearWheelSpeed_raw * 1000000) / FACTOR_RWP_KMH_890ADV) / 3600;
+            break;
+        case KTM_1290_SD_R_2023:
+            // raw / FACTOR_RWP_KMH_1290SD -> km/h * 100000 -> cm/h / 3600 -> cm/s
+            // raw * 500 -> cm/s
+            RearWheelSpeed_raw = (uint16_t)canMsg.data[5] << 8 | canMsg.data[6];
+            RWP_millimeter_per_second = (((uint32_t)RearWheelSpeed_raw * 1000000) / FACTOR_RWP_KMH_1290SD) / 3600;
+            break;
+        default:
+            break;
+        }
 
         uint32_t timesincelast = millis() - lastRecTimestamp;
         lastRecTimestamp = millis();
@@ -39,11 +110,80 @@ uint32_t Process_CAN_WheelSpeed()
         milimeters_to_add = (RWP_millimeter_per_second * timesincelast) / 1000;
     }
 
-    if (lastRecTimestamp != 0)
+    if (lastRecTimestamp > 1000)
     {
-        MaintainDTC(DTC_NO_CAN_SIGNAL, DTC_CRITICAL, (millis() > lastRecTimestamp + 10000 ? true : false));
+        MaintainDTC(DTC_NO_CAN_SIGNAL, (millis() > lastRecTimestamp + 10000 ? true : false));
     }
 
     return milimeters_to_add;
 }
+
+#ifdef CAN_DEBUG_MESSAGE
+/**
+ * @brief Sends periodic CAN debug messages for monitoring and diagnostics.
+ *
+ * This function sends periodic CAN debug messages containing various system information for monitoring and diagnostics.
+ * The information includes system status, timestamps, tank percentage, DTC flags, and other relevant data.
+ * The debug messages are sent with a configurable multiplexer to broadcast different types of information in each cycle.
+ */
+void sendCANDebugMessage()
+{
+#define MAX_DEBUG_MULTIPLEXER 6
+    static uint16_t DebugSendFailTimeout = 0;
+    static uint8_t debugMultiplexer = 0;
+    byte data[8] = {debugMultiplexer, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
+    uint32_t millisValue = millis();
+
+    switch (debugMultiplexer)
+    {
+    case 0:
+        memcpy(&data[1], &millisValue, sizeof(millisValue));
+        memcpy(&data[5], &globals.purgePulses, sizeof(globals.purgePulses));
+        break;
+    case 1:
+        data[1] = (uint8_t)globals.systemStatus;
+        data[2] = (uint8_t)globals.resumeStatus;
+        data[3] = (uint8_t)globals.requestEEAction;
+        data[4] = globals.TankPercentage;
+        data[5] = (0x01 & globals.hasDTC) | ((0x01 & globals.measurementActive) << 1);
+        break;
+    case 2:
+        memcpy(&data[1], &globals.eePersistanceAdress, sizeof(globals.eePersistanceAdress));
+        memcpy(&data[3], &PersistenceData.tankRemain_microL, sizeof(PersistenceData.tankRemain_microL));
+        break;
+    case 3:
+        memcpy(&data[1], &PersistenceData.writeCycleCounter, sizeof(PersistenceData.writeCycleCounter));
+        memcpy(&data[3], &PersistenceData.TravelDistance_highRes_mm, sizeof(PersistenceData.TravelDistance_highRes_mm));
+        break;
+    case 4:
+        memcpy(&data[1], &PersistenceData.odometer_mm, sizeof(PersistenceData.odometer_mm));
+        break;
+    case 5:
+        memcpy(&data[1], &PersistenceData.odometer, sizeof(PersistenceData.odometer));
+        break;
+    case 6:
+        memcpy(&data[1], &PersistenceData.checksum, sizeof(PersistenceData.checksum));
+        break;
+    default:
+        break;
+    }
+
+    debugMultiplexer++;
+    debugMultiplexer = debugMultiplexer > MAX_DEBUG_MULTIPLEXER ? 0 : debugMultiplexer;
+
+    if (DebugSendFailTimeout < MAX_DEBUG_RETRIES)
+    {
+        byte sndStat = CAN0.sendMsgBuf(0x7FF, 0, 8, data);
+        if (sndStat != CAN_OK)
+        {
+            Debug_pushMessage("failed sending CAN-DbgMsg: %d, %d\n", sndStat, DebugSendFailTimeout);
+            DebugSendFailTimeout++;
+        }
+    }
+    else if (DebugSendFailTimeout == MAX_DEBUG_RETRIES)
+    {
+        Debug_pushMessage("disable CAN-DbgMsg due to timeout");
+        DebugSendFailTimeout++;
+    }
+}
 #endif

Software/src/can.h

@@ -1,21 +0,0 @@
-#ifndef _CAN_H_
-#define _CAN_H_
-
-#include <Arduino.h>
-#include <mcp_can.h>
-#include <SPI.h>
-#include "common.h"
-#include "globals.h"
-#include "dtc.h"
-
-struct can_frame
-{
-    unsigned long can_id;
-    uint8_t can_dlc;
-    uint8_t data[8] __attribute__((aligned(8)));
-};
-
-void Init_CAN();
-uint32_t Process_CAN_WheelSpeed();
-
-#endif

Software/src/common.cpp

@@ -0,0 +1,32 @@
+#include "common.h"
+
+// String representation of SpeedSource enum
+const char *SpeedSourceString[] = {
+#ifdef FEATURE_ENABLE_TIMER
+    "Timer",
+#endif
+    "Impuls",
+    "GPS",
+    "CAN-Bus"
+    };
+
+const size_t SpeedSourceString_Elements = sizeof(SpeedSourceString) / sizeof(SpeedSourceString[0]);
+
+// String representation of GPSBaudRate enum
+const char *GPSBaudRateString[] = {
+    "4800",
+    "9600",
+    "19200",
+    "38400",
+    "57600",
+    "115200"
+    };
+
+const size_t GPSBaudRateString_Elements = sizeof(GPSBaudRateString) / sizeof(GPSBaudRateString[0]);
+
+// String representation of CANSource enum
+const char *CANSourceString[] = {
+    "KTM 890 Adventure R (2021)",
+    "KTM 1290 Superduke R (2023)"};
+
+const size_t CANSourceString_Elements = sizeof(CANSourceString) / sizeof(CANSourceString[0]);

Software/src/common.h

@@ -1,52 +0,0 @@
-#ifndef _COMMON_H_
-#define _COMMON_H_
-
-#define Q(x) #x
-#define QUOTE(x) Q(x)
-
-#if PCB_REV == 2
-    #define GPIO_BUTTON D7
-    #define GPIO_LED D8
-    #define GPIO_TRIGGER D6
-    #define GPIO_PUMP D5
-#elif PCB_REV == 1 || PCB_REV == 3
-    #define GPIO_BUTTON D5
-    #define GPIO_LED D6
-    #define GPIO_TRIGGER D4
-    #define GPIO_PUMP D3
-#elif PCB_REV == 4
-    #define GPIO_BUTTON D4
-    #define GPIO_LED D3
-    #define GPIO_TRIGGER D6
-    #define GPIO_PUMP D0
-    #define GPIO_CS_CAN D8
-#endif
-
-#ifndef HOST_NAME
-#define HOST_NAME "ChainLube_%06X" // Use printf-Formatting - Chip-ID (uin32_t) will be added
-#endif
-
-#define SW_VERSION 1.4
-#define FLASH_FS_VERSION 1.4
-
-#ifndef OTA_DELAY
-#define OTA_DELAY 50 // ticks -> 10ms / tick
-#endif
-
-#define LUBE_PULSE_LENGHT_MS 160
-#define LUBE_PULSE_PAUSE_MS 340
-
-// -> 2Hz PumpPulse
-// -> 49,7cc  / h @ 2Hz
-// -> 49,7 ml / h @ 2Hz
-// -> 828,4µl / min @ 2Hz
-// -> 828,3µl / 60s 
-// -> 13,81µl / 1s
-// ->  6,90µl / Pulse
-
-#define DEFAULT_PUMP_DOSE 7
-
-#define STARTUP_DELAY 5000
-#define SHUTDOWN_DELAY_MS 5000
-
-#endif

Software/src/config.cpp

@@ -1,24 +1,54 @@
+/**
+ * @file config.cpp
+ * @brief Implementation of EEPROM and configuration-related functions.
+ *
+ * This file contains functions for managing EEPROM storage and handling configuration data.
+ * It includes the definitions of configuration structures, EEPROM access, and utility functions.
+ */
+
 #include "config.h"
 #include "debugger.h"
+#include "globals.h"
 
+// Instance of I2C_eeprom for EEPROM access
 I2C_eeprom ee(0x50, EEPROM_SIZE_BYTES);
 
+// Configuration and persistence data structures
 LubeConfig_t LubeConfig;
 persistenceData_t PersistenceData;
-const uint16_t eeVersion = 2; // inc
+
+// EEPROM version identifier
+const uint16_t eeVersion = 2; // Increment this version when changing EEPROM structures
+
+// Flag indicating whether EEPROM is available
 boolean eeAvailable = false;
 
+// Offsets within EEPROM for LubeConfig and PersistenceData
 const uint16_t startofLubeConfig = 16;
 const uint16_t startofPersistence = 16 + sizeof(LubeConfig) + (sizeof(LubeConfig) % 16);
 
+// Function prototype to check EEPROM availability
 boolean checkEEPROMavailable();
 
+/**
+ * @brief Initializes EEPROM and checks its availability.
+ *
+ * This function initializes the EEPROM using the I2C_eeprom instance and checks if it's available.
+ */
 void InitEEPROM()
 {
+  LubeConfig = LubeConfig_defaults;
+  PersistenceData = {0};
   ee.begin();
   checkEEPROMavailable();
 }
 
+/**
+ * @brief Processes EEPROM actions based on the request from the global state.
+ *
+ * This function processes EEPROM actions based on the request from the global state.
+ * It performs actions such as saving, loading, and formatting EEPROM data for both configuration and persistence.
+ */
 void EEPROM_Process()
 {
   switch (globals.requestEEAction)
@@ -36,8 +66,8 @@ void EEPROM_Process()
   case EE_CFG_FORMAT:
     FormatConfig_EEPROM();
     globals.requestEEAction = EE_IDLE;
-    globals.systemStatus = sysStat_Shutdown;
+    GetConfig_EEPROM();
-    Debug_pushMessage("Formated EEPROM CFG\n");
+    Debug_pushMessage("Formatted EEPROM CFG\n");
     break;
   case EE_PDS_SAVE:
     StorePersistence_EEPROM();
@@ -52,13 +82,16 @@ void EEPROM_Process()
   case EE_PDS_FORMAT:
     FormatPersistence_EEPROM();
     globals.requestEEAction = EE_IDLE;
-    Debug_pushMessage("Formated EEPROM PDS\n");
+    GetPersistence_EEPROM();
+    Debug_pushMessage("Formatted EEPROM PDS\n");
     break;
   case EE_FORMAT_ALL:
     FormatConfig_EEPROM();
     FormatPersistence_EEPROM();
+    GetConfig_EEPROM();
+    GetPersistence_EEPROM();
     globals.requestEEAction = EE_IDLE;
-    Debug_pushMessage("Formated EEPROM ALL\n");
+    Debug_pushMessage("Formatted EEPROM ALL\n");
     break;
   case EE_ALL_SAVE:
     StorePersistence_EEPROM();
@@ -72,16 +105,36 @@ void EEPROM_Process()
   }
 }
 
+/**
+ * @brief Stores the configuration data in EEPROM.
+ *
+ * This function calculates the checksum for the configuration data, updates it, and stores it in EEPROM.
+ * It also performs a sanity check on the configuration and raises a diagnostic trouble code (DTC) if needed.
+ */
 void StoreConfig_EEPROM()
 {
   LubeConfig.checksum = 0;
   LubeConfig.checksum = Checksum_EEPROM((uint8_t *)&LubeConfig, sizeof(LubeConfig));
+
   if (!checkEEPROMavailable())
     return;
 
   ee.updateBlock(startofLubeConfig, (uint8_t *)&LubeConfig, sizeof(LubeConfig));
+
+  uint32_t ConfigSanityCheckResult = ConfigSanityCheck(false);
+
+  if (ConfigSanityCheckResult > 0)
+  {
+    MaintainDTC(DTC_EEPROM_CFG_SANITY, true, ConfigSanityCheckResult);
+  }
 }
 
+/**
+ * @brief Retrieves the configuration data from EEPROM.
+ *
+ * This function reads the configuration data from EEPROM, performs a checksum validation,
+ * and conducts a sanity check on the configuration. It raises a diagnostic trouble code (DTC) if needed.
+ */
 void GetConfig_EEPROM()
 {
   if (!checkEEPROMavailable())
@@ -94,19 +147,25 @@ void GetConfig_EEPROM()
 
   if (Checksum_EEPROM((uint8_t *)&LubeConfig, sizeof(LubeConfig)) != checksum)
   {
-    MaintainDTC(DTC_EEPROM_CFG_BAD, DTC_CRITICAL, true);
+    MaintainDTC(DTC_EEPROM_CFG_BAD, true);
   }
+
   LubeConfig.checksum = checksum;
 
   uint32_t ConfigSanityCheckResult = ConfigSanityCheck(false);
 
   if (ConfigSanityCheckResult > 0)
   {
-    MaintainDTC(DTC_EEPROM_CFG_SANITY, DTC_WARN, true, ConfigSanityCheckResult);
+    MaintainDTC(DTC_EEPROM_CFG_SANITY, true, ConfigSanityCheckResult);
-    globals.requestEEAction = EE_CFG_SAVE;
   }
 }
 
+/**
+ * @brief Stores the persistence data in EEPROM.
+ *
+ * This function increments the write cycle counter, performs a checksum calculation on the persistence data,
+ * and stores it in EEPROM. It also handles EEPROM page movement when needed.
+ */
 void StorePersistence_EEPROM()
 {
   if (PersistenceData.writeCycleCounter >= 0xFFF0)
@@ -123,6 +182,13 @@ void StorePersistence_EEPROM()
   ee.updateBlock(globals.eePersistanceAdress, (uint8_t *)&PersistenceData, sizeof(PersistenceData));
 }
 
+/**
+ * @brief Retrieves the persistence data from EEPROM.
+ *
+ * This function reads the EEPROM to get the start address of the persistence data.
+ * If the start address is out of range, it resets and stores defaults. Otherwise,
+ * it reads from EEPROM and checks if the data is correct.
+ */
 void GetPersistence_EEPROM()
 {
   if (!checkEEPROMavailable())
@@ -135,7 +201,7 @@ void GetPersistence_EEPROM()
   {
     MovePersistencePage_EEPROM(true);
     FormatPersistence_EEPROM();
-    MaintainDTC(DTC_EEPROM_PDSADRESS_BAD, DTC_CRITICAL, true);
+    MaintainDTC(DTC_EEPROM_PDSADRESS_BAD, true);
   }
   else
   {
@@ -146,12 +212,17 @@ void GetPersistence_EEPROM()
 
     if (Checksum_EEPROM((uint8_t *)&PersistenceData, sizeof(PersistenceData)) != checksum)
     {
-      MaintainDTC(DTC_EEPROM_PDS_BAD, DTC_CRITICAL, true);
+      MaintainDTC(DTC_EEPROM_PDS_BAD, true);
     }
     PersistenceData.checksum = checksum;
   }
 }
 
+/**
+ * @brief Formats the configuration partition in EEPROM.
+ *
+ * This function resets the configuration data to defaults and stores it in EEPROM.
+ */
 void FormatConfig_EEPROM()
 {
   Debug_pushMessage("Formatting Config-Partition\n");
@@ -160,6 +231,11 @@ void FormatConfig_EEPROM()
   StoreConfig_EEPROM();
 }
 
+/**
+ * @brief Formats the persistence partition in EEPROM.
+ *
+ * This function resets the persistence data to defaults and stores it in EEPROM.
+ */
 void FormatPersistence_EEPROM()
 {
   Debug_pushMessage("Formatting Persistance-Partition\n");
@@ -167,16 +243,22 @@ void FormatPersistence_EEPROM()
   // memset(&PersistenceData, 0, sizeof(PersistenceData));
   StorePersistence_EEPROM();
 }
-
+/**
+ * @brief Moves the persistence page in EEPROM.
+ *
+ * This function adjusts the persistence page address and resets the write cycle counter.
+ *
+ * @param reset If true, the function resets the persistence page address to the start of the partition.
+ */
 void MovePersistencePage_EEPROM(boolean reset)
 {
   if (!checkEEPROMavailable())
     return;
 
-  globals.eePersistanceAdress = +sizeof(PersistenceData);
+  globals.eePersistanceAdress += sizeof(PersistenceData);
   PersistenceData.writeCycleCounter = 0;
 
-  // check if we reached the End of the EEPROM and Startover at the beginning
+  // Check if we reached the end of the EEPROM and start over at the beginning
   if ((globals.eePersistanceAdress + sizeof(PersistenceData)) > ee.getDeviceSize() || reset)
   {
     globals.eePersistanceAdress = startofPersistence;
@@ -185,25 +267,45 @@ void MovePersistencePage_EEPROM(boolean reset)
   ee.updateBlock(0, (uint8_t *)&globals.eePersistanceAdress, sizeof(globals.eePersistanceAdress));
 }
 
+/**
+ * @brief Calculate CRC-32 checksum for a block of data.
+ *
+ * This function implements the CRC-32 algorithm.
+ *
+ * @param data Pointer to the data block.
+ * @param len Length of the data block in bytes.
+ * @return CRC-32 checksum.
+ */
 uint32_t Checksum_EEPROM(uint8_t const *data, size_t len)
 {
   if (data == NULL)
     return 0;
-  uint32_t crc, mask;
+
-  crc = 0xFFFFFFFF;
+  uint32_t crc = 0xFFFFFFFF;
+  uint32_t mask;
 
   while (len--)
   {
     crc ^= *data++;
+
     for (uint8_t k = 0; k < 8; k++)
     {
       mask = -(crc & 1);
       crc = (crc >> 1) ^ (0xEDB88320 & mask);
     }
   }
+
   return ~crc;
 }
 
+/**
+ * @brief Dump a portion of EEPROM contents for debugging.
+ *
+ * This function prints the contents of a specified portion of EEPROM in a formatted way.
+ *
+ * @param memoryAddress Starting address in EEPROM.
+ * @param length Number of bytes to dump.
+ */
 void dumpEEPROM(uint16_t memoryAddress, uint16_t length)
 {
 #define BLOCK_TO_LENGTH 16
@@ -213,146 +315,183 @@ void dumpEEPROM(uint16_t memoryAddress, uint16_t length)
 
   char ascii_buf[BLOCK_TO_LENGTH + 1];
   sprintf(ascii_buf, "%*s", BLOCK_TO_LENGTH, "ASCII");
+
+  // Print column headers
   Debug_pushMessage(PSTR("\nAddress "));
   for (int x = 0; x < BLOCK_TO_LENGTH; x++)
     Debug_pushMessage("%3d", x);
 
+  // Align address and length to BLOCK_TO_LENGTH boundaries
   memoryAddress = memoryAddress / BLOCK_TO_LENGTH * BLOCK_TO_LENGTH;
   length = (length + BLOCK_TO_LENGTH - 1) / BLOCK_TO_LENGTH * BLOCK_TO_LENGTH;
 
+  // Iterate through the specified portion of EEPROM
   for (unsigned int i = 0; i < length; i++)
   {
     int blockpoint = memoryAddress % BLOCK_TO_LENGTH;
+
+    // Print ASCII representation header for each block
     if (blockpoint == 0)
     {
       ascii_buf[BLOCK_TO_LENGTH] = 0;
       Debug_pushMessage("  %s", ascii_buf);
       Debug_pushMessage("\n0x%05X:", memoryAddress);
     }
+
+    // Read and print each byte
     ascii_buf[blockpoint] = ee.readByte(memoryAddress);
     Debug_pushMessage(" %02X", ascii_buf[blockpoint]);
+
+    // Replace non-printable characters with dots in ASCII representation
     if (ascii_buf[blockpoint] < 0x20 || ascii_buf[blockpoint] > 0x7E)
       ascii_buf[blockpoint] = '.';
+
     memoryAddress++;
   }
+
+  // Print a new line at the end of the dump
   Debug_pushMessage("\n");
 }
 
+/**
+ * @brief Check if EEPROM is available and connected.
+ *
+ * This function checks if the EEPROM is available and connected. If not, it triggers
+ * a diagnostic trouble code (DTC) indicating the absence of EEPROM.
+ *
+ * @return true if EEPROM is available, false otherwise.
+ */
 boolean checkEEPROMavailable()
 {
+  // Check if EEPROM is connected
   if (!ee.isConnected())
   {
-    MaintainDTC(DTC_NO_EEPROM_FOUND, DTC_CRITICAL, true);
+    // Trigger DTC for no EEPROM found
+    MaintainDTC(DTC_NO_EEPROM_FOUND, true);
     return false;
   }
-  MaintainDTC(DTC_NO_EEPROM_FOUND, DTC_CRITICAL, false);
+
+  // Clear DTC for no EEPROM found since it's available now
+  MaintainDTC(DTC_NO_EEPROM_FOUND, false);
+
+  // EEPROM is available
   return true;
 }
 
+/**
+ * @brief Perform sanity check on configuration settings.
+ *
+ * This function checks the validity of various configuration settings and returns a bitmask
+ * indicating which settings need to be reset. If autocorrect is enabled, it resets the settings
+ * to their default values.
+ *
+ * @param autocorrect If true, automatically correct invalid settings by resetting to defaults.
+ * @return A bitmask indicating which settings need to be reset.
+ */
 uint32_t ConfigSanityCheck(bool autocorrect)
 {
   uint32_t setting_reset_bits = 0;
 
   if (!(LubeConfig.DistancePerLube_Default > 0) || !(LubeConfig.DistancePerLube_Default < 50000))
   {
-    setting_reset_bits = setting_reset_bits | (1 << 0);
+    SET_BIT(setting_reset_bits, 0);
     if (autocorrect)
       LubeConfig.DistancePerLube_Default = LubeConfig_defaults.DistancePerLube_Default;
   }
 
   if (!(LubeConfig.DistancePerLube_Rain > 0) || !(LubeConfig.DistancePerLube_Rain < 50000))
   {
-    setting_reset_bits = setting_reset_bits | (1 << 1);
+    SET_BIT(setting_reset_bits, 1);
     if (autocorrect)
       LubeConfig.DistancePerLube_Rain = LubeConfig_defaults.DistancePerLube_Rain;
   }
 
   if (!(LubeConfig.tankCapacity_ml > 0) || !(LubeConfig.tankCapacity_ml < 5000))
   {
-    setting_reset_bits = setting_reset_bits | (1 << 2);
+    SET_BIT(setting_reset_bits, 2);
     if (autocorrect)
       LubeConfig.tankCapacity_ml = LubeConfig_defaults.tankCapacity_ml;
   }
 
   if (!(LubeConfig.amountPerDose_microL > 0) || !(LubeConfig.amountPerDose_microL < 100))
   {
-    setting_reset_bits = setting_reset_bits | (1 << 3);
+    SET_BIT(setting_reset_bits, 3);
     if (autocorrect)
       LubeConfig.amountPerDose_microL = LubeConfig_defaults.amountPerDose_microL;
   }
 
   if (!(LubeConfig.TankRemindAtPercentage >= 0) || !(LubeConfig.TankRemindAtPercentage <= 100))
   {
-    setting_reset_bits = setting_reset_bits | (1 << 4);
+    SET_BIT(setting_reset_bits, 4);
     if (autocorrect)
       LubeConfig.TankRemindAtPercentage = LubeConfig_defaults.TankRemindAtPercentage;
   }
 
-  if (!(LubeConfig.PulsePerRevolution > 0) || !(LubeConfig.PulsePerRevolution < 1000))
+  if (LubeConfig.SpeedSource == SOURCE_IMPULSE)
   {
-    setting_reset_bits = setting_reset_bits | (1 << 5);
+    if (!(LubeConfig.PulsePerRevolution > 0) || !(LubeConfig.PulsePerRevolution < 1000))
-    if (autocorrect)
+    {
-      LubeConfig.PulsePerRevolution = LubeConfig_defaults.PulsePerRevolution;
+      SET_BIT(setting_reset_bits, 5);
-  }
+      if (autocorrect)
+        LubeConfig.PulsePerRevolution = LubeConfig_defaults.PulsePerRevolution;
+    }
 
-  if (!(LubeConfig.TireWidth_mm > 0) || !(LubeConfig.TireWidth_mm < 500))
+    if (!(LubeConfig.TireWidth_mm > 0) || !(LubeConfig.TireWidth_mm < 500))
-  {
+    {
-    setting_reset_bits = setting_reset_bits | (1 << 6);
+      SET_BIT(setting_reset_bits, 6);
-    if (autocorrect)
+      if (autocorrect)
-      LubeConfig.TireWidth_mm = LubeConfig_defaults.TireWidth_mm;
+        LubeConfig.TireWidth_mm = LubeConfig_defaults.TireWidth_mm;
-  }
+    }
 
-  if (!(LubeConfig.TireWidthHeight_Ratio > 0) || !(LubeConfig.TireWidthHeight_Ratio < 150))
+    if (!(LubeConfig.TireWidthHeight_Ratio > 0) || !(LubeConfig.TireWidthHeight_Ratio < 150))
-  {
+    {
-    setting_reset_bits = setting_reset_bits | (1 << 7);
+      SET_BIT(setting_reset_bits, 7);
-    if (autocorrect)
+      if (autocorrect)
-      LubeConfig.TireWidthHeight_Ratio = LubeConfig_defaults.TireWidthHeight_Ratio;
+        LubeConfig.TireWidthHeight_Ratio = LubeConfig_defaults.TireWidthHeight_Ratio;
-  }
+    }
 
-  if (!(LubeConfig.RimDiameter_Inch > 0) || !(LubeConfig.RimDiameter_Inch < 30))
+    if (!(LubeConfig.RimDiameter_Inch > 0) || !(LubeConfig.RimDiameter_Inch < 30))
-  {
+    {
-    setting_reset_bits = setting_reset_bits | (1 << 8);
+      SET_BIT(setting_reset_bits, 8);
-    if (autocorrect)
+      if (autocorrect)
-      LubeConfig.RimDiameter_Inch = LubeConfig_defaults.RimDiameter_Inch;
+        LubeConfig.RimDiameter_Inch = LubeConfig_defaults.RimDiameter_Inch;
-  }
+    }
 
-  if (!(LubeConfig.DistancePerRevolution_mm > 0) || !(LubeConfig.DistancePerRevolution_mm < 10000))
+    if (!(LubeConfig.DistancePerRevolution_mm > 0) || !(LubeConfig.DistancePerRevolution_mm < 10000))
-  {
+    {
-    setting_reset_bits = setting_reset_bits | (1 << 9);
+      SET_BIT(setting_reset_bits, 9);
-    if (autocorrect)
+      if (autocorrect)
-      LubeConfig.DistancePerRevolution_mm = LubeConfig_defaults.DistancePerRevolution_mm;
+        LubeConfig.DistancePerRevolution_mm = LubeConfig_defaults.DistancePerRevolution_mm;
+    }
   }
 
   if (!(LubeConfig.BleedingPulses > 0) || !(LubeConfig.BleedingPulses < 1001))
   {
-    setting_reset_bits = setting_reset_bits | (1 << 10);
+    SET_BIT(setting_reset_bits, 10);
     if (autocorrect)
       LubeConfig.BleedingPulses = LubeConfig_defaults.BleedingPulses;
   }
 
   if (!(LubeConfig.SpeedSource >= 0) || !(LubeConfig.SpeedSource < SpeedSourceString_Elements))
   {
-    setting_reset_bits = setting_reset_bits | (1 << 11);
+    SET_BIT(setting_reset_bits, 11);
     if (autocorrect)
       LubeConfig.SpeedSource = LubeConfig_defaults.SpeedSource;
   }
 
-#ifdef FEATURE_ENABLE_GPS
   if (!(LubeConfig.GPSBaudRate >= 0) || !(LubeConfig.GPSBaudRate < GPSBaudRateString_Elements))
   {
-    setting_reset_bits = setting_reset_bits | (1 << 12);
+    SET_BIT(setting_reset_bits, 12);
     if (autocorrect)
       LubeConfig.GPSBaudRate = LubeConfig_defaults.GPSBaudRate;
   }
-#endif
 
-#ifdef FEATURE_ENABLE_CAN
   if (!(LubeConfig.CANSource >= 0) || !(LubeConfig.CANSource < CANSourceString_Elements))
   {
-    setting_reset_bits = setting_reset_bits | (1 << 13);
+    SET_BIT(setting_reset_bits, 13);
     if (autocorrect)
       LubeConfig.CANSource = LubeConfig_defaults.CANSource;
   }
-#endif
+  // Return the bitmask indicating which settings need to be reset
   return setting_reset_bits;
 }

Software/src/config.h

@@ -1,128 +0,0 @@
-#ifndef _CONFIG_H_
-#define _CONFIG_H_
-
-#include <Arduino.h>
-#include <Wire.h>
-#include <I2C_eeprom.h>
-#include "globals.h"
-#include "dtc.h"
-#include "common.h"
-
-#if PCB_REV == 1 || PCB_REV == 2 || PCB_REV == 3
-#define EEPROM_SIZE_BYTES I2C_DEVICESIZE_24LC64
-#elif PCB_REV == 4
-#define EEPROM_SIZE_BYTES I2C_DEVICESIZE_24LC256
-#endif
-
-typedef enum SpeedSource_e
-{
-  SOURCE_TIME,
-  SOURCE_IMPULSE,
-#ifdef FEATURE_ENABLE_GPS
-  SOURCE_GPS,
-#endif
-#if FEATURE_ENABLE_CAN
-  SOURCE_CAN
-#endif
-} SpeedSource_t;
-
-const char SpeedSourceString[][8] = {
-    "Timer",
-    "Impuls",
-#ifdef FEATURE_ENABLE_GPS
-    "GPS",
-#endif
-#if FEATURE_ENABLE_CAN
-    "CAN-Bus"
-#endif
-};
-
-#ifdef FEATURE_ENABLE_GPS
-typedef enum GPSBaudRate_e
-{
-  BAUD_9600,
-  BAUD_115200
-} GPSBaudRate_t;
-
-const char GPSBaudRateString[][7] = {
-    "9600",
-    "115200"};
-
-const size_t GPSBaudRateString_Elements = sizeof(GPSBaudRateString) / sizeof(GPSBaudRateString[0]);
-#endif
-
-#ifdef FEATURE_ENABLE_CAN
-typedef enum CANSource_e
-{
-  KTM_890_ADV_R_2021
-} CANSource_t;
-
-const char CANSourceString[][28] = {
-    "KTM 890 Adventure R (2021)"};
-
-const char CANSourceString_Elements = sizeof(CANSourceString) / sizeof(CANSourceString[0]);
-#endif
-
-const size_t SpeedSourceString_Elements = sizeof(SpeedSourceString) / sizeof(SpeedSourceString[0]);
-
-typedef struct
-{
-  uint16_t writeCycleCounter = 0;
-  uint32_t tankRemain_microL = 0;
-  uint32_t TravelDistance_highRes_mm = 0;
-  uint32_t odometer_mm = 0;
-  uint32_t odometer = 0;
-  uint32_t checksum = 0;
-} persistenceData_t;
-
-typedef struct
-{
-  uint8_t EEPROM_Version = 0;
-  uint32_t DistancePerLube_Default = 8000;
-  uint32_t DistancePerLube_Rain = 4000;
-  uint32_t tankCapacity_ml = 320;
-  uint32_t amountPerDose_microL = DEFAULT_PUMP_DOSE;
-  uint8_t TankRemindAtPercentage = 30;
-  uint8_t PulsePerRevolution = 1;
-  uint32_t TireWidth_mm = 150;
-  uint32_t TireWidthHeight_Ratio = 70;
-  uint32_t RimDiameter_Inch = 18;
-  uint32_t DistancePerRevolution_mm = 2000;
-  uint16_t BleedingPulses = 25;
-  SpeedSource_t SpeedSource = SOURCE_IMPULSE;
-#ifdef FEATURE_ENABLE_GPS
-  GPSBaudRate_t GPSBaudRate = BAUD_115200;
-#endif
-#ifdef FEATURE_ENABLE_CAN
-  CANSource_t CANSource = KTM_890_ADV_R_2021;
-#endif
-  uint32_t checksum = 0;
-} LubeConfig_t;
-
-const LubeConfig_t LubeConfig_defaults = {
-    0, 8000, 4000, 320, DEFAULT_PUMP_DOSE, 30, 1, 150, 70, 18, 2000, 25, SOURCE_IMPULSE,
-#ifdef FEATURE_ENABLE_GPS
-    BAUD_115200,
-#endif
-#ifdef FEATURE_ENABLE_CAN
-    KTM_890_ADV_R_2021,
-#endif
-    0};
-
-void InitEEPROM();
-void EEPROM_Process();
-void StoreConfig_EEPROM();
-void GetConfig_EEPROM();
-void StorePersistence_EEPROM();
-void GetPersistence_EEPROM();
-void FormatConfig_EEPROM();
-void FormatPersistence_EEPROM();
-uint32_t Checksum_EEPROM(uint8_t const *data, size_t len);
-void dumpEEPROM(uint16_t memoryAddress, uint16_t length);
-void MovePersistencePage_EEPROM(boolean reset);
-uint32_t ConfigSanityCheck(bool autocorrect = false);
-
-extern LubeConfig_t LubeConfig;
-extern persistenceData_t PersistenceData;
-extern uint16_t eePersistenceMarker;
-#endif // _CONFIG_H_

Software/src/debugger.cpp

@@ -1,9 +1,22 @@
+/**
+ * @file debugger.cpp
+ * @brief Implementation of debugging functions for monitoring and diagnostics.
+ *
+ * This file contains the implementation of various debugging functions to monitor
+ * and diagnose the system. It includes functions to print system information, WiFi
+ * details, EEPROM status, dump configuration settings, dump persistence data, show
+ * Diagnostic Trouble Codes (DTCs), and more.
+ *
+ * @author Marcel Peterkau
+ * @date 09.04.2024
+ */
+
 #include "debugger.h"
 
 DebugStatus_t DebuggerStatus[dbg_cntElements];
 
 String IpAddress2String(const IPAddress &ipAddress);
-void processCmdDebug();
+void processCmdDebug(String command);
 void Debug_formatCFG();
 void Debug_formatPersistence();
 void Debug_printSystemInfo();
@@ -13,40 +26,146 @@ void Debug_dumpConfig();
 void Debug_dumpPersistance();
 void Debug_ShowDTCs();
 void Debug_dumpGlobals();
+void Debug_printHelp();
 
+/**
+ * @brief Initializes the debugger by setting the initial status for different debug ports.
+ *        Serial debug output is turned off.
+ */
 void initDebugger()
 {
+    // Set the initial status of debug ports
     DebuggerStatus[dbg_Serial] = disabled;
     DebuggerStatus[dbg_Webui] = disabled;
 
+    // Disable serial debug output
     Serial.setDebugOutput(false);
 }
+/**
+ * @brief Processes incoming debug commands from the Serial interface.
+ *        It reads characters from Serial and interprets them as commands.
+ *        The recognized commands are processed accordingly.
+ */
+void Debug_Process()
+{
+    // Enumeration for tracking the state of input processing
+    typedef enum InputProcessed_e
+    {
+        IDLE,         ///< No command processing is in progress
+        CMD_COMPLETE, ///< Received a complete command
+        CMD_ABORT,    ///< Received an abort command (Esc)
+        CMD_OVERFLOW  ///< Input buffer overflow occurred
+    } InputProcessed_t;
 
+    static unsigned int inputCnt = 0;       ///< Counter for characters in the input buffer
+    static char inputBuffer[32];            ///< Buffer to store the received characters
+    InputProcessed_t InputProcessed = IDLE; ///< State variable for input processing
+
+    // Check if there are characters available in the Serial input buffer
+    if (Serial.available())
+    {
+        char inputChar = Serial.read();
+
+        // Process the received character based on its value
+        switch (inputChar)
+        {
+        case '\n':
+            inputBuffer[inputCnt] = 0; // terminate the String
+            inputCnt = 0;
+            InputProcessed = CMD_COMPLETE;
+            break;
+
+        case 0x1B: // Esc
+            inputBuffer[0] = 0;
+            inputCnt = 0;
+            InputProcessed = CMD_ABORT;
+            break;
+
+        case 0x21 ... 0x7E: // it's a real letter or sign and not some control-chars
+            inputBuffer[inputCnt] = inputChar;
+            inputCnt++;
+            break;
+
+        default:
+            break;
+        }
+
+        // Check for input buffer overflow
+        if (inputCnt > sizeof(inputBuffer))
+        {
+            inputCnt = 0;
+            inputBuffer[sizeof(inputBuffer) - 1] = 0; // terminate the String
+            InputProcessed = CMD_OVERFLOW;
+        }
+    }
+
+    // Process the command based on the detected state of input processing
+    switch (InputProcessed)
+    {
+    case CMD_ABORT:
+        Debug_pushMessage("Abort\n");
+        break;
+
+    case CMD_COMPLETE:
+        processCmdDebug(String(inputBuffer));
+        break;
+
+    case CMD_OVERFLOW:
+        Debug_pushMessage("Input buffer overflow\n");
+        break;
+
+    default:
+        break;
+    }
+    InputProcessed = IDLE;
+}
+/**
+ * @brief Sets the status of a specific debug port (Serial or WebUI).
+ *        Updates the status in the DebuggerStatus array and provides debug messages.
+ *
+ * @param port   The debug port to set the status for (dbg_Serial or dbg_Webui).
+ * @param status The status to set (enabled or disabled).
+ */
 void SetDebugportStatus(DebugPorts_t port, DebugStatus_t status)
 {
+    // Display a debug message based on the provided status
     if (status == disabled)
-        Debug_pushMessage("disable DebugPort %s", sDebugPorts[port]);
+        Debug_pushMessage("Disable DebugPort %s\n", sDebugPorts[port]);
 
+    // Update the status in the DebuggerStatus array
     DebuggerStatus[port] = status;
 
+    // Display a debug message based on the updated status
     if (status == enabled)
-        Debug_pushMessage("enabled DebugPort %s", sDebugPorts[port]);
+        Debug_pushMessage("Enabled DebugPort %s\n", sDebugPorts[port]);
 }
 
+/**
+ * @brief Pushes a formatted debug message to the enabled debug ports (Serial or WebUI).
+ *
+ * @param format The format string for the debug message.
+ * @param ...    Additional arguments for formatting the message.
+ */
 void Debug_pushMessage(const char *format, ...)
 {
+    // Check if either the Serial or WebUI debug port is enabled
     if ((DebuggerStatus[dbg_Serial] == enabled) || (DebuggerStatus[dbg_Webui] == enabled))
     {
-        char buff[64];
+        char buff[128]; // Buffer to hold the formatted message
-        va_list arg;
+        va_list arg;   // Variable argument list for vsnprintf
         va_start(arg, format);
+
+        // Format the message and store it in the buffer
         vsnprintf(buff, sizeof(buff), format, arg);
         va_end(arg);
 
+        // Send the message to the Serial debug port if enabled
         if (DebuggerStatus[dbg_Serial] == enabled)
         {
             Serial.print(buff);
         }
+
+        // Push the message to the WebUI debug port if enabled
         if (DebuggerStatus[dbg_Webui] == enabled)
         {
             Websocket_PushLiveDebug(String(buff));
@@ -54,12 +173,22 @@ void Debug_pushMessage(const char *format, ...)
     }
 }
 
+/**
+ * @brief Pushes a formatted CAN debug message to the enabled debug ports (Serial or WebUI).
+ *
+ * @param id   CAN message ID.
+ * @param dlc  Data Length Code of the CAN message.
+ * @param data Pointer to the data array of the CAN message.
+ */
 void pushCANDebug(uint32_t id, uint8_t dlc, uint8_t *data)
 {
+    // Check if either the Serial or WebUI debug port is enabled
     if ((DebuggerStatus[dbg_Serial] == enabled) || (DebuggerStatus[dbg_Webui] == enabled))
     {
-        char buff[100];
+        char buff[100]; // Buffer to hold the formatted message
-        char *p = buff;
+        char *p = buff; // Pointer to navigate the buffer
+
+        // Format the CAN message information into the buffer
         p += snprintf(p, sizeof(buff), "CAN: 0x%08X | %d | ", id, dlc);
         for (int i = 0; i < dlc; i++)
         {
@@ -68,10 +197,13 @@ void pushCANDebug(uint32_t id, uint8_t dlc, uint8_t *data)
         *(p++) = '\n';
         *p = '\0';
 
+        // Send the formatted CAN message to the Serial debug port if enabled
         if (DebuggerStatus[dbg_Serial] == enabled)
         {
             Serial.print(buff);
         }
+
+        // Push the formatted CAN message to the WebUI debug port if enabled
         if (DebuggerStatus[dbg_Webui] == enabled)
         {
             Websocket_PushLiveDebug(String(buff));
@@ -79,9 +211,17 @@ void pushCANDebug(uint32_t id, uint8_t dlc, uint8_t *data)
     }
 }
 
+/**
+ * @brief Processes a debug command and performs corresponding actions.
+ *
+ * @param command The debug command to be processed.
+ */
 void processCmdDebug(String command)
 {
-    if (command == "sysinfo")
+    // Check the received command and execute corresponding actions
+    if (command == "help")
+        Debug_printHelp();
+    else if (command == "sysinfo")
         Debug_printSystemInfo();
     else if (command == "netinfo")
         Debug_printWifiInfo();
@@ -103,99 +243,136 @@ void processCmdDebug(String command)
         Debug_dumpPersistance();
     else if (command == "saveEE")
         globals.requestEEAction = EE_ALL_SAVE;
-    else if (command == "showdtc")
-        Debug_ShowDTCs();
     else if (command == "dumpGlobals")
         Debug_dumpGlobals();
+    else if (command == "sdbg")
+        SetDebugportStatus(dbg_Serial, enabled);
+    else if (command == "dtc_show")
+        Debug_ShowDTCs();
+    else if (command == "dtc_clear")
+        ClearAllDTC();
+    else if (command == "dtc_crit")
+        MaintainDTC(DTC_FAKE_DTC_CRIT, true, millis());
+    else if (command == "dtc_warn")
+        MaintainDTC(DTC_FAKE_DTC_WARN, true, millis());
+    else if (command == "dtc_info")
+        MaintainDTC(DTC_FAKE_DTC_INFO, true, millis());
+    else
+        Debug_pushMessage("unknown Command\n");
 }
 
+/**
+ * @brief Formats the Config-EEPROM and resets it to default values.
+ *        Prints a debug message after formatting.
+ */
 void Debug_formatCFG()
 {
-    Debug_pushMessage("Formatting Config-EEPROM and reseting to default");
+    Debug_pushMessage("Formatting Config-EEPROM and resetting to default\n");
     FormatConfig_EEPROM();
 }
 
+/**
+ * @brief Formats the Persistence-EEPROM and resets it to default values.
+ *        Prints a debug message after formatting.
+ */
 void Debug_formatPersistence()
 {
-    Debug_pushMessage("Formatting Persistence-EEPROM and reseting to default");
+    Debug_pushMessage("Formatting Persistence-EEPROM and resetting to default\n");
     FormatPersistence_EEPROM();
 }
 
-void RemotDebug_printSystemInfo()
+/**
+ * @brief Prints system information and status to the debug output.
+ */
+void Debug_printSystemInfo()
 {
-    Debug_pushMessage("Souko's ChainOiler Mk1");
+    Debug_pushMessage("Souko's ChainOiler Mk1\n");
-    Debug_pushMessage("Hostname: %s", globals.DeviceName);
+    Debug_pushMessage("Hostname: %s\n", globals.DeviceName);
 
     FlashMode_t ideMode = ESP.getFlashChipMode();
-    Debug_pushMessage("Sdk version: %s", ESP.getSdkVersion());
+    Debug_pushMessage("Sdk version: %s\n", ESP.getSdkVersion());
-    Debug_pushMessage("Core Version: %s", ESP.getCoreVersion().c_str());
+    Debug_pushMessage("Core Version: %s\n", ESP.getCoreVersion().c_str());
-    Debug_pushMessage("Boot Version: %u", ESP.getBootVersion());
+    Debug_pushMessage("Boot Version: %u\n", ESP.getBootVersion());
-    Debug_pushMessage("Boot Mode: %u", ESP.getBootMode());
+    Debug_pushMessage("Boot Mode: %u\n", ESP.getBootMode());
-    Debug_pushMessage("CPU Frequency: %u MHz", ESP.getCpuFreqMHz());
+    Debug_pushMessage("CPU Frequency: %u MHz\n", ESP.getCpuFreqMHz());
-    Debug_pushMessage("Reset reason: %s", ESP.getResetReason().c_str());
+    Debug_pushMessage("Reset reason: %s\n", ESP.getResetReason().c_str());
-    Debug_pushMessage("Flash Size: %d", ESP.getFlashChipRealSize());
+    Debug_pushMessage("Flash Size: %d\n", ESP.getFlashChipRealSize());
-    Debug_pushMessage("Flash Size IDE: %d", ESP.getFlashChipSize());
+    Debug_pushMessage("Flash Size IDE: %d\n", ESP.getFlashChipSize());
-    Debug_pushMessage("Flash ide mode:  %s", (ideMode == FM_QIO ? "QIO" : ideMode == FM_QOUT ? "QOUT"
+    Debug_pushMessage("Flash ide mode:  %s\n", (ideMode == FM_QIO ? "QIO" : ideMode == FM_QOUT ? "QOUT"
-                                                           : ideMode == FM_DIO    ? "DIO"
+                                                                        : ideMode == FM_DIO    ? "DIO"
-                                                           : ideMode == FM_DOUT   ? "DOUT"
+                                                                        : ideMode == FM_DOUT   ? "DOUT"
-                                                                                  : "UNKNOWN"));
+                                                                                               : "UNKNOWN"));
-    Debug_pushMessage("OTA-Pass: %s", QUOTE(ADMIN_PASSWORD));
+    Debug_pushMessage("OTA-Pass: %s\n", QUOTE(ADMIN_PASSWORD));
-    Debug_pushMessage("Git-Revison: %s", GIT_REV);
+    Debug_pushMessage("Git-Revision: %s\n", constants.GitHash);
-    Debug_pushMessage("Sw-Version: %s", QUOTE(SW_VERSION));
+    Debug_pushMessage("Sw-Version: %d.%02d\n", constants.FW_Version_major, constants.FW_Version_minor);
 }
 
+/**
+ * @brief Dumps the current configuration parameters to the debug output.
+ */
 void Debug_dumpConfig()
 {
-    Debug_pushMessage("DistancePerLube_Default: %d", LubeConfig.DistancePerLube_Default);
+    Debug_pushMessage("DistancePerLube_Default: %d\n", LubeConfig.DistancePerLube_Default);
-    Debug_pushMessage("DistancePerLube_Rain: %d", LubeConfig.DistancePerLube_Rain);
+    Debug_pushMessage("DistancePerLube_Rain: %d\n", LubeConfig.DistancePerLube_Rain);
-    Debug_pushMessage("tankCapacity_ml: %d", LubeConfig.tankCapacity_ml);
+    Debug_pushMessage("tankCapacity_ml: %d\n", LubeConfig.tankCapacity_ml);
-    Debug_pushMessage("amountPerDose_microL: %d", LubeConfig.amountPerDose_microL);
+    Debug_pushMessage("amountPerDose_microL: %d\n", LubeConfig.amountPerDose_microL);
-    Debug_pushMessage("TankRemindAtPercentage: %d", LubeConfig.TankRemindAtPercentage);
+    Debug_pushMessage("TankRemindAtPercentage: %d\n", LubeConfig.TankRemindAtPercentage);
-    Debug_pushMessage("PulsePerRevolution: %d", LubeConfig.PulsePerRevolution);
+    Debug_pushMessage("PulsePerRevolution: %d\n", LubeConfig.PulsePerRevolution);
-    Debug_pushMessage("TireWidth_mm: %d", LubeConfig.TireWidth_mm);
+    Debug_pushMessage("TireWidth_mm: %d\n", LubeConfig.TireWidth_mm);
-    Debug_pushMessage("TireWidthHeight_Ratio: %d", LubeConfig.TireWidth_mm);
+    Debug_pushMessage("TireWidthHeight_Ratio: %d\n", LubeConfig.TireWidthHeight_Ratio);
-    Debug_pushMessage("RimDiameter_Inch: %d", LubeConfig.RimDiameter_Inch);
+    Debug_pushMessage("RimDiameter_Inch: %d\n", LubeConfig.RimDiameter_Inch);
-    Debug_pushMessage("DistancePerRevolution_mm: %d", LubeConfig.DistancePerRevolution_mm);
+    Debug_pushMessage("DistancePerRevolution_mm: %d\n", LubeConfig.DistancePerRevolution_mm);
-    Debug_pushMessage("BleedingPulses: %d", LubeConfig.BleedingPulses);
+    Debug_pushMessage("BleedingPulses: %d\n", LubeConfig.BleedingPulses);
-    Debug_pushMessage("SpeedSource: %d", LubeConfig.SpeedSource);
+    Debug_pushMessage("SpeedSource: %d\n", LubeConfig.SpeedSource);
-#ifdef FEATURE_ENABLE_GPS
+    Debug_pushMessage("GPSBaudRate: %d\n", LubeConfig.GPSBaudRate);
-    Debug_pushMessage("GPSBaudRate: %d", LubeConfig.GPSBaudRate);
+    Debug_pushMessage("CANSource: %d\n", LubeConfig.CANSource);
-#endif
+    Debug_pushMessage("checksum: 0x%08X\n", LubeConfig.checksum);
-#ifdef FEATURE_ENABLE_CAN
-    Debug_pushMessage("CANSource: %d", LubeConfig.CANSource);
-#endif
-    Debug_pushMessage("checksum: 0x%08X", LubeConfig.checksum);
 }
 
+/**
+ * @brief Dumps the global variables and their values to the debug output.
+ */
 void Debug_dumpGlobals()
 {
-    Debug_pushMessage("systemStatus: %d", globals.systemStatus);
+    Debug_pushMessage("systemStatus: %d\n", globals.systemStatus);
-    Debug_pushMessage("resumeStatus: %d", globals.resumeStatus);
+    Debug_pushMessage("resumeStatus: %d\n", globals.resumeStatus);
-    Debug_pushMessage("systemStatustxt: %s", globals.systemStatustxt);
+    Debug_pushMessage("systemStatustxt: %s\n", globals.systemStatustxt);
-    Debug_pushMessage("purgePulses: %d", globals.purgePulses);
+    Debug_pushMessage("purgePulses: %d\n", globals.purgePulses);
-    Debug_pushMessage("requestEEAction: %d", globals.requestEEAction);
+    Debug_pushMessage("requestEEAction: %d\n", globals.requestEEAction);
-    Debug_pushMessage("DeviceName: %s", globals.DeviceName);
+    Debug_pushMessage("DeviceName: %s\n", globals.DeviceName);
-    Debug_pushMessage("FlashVersion: %s", globals.FlashVersion);
+    Debug_pushMessage("FlashVersion: %s\n", globals.FlashVersion);
-    Debug_pushMessage("eePersistanceAdress: %d", globals.eePersistanceAdress);
+    Debug_pushMessage("eePersistanceAdress: %d\n", globals.eePersistanceAdress);
-    Debug_pushMessage("TankPercentage: %d", globals.TankPercentage);
+    Debug_pushMessage("TankPercentage: %d\n", globals.TankPercentage);
-    Debug_pushMessage("hasDTC: %d", globals.hasDTC);
+    Debug_pushMessage("hasDTC: %d\n", globals.hasDTC);
 }
 
+/**
+ * @brief Dumps the persistence data variables and their values to the debug output.
+ */
 void Debug_dumpPersistance()
 {
-    Debug_pushMessage("writeCycleCounter: %d", PersistenceData.writeCycleCounter);
+    Debug_pushMessage("writeCycleCounter: %d\n", PersistenceData.writeCycleCounter);
-    Debug_pushMessage("tankRemain_microL: %d", PersistenceData.tankRemain_microL);
+    Debug_pushMessage("tankRemain_microL: %d\n", PersistenceData.tankRemain_microL);
-    Debug_pushMessage("TravelDistance_highRes_mm: %d", PersistenceData.TravelDistance_highRes_mm);
+    Debug_pushMessage("TravelDistance_highRes_mm: %d\n", PersistenceData.TravelDistance_highRes_mm);
-    Debug_pushMessage("checksum: %d", PersistenceData.checksum);
+    Debug_pushMessage("checksum: %d\n", PersistenceData.checksum);
-    Debug_pushMessage("PSD Adress: 0x%04X", globals.eePersistanceAdress);
+    Debug_pushMessage("PSD Adress: 0x%04X\n", globals.eePersistanceAdress);
 }
 
+/**
+ * @brief Prints information related to WiFi to the debug output.
+ */
 void Debug_printWifiInfo()
 {
+    // Add relevant code here if needed
 }
 
+/**
+ * @brief Checks the EEPROM data integrity by calculating and comparing checksums.
+ *        Prints the result to the debug output.
+ */
 void Debug_CheckEEPOM()
 {
+    // Check PersistenceData EEPROM checksum
     uint32_t checksum = PersistenceData.checksum;
     PersistenceData.checksum = 0;
 
@@ -210,6 +387,7 @@ void Debug_CheckEEPOM()
 
     PersistenceData.checksum = checksum;
 
+    // Check LubeConfig EEPROM checksum
     checksum = LubeConfig.checksum;
     LubeConfig.checksum = 0;
 
@@ -224,22 +402,32 @@ void Debug_CheckEEPOM()
     LubeConfig.checksum = checksum;
 }
 
+/**
+ * @brief Displays Diagnostic Trouble Codes (DTCs) along with their timestamps,
+ *        status, and severity in a formatted manner.
+ */
 void Debug_ShowDTCs()
 {
     char buff_timestamp[16]; // Format: DD-hh:mm:ss:xxx
     char buff_active[9];
 
+    // Header for the DTC display
+    Debug_pushMessage("\n      timestamp | DTC-Nr. |   status | severity\n");
+
+    // Iterate through DTCStorage and display each entry
     for (uint32_t i = 0; i < MAX_DTC_STORAGE; i++)
     {
         if (DTCStorage[i].Number < DTC_LAST_DTC)
         {
+            // Format timestamp
             sprintf(buff_timestamp, "%02d-%02d:%02d:%02d:%03d",
                     DTCStorage[i].timestamp / 86400000,    // Days
                     DTCStorage[i].timestamp / 360000 % 24, // Hours
                     DTCStorage[i].timestamp / 60000 % 60,  // Minutes
                     DTCStorage[i].timestamp / 1000 % 60,   // Seconds
-                    DTCStorage[i].timestamp % 1000);       // milliseconds
+                    DTCStorage[i].timestamp % 1000);       // Milliseconds
 
+            // Determine DTC status
             if (DTCStorage[i].active == DTC_ACTIVE)
                 strcpy(buff_active, "active");
             else if (DTCStorage[i].active == DTC_PREVIOUS)
@@ -247,7 +435,28 @@ void Debug_ShowDTCs()
             else
                 strcpy(buff_active, "none");
 
-            Debug_pushMessage("%s \t %6d \t %s \t %d", buff_timestamp, DTCStorage[i].Number, buff_active, DTCStorage[i].severity);
+            // Display DTC information
+            Debug_pushMessage("%s   %7d   %8s   %8d\n", buff_timestamp, DTCStorage[i].Number, buff_active);
         }
     }
-}
+}
+
+/**
+ * @brief Displays the help commands for debugging through Serial or WebUI.
+ *        Each command is printed individually in a formatted manner.
+ */
+void Debug_printHelp()
+{
+    char buff[64];
+
+    // Iterate through helpCmd and display each command
+    for (unsigned int i = 0; i < sizeof(helpCmd) / 63; i++)
+    {
+        // Copy a portion of helpCmd to buff for display
+        memcpy_P(buff, (helpCmd + (i * 63)), 63);
+        buff[63] = 0;
+
+        // Display the help command
+        Debug_pushMessage(buff);
+    }
+}

Software/src/debugger.h

@@ -1,45 +0,0 @@
-#ifndef _DEBUGGER_H_
-#define _DEBUGGER_H_
-
-#include <Arduino.h>
-#include "webui.h"
-
-const char helpCmd[] = "sysinfo     - System Info\r\n"
-                       "netinfo     - WiFi Info\r\n"
-                       "formatPDS   - Format Persistence EEPROM Data\r\n"
-                       "formatCFG   - Format Configuration EEPROM Data\r\n"
-                       "checkEE     - Check EEPROM with checksum\r\n"
-                       "dumpEE1k    - dump the first 1kb of EEPROM to Serial\r\n"
-                       "dumpEE      - dump the whole EPPROM to Serial\r\n"
-                       "resetPageEE - Reset the PersistenceData Page\r\n"
-                       "dumpCFG     - print Config struct\r\n"
-                       "dumpPDS     - print PersistanceStruct\r\n"
-                       "saveEE      - save EE-Data\r\n"
-                       "showdtc     - Show all DTCs\r\n"
-                       "dumpGlobals - print globals\r\n";
-
-typedef enum DebugStatus_e
-{
-    disabled,
-    enabled
-} DebugStatus_t;
-
-typedef enum DebugPorts_e
-{
-    dbg_Serial,
-    dbg_Webui,
-    dbg_cntElements
-} DebugPorts_t;
-
-const char sDebugPorts[dbg_cntElements][7] = {
-    "Serial",
-    "WebUI"};
-
-extern DebugStatus_t DebuggerStatus[dbg_cntElements];
-
-void initDebugger();
-void pushCANDebug(uint32_t id, uint8_t dlc, uint8_t *data);
-void Debug_pushMessage(const char *format, ...);
-void SetDebugportStatus(DebugPorts_t port, DebugStatus_t status);
-
-#endif

Software/src/dtc.cpp

@@ -1,37 +1,61 @@
+/**
+ * @file dtc.cpp
+ * @brief Implementation of functions related to Diagnostic Trouble Codes (DTCs).
+ *
+ * This file contains the implementation of functions that manage the status
+ * and registration of Diagnostic Trouble Codes in the system.
+ *
+ * @author Marcel Peterkau
+ * @date 09.01.2024
+ */
 #include "dtc.h"
 #include "debugger.h"
 
-DTCEntry_s DTCStorage[MAX_DTC_STORAGE];
+DTCEntry_t DTCStorage[MAX_DTC_STORAGE];
 
-void MaintainDTC(DTCNums_t DTC_no, DTCSeverity_t DTC_severity, boolean active, uint32_t DebugValue)
+// Function implementations...
+
+/**
+ * @brief Maintains the status of Diagnostic Trouble Codes (DTCs) in the DTCStorage array.
+ *        Updates the status of existing DTCs or adds new ones based on their activity.
+ *
+ * @param DTC_no      The number of the Diagnostic Trouble Code.
+ * @param active      Indicates whether the DTC is active (true) or inactive (false).
+ * @param DebugValue  Additional debugging information associated with the DTC.
+ */
+void MaintainDTC(DTCNum_t DTC_no, boolean active, uint32_t DebugValue)
 {
+    // Iterate through the existing DTCs in the storage
     for (int i = 0; i < MAX_DTC_STORAGE; i++)
     {
+        // Check if the DTC with the specified number exists
         if (DTCStorage[i].Number == DTC_no)
         {
+            // If the DTC is active and was not active before, update its status
             if (active && DTCStorage[i].active != DTC_ACTIVE)
             {
                 Debug_pushMessage("DTC gone active: %d, DebugVal: %d\n", DTC_no, DebugValue);
                 DTCStorage[i].timestamp = millis();
                 DTCStorage[i].active = DTC_ACTIVE;
-                DTCStorage[i].severity = DTC_severity;
                 DTCStorage[i].debugVal = DebugValue;
             }
+            // If the DTC is not active anymore, update its status to previous
             if (!active && DTCStorage[i].active == DTC_ACTIVE)
             {
                 Debug_pushMessage("DTC gone previous: %d\n", DTC_no);
                 DTCStorage[i].active = DTC_PREVIOUS;
             }
-            return;
+            return; // DTC found and processed, exit the function
         }
     }
 
-    // DTC was not found with upper iteration, but is active
+    // DTC was not found in the existing storage, but it is active,
-    // so we need to look for free space to store DTC
+    // so look for free space to store the new DTC
     if (active == true)
     {
         for (int i = 0; i < MAX_DTC_STORAGE; i++)
         {
+            // Check for an empty slot in the storage
             if (DTCStorage[i].Number == DTC_LAST_DTC)
             {
                 Debug_pushMessage("new DTC registered: %d, DebugVal: %d\n", DTC_no, DebugValue);
@@ -39,37 +63,59 @@ void MaintainDTC(DTCNums_t DTC_no, DTCSeverity_t DTC_severity, boolean active, u
                 DTCStorage[i].timestamp = millis();
                 DTCStorage[i].active = DTC_ACTIVE;
                 DTCStorage[i].debugVal = DebugValue;
-                DTCStorage[i].severity = DTC_severity;
+                return; // New DTC registered, exit the function
-                return;
             }
         }
     }
 }
 
-void ClearDTC(DTCNums_t DTC_no)
+/**
+ * @brief Clears a specific Diagnostic Trouble Code (DTC) entry.
+ *
+ * This function clears the information related to a specific DTC entry,
+ * setting its status to inactive and timestamp to zero.
+ *
+ * @param DTC_no The Diagnostic Trouble Code number to be cleared.
+ */
+void ClearDTC(DTCNum_t DTC_no)
 {
     for (int i = 0; i < MAX_DTC_STORAGE; i++)
     {
         if (DTCStorage[i].Number == DTC_no)
         {
             DTCStorage[i].Number = DTC_LAST_DTC;
-            DTCStorage[i].active = DTC_NONE;
+            DTCStorage[i].active = DTC_INACTIVE;
             DTCStorage[i].timestamp = 0;
         }
     }
 }
 
+/**
+ * @brief Clears all Diagnostic Trouble Code (DTC) entries.
+ *
+ * This function clears all DTC entries, setting their status to inactive and
+ * timestamps to zero.
+ */
 void ClearAllDTC()
 {
     for (int i = 0; i < MAX_DTC_STORAGE; i++)
     {
         DTCStorage[i].Number = DTC_LAST_DTC;
-        DTCStorage[i].active = DTC_NONE;
+        DTCStorage[i].active = DTC_INACTIVE;
         DTCStorage[i].timestamp = 0;
     }
 }
 
-DTCNums_t getlastDTC(boolean only_active)
+/**
+ * @brief Gets the last recorded Diagnostic Trouble Code (DTC) number.
+ *
+ * This function retrieves the DTC number of the last recorded DTC based on the
+ * timestamp. Optionally, it can filter only active DTCs.
+ *
+ * @param only_active If true, considers only active DTCs; otherwise, considers all.
+ * @return The DTC number of the last recorded DTC or DTC_LAST_DTC if none found.
+ */
+DTCNum_t getlastDTC(boolean only_active)
 {
     int8_t pointer = -1;
     uint32_t lasttimestamp = 0;
@@ -89,34 +135,47 @@ DTCNums_t getlastDTC(boolean only_active)
     return pointer >= 0 ? DTCStorage[pointer].Number : DTC_LAST_DTC;
 }
 
-DTCNums_t getlastDTC_Severity(boolean only_active, DTCSeverity_t severity)
+/**
+ * @brief Gets the severity level for a specific Diagnostic Trouble Code (DTC).
+ *
+ * This function looks up the severity level associated with the provided DTC code
+ * from the predefined list of DTC definitions.
+ *
+ * @param targetCode The DTC code for which to retrieve the severity.
+ * @return The severity level of the specified DTC or DTC_NONE if not found.
+ */
+DTCSeverity_t getSeverityForDTC(DTCNum_t targetCode)
 {
-    int8_t pointer = -1;
+    for (int i = 0; i < DTC_LAST_DTC; i++)
-    uint32_t lasttimestamp = 0;
-
-    for (int i = 0; i < MAX_DTC_STORAGE; i++)
     {
-        if (DTCStorage[i].Number > 0 && DTCStorage[i].timestamp > lasttimestamp)
+        if (dtc_definitions[i].code == targetCode)
         {
-            if ((only_active == false || DTCStorage[i].active == DTC_ACTIVE) && DTCStorage[i].severity == severity)
+            return dtc_definitions[i].severity;
-            {
-                pointer = i;
-                lasttimestamp = DTCStorage[i].timestamp;
-            }
         }
     }
-
+    return DTC_NONE;
-    return pointer >= 0 ? DTCStorage[pointer].Number : DTC_LAST_DTC;
 }
 
+/**
+ * @brief Processes Diagnostic Trouble Codes (DTCs) and updates system status accordingly.
+ *
+ * This function checks for the presence of active DTCs and adjusts the system status
+ * based on the severity of the most critical DTC. If a critical DTC is detected,
+ * the system status is set to sysStat_Error, potentially triggering a system shutdown.
+ *
+ * @note The function also preserves the original system status when transitioning to an error state
+ *       and restores it when all DTCs are cleared.
+ */
 void DTC_Process()
 {
     static tSystem_Status preserverSysStatusError;
+    DTCNum_t lastDTC = getlastDTC(true);
 
-    if (getlastDTC(false) < DTC_LAST_DTC)
+    if (lastDTC < DTC_LAST_DTC)
     {
         globals.hasDTC = true;
-        if (getlastDTC_Severity(true, DTC_CRITICAL) < DTC_LAST_DTC)
+
+        if (getSeverityForDTC(lastDTC) == DTC_CRITICAL && globals.systemStatus != sysStat_Shutdown)
         {
             if (globals.systemStatus != sysStat_Error)
             {
@@ -124,16 +183,14 @@ void DTC_Process()
             }
             globals.systemStatus = sysStat_Error;
         }
-        else
-        {
-            if (globals.systemStatus == sysStat_Error)
-            {
-                globals.systemStatus = preserverSysStatusError;
-            }
-        }
     }
     else
     {
         globals.hasDTC = false;
+
+        if (globals.systemStatus == sysStat_Error)
+        {
+            globals.systemStatus = preserverSysStatusError;
+        }
     }
-}
+}

Software/src/dtc.h

@@ -1,61 +0,0 @@
-#ifndef _DTC_H_
-#define _DTC_H_
-
-#include <Arduino.h>
-
-#define MAX_DTC_STORAGE 6
-
-typedef enum DTCNums_e
-{
-  DTC_TANK_EMPTY = 1,
-  DTC_TANK_LOW,
-  DTC_NO_EEPROM_FOUND,
-  DTC_EEPROM_CFG_BAD,
-  DTC_EEPROM_PDS_BAD,
-  DTC_EEPROM_PDSADRESS_BAD,
-  DTC_EEPROM_VERSION_BAD,
-  DTC_FLASHFS_ERROR,
-  DTC_FLASHFS_VERSION_ERROR,
-#ifdef FEATURE_ENABLE_GPS
-  DTC_NO_GPS_SERIAL,
-#endif
-#ifdef FEATURE_ENABLE_CAN
-  DTC_CAN_TRANSCEIVER_FAILED,
-  DTC_NO_CAN_SIGNAL,
-#endif
-  DTC_EEPROM_CFG_SANITY,
-  DTC_LAST_DTC
-} DTCNums_t;
-
-typedef enum DTCActive_e
-{
-  DTC_NONE,
-  DTC_ACTIVE,
-  DTC_PREVIOUS
-} DTCActive_t;
-
-typedef enum DTCSeverity_e
-{
-  DTC_INFO,
-  DTC_WARN,
-  DTC_CRITICAL
-} DTCSeverity_t;
-
-typedef struct DTCEntry_s
-{
-  DTCNums_t Number;
-  uint32_t timestamp;
-  DTCActive_t active;
-  DTCSeverity_t severity;
-  uint32_t debugVal;
-} DTCEntry_t;
-
-void MaintainDTC(DTCNums_t DTC_no, DTCSeverity_t DTC_severity, boolean active, uint32_t DebugValue = 0);
-void ClearDTC(DTCNums_t DTC_no);
-void ClearAllDTC();
-DTCNums_t getlastDTC(boolean only_active);
-DTCNums_t getlastDTC_Severity(boolean only_active, DTCSeverity_t severity);
-void DTC_Process();
-
-extern DTCEntry_s DTCStorage[MAX_DTC_STORAGE];
-#endif

Software/src/dtc_defs.txt

@@ -0,0 +1,18 @@
+# No. |                 DTC-Constant |      Severity |                 Title | Description     
+#-----|------------------------------|---------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------
+    1;                DTC_TANK_EMPTY;   DTC_CRITICAL;          Ölvorrat leer;  Ölvorrat ist komplett leer. Den Ölvorrat auffüllen und im Menu 'Wartung' zurück setzen
+    2;                  DTC_TANK_LOW;       DTC_WARN;       Ölvorrat niedrig;  Ölvorrat ist unter der Warnschwelle. Den Ölvorrat demnächst auffüllen und im Menu 'Wartung' zurück setzen
+    3;           DTC_NO_EEPROM_FOUND;   DTC_CRITICAL;    kein EEPROM erkannt;  Es wurde kein EEPROM gefunden. Dies lässt einen Hardware-Defekt vermuten.
+    4;            DTC_EEPROM_CFG_BAD;   DTC_CRITICAL;  EEPROM CFG Checksumme;  Die Checksumme der Config-Partition des EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'CFG' im Menu 'Wartung' zurück
+    5;            DTC_EEPROM_PDS_BAD;   DTC_CRITICAL;  EEPROM PDS Checksumme;  Die Checksumme der Betriebsdaten-Partition des EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'PDS' im Menu 'Wartung' zurück
+    6;      DTC_EEPROM_PDSADRESS_BAD;   DTC_CRITICAL;     EEPROM PDS Adresse;  Die Adresse der Betriebsdaten-Partition im EEPROM ist ungültig. Setzen sie den EEPROM-Bereich 'PDS' im Menu 'Wartung' zurück
+    7;        DTC_EEPROM_VERSION_BAD;   DTC_CRITICAL;  EEPROM Version falsch;  Die Layout-Version des EEPROM stimmt nicht mit der Firmware-Version überein. Setzen sie den EEPROM-Bereich 'CFG' im Menu 'Wartung' zurück
+    8;             DTC_FLASHFS_ERROR;   DTC_CRITICAL;   Flashspeicher Fehler;  Der Flashspeicher konnte nicht initialisiert werden. Aktualisieren sie Flash & Firmware
+    9;     DTC_FLASHFS_VERSION_ERROR;   DTC_CRITICAL;    Flashversion falsch;  Die Version des Flashspeicher stimmt nicht mit der Firmware-Version überein. Aktualisieren sie den Flash mit der passenden Update-Datei
+   10;             DTC_NO_GPS_SERIAL;   DTC_CRITICAL;   Keine GPS-Verbindung;  Es wurde kein GPS-Signal über die serielle Schnittstelle empfangen, Prüfen sie die Verbindung und das GPS-Modul
+   11;    DTC_CAN_TRANSCEIVER_FAILED;   DTC_CRITICAL;  CAN-Transceiver Error;  Es konnte keine Verbindung zum CAN-Transceiver hergestellt werden. Prüfen Sie die Hardware auf Defekte
+   12;             DTC_NO_CAN_SIGNAL;       DTC_WARN;   Keine CAN-Verbindung;  Es konnte kein CAN-Signal empfangen werden. Prüfen sie die Verbindung und die Einstellungen
+   13;         DTC_EEPROM_CFG_SANITY;       DTC_WARN;     Config-Validierung;  Ein oder mehrer Einstellungswerte sind ausserhalb plausibler Werte. Prüfen Sie Ihre Einstellungen
+   14;             DTC_FAKE_DTC_INFO;       DTC_INFO;         Dummy-DTC Info;  Ein Dummy-DTC der Schwere "Info" für Debugging-Zwecke
+   15;             DTC_FAKE_DTC_WARN;       DTC_WARN;      Dummy-DTC Warnung;  Ein Dummy-DTC der Schwere "Warnung" für Debugging-Zwecke
+   16;             DTC_FAKE_DTC_CRIT;   DTC_CRITICAL;     Dummy-DTC Kritisch;  Ein Dummy-DTC der Schwere "Kritisch" für Debugging-Zwecke

Software/src/globals.cpp

@@ -1,11 +1,29 @@
+/**
+ * @file globals.cpp
+ * @brief Implementation of global variables and initialization functions.
+ *
+ * This file defines and initializes the global variables used throughout the project.
+ * The global variables are encapsulated in the Globals_t structure. The initGlobals function
+ * is responsible for initializing these variables to their default values during system startup.
+ */
+
 #include "globals.h"
 
+// Global instance of the Globals_t structure
 Globals_t globals;
 
+/**
+ * @brief Initializes global variables to default values during system startup.
+ *
+ * This function sets the initial values for various global variables, ensuring proper
+ * initialization of system-wide parameters.
+ */
 void initGlobals()
 {
   globals.purgePulses = 0;
   globals.requestEEAction = EE_IDLE;
   globals.resumeStatus = sysStat_Normal;
   globals.systemStatus = sysStat_Startup;
+  globals.measurementActive = false;
+  globals.measuredPulses = 0;
 }

Software/src/globals.h

@@ -1,48 +0,0 @@
-#ifndef _GLOBALS_H_
-#define _GLOBALS_H_
-
-#include <Arduino.h>
-
-typedef enum eSystem_Status
-{
-  sysStat_Startup,
-  sysStat_Normal,
-  sysStat_Rain,
-  sysStat_Purge,
-  sysStat_Error,
-  sysStat_Shutdown
-} tSystem_Status;
-
-typedef enum eEERequest
-{
-  EE_IDLE,
-  EE_CFG_SAVE,
-  EE_CFG_LOAD,
-  EE_CFG_FORMAT,
-  EE_PDS_SAVE,
-  EE_PDS_LOAD,
-  EE_PDS_FORMAT,
-  EE_FORMAT_ALL,
-  EE_ALL_SAVE
-
-} tEERequest;
-
-typedef struct Globals_s
-{
-  tSystem_Status systemStatus = sysStat_Startup;
-  tSystem_Status resumeStatus = sysStat_Startup;
-  char systemStatustxt[16] = "";
-  uint16_t purgePulses = 0;
-  eEERequest requestEEAction = EE_IDLE;
-  char DeviceName[33];
-  char FlashVersion[10];
-  uint16_t eePersistanceAdress;
-  uint8_t TankPercentage;
-  bool hasDTC;
-} Globals_t;
-
-extern Globals_t globals;
-
-void initGlobals();
-
-#endif

Software/src/gps.cpp

@@ -1,8 +1,26 @@
-#ifdef FEATURE_ENABLE_GPS
+/**
+ * @file gps.cpp
+ *
+ * @brief Implementation file for GPS-related functions in the ChainLube application.
+ *
+ * This file contains the implementation of functions related to GPS functionality within the ChainLube
+ * application. It includes the initialization of the GPS module, processing GPS data for wheel speed,
+ * and maintaining Diagnostic Trouble Codes (DTCs) based on GPS communication status.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
 #include "gps.h"
 
 TinyGPSPlus gps;
 
+/**
+ * @brief Initializes the GPS module with the specified baud rate.
+ *
+ * This function initializes the GPS module with the baud rate configured in the application settings.
+ * It also prints a debug message indicating the initialization status.
+ */
 void Init_GPS()
 {
     uint32_t baudrate;
@@ -23,6 +41,15 @@ void Init_GPS()
     Serial.begin(baudrate);
 }
 
+/**
+ * @brief Processes GPS data to calculate rear wheel speed and returns the distance traveled.
+ *
+ * This function processes GPS data received from the GPS module, calculates the rear wheel speed in
+ * kilometers per hour, and returns the distance traveled based on the speed and time elapsed since
+ * the last valid speed measurement.
+ *
+ * @return The distance traveled in millimeters since the last GPS speed measurement.
+ */
 uint32_t Process_GPS_WheelSpeed()
 {
     static uint32_t lastRecTimestamp;
@@ -51,9 +78,8 @@ uint32_t Process_GPS_WheelSpeed()
         }
     }
 
-    MaintainDTC(DTC_NO_GPS_SERIAL,DTC_CRITICAL, (millis() > lastRecTimestamp + 10000));
+    // Maintain DTC for no GPS data received within a certain time frame
+    MaintainDTC(DTC_NO_GPS_SERIAL, (millis() > lastRecTimestamp + 10000));
 
     return 0;
 }
-
-#endif

Software/src/gps.h

@@ -1,12 +0,0 @@
-#ifndef _GPS_H_
-#define _GPS_H_
-
-#include <TinyGPSPlus.h>
-#include "config.h"
-#include "common.h"
-#include "dtc.h"
-
-void Init_GPS();
-uint32_t Process_GPS_WheelSpeed();
-
-#endif

Software/src/lubeapp.cpp

@@ -1,27 +1,56 @@
+/**
+ * @file lubeapp.cpp
+ *
+ * @brief Implementation file for the ChainLube application logic.
+ *
+ * This file contains the implementation of the ChainLube application logic, including functions
+ * for running the main application, initiating lubrication pulses, and maintaining system status.
+ * Global variables related to lubrication pulses are also defined in this file.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
 #include "lubeapp.h"
 
 uint32_t lubePulseTimestamp = 0;
 
+/**
+ * @brief Runs the main logic of the ChainLube application based on the current system status.
+ *
+ * This function is responsible for executing the main logic of the ChainLube application. It calculates
+ * the tank percentage, maintains Diagnostic Trouble Codes (DTCs) related to the tank level, updates travel
+ * distances, triggers lubrication pulses, and handles the behavior based on the current system status
+ * (Startup, Normal, Rain, Purge, Error, Shutdown). It also manages the pin state of the lube pump.
+ *
+ * @param add_milimeters The additional distance traveled in millimeters to be processed by the application.
+ */
 void RunLubeApp(uint32_t add_milimeters)
 {
-
+    // Calculate and update tank percentage
     globals.TankPercentage = PersistenceData.tankRemain_microL / (LubeConfig.tankCapacity_ml * 10);
 
-    MaintainDTC(DTC_TANK_EMPTY, DTC_CRITICAL, (PersistenceData.tankRemain_microL < LubeConfig.amountPerDose_microL));
+    // Maintain DTCs related to tank level
-    MaintainDTC(DTC_TANK_LOW, DTC_WARN, (globals.TankPercentage < LubeConfig.TankRemindAtPercentage));
+    MaintainDTC(DTC_TANK_EMPTY, (PersistenceData.tankRemain_microL < LubeConfig.amountPerDose_microL));
+    MaintainDTC(DTC_TANK_LOW, (globals.TankPercentage < LubeConfig.TankRemindAtPercentage));
 
-    // Add traveled Distance in mm
+    // Add traveled distance in millimeters
     PersistenceData.TravelDistance_highRes_mm += add_milimeters;
     PersistenceData.odometer_mm += add_milimeters;
+
+    // Update odometer if necessary
     if (PersistenceData.odometer_mm >= 1000000)
     {
         PersistenceData.odometer++;
         PersistenceData.odometer_mm = 0;
     }
 
+    // Handle different system statuses
     switch (globals.systemStatus)
     {
     case sysStat_Startup:
+        strcpy_P(globals.systemStatustxt, PSTR("Startup"));
+        // Transition to Normal status after startup delay
         if (millis() > STARTUP_DELAY)
         {
             globals.systemStatus = sysStat_Normal;
@@ -30,6 +59,8 @@ void RunLubeApp(uint32_t add_milimeters)
         break;
 
     case sysStat_Normal:
+        strcpy_P(globals.systemStatustxt, PSTR("Normal"));
+        // Trigger lube pulse if traveled distance exceeds the configured limit
         if (PersistenceData.TravelDistance_highRes_mm / 1000 > LubeConfig.DistancePerLube_Default)
         {
             LubePulse();
@@ -38,70 +69,72 @@ void RunLubeApp(uint32_t add_milimeters)
         break;
 
     case sysStat_Rain:
+        strcpy_P(globals.systemStatustxt, PSTR("Rain"));
+        // Trigger lube pulse if traveled distance exceeds the configured limit in Rain mode
         if (PersistenceData.TravelDistance_highRes_mm / 1000 > LubeConfig.DistancePerLube_Rain)
         {
             LubePulse();
             PersistenceData.TravelDistance_highRes_mm = 0;
         }
         break;
+
     case sysStat_Purge:
+        strcpy_P(globals.systemStatustxt, PSTR("Purge"));
+        // Execute lube pulses during the Purge status
         if (globals.purgePulses > 0)
         {
+            // Check if enough time has passed since the last lube pulse
             if (lubePulseTimestamp + LUBE_PULSE_PAUSE_MS < millis())
             {
                 LubePulse();
                 globals.purgePulses--;
+                Debug_pushMessage("Purge remain: %d\n", globals.purgePulses);
             }
         }
         else
         {
+            // Transition back to the previous status after completing purge pulses
             globals.systemStatus = globals.resumeStatus;
         }
         break;
+
     case sysStat_Error:
+        strcpy_P(globals.systemStatustxt, PSTR("Error"));
+        break;
+
     case sysStat_Shutdown:
+        strcpy_P(globals.systemStatustxt, PSTR("Shutdown"));
+        break;
+
     default:
         break;
     }
 
-    switch (globals.systemStatus)
+    // Maintain Pin-State of Lube-Pump
-    {
-    case sysStat_Normal:
-        strcpy_P(globals.systemStatustxt, PSTR("Normal"));
-        break;
-    case sysStat_Purge:
-        strcpy_P(globals.systemStatustxt, PSTR("Purge"));
-        break;
-    case sysStat_Rain:
-        strcpy_P(globals.systemStatustxt, PSTR("Rain"));
-        break;
-    case sysStat_Startup:
-        strcpy_P(globals.systemStatustxt, PSTR("Startup"));
-        break;
-    case sysStat_Error:
-        strcpy_P(globals.systemStatustxt, PSTR("Error"));
-        break;
-    case sysStat_Shutdown:
-        strcpy_P(globals.systemStatustxt, PSTR("Shutdown"));
-        break;
-    }
-
-    // maintain Pin-State of Lube-Pump
     if (lubePulseTimestamp > millis())
         digitalWrite(GPIO_PUMP, HIGH);
     else
         digitalWrite(GPIO_PUMP, LOW);
 }
 
+/**
+ * @brief Initiates a lubrication pulse if there is sufficient oil remaining in the tank.
+ *
+ * This function checks if there is enough oil remaining in the tank to perform a lubrication pulse.
+ * If there is sufficient oil, it updates the lubePulseTimestamp to trigger the pulse and decreases
+ * the tank oil level by the configured amount per dose (LubeConfig.amountPerDose_microL).
+ */
 void LubePulse()
 {
-    if (PersistenceData.tankRemain_microL > 0) // Only Lube if theres Oil remaining!
+    // Only initiate a lubrication pulse if there is oil remaining in the tank
+    if (PersistenceData.tankRemain_microL > 0)
     {
         lubePulseTimestamp = millis() + LUBE_PULSE_LENGHT_MS;
 
-        if (PersistenceData.tankRemain_microL < LubeConfig.amountPerDose_microL) // Prevent underrun and shiftover
+        // Prevent underrun and shift over by adjusting the tank oil level
+        if (PersistenceData.tankRemain_microL < LubeConfig.amountPerDose_microL)
             PersistenceData.tankRemain_microL = 0;
         else
-            PersistenceData.tankRemain_microL = PersistenceData.tankRemain_microL - LubeConfig.amountPerDose_microL;
+            PersistenceData.tankRemain_microL -= LubeConfig.amountPerDose_microL;
     }
-}
+}

Software/src/lubeapp.h

@@ -1,14 +0,0 @@
-#ifndef _LUBEAPP_H_
-#define _LUBEAPP_H_
-
-#include <Arduino.h>
-#include <stdlib.h>
-#include "config.h"
-#include "common.h"
-#include "globals.h"
-#include "dtc.h"
-
-void RunLubeApp(uint32_t add_milimeters);
-void LubePulse();
-
-#endif

Software/src/main.cpp

@@ -1,3 +1,18 @@
+/**
+ * @file main.cpp
+ *
+ * @brief Main source file for the Souko's ChainLube Mk1 ESP8266 project.
+ *
+ * This file includes necessary libraries, defines configuration options, and declares global variables
+ * and function prototypes. It sets up essential components, initializes peripherals, and defines
+ * callbacks for interrupt service routines (ISRs) and timers. The main setup function configures the
+ * project, and the loop function handles the main execution loop, performing various tasks based on
+ * the configured options.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
 #include <Arduino.h>
 #include <Wire.h>
 #ifdef FEATURE_ENABLE_OLED
@@ -6,7 +21,7 @@
 #include <ESP8266WiFi.h>
 #include <ArduinoOTA.h>
 
-#include <FastLED.h>
+#include <Adafruit_NeoPixel.h>
 #include <Ticker.h>
 
 #include "common.h"
@@ -18,13 +33,10 @@
 #include "config.h"
 #include "globals.h"
 #include "debugger.h"
-#ifdef FEATURE_ENABLE_CAN
 #include "can.h"
-#endif
-#ifdef FEATURE_ENABLE_GPS
 #include "gps.h"
-#endif
 #include "dtc.h"
+#include "led_colors.h"
 
 #ifdef FEATURE_ENABLE_WIFI_CLIENT
 #include <ESP8266WiFiMulti.h>
@@ -39,18 +51,18 @@ ESP8266WiFiMulti wifiMulti;
 bool startSetupMode = false;
 volatile uint32_t wheel_pulse = 0;
 
-CRGB leds[1];
+Adafruit_NeoPixel leds(1, GPIO_LED, NEO_RGB + NEO_KHZ800);
 
 // Function-Prototypes
 void IRAM_ATTR trigger_ISR();
-void LED_Process(uint8_t override = false, CRGB setColor = CRGB::White);
+void LED_Process(uint8_t override = false, uint32_t setColor = LED_DEFAULT_COLOR);
 #ifdef FEATURE_ENABLE_OLED
 U8X8_SSD1306_128X64_NONAME_HW_I2C u8x8(-1);
 void Display_Process();
 #endif
 void Button_Process();
-void toggleWiFiAP(boolean shutdown = false);
+void toggleWiFiAP(bool shutdown = false);
-void SystemShutdown();
+void SystemShutdown(bool restart = false);
 uint32_t Process_Impulse_WheelSpeed();
 void EEPROMCyclicPDS_callback();
 
@@ -60,71 +72,104 @@ Ticker WiFiMaintainConnectionTicker(wifiMaintainConnectionTicker_callback, 1000,
 #endif
 Ticker EEPROMCyclicPDSTicker(EEPROMCyclicPDS_callback, 60000, 0, MILLIS);
 
+/**
+ * @brief Initializes the ESP8266 project, configuring various components and setting up required services.
+ *
+ * This setup function is responsible for initializing the ESP8266 project, including setting the CPU frequency,
+ * configuring WiFi settings, initializing DTC storage, handling WiFi client functionality (if enabled),
+ * initializing the Serial communication, setting up an OLED display (if enabled), initializing EEPROM,
+ * loading configuration and persistence data from EEPROM, initializing LEDs, setting up the chosen speed source
+ * (CAN, GPS, Impulse), configuring GPIO pins, setting up Over-The-Air (OTA) updates, initializing the web user interface,
+ * initializing global variables, starting cyclic EEPROM updates for Persistence Data Structure (PDS), and printing
+ * initialization status messages to Serial.
+ */
 void setup()
 {
+  // Set CPU frequency to 80MHz
   system_update_cpu_freq(SYS_CPU_80MHZ);
+
+  // Generate a unique device name based on ESP chip ID
   snprintf(globals.DeviceName, 32, HOST_NAME, ESP.getChipId());
+
+  // Disable WiFi persistent storage
   WiFi.persistent(false);
 
-  ClearAllDTC(); // Init DTC-Storage
+  // Initialize and clear Diagnostic Trouble Code (DTC) storage
+  ClearAllDTC();
 
 #ifdef FEATURE_ENABLE_WIFI_CLIENT
+  // Configure WiFi settings for client mode if enabled
   WiFi.mode(WIFI_STA);
   WiFi.setHostname(globals.DeviceName);
   wifiMulti.addAP(QUOTE(WIFI_SSID_CLIENT), QUOTE(WIFI_PASSWORD_CLIENT));
   WiFiMaintainConnectionTicker.start();
 #else
+  // Disable WiFi if WiFi client feature is not enabled
   WiFi.mode(WIFI_OFF);
 #endif
 
+  // Initialize Serial communication
   Serial.begin(115200);
-  Serial.println("\n\nSouko's ChainLube Mk1");
+  Serial.print("\n\nSouko's ChainLube Mk1\n");
-  Serial.println(globals.DeviceName);
+  Serial.print(globals.DeviceName);
 
+#ifdef FEATURE_ENABLE_OLED
+  // Initialize OLED display if enabled
+  u8x8.begin();
+  u8x8.setFont(u8x8_font_chroma48medium8_r);
+  u8x8.clearDisplay();
+  u8x8.drawString(0, 0, "KTM ChainLube V1");
+  u8x8.refreshDisplay();
+  Serial.print("\nDisplay-Init done");
+#endif
+
+  // Initialize EEPROM, load configuration, and persistence data from EEPROM
   InitEEPROM();
   GetConfig_EEPROM();
   GetPersistence_EEPROM();
-#ifdef FEATURE_ENABLE_OLED
+  Serial.print("\nEE-Init done");
-  u8x8.begin();
-  u8x8.setFont(u8x8_font_chroma48medium8_r);
-#endif
-  FastLED.addLeds<WS2811, GPIO_LED, RGB>(leds, 1); // GRB ordering is assumed
 
+  // Initialize LEDs
+  leds.begin();
+  Serial.print("\nLED-Init done");
+
+  // Initialize based on the chosen speed source (CAN, GPS, Impulse)
   switch (LubeConfig.SpeedSource)
   {
+  case SOURCE_CAN:
+    Init_CAN();
+    Serial.print("\nCAN-Init done");
+    break;
+  case SOURCE_GPS:
+    Init_GPS();
+    Serial.print("\nGPS-Init done");
+    break;
   case SOURCE_IMPULSE:
     pinMode(GPIO_TRIGGER, INPUT_PULLUP);
     attachInterrupt(digitalPinToInterrupt(GPIO_TRIGGER), trigger_ISR, FALLING);
+    Serial.print("\nPulse-Input Init done");
     break;
-#ifdef FEATURE_ENABLE_GPS
-  case SOURCE_GPS:
-    Init_GPS();
-    break;
-#endif
-  case SOURCE_TIME:
-
-    break;
-#ifdef FEATURE_ENABLE_CAN
-  case SOURCE_CAN:
-    Init_CAN();
-    break;
-#endif
   default:
-    Debug_pushMessage("Source Setting N/A");
     break;
   }
 
+  Serial.print("\nSource-Init done");
+
+  // Configure GPIO pins for button and pump control
   pinMode(GPIO_BUTTON, INPUT_PULLUP);
   pinMode(GPIO_PUMP, OUTPUT);
 
+  // Set up OTA updates
   ArduinoOTA.setPort(8266);
   ArduinoOTA.setHostname(globals.DeviceName);
   ArduinoOTA.setPassword(QUOTE(ADMIN_PASSWORD));
+
 #ifdef FEATURE_ENABLE_OLED
+  // Set up OTA callbacks for OLED display if enabled
   ArduinoOTA.onStart([]()
                      {
                        u8x8.clearDisplay();
-                       u8x8.drawString(0, 0, "OTA-Update");
+                       u8x8.drawString(0, 6, "OTA-Update");
                        u8x8.refreshDisplay(); });
 
   ArduinoOTA.onProgress([](unsigned int progress, unsigned int total)
@@ -134,78 +179,123 @@ void setup()
                           {
                             u8x8.clearDisplay();
                             refreshed = true;
-                            u8x8.drawString(0, 0, "OTA Upload");
+                            u8x8.drawString(0, 6, "OTA Upload");
                           }
                           uint32_t percent = progress / (total / 100);
-                          u8x8.setCursor(0, 1);
+                          u8x8.setCursor(0, 7);
                           u8x8.printf("%d %%", percent);
                           u8x8.refreshDisplay(); });
 
   ArduinoOTA.onEnd([]()
                    {
                      u8x8.clearDisplay();
-                     u8x8.drawString(0, 0, "OTA-Restart");
+                     u8x8.drawString(0, 6, "OTA-Restart");
                      u8x8.refreshDisplay(); });
 #endif
+
+  // Begin OTA updates
   ArduinoOTA.begin();
+  Serial.print("\nOTA-Init done");
 
-#ifdef FEATURE_ENABLE_OLED
+  // Initialize the web user interface
-  u8x8.clearDisplay();
-  u8x8.drawString(0, 0, "KTM ChainLube V1");
-  u8x8.refreshDisplay();
-#endif
-
   initWebUI();
+  Serial.print("\nWebUI-Init done");
+
+  // Initialize global variables
   initGlobals();
+  Serial.print("\nglobals-Init done");
+
+  // Start cyclic EEPROM updates for Persistence Data Structure (PDS)
   EEPROMCyclicPDSTicker.start();
-  Serial.println("Setup Done");
+  Serial.print("\nSetup Done\n");
 }
 
+/**
+ * @brief Main execution loop for the ESP8266 project, performing various tasks based on configuration.
+ *
+ * This loop function handles different tasks based on the configured source of speed data (impulse, CAN, time, GPS).
+ * It calculates wheel distance, runs the lubrication application, updates the OLED display (if enabled),
+ * processes CAN messages, handles button input, manages LED behavior, performs EEPROM-related tasks, handles
+ * webserver operations, processes Diagnostic Trouble Codes (DTC), and manages debugging. Additionally, it
+ * integrates functionalities such as Over-The-Air (OTA) updates, cyclic EEPROM updates for Persistence Data
+ * Structure (PDS), WiFi connection maintenance, and system shutdown handling.
+ */
 void loop()
 {
+  // Variable to store calculated wheel distance
   uint32_t wheelDistance = 0;
 
+  // Switch based on the configured speed source
   switch (LubeConfig.SpeedSource)
   {
   case SOURCE_IMPULSE:
     wheelDistance = Process_Impulse_WheelSpeed();
     break;
-#ifdef FEATURE_ENABLE_CAN
   case SOURCE_CAN:
     wheelDistance = Process_CAN_WheelSpeed();
     break;
-#endif
+
+#ifdef FEATURE_ENABLE_TIMER
   case SOURCE_TIME:
     break;
-#ifdef FEATURE_ENABLE_GPS
+#endif
   case SOURCE_GPS:
     wheelDistance = Process_GPS_WheelSpeed();
     break;
-#endif
   }
 
+  // Run lubrication application with the calculated wheel distance
   RunLubeApp(wheelDistance);
+
 #ifdef FEATURE_ENABLE_OLED
+  // Update OLED display if enabled
   Display_Process();
 #endif
+
+  // Process CAN messages if the speed source is not impulse
+  if (LubeConfig.SpeedSource != SOURCE_IMPULSE)
+  {
+    CAN_Process();
+  }
+
+  // Process button input, manage LED behavior, perform EEPROM tasks, handle webserver operations,
+  // process Diagnostic Trouble Codes (DTC), and manage debugging
   Button_Process();
   LED_Process();
   EEPROM_Process();
   Webserver_Process();
   DTC_Process();
+  Debug_Process();
 
+  // Handle OTA updates and update cyclic EEPROM tasks for Persistence Data Structure (PDS)
   ArduinoOTA.handle();
   EEPROMCyclicPDSTicker.update();
+
 #ifdef FEATURE_ENABLE_WIFI_CLIENT
+  // Update WiFi connection maintenance ticker if WiFi client feature is enabled
   WiFiMaintainConnectionTicker.update();
 #endif
+
+  // Perform system shutdown if the status is set to shutdown
   if (globals.systemStatus == sysStat_Shutdown)
-    SystemShutdown();
+    SystemShutdown(false);
+
+  // Yield to allow other tasks to run
   yield();
 }
 
+/**
+ * @brief Converts an IPAddress object to a String representation.
+ *
+ * This function takes an IPAddress object and converts it into a String representing
+ * the IPv4 address. Each octet of the address is separated by a dot.
+ *
+ * @param ipAddress The IPAddress object to be converted.
+ * @return A String representing the IPv4 address.
+ */
 String IpAddress2String(const IPAddress &ipAddress)
 {
+  // Concatenate each octet of the IPAddress with dots in between
   return String(ipAddress[0]) + String(".") +
          String(ipAddress[1]) + String(".") +
          String(ipAddress[2]) + String(".") +
@@ -213,42 +303,80 @@ String IpAddress2String(const IPAddress &ipAddress)
 }
 
 #ifdef FEATURE_ENABLE_WIFI_CLIENT
+/**
+ * @brief Callback function for maintaining WiFi connection and handling connection failures.
+ *
+ * This callback function is used by a ticker to periodically check the WiFi connection status.
+ * If the device is not connected to WiFi, it counts connection failures. If the number of failures
+ * exceeds a defined threshold, the function triggers the initiation of an Access Point (AP) mode
+ * using the `toggleWiFiAP` function.
+ */
 void wifiMaintainConnectionTicker_callback()
 {
+  // Static variables to track WiFi connection failure count and maximum allowed failures
   static uint32_t WiFiFailCount = 0;
   const uint32_t WiFiFailMax = 20;
 
+  // Check if the device is connected to WiFi
   if (wifiMulti.run(connectTimeoutMs) == WL_CONNECTED)
   {
-    return;
+    return; // Exit if connected
   }
   else
   {
+    // Increment WiFi connection failure count
     if (WiFiFailCount < WiFiFailMax)
     {
       WiFiFailCount++;
     }
     else
     {
+      // Trigger AP mode if the maximum failures are reached
       Debug_pushMessage("WiFi not connected! - Start AP");
       toggleWiFiAP();
     }
   }
 }
+
 #endif
 
+/**
+ * @brief Callback function for cyclically storing Persistence Data Structure (PDS) to EEPROM.
+ *
+ * This callback function is invoked periodically to store the Persistence Data Structure (PDS)
+ * to the EEPROM. It ensures that essential data is saved persistently, allowing the system to
+ * recover its state after power cycles or resets.
+ */
 void EEPROMCyclicPDS_callback()
 {
   StorePersistence_EEPROM();
 }
 
+/**
+ * @brief Interrupt Service Routine (ISR) triggered by wheel speed sensor pulses.
+ *
+ * This ISR is called whenever a pulse is detected from the wheel speed sensor. It increments
+ * the `wheel_pulse` variable, which is used to track the number of pulses received.
+ */
 void trigger_ISR()
 {
   wheel_pulse++;
 }
 
-void LED_Process(uint8_t override, CRGB SetColor)
+/**
+ * @brief Manages LED behavior based on the current system status and user overrides.
+ *
+ * This function handles LED behavior, including startup animations, confirmation animations for
+ * normal and rain modes, indication for purge, error, shutdown, and normal operation. It supports
+ * user overrides to set a specific LED color. The LED status is determined by the current system
+ * status, and specific LED patterns are displayed accordingly.
+ *
+ * @param override Flag indicating whether to override the LED behavior (0: No override, 1: Override, 2: Resume previous state).
+ * @param SetColor The color to set when overriding the LED behavior.
+ */
+void LED_Process(uint8_t override, uint32_t SetColor)
 {
+  // Enumeration to represent LED status
   typedef enum
   {
     LED_Startup,
@@ -258,25 +386,30 @@ void LED_Process(uint8_t override, CRGB SetColor)
     LED_Confirm_Rain,
     LED_Purge,
     LED_Error,
+    LED_Shutdown,
     LED_Override
   } tLED_Status;
 
+  // Static variables to track LED status, system status, override color, and previous LED status
   static tSystem_Status oldSysStatus = sysStat_Startup;
   static tLED_Status LED_Status = LED_Startup;
-  static CRGB LED_override_color = 0;
+  static uint32_t LED_override_color = 0;
   static tLED_Status LED_ResumeOverrideStatus = LED_Startup;
 
+  // Variables for managing LED animation timing
   uint8_t color = 0;
   uint32_t timer = 0;
+  uint32_t animtimer = 0;
   static uint32_t timestamp = 0;
   timer = millis();
 
+  // Handle LED overrides
   if (override == 1)
   {
     if (LED_Status != LED_Override)
     {
       LED_ResumeOverrideStatus = LED_Status;
-      Debug_pushMessage("Override LED_Status");
+      Debug_pushMessage("Override LED_Status\n");
     }
     LED_Status = LED_Override;
     LED_override_color = SetColor;
@@ -287,147 +420,192 @@ void LED_Process(uint8_t override, CRGB SetColor)
     if (LED_Status == LED_Override)
     {
       LED_Status = LED_ResumeOverrideStatus;
-      Debug_pushMessage("Resume LED_Status");
+      Debug_pushMessage("Resume LED_Status\n");
     }
   }
 
+  // Update LED status when system status changes
   if (oldSysStatus != globals.systemStatus)
   {
     switch (globals.systemStatus)
     {
     case sysStat_Startup:
       LED_Status = LED_Startup;
-      Debug_pushMessage("sysStat: Startup");
+      Debug_pushMessage("sysStat: Startup\n");
       break;
     case sysStat_Normal:
       timestamp = timer + 3500;
       LED_Status = LED_Confirm_Normal;
-      Debug_pushMessage("sysStat: Normal");
+      Debug_pushMessage("sysStat: Normal\n");
       break;
     case sysStat_Rain:
       timestamp = timer + 3500;
       LED_Status = LED_Confirm_Rain;
-      Debug_pushMessage("sysStat: Rain");
+      Debug_pushMessage("sysStat: Rain\n");
       break;
     case sysStat_Purge:
       LED_Status = LED_Purge;
-      Debug_pushMessage("sysStat: Purge");
+      Debug_pushMessage("sysStat: Purge\n");
       break;
     case sysStat_Error:
       LED_Status = LED_Error;
-      Debug_pushMessage("sysStat: Error");
+      Debug_pushMessage("sysStat: Error\n");
       break;
     case sysStat_Shutdown:
+      LED_Status = LED_Shutdown;
+      Debug_pushMessage("sysStat: Shutdown\n");
+      break;
     default:
       break;
     }
     oldSysStatus = globals.systemStatus;
   }
 
+  // Handle different LED statuses
   switch (LED_Status)
   {
   case LED_Startup:
-    FastLED.setBrightness(255);
+    leds.setBrightness(LubeConfig.LED_Max_Brightness);
 
     if (globals.TankPercentage < LubeConfig.TankRemindAtPercentage)
-      leds[0] = CRGB::OrangeRed;
+      leds.setPixelColor(0, LED_STARTUP_TANKWARN);
     else
-      leds[0] = CRGB::White;
+      leds.setPixelColor(0, LED_STARTUP_NORMAL);
     break;
 
   case LED_Confirm_Normal:
-    FastLED.setBrightness(255);
+    animtimer = timer % 500;
-    leds[0] = timer % 250 > 125 ? CRGB(0, 255, 0) : CRGB(0, 4, 0);
+    color = map(animtimer / 2, 0, 250, 0, LubeConfig.LED_Max_Brightness);
+    leds.setPixelColor(0, LED_NORMAL_COLOR);
+    if (animtimer < 250)
+      leds.setBrightness(color);
+    else
+      leds.setBrightness(LubeConfig.LED_Max_Brightness - color);
+
     if (timestamp < timer)
     {
       LED_Status = LED_Normal;
-      FastLED.setBrightness(64);
+      Debug_pushMessage("LED_Status: Confirm -> Normal\n");
-      Debug_pushMessage("LED_Status: Confirm -> Normal");
     }
     break;
 
   case LED_Normal:
-#ifndef NO_MODE_FLASH
+    leds.setBrightness(LubeConfig.LED_Min_Brightness);
-    if (timer % 2000 > 1950)
+    leds.setPixelColor(0, LED_NORMAL_COLOR);
-      leds[0] = CRGB(0, 255, 0);
+
-    else if (WiFi.getMode() != WIFI_OFF && timer % 2000 > 1800 && timer % 2000 < 1850)
+    if (timer % 2000 > 1950 && LubeConfig.LED_Mode_Flash == true)
-#else
+      leds.setBrightness(LubeConfig.LED_Max_Brightness);
-    if (WiFi.getMode() != WIFI_OFF && timer % 2000 > 1950)
+    else if (timer % 2000 > 1500 && WiFi.getMode() != WIFI_OFF)
-#endif
+      leds.setPixelColor(0, LED_WIFI_BLINK);
-      leds[0] = CRGB(255, 128, 0);
+
-    else
-      leds[0] = CRGB(0, 4, 0);
     break;
 
   case LED_Confirm_Rain:
-    FastLED.setBrightness(255);
+    animtimer = timer % 500;
-    leds[0] = timer % 250 > 125 ? CRGB(0, 0, 255) : CRGB(0, 0, 4);
+    color = map(animtimer / 2, 0, 250, 0, LubeConfig.LED_Max_Brightness);
+    leds.setPixelColor(0, LED_RAIN_COLOR);
+    if (animtimer < 250)
+      leds.setBrightness(color);
+    else
+      leds.setBrightness(LubeConfig.LED_Max_Brightness - color);
     if (timestamp < timer)
     {
       LED_Status = LED_Rain;
-      FastLED.setBrightness(64);
+      Debug_pushMessage("LED_Status: Confirm -> Rain\n");
-      Debug_pushMessage("LED_Status: Confirm -> Rain");
     }
     break;
 
   case LED_Rain:
-#ifndef NO_MODE_FLASH
+    leds.setBrightness(LubeConfig.LED_Min_Brightness);
-    if (timer % 2000 > 1950)
+    leds.setPixelColor(0, LED_RAIN_COLOR);
-      leds[0] = CRGB(0, 0, 255);
+
-    else if (WiFi.getMode() != WIFI_OFF && timer % 2000 > 1800 && timer % 2000 < 1850)
+    if (timer % 2000 > 1950 && LubeConfig.LED_Mode_Flash == true)
-#else
+      leds.setBrightness(LubeConfig.LED_Max_Brightness);
-    if (WiFi.getMode() != WIFI_OFF && timer % 2000 > 1950)
+    else if (timer % 2000 > 1500 && WiFi.getMode() != WIFI_OFF)
-#endif
+      leds.setPixelColor(0, LED_WIFI_BLINK);
-      leds[0] = CRGB(255, 128, 0);
+
-    else
-      leds[0] = CRGB(0, 0, 4);
     break;
 
   case LED_Purge:
     timer = timer % 500;
-    color = timer / 2;
+    color = map(timer / 2, 0, 250, LubeConfig.LED_Min_Brightness, LubeConfig.LED_Max_Brightness);
-    leds[0] = CRGB::DeepPink;
+    leds.setPixelColor(0, LED_PURGE_COLOR);
     if (timer < 250)
-      FastLED.setBrightness(color);
+      leds.setBrightness(color);
     else
-      FastLED.setBrightness(250 - color);
+      leds.setBrightness(LubeConfig.LED_Max_Brightness - color);
     break;
 
   case LED_Error:
-    leds[0] = timer % 500 > 250 ? CRGB::Red : CRGB::Black;
+    leds.setBrightness(LubeConfig.LED_Max_Brightness);
+    leds.setPixelColor(0, timer % 500 > 250 ? LED_ERROR_BLINK : 0);
+    break;
+
+  case LED_Shutdown:
+    timer = timer % 600;
+    leds.setPixelColor(0, LED_SHUTDOWN_BLINK);
+    if (timer < 500)
+    {
+      color = map(timer, 0, 500, LubeConfig.LED_Max_Brightness, LubeConfig.LED_Min_Brightness);
+      leds.setBrightness(color);
+    }
+    else
+    {
+      leds.setBrightness(LubeConfig.LED_Min_Brightness);
+    }
     break;
 
   case LED_Override:
-    leds[0] = LED_override_color;
+    leds.setBrightness(LubeConfig.LED_Max_Brightness);
+    leds.setPixelColor(0, LED_override_color);
     break;
 
   default:
     break;
   }
-  FastLED.show();
+  leds.show();
 }
+
 #ifdef FEATURE_ENABLE_OLED
+/**
+ * @brief Manages the display content based on the current system status and updates the OLED display.
+ *
+ * This function handles the content to be displayed on the OLED screen, taking into account the
+ * current system status. It clears the display and prints relevant information such as system mode,
+ * remaining lubrication distance, tank level, WiFi status, speed source, and IP address. Additionally,
+ * it refreshes the OLED display with the updated content.
+ */
 void Display_Process()
 {
+  // Static variable to track the previous system status
   static tSystem_Status oldSysStatus = sysStat_Startup;
 
+  // Check if the system status has changed since the last update
   if (oldSysStatus != globals.systemStatus)
   {
+    // Clear the display and print the system title when the status changes
     u8x8.clearDisplay();
     u8x8.drawString(0, 0, "KTM ChainLube V1");
     oldSysStatus = globals.systemStatus;
   }
 
+  // Set the cursor position for displaying information on the OLED screen
   u8x8.setCursor(0, 1);
+
+  // Calculate remaining lubrication distance based on system mode
   uint32_t DistRemain = globals.systemStatus == sysStat_Normal ? LubeConfig.DistancePerLube_Default : LubeConfig.DistancePerLube_Rain;
   DistRemain = DistRemain - (PersistenceData.TravelDistance_highRes_mm / 1000);
+
+  // Display relevant information on the OLED screen based on system status
   u8x8.printf(PSTR("Mode: %10s\n"), globals.systemStatustxt);
   if (globals.systemStatus == sysStat_Error)
   {
+    // Display the last Diagnostic Trouble Code (DTC) in case of an error
     u8x8.printf(PSTR("last DTC: %6d\n"), getlastDTC(false));
   }
   else
   {
+    // Display information such as next lubrication distance, tank level, WiFi status, speed source, and IP address
     u8x8.printf(PSTR("next Lube: %4dm\n"), DistRemain);
     u8x8.printf(PSTR("Tank: %8dml\n"), PersistenceData.tankRemain_microL / 1000);
     u8x8.printf(PSTR("WiFi: %10s\n"), (WiFi.getMode() == WIFI_AP ? "AP" : WiFi.getMode() == WIFI_OFF ? "OFF"
@@ -436,18 +614,29 @@ void Display_Process()
     u8x8.printf(PSTR("Source: %8s\n"), SpeedSourceString[LubeConfig.SpeedSource]);
     u8x8.printf("%s\n", WiFi.localIP().toString().c_str());
   }
+
+  // Refresh the OLED display with the updated content
   u8x8.refreshDisplay();
 }
 #endif
 
+/**
+ * @brief Processes the button input and performs corresponding actions based on button state and timing.
+ *
+ * This function handles the button input, detecting button presses and executing actions based on
+ * predefined time delays. Actions include toggling WiFi, starting purge, toggling operating modes,
+ * and displaying feedback through LEDs. The function utilizes an enumeration to track button actions
+ * and manages the timing for different actions.
+ */
 void Button_Process()
 {
-
+  // Time delays for different button actions
 #define BUTTON_ACTION_DELAY_TOGGLEMODE 500
 #define BUTTON_ACTION_DELAY_PURGE 3500
 #define BUTTON_ACTION_DELAY_WIFI 6500
 #define BUTTON_ACTION_DELAY_NOTHING 9500
 
+  // Enumeration to represent button actions
   typedef enum buttonAction_e
   {
     BTN_INACTIVE,
@@ -457,52 +646,56 @@ void Button_Process()
     BTN_STARTPURGE
   } buttonAction_t;
 
+  // Static variables to track button state and timing
   static uint32_t buttonTimestamp = 0;
   static buttonAction_t buttonAction = BTN_INACTIVE;
 
+  // Check if button is pressed (LOW)
   if (digitalRead(GPIO_BUTTON) == LOW)
   {
-
+    // Update button timestamp on the first button press
     if (buttonTimestamp == 0)
       buttonTimestamp = millis();
 
+    // Check and execute actions based on predefined time delays
     if (buttonTimestamp + BUTTON_ACTION_DELAY_NOTHING < millis())
     {
-      LED_Process(1, CRGB::White);
+      LED_Process(1, COLOR_WARM_WHITE);
       buttonAction = BTN_NOTHING;
     }
     else if (buttonTimestamp + BUTTON_ACTION_DELAY_WIFI < millis())
     {
-      LED_Process(1, CRGB::Yellow);
+      LED_Process(1, LED_WIFI_BLINK);
       buttonAction = BTN_TOGGLEWIFI;
     }
     else if (buttonTimestamp + BUTTON_ACTION_DELAY_PURGE < millis())
     {
-      LED_Process(1, CRGB::DeepPink);
+      LED_Process(1, LED_PURGE_COLOR);
       buttonAction = BTN_STARTPURGE;
     }
     else if (buttonTimestamp + BUTTON_ACTION_DELAY_TOGGLEMODE < millis())
     {
-      CRGB color = globals.systemStatus == sysStat_Normal ? CRGB::Blue : CRGB::Green;
+      uint32_t color = globals.systemStatus == sysStat_Normal ? LED_RAIN_COLOR : LED_NORMAL_COLOR;
       LED_Process(1, color);
       buttonAction = BTN_TOGGLEMODE;
     }
   }
-  else
+  else // Button is released
   {
+    // Execute corresponding actions based on the detected button action
     if (buttonAction != BTN_INACTIVE)
     {
       switch (buttonAction)
       {
       case BTN_TOGGLEWIFI:
         toggleWiFiAP();
-        Debug_pushMessage("Starting WiFi AP");
+        Debug_pushMessage("Starting WiFi AP\n");
         break;
 
       case BTN_STARTPURGE:
         globals.systemStatus = sysStat_Purge;
         globals.purgePulses = LubeConfig.BleedingPulses;
-        Debug_pushMessage("Starting Purge");
+        Debug_pushMessage("Starting Purge\n");
         break;
 
       case BTN_TOGGLEMODE:
@@ -517,72 +710,127 @@ void Button_Process()
           globals.systemStatus = sysStat_Normal;
           globals.resumeStatus = sysStat_Normal;
           break;
+
         default:
           break;
         }
-        Debug_pushMessage("Toggling Mode");
+        Debug_pushMessage("Toggling Mode\n");
         break;
 
       case BTN_NOTHING:
       default:
-        Debug_pushMessage("Nothing or invalid");
+        Debug_pushMessage("Nothing or invalid\n");
         break;
       }
+
+      // Display feedback through LEDs
       LED_Process(2);
     }
+
+    // Reset button state and timestamp
     buttonAction = BTN_INACTIVE;
     buttonTimestamp = 0;
   }
 }
 
-void toggleWiFiAP(boolean shutdown)
+/**
+ * @brief Toggles the WiFi functionality based on the current status.
+ *
+ * This function manages the WiFi state, either turning it off or starting it as an Access Point (AP),
+ * depending on the current mode. If the WiFi is turned off, it can be started in AP mode with the
+ * device name and password configured. Additionally, it may stop certain operations related to WiFi
+ * maintenance or display debug messages based on the defined features.
+ *
+ * @param shutdown Flag indicating whether the system is in a shutdown state.
+ */
+void toggleWiFiAP(bool shutdown)
 {
+  // Check if WiFi is currently active
   if (WiFi.getMode() != WIFI_OFF)
   {
+    // Turn off WiFi
     WiFi.mode(WIFI_OFF);
-    Debug_pushMessage("WiFi turned off");
+    Debug_pushMessage("WiFi turned off\n");
+
+    // Stop WiFi maintenance connection ticker if enabled
 #ifdef FEATURE_ENABLE_WIFI_CLIENT
     WiFiMaintainConnectionTicker.stop();
 #endif
   }
   else
   {
+    // Start WiFi in Access Point (AP) mode
     WiFi.mode(WIFI_AP);
     WiFi.softAPConfig(IPAddress(WIFI_AP_IP_GW), IPAddress(WIFI_AP_IP_GW), IPAddress(255, 255, 255, 0));
     WiFi.softAP(globals.DeviceName, QUOTE(WIFI_AP_PASSWORD));
+
+    // Stop WiFi maintenance connection ticker if enabled and display debug messages
 #ifdef FEATURE_ENABLE_WIFI_CLIENT
     WiFiMaintainConnectionTicker.stop();
-    Debug_pushMessage("WiFi AP started, stopped Maintain-Timer");
+    Debug_pushMessage("WiFi AP started, stopped Maintain-Timer\n");
 #else
-    Debug_pushMessage("WiFi AP started");
+    Debug_pushMessage("WiFi AP started\n");
 #endif
   }
 }
 
-void SystemShutdown()
+/**
+ * @brief Performs necessary tasks before shutting down and optionally restarts the ESP.
+ *
+ * This function initiates a system shutdown, performing tasks such as storing configuration
+ * and persistence data to EEPROM before shutting down. If a restart is requested, the ESP
+ * will be restarted; otherwise, the system will enter an indefinite loop.
+ *
+ * @param restart Flag indicating whether to restart the ESP after shutdown (default: false).
+ */
+void SystemShutdown(bool restart)
 {
   static uint32_t shutdown_delay = 0;
 
+  // Initialize shutdown delay on the first call
   if (shutdown_delay == 0)
   {
     shutdown_delay = millis() + SHUTDOWN_DELAY_MS;
     Serial.printf("Shutdown requested - Restarting in %d seconds\n", SHUTDOWN_DELAY_MS / 1000);
   }
+
+  // Check if the shutdown delay has elapsed
   if (shutdown_delay < millis())
   {
-    StoreConfig_EEPROM();
+    Webserver_Shutdown();
+
+    // Store persistence data to EEPROM
     StorePersistence_EEPROM();
-    ESP.restart();
+
+    // Perform restart if requested, otherwise enter an indefinite loop
+    if (restart)
+      ESP.restart();
+    else
+      while (1)
+        ;
   }
 }
 
+/**
+ * @brief Processes the impulses from the wheel speed sensor and converts them into traveled distance.
+ *
+ * This function takes the pulse count from the wheel speed sensor and converts it into distance
+ * traveled in millimeters. The conversion is based on the configured parameters such as the number
+ * of pulses per revolution and the distance traveled per revolution.
+ *
+ * @return The calculated distance traveled in millimeters.
+ */
 uint32_t Process_Impulse_WheelSpeed()
 {
-  uint32_t add_milimeters;
+  uint32_t add_milimeters = 0;
   // Calculate traveled Distance in mm
-  add_milimeters = (wheel_pulse * (LubeConfig.DistancePerRevolution_mm / LubeConfig.PulsePerRevolution));
+  if (LubeConfig.PulsePerRevolution != 0)
+    add_milimeters = (wheel_pulse * (LubeConfig.DistancePerRevolution_mm / LubeConfig.PulsePerRevolution));
+
+  if (globals.measurementActive == true)
+    globals.measuredPulses = globals.measuredPulses + wheel_pulse;
+
   wheel_pulse = 0;
 
   return add_milimeters;
 }
-

Software/src/struct2json.cpp

@@ -0,0 +1,50 @@
+/**
+ * @file struct2json.cpp
+ *
+ * @brief Implementation file for converting structs to JSON objects.
+ *
+ * @note This file is auto-generated by a script on 2024-01-10 18:01:52.
+ *
+ * @author Marcel Peterkau
+ * @date   10.01.2024
+ */
+
+
+#include "struct2json.h"
+
+void generateJsonObject_LubeConfig(JsonObject& data)
+{
+    data["EEPROM_Version"] = LubeConfig.EEPROM_Version;
+    data["DistancePerLube_Default"] = LubeConfig.DistancePerLube_Default;
+    data["DistancePerLube_Rain"] = LubeConfig.DistancePerLube_Rain;
+    data["tankCapacity_ml"] = LubeConfig.tankCapacity_ml;
+    data["amountPerDose_microL"] = LubeConfig.amountPerDose_microL;
+    data["TankRemindAtPercentage"] = LubeConfig.TankRemindAtPercentage;
+    data["PulsePerRevolution"] = LubeConfig.PulsePerRevolution;
+    data["TireWidth_mm"] = LubeConfig.TireWidth_mm;
+    data["TireWidthHeight_Ratio"] = LubeConfig.TireWidthHeight_Ratio;
+    data["RimDiameter_Inch"] = LubeConfig.RimDiameter_Inch;
+    data["DistancePerRevolution_mm"] = LubeConfig.DistancePerRevolution_mm;
+    data["BleedingPulses"] = LubeConfig.BleedingPulses;
+    data["SpeedSource"] = LubeConfig.SpeedSource;
+    data["GPSBaudRate"] = LubeConfig.GPSBaudRate;
+    data["CANSource"] = LubeConfig.CANSource;
+    data["LED_Mode_Flash"] = LubeConfig.LED_Mode_Flash;
+    data["LED_Max_Brightness"] = LubeConfig.LED_Max_Brightness;
+    data["LED_Min_Brightness"] = LubeConfig.LED_Min_Brightness;
+    data["checksum"] = LubeConfig.checksum;
+    }
+
+void generateJsonObject_PersistenceData(JsonObject& data)
+{
+    data["writeCycleCounter"] = PersistenceData.writeCycleCounter;
+    data["tankRemain_microL"] = PersistenceData.tankRemain_microL;
+    data["TravelDistance_highRes_mm"] = PersistenceData.TravelDistance_highRes_mm;
+    data["odometer_mm"] = PersistenceData.odometer_mm;
+    data["odometer"] = PersistenceData.odometer;
+    data["checksum"] = PersistenceData.checksum;
+    }
+
+
+
+// CODEGENERATOR_CHECKSUM: 9e8dd21170fd6ef8fbf8c4b156d9af751836a76081f811bf0e3ab2b1eb8ee48c

Software/src/webui.h

@@ -1,27 +0,0 @@
-#ifndef _WEBUI_H_
-#define _WEBUI_H_
-
-#include <Arduino.h>
-#include <FS.h>
-#include <LittleFS.h>
-#include <ESPAsyncTCP.h>
-#include <ESPAsyncWebServer.h>
-#include <Updater.h>
-#include <ESP8266mDNS.h>
-#include <AsyncJson.h>
-#include <ArduinoJson.h>
-
-#include "config.h"
-#include "globals.h"
-#include "dtc.h"
-#include "common.h"
-#include "debugger.h"
-
-void initWebUI();
-void Webserver_Process();
-
-#ifdef FEATURE_ENABLE_WEBSOCKETS
-void Websocket_PushLiveDebug(String Message);
-#endif
-
-#endif