bumped Version before Release

Software/.gitignore

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

Software/codegen/README_flash_esp8266.md

@@ -0,0 +1,97 @@
+
+# Flash ESP8266 Script
+
+## Version: 1.0.0
+
+### Author: Marcel Peterkau
+### Copyright: 2024
+### License: MIT
+
+---
+
+## Beschreibung
+
+Dieses Skript entpackt ein ZIP-Archiv, das Firmware- und Dateisystem-Dateien für einen ESP8266 enthält, und flasht diese auf das Gerät. Nach dem Flashen werden die entpackten Dateien automatisch gelöscht.
+
+---
+
+## Benutzung
+
+```sh
+python flash_esp8266.py <zip_file> [-v]
+```
+
+### Parameter
+
+- `<zip_file>`: Der Name der ZIP-Datei, die die Firmware- und Dateisystem-Dateien enthält.
+- `-v`: Aktiviert Debug-Ausgaben (optional).
+
+### Beispiel
+
+```sh
+python flash_esp8266.py firmware_1.07_cbcdc34.zip -v
+```
+
+---
+
+## Voraussetzungen
+
+- Python 3.x
+- Die folgenden Python-Bibliotheken müssen installiert sein:
+  - esptool
+  - pyserial
+
+Installiere die benötigten Bibliotheken mit:
+
+```sh
+pip install esptool pyserial
+```
+
+---
+
+## Funktionen
+
+- **get_com_ports**: Ermittelt die verfügbaren COM-Ports.
+- **find_new_com_port**: Findet den neuen COM-Port, wenn der ESP8266 angeschlossen wird.
+- **extract_files**: Entpackt die ZIP-Datei und gibt die enthaltenen Dateien zurück.
+- **decompress_gz**: Entpackt eine GZ-Datei.
+- **clean_up**: Löscht die angegebenen Dateien nach dem Flashen.
+
+---
+
+## Ablauf
+
+1. Das Skript überprüft, ob die angegebene ZIP-Datei existiert.
+2. Die ZIP-Datei wird entpackt und die Firmware- und Dateisystem-Dateien werden identifiziert.
+3. Die Dateisystem-Datei (GZ) wird entpackt.
+4. Der Benutzer wird aufgefordert, den ESP8266 abzustecken und erneut anzustecken, um den neuen COM-Port zu ermitteln.
+5. Die Firmware- und Dateisystem-Dateien werden auf den ESP8266 geflasht.
+6. Die temporären Dateien werden nach dem erfolgreichen Flashen gelöscht.
+
+---
+
+## Fehlerbehebung
+
+- **ZIP-Datei nicht gefunden**: Stelle sicher, dass der Pfad zur ZIP-Datei korrekt angegeben ist.
+- **Erforderliche Dateien nicht im ZIP-Archiv**: Überprüfe, ob die ZIP-Datei die richtigen Dateien (`.fw.bin` und `.fs.gz`) enthält.
+- **Kein neuer COM-Port gefunden**: Stelle sicher, dass der ESP8266 korrekt angeschlossen ist und warte, bis der neue COM-Port erkannt wird.
+
+---
+
+## Lizenz
+
+Dieses Projekt ist unter der MIT-Lizenz lizenziert
+
+---
+
+## Versionshistorie
+
+- **1.0.0** - Initiale Version
+
+---
+
+## Haftungsausschluss
+
+Dieses Skript wird ohne Garantie bereitgestellt. Der Autor übernimmt keine Verantwortung für Schäden oder Datenverlust, die durch die Nutzung dieses Skripts entstehen könnten.
+
+---

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/flash_esp8266.py

@@ -0,0 +1,156 @@
+"""
+flash_esp8266.py
+
+Version: 1.0.0
+Author: Marcel Peterkau
+Copyright: 2024
+License: MIT
+
+Beschreibung:
+Dieses Skript entpackt ein ZIP-Archiv mit Firmware- und Dateisystem-Dateien und flasht diese auf einen ESP8266.
+Die entpackten Dateien werden nach dem Flashen gelöscht.
+
+Versionshistorie:
+1.0.0 - Initiale Version
+
+Benutzung:
+python flash_esp8266.py <zip_file> [-v]
+
+Optionen:
+-v    Aktiviert Debug-Ausgaben
+"""
+
+import esptool
+import sys
+import serial.tools.list_ports
+import zipfile
+import os
+import gzip
+import shutil
+
+BAUD_RATE = 921600  # Erhöhte Baudrate
+DEBUG = '-v' in sys.argv
+
+def debug_print(message):
+    if DEBUG:
+        print(message)
+
+def get_com_ports():
+    ports = [comport.device for comport in serial.tools.list_ports.comports()]
+    debug_print(f"Verfügbare COM-Ports: {ports}")
+    return ports
+
+def find_new_com_port(old_ports, timeout=15):
+    debug_print("Suche nach neuen COM-Ports...")
+    import time
+    start_time = time.time()
+    while time.time() - start_time < timeout:
+        new_ports = get_com_ports()
+        added_ports = list(set(new_ports) - set(old_ports))
+        if added_ports:
+            new_port = added_ports[0]
+            print(f"Neuer COM-Port gefunden: {new_port}")
+            return new_port
+        time.sleep(1)
+    return None
+
+def extract_files(zip_file):
+    with zipfile.ZipFile(zip_file, 'r') as zip_ref:
+        zip_ref.extractall()
+        debug_print(f"Entpackt: {zip_ref.namelist()}")
+        return zip_ref.namelist()
+
+def decompress_gz(file_path):
+    output_file = file_path.replace('.gz', '')
+    with gzip.open(file_path, 'rb') as f_in:
+        with open(output_file, 'wb') as f_out:
+            shutil.copyfileobj(f_in, f_out)
+    debug_print(f"Entpackt {file_path} zu {output_file}")
+    return output_file
+
+def clean_up(files):
+    for file in files:
+        if os.path.isfile(file):
+            os.remove(file)
+            debug_print(f"Gelöscht: {file}")
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print("Verwendung: python flash_esp8266.py <zip_file> [-v]")
+        sys.exit(1)
+
+    ZIP_FILE = sys.argv[1]
+
+    # Überprüfe, ob das ZIP-Archiv existiert
+    if not os.path.isfile(ZIP_FILE):
+        print(f"ZIP-Archiv {ZIP_FILE} nicht gefunden.")
+        sys.exit(1)
+
+    # Entpacke das ZIP-Archiv
+    extracted_files = extract_files(ZIP_FILE)
+
+    # Finde die .fw.bin- und .fs.gz-Dateien
+    bin_file = None
+    fs_file = None
+
+    for file in extracted_files:
+        if file.endswith('.fw.bin'):
+            bin_file = file
+        elif file.endswith('.fs.gz'):
+            fs_file = file
+
+    if not bin_file or not fs_file:
+        print(f"Die erforderlichen Dateien (.fw.bin und .fs.gz) wurden nicht im ZIP-Archiv {ZIP_FILE} gefunden.")
+        sys.exit(1)
+
+    print(f"Gefundene Firmware-Datei: {bin_file}")
+    print(f"Gefundene Dateisystem-Datei: {fs_file}")
+
+    # Entpacke die .fs.gz-Datei
+    decompressed_fs_file = decompress_gz(fs_file)
+
+    print("Bitte stecke den ESP8266 ab, falls er angeschlossen ist, und drücke Enter.")
+    input()
+
+    print("Suche nach verfügbaren COM-Ports...")
+    old_ports = get_com_ports()
+
+    print("Bitte stecke den ESP8266 jetzt an und warte, bis der neue COM-Port erkannt wird...")
+
+    port = find_new_com_port(old_ports, timeout=15)
+
+    if port is None:
+        print("Kein neuer COM-Port gefunden. Bitte versuche es erneut.")
+        sys.exit(1)
+
+    print(f"Neuer COM-Port gefunden: {port}")
+
+    # Benutze esptool zum Flashen der Firmware und des Dateisystems
+    try:
+        # Flashen der Firmware
+        esptool_args_bin = [
+            '--port', port,
+            '--baud', str(BAUD_RATE),
+            'write_flash', '-fm', 'dout', '0x00000', bin_file
+        ]
+        esptool.main(esptool_args_bin)
+        print("Firmware erfolgreich geflasht!")
+
+        # Flashen des Dateisystems
+        esptool_args_fs = [
+            '--port', port,
+            '--baud', str(BAUD_RATE),
+            'write_flash', '0x300000', decompressed_fs_file
+        ]
+        esptool.main(esptool_args_fs)
+        print("Dateisystem erfolgreich geflasht!")
+
+        # Bereinigen der entpackten Dateien
+        clean_up(extracted_files)
+        clean_up([decompressed_fs_file])
+
+    except Exception as e:
+        print(f"Fehler beim Flashen: {e}")
+        sys.exit(1)
+
+    input("Drücke Enter, um das Fenster zu schließen...")  # Hält das Fenster offen

Software/codegen/prepare_littlefs.py

@@ -0,0 +1,200 @@
+import shutil
+import gzip
+import os
+import subprocess
+import platform
+from os import popen
+Import("env")
+Import("projenv")
+
+def resolve_tool(name):
+    local_bin = os.path.join(env['PROJECT_DIR'], 'node_modules', '.bin', name)
+    if platform.system() == "Windows":
+        local_bin += ".cmd"
+    if os.path.exists(local_bin):
+        return local_bin
+
+    found = shutil.which(name)
+    if found:
+        return found
+
+    raise FileNotFoundError(f"{name} wurde nicht gefunden. Bitte `npm install` ausführen.")
+
+def ensure_npm_dependencies():
+    node_modules_bin = os.path.join(env['PROJECT_DIR'], 'node_modules', '.bin')
+    required_tools = ["html-minifier", "terser", "cleancss"]
+    missing = False
+
+    for tool in required_tools:
+        path = os.path.join(node_modules_bin, tool + ('.cmd' if platform.system() == "Windows" else ''))
+        if not os.path.exists(path):
+            missing = True
+            break
+
+    if missing:
+        print("NPM-Abhängigkeiten fehlen – führe `npm install` aus...")
+        subprocess.run(["npm", "install"], cwd=env['PROJECT_DIR'], check=True)
+
+
+ensure_npm_dependencies()
+
+html_minifier_path = resolve_tool("html-minifier")
+terser_path = resolve_tool("terser")
+cleancss_path = resolve_tool("cleancss")
+
+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([cleancss_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):
+
+    with open(src_path, 'rb') as src, gzip.open(dst_path, 'wb') as dst:
+        for chunk in iter(lambda: src.read(4096), b""):
+            dst.write(chunk)
+
+
+def getListOfFiles(dirName):
+    # create a list of file and sub directories
+    # names in the given directory
+    listOfFile = os.listdir(dirName)
+    allFiles = list()
+    # Iterate over all the entries
+    for entry in listOfFile:
+        # Create full path
+        fullPath = os.path.join(dirName, entry)
+        # If entry is a directory then get the list of files in this directory
+        if os.path.isdir(fullPath):
+            allFiles = allFiles + getListOfFiles(fullPath)
+        else:
+            allFiles.append(fullPath)
+
+    return allFiles
+
+def remove_prefix(text, prefix):
+    if text.startswith(prefix):
+        return text[len(prefix):]
+    return text  # or whatever
+
+# Compress files from 'data_src/' to 'data/'
+
+
+def gzip_webfiles(source, target, env):
+    # Filetypes to compress
+    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_temp_dir_path)):
+        print('GZIP: Directory "'+data_dir_path +
+              '" exists, "'+data_temp_dir_path+'" is not found.')
+        print('GZIP: Renaming "' + data_dir_path +
+              '" to "' + data_temp_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)
+        shutil.rmtree(data_dir_path)
+    # Recreate empty 'data' directory
+    print('GZIP: Re-creating an empty data directory ' + data_dir_path)
+    os.mkdir(data_dir_path)
+    # Determine the files to compress
+
+    files_to_copy = []
+    files_to_gzip = []
+
+    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_temp_dir_path)
+            files_to_copy.append(filename_subdir)
+
+    for file in files_to_copy:
+        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_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_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)
+            gzip_target_path = target_file_path + ".gz"
+            gzip_file(source_file_path, gzip_target_path)
+    except IOError as e:
+        was_error = True
+        print('GZIP: Failed to compress file: ' + source_file_path)
+        # print( 'GZIP: EXCEPTION... {}'.format( e ) )
+    if was_error:
+        print('GZIP: Failure/Incomplete.\n')
+    else:
+        print('GZIP: Compressed correctly.\n')
+        shutil.rmtree(data_temp_dir_path)
+
+    return
+
+def gzip_binffiles(source, target, env):
+    git_revision = popen('git rev-parse --short HEAD').read().strip()
+    custom_flash_version = env.GetProjectOption("custom_flash_version", "0.99")
+
+    # Format the target file name
+    target_filename = f"filesystem_{custom_flash_version}_{git_revision}.fs"
+    littlefsbin = target[0].get_abspath()
+    targetbin = os.path.join(os.path.dirname(littlefsbin), target_filename)
+    shutil.copyfile(littlefsbin, targetbin)
+    gzip_file(targetbin, os.path.join(str(targetbin) + '.gz'))
+    os.remove(targetbin)
+    return
+
+# IMPORTANT, this needs to be added to call the routine
+env.AddPreAction('$BUILD_DIR/littlefs.bin', gzip_webfiles)
+env.AddPostAction('$BUILD_DIR/littlefs.bin', gzip_binffiles)

Software/codegen/run_pre.py

@@ -0,0 +1,38 @@
+Import("env")  # pylint: disable=undefined-variable
+env.Execute("\"$PYTHONEXE\" -m pip install jinja2")
+
+import struct2json
+import dtcs
+from os import popen
+
+git_revision = popen('git rev-parse --short HEAD').read().strip()
+
+# Versionsnummern aus platformio.ini holen
+custom_firmware_version = env.GetProjectOption("custom_firmware_version", "0.99")
+custom_flash_version = env.GetProjectOption("custom_flash_version", "0.99")
+
+# Versionsnummern aufteilen in Major und Minor
+fw_major, fw_minor = custom_firmware_version.split('.')
+fl_major, fl_minor = custom_flash_version.split('.')
+
+fw_major_int = int(fw_major)
+fw_minor_int = int(fw_minor)
+fl_major_int = int(fl_major)
+fl_minor_int = int(fl_minor)
+
+# Version in Datei "version" im Ordner "data_src" überschreiben
+with open('data_src/version', 'w') as version_file:
+    version_file.write(custom_flash_version)
+    
+# Build-Flags setzen
+env.Replace(PROGNAME="firmware_%s_%s.fw" % (custom_firmware_version, git_revision))
+env.Append(CPPDEFINES=[
+    ('GIT_REV', '\\"{}\\"'.format(git_revision)),
+    ('FW_MAJOR', fw_major_int),
+    ('FW_MINOR', fw_minor_int),
+    ('FL_MAJOR', fl_major_int),
+    ('FL_MINOR', fl_minor_int)
+])
+
+struct2json.struct2json()
+dtcs.build_dtcs()

Software/codegen/struct2json.py

@@ -0,0 +1,113 @@
+import os
+import time
+from jinja2 import Environment, FileSystemLoader
+import re
+
+import filechecksum as fcs
+
+# Pfad zur Eingabedatei und Ausgabedatei
+input_file = "include/eeprom.h"
+output_sourcefile = "src/struct2json.cpp"
+output_headerfile = "include/struct2json.h"
+# Liste der zu suchenden Variablen/Structs
+variable_names = ['ConfigData', '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+)(?:\[(\d+)\])?\s*;', match.group(1))
+            if fields_match:
+                result[var_name] = {'type': var_type, 'fields': {}}
+                for field_type, field_name, array_size in fields_match:
+                    if array_size:
+                        result[var_name]['fields'][field_name] = {'type': field_type, 'size': int(array_size)}
+                    else:
+                        result[var_name]['fields'][field_name] = {'type': field_type}
+
+    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 DE-Timer application.
+ *
+ * This file contains definitions for Diagnostic Trouble Codes (DTC) in the DE-Timer 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 "eeprom.h"
+
+{% for var_name, var_info in structs.items() -%}
+void generateJsonObject_{{ var_name }}(JsonObject data);
+{% endfor %}
+
+#endif /* _STRUCT2JSON_H_ */
+
+// CODEGENERATOR_CHECKSUM: {{ checksum }}

Software/codegen/wifiAP_passcalc.py

@@ -0,0 +1,19 @@
+def djb2_hash(s):
+    hash = 5381
+    for c in s:
+        hash = ((hash << 5) + hash) + ord(c)  # hash * 33 + c
+    return hash & 0xFFFFFFFF  # Ensure it's a 32-bit unsigned integer
+
+def generate_password(seed, chip_id):
+    combined = (seed + chip_id)[:24]  # Ensure the combined string is up to 24 characters
+    hash_value = djb2_hash(combined)
+    hash_str = f"{hash_value:08X}{hash_value:08X}"  # Repeat the hash to ensure at least 16 characters
+    return hash_str[:32]  # Ensure the password is at most 32 characters
+
+if __name__ == "__main__":
+    SEED = "ilikekgg"
+    chip_id = input("Enter the Chip ID in hex (e.g., 1A2B3C4D): ").strip()
+    chip_id = chip_id.zfill(8).upper()  # Ensure it's 8 characters, upper case
+
+    password = generate_password(SEED, chip_id)
+    print(f"Generated Password: {password}")

Software/data_src/index.htm

@@ -0,0 +1,411 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="utf-8" />
+  <title>Dark Emergency Timer</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <link rel="stylesheet" href="static/css/bootstrap.min.css" />
+  <link rel="stylesheet" href="static/css/custom.css" />
+  <link rel="stylesheet" href="static/css/tweaks.css" />
+  <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" />
+  <link rel="manifest" href="static/img/site.webmanifest" />
+</head>
+
+<body>
+  <!-- Connection-Overlay -->
+  <div id="overlay">
+    <div class="overlay-content">
+      <p>Verbinde...</p>
+      <span class="loader"></span>
+    </div>
+  </div>
+  <!-- Connection-Overlay -->
+  <!-- Notification-Container -->
+  <div id="notification-container" class="notification-container"></div>
+  <!-- Notification-Container -->
+  <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="" />
+      <span class="data-devicename">DE Airsoft Timer</span>
+    </a>
+    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#collapsingNavbar"
+      aria-controls="collapsingNavbar" aria-expanded="false" aria-label="Toggle navigation">
+      <span class="navbar-toggler-icon"></span>
+    </button>
+    <div class="collapse navbar-collapse" id="collapsingNavbar">
+      <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_maintenance">Wartung</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>
+    </div>
+  </nav>
+  <main class="container">
+    <!-- Tabs Content -->
+    <div class="tab-content">
+      <!-- Div Tab Home-->
+      <div id="tab_home" class="tab-pane fade show active" role="tabpanel">
+        <div class="col text-center">
+          <div class="jumbotron">
+            <img src="static/img/logo.png" width="120" height="120" class="img-fluid" alt="" />
+            <h3 class="pt-3">
+              <span class="data-devicename">DE Airsoft Timer</span>
+            </h3>
+          </div>
+        </div>
+        <!-- Div Group Battery remain -->
+        <hr />
+        <h4>Akkuladestand</h4>
+        <div class="progress">
+          <div id="batterylevel" class="data-batterylevel progress-bar text-light" role="progressbar" aria-valuenow="0"
+            aria-valuemin="0" aria-valuemax="100" style="width: 0%">
+            0
+          </div>
+        </div>
+        <!-- Div Group Battery remain -->
+        <!-- Div Group current Mode -->
+        <hr />
+        <h4>aktueller Modus</h4>
+        <input class="data-systemstatus form-control" type="text" id="sysstatus" readonly />
+        <!-- Div Group current Mode -->
+        <!-- Div Group Faction Points -->
+        <hr />
+        <h4>aktueller Punktestand</h4>
+        <div class="container-fluid">
+          <div class="row">
+            <div id="header_faction1" class="col text-center data-name_faction1 text-white p-3">
+              %NAME_FAC_1%
+            </div>
+            <div id="header_faction2" class="col text-center data-name_faction2 text-white p-3">
+              %NAME_FAC_2%
+            </div>
+            <div id="header_faction3" class="col text-center data-name_faction3 text-white p-3">
+              %NAME_FAC_3%
+            </div>
+          </div>
+          <div class="row">
+            <div class="col bg-dark text-white p-3 data-activefaction faction-logo faction1">
+              <div class="glow-container">
+                <img src="static/img/logo_fac1.png" class="rounded mx-auto img-fluid d-block" alt="..." />
+              </div>
+            </div>
+            <div class="col bg-dark text-white p-3 data-activefaction faction-logo faction2 glow-active-faction">
+              <div class="glow-container">
+                <img src="static/img/logo_fac2.png" class="rounded mx-auto img-fluid d-block" alt="..." />
+              </div>
+            </div>
+            <div class="col bg-dark text-white p-3 data-activefaction faction-logo faction3">
+              <div class="glow-container">
+                <img src="static/img/logo_fac3.png" class="rounded mx-auto img-fluid d-block" alt="..." />
+              </div>
+            </div>
+          </div>
+          <div class="row">
+            <div id="time_faction1" class="data-time_faction1 col text-center bg-secondary text-white p-3 format-time">
+              0
+            </div>
+            <div id="time_faction2" class="data-time_faction2 col text-center bg-secondary text-white p-3 format-time">
+              0
+            </div>
+            <div id="time_faction3" class="data-time_faction3 col text-center bg-secondary text-white p-3 format-time">
+              0
+            </div>
+          </div>
+          <div class="row mt-3">
+            <div class="col text-center">
+              <button id="faction1" class="btn-wsevent btn btn-outline-primary">
+                Aktivieren
+              </button>
+            </div>
+            <div class="col text-center">
+              <button id="faction2" class="btn-wsevent btn btn-outline-primary">
+                Aktivieren
+              </button>
+            </div>
+            <div class="col text-center">
+              <button id="faction3" class="btn-wsevent btn btn-outline-primary">
+                Aktivieren
+              </button>
+            </div>
+          </div>
+        </div>
+        <!-- Div GroupFaction Points -->
+        <!-- Div Group DTC Table -->
+        <div id="dtc_container" hidden>
+          <hr />
+          <h4>Fehlercodes</h4>
+          <table class="table" id="dtc_table">
+            <tbody>
+              <tr>
+                <th class="col-6" scope="col">Zeitstempel</th>
+                <th class="col-2" scope="col">Fehlercode</th>
+                <th class="col-2" scope="col">Schwere</th>
+                <th class="col-2" scope="col">Aktiv</th>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+        <!-- Div Group DTC Table -->
+      </div>
+      <!-- Div Tab Home-->
+      <!-- Div Tab Maintenance -->
+      <div id="tab_maintenance" class="tab-pane fade" role="tabpanel">
+        <h3>Wartung</h3>
+        <!-- Div Group Reset Timers -->
+        <hr />
+        <h4>Punkte zur&uuml;cksetzen</h4>
+        <div class="form-group row">
+          <div class="col text-center">
+            <button id="reset-timer" class="btn-wsevent btn btn-outline-primary ml-2">
+              Timer zurücksetzen
+            </button>
+          </div>
+        </div>
+        <!-- Div Group Reset Timers  -->
+        <!-- Div Group LiveDebug -->
+        <hr />
+        <h4>Live Debug</h4>
+        <div class="form-group row">
+          <input id="livedebug-in" type="text" class="set-wsevent data-livedebug-in form-control" />
+        </div>
+        <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>
+        <!-- Div Group LiveDebug -->
+        <!-- Div Group Device Reboot -->
+        <hr />
+        <h4>Ger&auml;t neustarten</h4>
+        <div class="form-group row">
+          <div class="col text-center">
+            <button id="reboot" class="btn-wsevent confirm btn btn-outline-primary">
+              Reboot
+            </button>
+          </div>
+        </div>
+        <!-- Div Group Device Reboot -->
+      </div>
+      <!-- Div Tab Maintenance -->
+      <!-- Div Tab Settings-->
+      <div id="tab_source" class="tab-pane fade" role="tabpanel">
+        <h3>Einstellungen</h3>
+        <!-- Div Group Battery Type -->
+        <hr />
+        <h4>Akku</h4>
+        <div class="form-group row">
+          <label for="batterytype" class="control-label col-4">Akku-Variante</label>
+          <div class="col-8">
+            <select id="batterytype" class="set-wsevent data-batterytype select form-control">
+              <option value="Undefined">Undefined</option>
+              <option value="LiPo 3S">LiPo 3S</option>
+              <option value="LiPo 2S">LiPo 2S</option>
+            </select>
+          </div>
+        </div>
+        <!-- Div Group Battery Type -->
+        <!-- Div Group Timer Settings -->
+        <hr />
+        <h4>Timer Einstellungen</h4>
+        <div class="form-group row">
+          <label for="active_faction_on_reboot" class="control-label col-4">Aktive Fraktion wiederherstellen</label>
+          <div class="col-8">
+            <div class="form-check">
+              <input class="set-wsevent data-active_faction_on_reboot form-check-input" type="checkbox"
+                id="active_faction_on_reboot" />
+              <label class="form-check-label" for="active_faction_on_reboot">
+                aktivieren
+              </label>
+            </div>
+          </div>
+        </div>
+        <div class="form-group row">
+          <label for="name_faction1" class="control-label col-4">Faktion 1</label>
+          <div class="col-8">
+            <div class="input-group">
+              <input id="name_faction1" type="text" class="set-wsevent data-name_faction1 form-control"
+                required="required" />
+              <div class="input-group-append">
+                <span class="input-group-text">max. 32 Zeichen</span>
+              </div>
+            </div>
+          </div>
+        </div>
+        <div class="form-group row">
+          <label for="name_faction2" class="control-label col-4">Faktion 2</label>
+          <div class="col-8">
+            <div class="input-group">
+              <input id="name_faction2" type="text" class="set-wsevent data-name_faction2 form-control"
+                required="required" />
+              <div class="input-group-append">
+                <span class="input-group-text">max. 32 Zeichen</span>
+              </div>
+            </div>
+          </div>
+        </div>
+        <div class="form-group row">
+          <label for="name_faction3" class="control-label col-4">Faktion 3</label>
+          <div class="col-8">
+            <div class="input-group">
+              <input id="name_faction3" type="text" class="set-wsevent data-name_faction3 form-control"
+                required="required" />
+              <div class="input-group-append">
+                <span class="input-group-text">max. 32 Zeichen</span>
+              </div>
+            </div>
+          </div>
+        </div>
+        <!-- Div Group Timer Settings -->
+        <!-- Div Group Save Button-->
+        <hr />
+        <div class="form-group row">
+          <div class="col text-center">
+            <button id="settingssave" class="btn-wsevent btn btn-outline-primary">
+              Speichern
+            </button>
+          </div>
+        </div>
+      </div>
+      <!-- Div Tab Settings -->
+      <!-- Div Tab Firmware Update-->
+      <div id="tab_fwupdate" class="tab-pane fade" role="tabpanel">
+        <h3>Firmware</h3>
+        <!-- Div Group VersionInfo -->
+        <hr />
+        <h4>Version-Info</h4>
+        <table class="table">
+          <tbody>
+            <tr>
+              <th class="col-7" scope="col">Parameter</th>
+              <th class="col-5" scope="col">Value</th>
+            </tr>
+            <tr>
+              <td>Firmware Version</td>
+              <td><span class="data-fw-version"></span></td>
+            </tr>
+            <tr>
+              <td>Flash Version</td>
+              <td><span class="data-flash-version"></span></td>
+            </tr>
+            <tr>
+              <td>Git Revision</td>
+              <td><span class="data-git-revision"></span></td>
+            </tr>
+          </tbody>
+        </table>
+        <!-- Div Group VersionInfo -->
+        <!-- Div Group EEPROM Backup -->
+        <hr />
+        <h4>EEPROM-Backup</h4>
+        <div class="form-group row">
+          <div class="col text-center">
+            <a class="btn btn-outline-primary" href="eejson" role="button" id="ee-backup-download">Download</a>
+          </div>
+        </div>
+        <!-- Div Group EEPROM Backup -->
+        <!-- Div Group EEPROM Restore -->
+        <hr />
+        <h4>EEPROM-Restore</h4>
+        <form method="POST" action="eeRestore" enctype="multipart/form-data">
+          <div class="form-group row">
+            <div class="custom-file">
+              <input type="file" name="ee-restore-file" class="custom-file-input" id="ee-restore-file" accept=".ee.json"
+                required />
+              <label class="custom-file-label" for="ee-restore-file">EEPROM-Backup ausw&auml;hlen</label>
+            </div>
+          </div>
+          <div class="form-group row">
+            <div class="col text-center">
+              <button name="submit" type="submit" class="btn btn-outline-primary">
+                Restore starten
+              </button>
+            </div>
+          </div>
+        </form>
+        <!-- Div Group EEPROM Restore -->
+        <!-- Div Group Firmware Update -->
+        <hr />
+        <h4>Firmware-Update</h4>
+        <form method="POST" action="doUpdate" enctype="multipart/form-data">
+          <div class="form-group row">
+            <div class="custom-file">
+              <input type="file" name="fw-update-file" class="custom-file-input" id="fw-update-file"
+                accept=".fw.bin,.fs.gz" required />
+              <label class="custom-file-label" for="fw-update-file">Firmware-Update ausw&auml;hlen</label>
+            </div>
+          </div>
+          <div class="form-group row">
+            <div class="col text-center">
+              <button name="submit" type="submit" class="btn btn-outline-primary">
+                Update starten
+              </button>
+            </div>
+          </div>
+        </form>
+        <!-- Div Group Firmware Update -->
+      </div>
+      <!-- Div Tab Firmware Update-->
+    </div>
+    <!-- Tabs Content -->
+  </main>
+  <!-- Footer -->
+  <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">© 2023 -
+          <a class="text-reset fw-bold" href="https://eventronics.de/">Marcel Peterkau</a></span>
+      </div>
+    </div>
+  </footer>
+  <!-- Footer -->
+  <!-- Modal Dialog -->
+  <div class="modal fade" id="dtcModal" tabindex="-1" role="dialog" aria-labelledby="dtcModalLabel" aria-hidden="true">
+    <div class="modal-dialog modal-dialog-centered" role="document">
+      <div class="modal-content">
+        <div class="modal-header">
+          <h5 class="modal-title" id="dtcModalLabel">DTC-Description</h5>
+          <button type="button" class="close" data-dismiss="modal" aria-label="Close">
+            <span aria-hidden="true">&times;</span>
+          </button>
+        </div>
+        <div class="modal-body">
+          <p class="dtc-desc">DTC Description</p>
+          <p class="dtc-debugval">DTC DebugVal</p>
+        </div>
+        <div class="modal-footer">
+          <button type="button" class="btn btn-outline-secondary" data-dismiss="modal">
+            Close
+          </button>
+        </div>
+      </div>
+    </div>
+  </div>
+  <!-- Modal Dialog -->
+</body>
+
+</html>

Software/data_src/static/css/tweaks.css

@@ -0,0 +1,90 @@
+@font-face {
+    font-family: 'Comfortaa';
+    font-style: normal;
+    font-weight: 300;
+    src: url(../fonts/comfortaa.woff2) format('woff2');
+    unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+  }
+
+body {
+    padding-top: 70px;
+    margin-bottom: 70px;
+}
+
+hr {
+    height: 2px;
+    border-width: 0;
+    color: gray;
+    background-color: gray
+}
+
+.dtc-debugval {
+    color: #F2771A;
+    font: 0.8rem Inconsolata, monospace;
+    background-color: black;
+    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;
+    font-size: 4rem;
+}
+
+.loader {
+    width: 96px;
+    height: 96px;
+    border: 12px solid #FFF;
+    border-radius: 50%;
+    display: inline-block;
+    position: relative;
+    box-sizing: border-box;
+    animation: rotation 1s linear infinite;
+  } 
+  .loader::after {
+    content: '';  
+    box-sizing: border-box;
+    position: absolute;
+    left: 50%;
+    top: 50%;
+    transform: translate(-50%, -50%);
+    width: 120px;
+    height: 120px;
+    border-radius: 50%;
+    border: 12px solid transparent;
+    border-bottom-color: #FF3D00;
+  }
+  
+  @keyframes rotation {
+    0% {
+      transform: rotate(0deg);
+    }
+    100% {
+      transform: rotate(360deg);
+    }
+  } 
+
+  .notification-container {
+    position: fixed;
+    top: 30%;
+    left: 50%;
+    transform: translateX(-50%);
+    z-index: 1000;
+  }
+  
+  .notification {
+    margin-bottom: 20px; /* Fügen Sie bei Bedarf weitere Stile hinzu */
+  }

Software/data_src/static/dtc_table.json

@@ -0,0 +1,96 @@
+{
+    "codegenerator_checksum": "313d59949b074024df3c5d796f65e3bd518e34f0bb171185c30f008f21c19d30",
+    "timestamp": "2024-05-30 21:56:51",
+    "dtc_table_data": [
+        {
+            "num": 0,
+            "title": "No Error",
+            "description": "No Error"
+        },
+        {
+            "num": 1,
+            "title": "Akku leer",
+            "description": "Akku ist komplett leer. Den Akku aufladen!"
+        },
+        {
+            "num": 2,
+            "title": "Akku niedrig",
+            "description": "Akku ist unter der Warnschwelle. Den Akku demnächst aufladen"
+        },
+        {
+            "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 Akkuüberwachung",
+            "description": "Es wurde keine Akkuüberwachung über I2C gefunden, Prüfen sie die Hardware!"
+        },
+        {
+            "num": 11,
+            "title": "LoRa-Transceiver Error",
+            "description": "Es konnte keine Verbindung zum LoRa-Transceiver hergestellt werden. Prüfen Sie die Hardware auf Defekte"
+        },
+        {
+            "num": 12,
+            "title": "Config-Validierung",
+            "description": "Ein oder mehrer Einstellungswerte sind ausserhalb plausibler Werte. Prüfen Sie Ihre Einstellungen"
+        },
+        {
+            "num": 13,
+            "title": "EEPROM-Migration",
+            "description": "Es wurde ein altes EEPROm Image erkannt, konnte aber nicht migriert werden. EEPROM manuell zurück setzen und neue Einstellunge speichern."
+        },
+        {
+            "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/img/browserconfig.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square150x150logo src="/mstile-150x150.png"/>
+            <TileColor>#da532c</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>

Software/data_src/static/img/safari-pinned-tab.svg

@@ -0,0 +1,345 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="300.000000pt" height="300.000000pt" viewBox="0 0 300.000000 300.000000"
+ preserveAspectRatio="xMidYMid meet">
+<metadata>
+Created by potrace 1.14, written by Peter Selinger 2001-2017
+</metadata>
+<g transform="translate(0.000000,300.000000) scale(0.100000,-0.100000)"
+fill="#000000" stroke="none">
+<path d="M210 2778 c1 -198 2 -221 15 -204 13 18 17 18 41 5 31 -16 41 -36 26
+-51 -8 -8 -15 -8 -25 0 -19 16 -49 -22 -53 -69 -3 -30 1 -38 16 -42 26 -7 25
+-27 -1 -34 -18 -5 -20 -11 -15 -47 3 -23 6 -48 5 -56 0 -8 -2 -168 -4 -355
+l-4 -340 31 -18 c29 -17 31 -16 69 5 22 12 38 27 35 33 -2 7 0 18 5 26 7 11 9
+11 9 -3 0 -26 13 -23 93 25 39 24 98 58 130 76 31 18 57 38 58 44 0 7 1 63 1
+125 1 87 -2 116 -14 130 -26 29 -30 59 -13 92 8 16 19 30 23 30 8 0 7 212 -2
+235 -3 8 -2 15 2 15 10 0 8 62 -2 78 -4 7 -5 12 -1 12 3 0 1 9 -5 20 -6 11
+-17 20 -25 20 -8 0 -15 5 -15 11 0 16 -26 39 -45 39 -12 0 -15 6 -10 21 8 26
+78 139 86 139 3 0 11 -36 18 -80 13 -79 23 -101 36 -80 4 7 11 8 18 1 14 -11
+36 -14 103 -12 l52 1 25 53 c15 28 40 67 56 85 29 31 31 32 51 15 27 -23 25
+-37 -10 -100 l-30 -53 75 0 c41 0 74 3 74 8 -3 18 2 32 11 32 6 0 10 -9 10
+-20 0 -17 7 -20 39 -20 29 0 41 5 44 18 4 15 5 15 6 0 1 -13 13 -18 54 -20 99
+-6 227 3 227 15 0 7 9 23 19 37 l19 24 18 -37 c19 -39 32 -43 118 -37 30 2 60
+23 49 34 -13 13 -13 48 -1 44 7 -3 14 -20 15 -38 2 -18 5 -35 7 -37 2 -2 30
+-3 62 -1 53 3 57 4 41 19 -18 19 -13 29 15 29 13 0 18 -7 18 -25 0 -33 10 -32
+50 10 19 19 38 35 42 35 5 0 16 -16 24 -36 13 -31 18 -35 47 -32 20 2 32 8 32
+18 0 8 9 15 20 16 48 2 48 3 34 22 -13 15 -12 16 3 4 14 -11 23 -9 59 17 23
+17 46 31 52 31 8 0 539 302 556 316 2 2 -186 4 -418 3 -265 0 -419 -3 -416 -9
+4 -6 1 -10 -4 -10 -6 0 -11 5 -11 10 0 6 -16 10 -35 10 -24 0 -35 -4 -33 -12
+1 -7 -6 -26 -17 -41 l-18 -29 -16 29 c-8 15 -14 34 -13 41 2 9 -21 12 -88 12
+-70 0 -89 -3 -84 -12 6 -10 4 -10 -8 0 -23 18 -184 13 -180 -6 1 -8 -3 -12
+-10 -9 -7 2 -12 10 -11 16 2 7 -16 11 -52 11 -42 0 -55 -3 -55 -15 0 -19 -34
+-19 -50 0 -10 12 -45 14 -193 14 -128 0 -184 -4 -189 -12 -6 -9 -8 -9 -8 1 0
+7 -13 12 -30 12 -16 0 -30 -4 -30 -10 0 -5 -5 -10 -11 -10 -5 0 -7 5 -4 10 4
+7 -12 10 -44 9 -28 -1 -51 -5 -51 -9 0 -4 10 -19 21 -34 30 -38 39 -87 23
+-122 -11 -26 -12 -27 -13 -6 -1 28 -81 108 -91 91 -6 -8 -10 -8 -16 2 -4 7 -3
+14 3 16 6 2 -2 17 -18 34 -26 27 -33 29 -104 29 -61 0 -75 -3 -75 -15 0 -9 -7
+-27 -16 -41 l-17 -25 -12 23 c-6 13 -8 28 -3 34 14 19 -4 24 -89 24 l-83 0 0
+-222z m2395 192 c3 -5 1 -10 -4 -10 -6 0 -11 5 -11 10 0 6 2 10 4 10 3 0 8 -4
+11 -10z m-107 -33 c-2 -11 -9 -12 -28 -5 -24 9 -24 10 -6 24 22 15 40 6 34
+-19z m-1928 -52 c0 -5 -11 -23 -25 -40 l-24 -30 -24 26 -25 26 21 48 21 47 28
+-33 c15 -19 28 -38 28 -44z m1139 13 c-5 -10 -14 -18 -19 -18 -16 0 -23 49 -9
+66 11 14 14 13 25 -8 8 -15 9 -29 3 -40z m186 42 c3 -5 1 -10 -4 -10 -6 0 -11
+5 -11 10 0 6 2 10 4 10 3 0 8 -4 11 -10z m-1066 -9 c11 -7 10 -11 -5 -19 -18
+-10 -16 -14 19 -47 35 -33 63 -82 53 -92 -2 -2 -25 17 -50 42 -54 52 -72 90
+-55 111 13 16 19 17 38 5z m106 -1 c3 -5 1 -10 -4 -10 -6 0 -11 5 -11 10 0 6
+2 10 4 10 3 0 8 -4 11 -10z m169 -17 c9 -22 -12 -43 -23 -24 -10 15 -4 41 9
+41 4 0 11 -8 14 -17z m391 7 c3 -5 1 -10 -4 -10 -6 0 -11 5 -11 10 0 6 2 10 4
+10 3 0 8 -4 11 -10z m465 -30 c0 -13 -5 -18 -15 -14 -8 4 -15 12 -15 20 0 8 7
+14 15 14 8 0 15 -9 15 -20z m-1573 -22 c-3 -8 -6 -5 -6 6 -1 11 2 17 5 13 3
+-3 4 -12 1 -19z m592 13 c17 -11 7 -41 -14 -41 -9 0 -15 9 -15 25 0 27 6 30
+29 16z m881 -1 c0 -5 -4 -10 -10 -10 -5 0 -10 5 -10 10 0 6 5 10 10 10 6 0 10
+-4 10 -10z m-1541 -31 c33 -32 37 -44 21 -54 -6 -3 -10 4 -10 17 l0 23 -18
+-23 -18 -24 -18 27 c-16 25 -14 65 4 65 5 0 22 -14 39 -31z m1131 11 c0 -5 -4
+-10 -10 -10 -5 0 -10 5 -10 10 0 6 5 10 10 10 6 0 10 -4 10 -10z m-300 -20 c0
+-5 -4 -10 -10 -10 -5 0 -10 5 -10 10 0 6 5 10 10 10 6 0 10 -4 10 -10z m250
+-10 c0 -11 -4 -20 -10 -20 -5 0 -10 9 -10 20 0 11 5 20 10 20 6 0 10 -9 10
+-20z m116 -32 l2 -42 -19 23 c-14 17 -16 27 -9 42 17 30 25 22 26 -23z m179
+22 c3 -5 1 -10 -4 -10 -6 0 -11 5 -11 10 0 6 2 10 4 10 3 0 8 -4 11 -10z
+m-891 -16 c4 -9 1 -23 -6 -31 -10 -12 -13 -12 -20 1 -9 15 -1 46 12 46 4 0 11
+-7 14 -16z m-106 -35 c-2 -6 -8 -10 -13 -10 -5 0 -11 4 -13 10 -2 6 4 11 13
+11 9 0 15 -5 13 -11z m719 -44 c-4 -53 4 -77 18 -55 10 16 25 1 25 -24 0 -27
+-44 -71 -60 -61 -6 4 -10 17 -8 30 1 12 -4 35 -12 49 -13 25 -12 31 9 72 13
+24 25 44 27 44 3 0 3 -25 1 -55z m-167 29 c0 -8 -5 -12 -10 -9 -6 4 -8 11 -5
+16 9 14 15 11 15 -7z m560 -30 c0 -8 -4 -14 -10 -14 -5 0 -10 9 -10 21 0 11 5
+17 10 14 6 -3 10 -13 10 -21z m270 -46 c0 -23 -12 -23 -34 1 -12 13 -15 27
+-11 41 l7 21 19 -22 c10 -12 19 -30 19 -41z m-1830 18 c-13 -13 -35 7 -25 24
+5 8 11 8 21 -1 10 -8 12 -15 4 -23z m968 4 c9 -16 23 -30 30 -30 13 0 15 -10
+6 -34 -6 -15 -8 -15 -19 1 -11 15 -13 15 -20 -6 -5 -18 -9 -20 -21 -10 -29 24
+-36 48 -22 79 16 38 25 38 46 0z m-362 -88 c-6 -5 -56 44 -56 54 0 3 8 16 17
+31 l17 26 14 -53 c7 -29 11 -55 8 -58z m257 72 c-7 -19 -23 -7 -23 18 0 17 3
+18 14 8 8 -6 12 -18 9 -26z m-673 16 c0 -5 -2 -10 -4 -10 -3 0 -8 5 -11 10 -3
+6 -1 10 4 10 6 0 11 -4 11 -10z m1060 0 c0 -5 -2 -10 -4 -10 -3 0 -8 5 -11 10
+-3 6 -1 10 4 10 6 0 11 -4 11 -10z m58 -35 c-8 -17 -15 -22 -21 -16 -7 7 -6
+15 3 26 20 24 31 18 18 -10z m606 9 c3 -8 2 -12 -4 -9 -6 3 -10 10 -10 16 0
+14 7 11 14 -7z m-1469 -14 c3 -5 1 -10 -4 -10 -6 0 -11 5 -11 10 0 6 2 10 4
+10 3 0 8 -4 11 -10z m-395 -21 c0 -5 -4 -9 -10 -9 -5 0 -10 7 -10 16 0 8 5 12
+10 9 6 -3 10 -10 10 -16z m1044 5 c3 -8 2 -12 -4 -9 -6 3 -10 10 -10 16 0 14
+7 11 14 -7z m-602 -36 c-9 -9 -12 -7 -12 12 0 19 3 21 12 12 9 -9 9 -15 0 -24z
+m-432 8 c0 -2 3 -12 7 -21 5 -14 2 -16 -18 -10 -31 9 -32 11 -24 24 6 10 35
+16 35 7z m111 -68 c24 -29 23 -37 -5 -71 l-22 -28 -2 61 c0 33 1 60 4 60 3 0
+14 -10 25 -22z m73 -14 c3 -8 2 -12 -4 -9 -6 3 -10 10 -10 16 0 14 7 11 14 -7z
+m-185 -94 c17 -22 31 -44 31 -49 0 -6 4 -11 10 -11 5 0 -2 -12 -15 -26 -14
+-15 -25 -31 -25 -35 0 -5 -7 -6 -15 -3 -8 3 -13 9 -12 12 1 4 -4 22 -12 40
+-10 24 -11 35 -2 46 8 10 6 19 -9 39 -25 31 -25 36 -1 30 11 -3 33 -22 50 -43z
+m150 -30 c0 -44 0 -45 -14 -19 -8 14 -13 39 -11 55 5 41 5 41 16 24 5 -8 10
+-35 9 -60z m-54 20 c-3 -5 -11 -10 -16 -10 -6 0 -7 5 -4 10 3 6 11 10 16 10 6
+0 7 -4 4 -10z m35 -115 c11 7 29 -26 23 -42 -2 -6 1 -14 6 -18 21 -12 11 -25
+-39 -49 -44 -21 -70 -21 -56 2 2 4 8 35 11 67 9 74 13 82 32 56 8 -12 18 -19
+23 -16z m-80 -35 c0 -5 -4 -10 -10 -10 -5 0 -10 5 -10 10 0 6 5 10 10 10 6 0
+10 -4 10 -10z m237 -17 c8 -12 12 -27 8 -33 -8 -13 -65 26 -65 45 0 22 41 13
+57 -12z m-56 -33 c18 -10 26 -49 13 -63 -6 -5 -64 55 -64 67 0 9 29 7 51 -4z
+m-78 -66 c-4 -11 -9 -12 -19 -4 -7 7 -10 18 -7 26 4 11 9 12 19 4 7 -7 10 -18
+7 -26z m49 -46 c-15 -15 -27 14 -17 40 6 15 8 15 18 -6 7 -16 7 -26 -1 -34z
+m87 -90 c5 -16 6 -28 1 -28 -17 0 -60 63 -60 88 l0 27 25 -30 c13 -16 29 -42
+34 -57z m-235 -89 c-10 -16 -24 -9 -24 12 0 18 2 19 15 9 8 -7 12 -16 9 -21z
+m-37 -65 c-1 -2 -13 6 -27 16 -23 17 -23 20 -10 45 l14 26 13 -43 c6 -23 11
+-43 10 -44z m284 23 c-8 -8 -11 -3 -11 19 1 25 2 27 11 11 8 -14 8 -22 0 -30z
+m-201 -8 c0 -6 -4 -7 -10 -4 -5 3 -10 11 -10 16 0 6 5 7 10 4 6 -3 10 -11 10
+-16z m45 -59 c3 -11 11 -20 17 -20 7 0 7 -4 0 -13 -6 -7 -9 -23 -6 -34 3 -12
+1 -30 -4 -40 -10 -17 -11 -17 -17 2 -11 33 -20 48 -30 46 -18 -4 -23 43 -7 62
+20 23 39 22 47 -3z m167 -37 c-4 -24 -6 -25 -17 -9 -7 9 -11 26 -8 37 8 30 31
+5 25 -28z m-102 -5 c0 -19 -2 -20 -10 -8 -13 19 -13 30 0 30 6 0 10 -10 10
+-22z m-257 -49 c3 -14 1 -32 -3 -39 -7 -11 -12 -7 -21 13 -9 21 -9 30 1 42 15
+19 17 17 23 -16z m157 -59 c0 -25 -4 -30 -25 -30 -31 0 -31 7 -3 37 27 29 28
+29 28 -7z"/>
+<path d="M2695 2824 c-44 -25 -82 -48 -85 -52 -3 -4 -11 -8 -19 -10 -7 -1 -38
+-19 -70 -39 -31 -20 -60 -38 -66 -39 -5 -1 -57 -29 -113 -63 -57 -34 -118 -70
+-135 -79 -18 -9 -78 -44 -134 -76 l-101 -59 18 -35 c14 -25 16 -40 9 -53 -23
+-43 -42 -35 -64 26 l-13 38 -24 -24 c-13 -13 -33 -24 -43 -24 -13 0 -20 -7
+-21 -20 -2 -37 -5 -40 -17 -23 -12 14 -25 9 -140 -55 l-127 -72 2 -47 c1 -55
+-23 -98 -32 -58 -7 31 -26 36 -27 8 -1 -60 -3 -68 -21 -68 -26 0 -44 41 -26
+58 8 7 14 22 14 32 0 19 -4 18 -57 -11 -32 -18 -64 -39 -70 -47 -7 -9 -13 -12
+-13 -8 0 4 -13 0 -29 -10 -18 -11 -31 -29 -37 -53 -6 -25 -15 -36 -26 -35 -11
+1 -21 -10 -29 -33 l-11 -35 -27 26 c-30 28 -53 33 -69 13 -12 -14 11 -52 31
+-52 7 0 13 -12 15 -27 3 -22 -1 -28 -16 -28 -20 0 -39 16 -42 35 -3 23 -12 55
+-17 55 -13 0 -133 -76 -133 -85 0 -6 -10 -15 -22 -20 -12 -6 -25 -21 -29 -35
+-4 -14 -7 -18 -8 -8 -2 27 -19 31 -51 11 -28 -16 -35 -26 -31 -47 1 -4 -9 -6
+-23 -2 -14 3 -30 1 -38 -6 -8 -7 -49 -31 -92 -53 -43 -22 -89 -50 -102 -62
+-13 -12 -24 -20 -24 -17 0 3 -8 1 -17 -5 -10 -5 -18 -19 -18 -32 0 -12 -6 -24
+-12 -26 -7 -3 -13 2 -13 11 0 21 -4 20 -61 -10 -40 -22 -48 -31 -43 -49 4 -17
+-6 -31 -47 -66 -28 -24 -60 -50 -70 -57 -16 -11 -19 -27 -19 -108 0 -81 3 -96
+18 -101 64 -23 134 -105 116 -135 -4 -6 4 -4 17 3 26 13 253 144 309 178 19
+11 46 26 60 33 14 7 27 15 30 18 3 3 26 16 52 30 83 43 83 44 59 83 -11 19
+-21 45 -21 58 0 24 37 95 45 87 10 -10 42 -118 35 -118 -5 0 -13 -14 -19 -30
+l-10 -31 42 26 c23 14 95 55 160 92 109 63 117 70 112 94 -3 14 -2 36 4 50 l9
+24 7 -30 c13 -58 12 -57 57 -29 24 15 45 28 47 30 2 2 -4 20 -15 39 -17 31
+-17 37 -4 45 22 14 27 12 27 -7 0 -10 1 -31 2 -48 2 -29 2 -30 19 -10 9 11 23
+20 30 21 29 2 33 5 30 22 -2 13 3 17 25 15 34 -2 34 7 1 38 -42 39 -55 71 -43
+112 5 19 9 39 8 44 -7 40 26 44 70 8 24 -21 28 -30 22 -47 -6 -16 0 -33 22
+-64 l30 -43 36 24 c20 14 52 32 71 42 19 9 63 34 98 55 34 21 66 38 71 38 4 0
+5 17 2 38 -4 20 -4 55 0 77 11 60 1 99 -38 145 -31 36 -35 46 -29 78 6 40 28
+62 62 62 18 0 31 -21 80 -130 33 -71 65 -130 72 -130 6 0 12 -9 12 -20 0 -23
+8 -25 32 -6 14 10 15 15 5 26 -10 10 -8 10 10 1 18 -9 24 -8 32 7 7 12 6 25
+-2 39 -47 81 -48 83 -34 83 25 0 65 -39 72 -70 7 -33 8 -33 107 23 36 21 69
+45 72 53 3 8 11 12 17 9 5 -4 29 6 52 21 23 16 44 29 47 29 3 0 28 14 55 29
+28 16 67 39 88 51 20 12 35 25 32 28 -3 4 -2 5 1 2 9 -6 84 34 84 45 0 6 7 10
+16 10 8 0 35 12 60 26 36 21 44 31 44 54 0 16 -11 42 -25 59 l-26 30 23 3 c20
+3 23 10 26 50 2 38 0 47 -11 42 -9 -3 -16 3 -19 14 -6 23 9 55 23 47 5 -4 9
+38 9 104 0 61 -3 111 -7 111 -5 0 -44 -21 -88 -46z m33 -44 c12 -12 22 -23 22
+-25 0 -11 -24 -55 -30 -55 -3 0 -11 23 -16 50 -12 55 -8 60 24 30z m42 -70 c0
+-5 -2 -10 -4 -10 -3 0 -8 5 -11 10 -3 6 -1 10 4 10 6 0 11 -4 11 -10z m-150
+-52 c0 -16 -3 -19 -11 -11 -6 6 -8 16 -5 22 11 17 16 13 16 -11z m-97 -14 c-7
+-18 -19 -18 -26 0 -7 18 1 26 18 19 8 -2 11 -11 8 -19z m15 -100 c12 -22 -9
+-79 -33 -88 -10 -4 -13 12 -13 70 0 72 1 75 18 57 9 -11 22 -28 28 -39z m-316
+-26 c-7 -7 -12 -8 -12 -2 0 6 3 14 7 17 3 4 9 5 12 2 2 -3 -1 -11 -7 -17z m20
+-93 c0 -5 -5 -11 -11 -13 -6 -2 -11 4 -11 13 0 9 5 15 11 13 6 -2 11 -8 11
+-13z m-212 -20 c0 -8 -2 -15 -4 -15 -2 0 -6 7 -10 15 -3 8 -1 15 4 15 6 0 10
+-7 10 -15z m173 -31 c22 -22 24 -29 15 -50 -13 -27 -25 -30 -51 -10 -14 11
+-17 22 -12 50 9 43 14 44 48 10z m-113 -19 c0 -9 -6 -12 -16 -8 -13 5 -13 7
+-2 14 17 11 18 11 18 -6z m48 -25 c-1 -16 -6 -30 -10 -30 -9 0 -10 22 -2 44
+10 25 15 19 12 -14z m182 -20 c13 -31 6 -100 -10 -100 -14 0 -40 43 -40 67 0
+31 18 75 29 69 4 -3 14 -19 21 -36z m-390 -20 c0 -5 -2 -10 -4 -10 -3 0 -8 5
+-11 10 -3 6 -1 10 4 10 6 0 11 -4 11 -10z m66 -57 c-10 -11 -25 18 -18 35 4
+13 8 11 15 -6 6 -12 7 -25 3 -29z m-226 7 c0 -5 -4 -10 -10 -10 -5 0 -10 5
+-10 10 0 6 5 10 10 10 6 0 10 -4 10 -10z m483 -47 c-5 -12 -7 -12 -14 -1 -5 7
+-9 19 -9 27 0 11 3 11 14 1 8 -6 12 -18 9 -27z m207 16 c0 -5 -4 -9 -10 -9 -5
+0 -10 7 -10 16 0 8 5 12 10 9 6 -3 10 -10 10 -16z m-123 -11 c-3 -8 -6 -5 -6
+6 -1 11 2 17 5 13 3 -3 4 -12 1 -19z m-617 -15 c0 -21 -3 -24 -9 -14 -5 8 -7
+20 -4 28 8 21 13 15 13 -14z m383 -22 c3 -11 2 -22 -1 -25 -9 -10 -31 15 -25
+30 7 20 20 17 26 -5z m-113 -27 c0 -8 -4 -12 -10 -9 -5 3 -10 10 -10 16 0 5 5
+9 10 9 6 0 10 -7 10 -16z m-273 -66 c-3 -8 -6 -5 -6 6 -1 11 2 17 5 13 3 -3 4
+-12 1 -19z m296 -22 c3 -8 0 -22 -7 -32 -13 -17 -14 -16 -20 4 -11 34 15 60
+27 28z m-643 -46 c0 -5 -2 -10 -4 -10 -3 0 -8 5 -11 10 -3 6 -1 10 4 10 6 0
+11 -4 11 -10z m178 -23 c13 -15 -1 -42 -17 -33 -13 8 -15 46 -2 46 5 0 13 -6
+19 -13z m93 -20 c-1 -12 -15 -9 -19 4 -3 6 1 10 8 8 6 -3 11 -8 11 -12z m108
+-29 c5 -13 16 -39 25 -59 l15 -37 -27 3 c-35 4 -72 16 -72 23 0 7 43 92 47 92
+2 0 7 -10 12 -22z m-159 -29 c0 -18 -18 -9 -23 12 -4 16 -3 18 9 8 8 -6 14
+-15 14 -20z m-95 11 c11 -17 -5 -32 -21 -19 -7 6 -11 15 -8 20 7 12 21 11 29
+-1z m-128 -22 c-3 -8 -6 -5 -6 6 -1 11 2 17 5 13 3 -3 4 -12 1 -19z m-31 -58
+c2 -35 -6 -38 -23 -10 -11 16 -10 21 5 29 9 6 17 11 17 11 0 0 1 -13 1 -30z
+m-306 -26 c0 -8 -4 -12 -10 -9 -5 3 -10 13 -10 21 0 8 5 12 10 9 6 -3 10 -13
+10 -21z m573 -21 c-3 -7 -9 -13 -13 -13 -14 0 -18 24 -7 45 10 19 10 19 17 0
+4 -11 5 -26 3 -32z m-337 -56 c-4 -18 1 -38 12 -55 l17 -27 -33 23 c-40 29
+-64 72 -51 93 5 8 9 25 9 38 0 24 1 23 26 -10 18 -25 24 -42 20 -62z m124 57
+c0 -24 -17 -15 -22 11 -4 20 -3 23 8 14 8 -6 14 -18 14 -25z m310 -8 c-15 -15
+-32 7 -24 29 7 17 8 17 21 -1 9 -12 10 -21 3 -28z m-725 -12 c-3 -29 -2 -34 9
+-25 11 9 15 5 18 -23 4 -33 3 -34 -13 -20 -36 33 -49 104 -19 104 6 0 8 -15 5
+-36z m107 14 c6 -17 -1 -38 -13 -38 -5 0 -9 11 -9 25 0 26 14 34 22 13z m64
+-53 c4 -8 1 -22 -6 -30 -9 -11 -9 -22 1 -49 11 -31 10 -41 -5 -72 l-17 -37
+-24 34 c-14 18 -25 43 -25 55 0 24 30 84 43 84 4 0 7 7 7 15 0 20 19 19 26 0z
+m189 6 c3 -5 1 -12 -4 -15 -5 -3 -11 1 -15 9 -6 16 9 21 19 6z m-515 -31 c0
+-5 -5 -10 -11 -10 -5 0 -7 5 -4 10 3 6 8 10 11 10 2 0 4 -4 4 -10z m-45 -40
+c7 -23 -2 -43 -16 -35 -12 8 -12 55 0 55 5 0 12 -9 16 -20z m205 -15 c0 -18
+-4 -23 -15 -19 -15 6 -20 35 -9 47 12 11 24 -3 24 -28z m-90 -32 l-1 -58 -19
+24 c-23 27 -25 44 -8 71 21 33 28 23 28 -37z m-231 -20 c1 -26 0 -45 -1 -42
+-2 2 -11 13 -20 25 -16 18 -16 22 -2 42 8 12 16 22 18 22 1 0 4 -21 5 -47z
+m290 1 c21 -27 36 -63 28 -70 -10 -10 -39 10 -52 37 -29 56 -13 79 24 33z m86
+-4 c-5 -8 -11 -8 -17 -2 -6 6 -7 16 -3 22 5 8 11 8 17 2 6 -6 7 -16 3 -22z
+m163 -52 c-7 -19 -21 -12 -23 9 -1 18 1 20 12 11 8 -6 12 -15 11 -20z m-113
+-8 c3 -5 1 -10 -4 -10 -6 0 -11 5 -11 10 0 6 2 10 4 10 3 0 8 -4 11 -10z m-42
+-46 c-4 -11 -9 -12 -19 -4 -7 7 -10 18 -7 26 4 11 9 12 19 4 7 -7 10 -18 7
+-26z m-453 -28 c0 -6 -8 -20 -16 -31 l-15 -20 -15 20 c-8 11 -20 20 -27 20 -6
+0 -13 8 -15 19 -2 11 0 16 7 12 5 -4 15 3 21 15 l12 21 24 -23 c13 -12 24 -27
+24 -33z m344 9 c-6 -15 -8 -15 -16 -2 -4 8 -5 23 -2 32 6 15 8 15 16 2 4 -8 5
+-23 2 -32z m-152 -44 c-5 -3 -12 -13 -16 -21 -3 -8 -4 -4 -2 9 3 14 1 30 -4
+36 -6 7 -3 20 8 36 l17 24 3 -39 c2 -21 -1 -42 -6 -45z m308 -1 c0 -5 -2 -10
+-4 -10 -3 0 -8 5 -11 10 -3 6 -1 10 4 10 6 0 11 -4 11 -10z m-655 -17 c13 -12
+19 -13 24 -4 14 23 6 -53 -8 -79 -13 -23 -14 -23 -21 -5 -10 27 -21 105 -16
+105 3 0 12 -7 21 -17z m239 -19 c-6 -3 -10 -18 -8 -34 4 -32 -6 -39 -24 -17
+-13 15 11 58 31 56 8 0 9 -2 1 -5z m50 -20 c3 -8 2 -12 -4 -9 -6 3 -10 10 -10
+16 0 14 7 11 14 -7z m-71 -86 c-19 -33 -40 -39 -35 -10 4 18 29 42 45 42 5 0
+1 -14 -10 -32z m-198 -102 c7 3 27 -7 44 -23 l31 -28 -26 -23 -27 -23 6 30 c6
+28 5 30 -16 20 -19 -9 -22 -17 -19 -47 l3 -37 -25 40 c-25 40 -26 65 -3 94 7
+8 13 9 15 3 2 -6 9 -9 17 -6z m-125 -46 c0 -22 -16 -35 -25 -20 -9 14 4 52 16
+45 5 -4 9 -15 9 -25z"/>
+<path d="M2720 2219 c-68 -38 -62 -31 -62 -73 0 -41 -17 -47 -46 -16 l-19 20
+-24 -22 c-14 -13 -29 -23 -34 -23 -22 0 -185 -101 -181 -112 3 -7 -1 -10 -9
+-6 -11 4 -109 -42 -133 -62 -1 -1 7 -23 19 -49 31 -70 24 -211 -12 -250 -9
+-11 -29 34 -29 67 0 11 -9 31 -21 43 -14 15 -19 29 -14 43 3 12 11 19 16 15 5
+-3 7 -9 5 -13 -3 -4 0 -13 5 -21 7 -11 9 -5 8 20 -1 19 1 59 5 88 l8 53 -24
+-14 c-24 -15 -366 -215 -428 -249 -221 -125 -349 -202 -344 -209 3 -5 2 -14
+-2 -21 -5 -8 -9 -7 -13 5 -6 15 -9 15 -36 -3 -19 -13 -24 -20 -14 -20 31 0 40
+-24 20 -54 l-19 -28 -12 36 c-13 41 -21 43 -58 18 -15 -10 -35 -22 -45 -25
+-11 -4 -21 -16 -24 -28 -4 -14 -8 -17 -13 -8 -6 8 -25 1 -71 -26 -77 -46 -100
+-65 -93 -76 3 -5 0 -9 -5 -9 -6 0 -11 5 -11 11 0 5 -5 7 -10 4 -6 -4 -8 -11
+-5 -16 11 -16 -5 -31 -21 -18 -11 9 -54 -12 -203 -97 -180 -103 -191 -111
+-191 -139 -1 -25 -2 -27 -11 -12 -14 24 -24 22 -83 -15 -28 -17 -67 -40 -86
+-50 -129 -73 -180 -103 -180 -108 0 -4 17 -16 38 -28 l39 -22 13 25 c16 29 27
+32 27 7 0 -51 5 -61 39 -81 19 -12 36 -21 37 -21 1 0 11 15 21 34 13 24 23 33
+34 29 11 -5 14 -2 9 10 -3 9 -3 17 2 17 8 0 12 -18 28 -118 5 -29 15 -39 87
+-80 44 -26 84 -46 89 -44 4 1 7 -3 7 -8 0 -6 12 -16 28 -23 15 -6 49 -27 77
+-44 27 -18 52 -33 56 -33 3 0 14 18 24 40 10 22 22 40 27 40 18 0 47 -82 38
+-106 -8 -20 -4 -26 26 -45 34 -21 36 -21 49 -3 13 18 14 18 34 0 12 -11 20
+-28 19 -38 -2 -14 47 -47 212 -146 118 -71 216 -128 218 -126 2 1 -2 11 -9 22
+-11 17 -10 24 2 38 13 16 14 14 19 -19 l5 -36 74 44 c40 25 74 45 76 45 1 0
+29 16 61 35 50 30 59 40 60 66 1 16 10 39 20 50 18 20 18 20 31 -6 8 -14 16
+-25 19 -25 3 0 25 11 50 24 l45 24 -25 18 c-19 15 -24 25 -19 46 6 30 22 35
+55 17 15 -8 19 -17 14 -39 -5 -28 -2 -27 124 48 71 42 130 83 130 90 0 6 10
+12 22 12 16 0 85 36 127 67 2 1 -2 9 -8 17 -7 8 -9 20 -5 27 5 8 12 5 23 -9
+16 -21 17 -21 209 94 l192 116 0 244 c0 134 -3 244 -6 244 -3 0 -46 -24 -97
+-54 -51 -29 -112 -65 -137 -78 -119 -66 -220 -130 -216 -137 3 -4 1 -13 -4
+-21 -7 -12 -10 -12 -15 2 -6 16 -9 16 -30 2 -13 -8 -29 -28 -35 -45 -11 -26
+-14 -28 -25 -12 -11 15 -20 12 -96 -32 -134 -78 -127 -70 -85 -97 46 -30 60
+-64 49 -119 l-9 -44 -44 2 c-25 1 -47 -3 -51 -9 -15 -25 21 -68 78 -93 52 -23
+55 -27 48 -52 -13 -56 -27 -59 -94 -19 -34 20 -64 36 -67 36 -21 0 -64 77 -64
+114 0 7 19 19 43 27 61 23 62 50 1 88 l-48 29 -28 -19 c-15 -11 -28 -26 -28
+-34 0 -7 -9 -23 -20 -36 l-19 -24 -1 23 c0 28 -3 27 -67 -7 -52 -28 -52 -28
+-33 -46 22 -20 26 -55 8 -73 -20 -20 -28 -14 -28 21 0 59 -11 62 -78 21 -34
+-20 -62 -38 -62 -41 0 -2 18 -31 40 -63 22 -32 40 -61 40 -65 0 -3 -17 5 -38
+18 -20 13 -45 26 -55 30 -9 4 -26 22 -37 41 -16 26 -66 61 -215 150 -107 64
+-195 118 -195 120 0 2 56 36 125 75 69 40 125 76 125 80 0 16 -46 47 -68 45
+-16 -1 -21 3 -18 12 3 8 1 14 -4 14 -6 0 -10 -6 -10 -12 0 -18 -20 13 -20 31
+0 10 3 11 14 2 11 -9 15 -5 18 24 2 19 0 41 -4 48 -6 9 -8 8 -8 -3 -1 -12 -3
+-11 -14 3 -8 10 -11 27 -8 39 5 20 6 20 18 3 8 -10 16 -16 18 -14 10 9 8 86
+-3 129 -16 66 -14 79 7 52 28 -37 101 -47 160 -23 72 29 75 29 100 -1 31 -36
+23 -58 -23 -59 -19 -1 -39 -3 -45 -4 -5 -1 -14 -3 -18 -4 -12 -1 -14 -93 -3
+-109 4 -8 24 -17 42 -21 26 -5 35 -13 39 -33 l5 -26 125 73 c92 54 128 80 137
+101 8 19 12 23 13 12 0 -10 3 -18 6 -18 16 0 143 78 173 106 36 34 38 43 40
+157 1 44 3 47 20 38 20 -11 39 -54 48 -106 3 -16 6 -31 7 -32 1 -1 59 32 129
+72 70 41 146 85 170 98 113 64 167 99 167 107 0 6 7 10 16 10 27 0 75 33 69
+48 -3 8 1 23 9 34 14 20 14 20 21 -1 3 -12 11 -21 17 -21 13 0 128 69 128 77
+0 4 -3 3 -6 0 -8 -8 -39 30 -48 59 -4 12 -2 34 4 49 10 27 11 27 30 10 20 -18
+20 -17 20 65 0 72 -2 81 -13 66 -13 -18 -15 -17 -34 8 -12 14 -28 26 -38 26
+-9 0 -13 5 -10 10 4 6 11 8 16 5 5 -4 9 -2 9 3 0 19 33 22 51 6 18 -17 19 -14
+19 79 0 54 -3 97 -7 97 -5 0 -33 -14 -63 -31z m-42 -220 c-2 -6 -8 -10 -13
+-10 -5 0 -11 4 -13 10 -2 6 4 11 13 11 9 0 15 -5 13 -11z m-246 -46 c20 -18
+24 -58 8 -68 -16 -10 -60 23 -55 40 3 8 7 22 10 30 6 19 14 19 37 -2z m248
+-42 c0 -3 -8 -17 -17 -31 l-17 -24 -12 35 c-18 48 -17 49 16 38 17 -6 30 -14
+30 -18z m-317 -36 c-7 -21 -13 -19 -13 6 0 11 4 18 10 14 5 -3 7 -12 3 -20z
+m-183 -9 c0 -11 -19 -15 -25 -6 -3 5 1 10 9 10 9 0 16 -2 16 -4z m450 -40 c-8
+-8 -13 -7 -20 4 -12 20 -1 33 16 19 11 -9 12 -15 4 -23z m-500 -6 c0 -10 -5
+-22 -11 -25 -6 -5 -4 -11 6 -19 15 -11 15 -14 -4 -36 l-20 -25 -2 30 c-2 17
+-3 39 -4 50 -2 27 14 57 26 50 5 -4 9 -15 9 -25z m-10 -120 c0 -5 -2 -10 -4
+-10 -3 0 -8 5 -11 10 -3 6 -1 10 4 10 6 0 11 -4 11 -10z m-215 -10 c3 -5 1
+-10 -4 -10 -6 0 -11 5 -11 10 0 6 2 10 4 10 3 0 8 -4 11 -10z m152 -36 c7 3
+15 1 17 -3 3 -5 18 -11 34 -14 24 -5 28 -11 30 -44 1 -21 5 -55 8 -76 5 -37 5
+-38 -18 -26 -40 21 -128 82 -128 88 -1 3 -7 31 -14 62 l-14 57 36 -24 c20 -14
+42 -22 49 -20z m433 6 c0 -5 -4 -10 -10 -10 -5 0 -10 5 -10 10 0 6 5 10 10 10
+6 0 10 -4 10 -10z m-690 -93 c0 -5 -5 -5 -10 -2 -6 4 -8 10 -5 15 3 5 -4 11
+-15 15 -22 7 -26 35 -8 53 10 10 15 3 25 -30 7 -24 13 -47 13 -51z m121 -25
+c15 -27 15 -31 -1 -61 l-16 -33 -17 26 c-9 14 -17 31 -17 38 0 9 -3 9 -10 -2
+-5 -8 -10 -11 -10 -7 0 12 40 67 48 67 4 0 14 -13 23 -28z m270 -19 c-9 -17
+-10 -17 -16 0 -4 9 -4 25 0 35 6 16 7 16 16 0 7 -12 7 -24 0 -35z m-505 1 c17
+-16 24 -32 21 -45 -3 -10 0 -19 6 -20 7 0 2 -4 -11 -10 -25 -10 -72 13 -72 35
+0 12 23 66 28 66 2 0 14 -12 28 -26z m73 -8 c7 -8 8 -17 3 -20 -6 -3 -12 3
+-15 14 -6 24 -4 25 12 6z m491 -36 c0 -5 -2 -10 -4 -10 -3 0 -8 5 -11 10 -3 6
+-1 10 4 10 6 0 11 -4 11 -10z m-746 -36 c3 -8 2 -12 -4 -9 -6 3 -10 10 -10 16
+0 14 7 11 14 -7z m-42 -56 c-9 -9 -12 -7 -12 12 0 19 3 21 12 12 9 -9 9 -15 0
+-24z m405 10 c-3 -8 -6 -5 -6 6 -1 11 2 17 5 13 3 -3 4 -12 1 -19z m-457 -59
+c0 -10 -4 -19 -10 -19 -5 0 -10 12 -10 26 0 14 4 23 10 19 6 -3 10 -15 10 -26z
+m203 16 c4 -8 2 -17 -2 -20 -5 -2 -11 4 -14 15 -6 23 8 27 16 5z m87 -84 c0
+-11 5 -21 11 -23 5 -2 7 -11 3 -21 -5 -14 -13 -17 -33 -11 -14 4 -37 8 -51 9
+-16 1 -26 9 -28 21 -3 15 -1 16 9 7 9 -10 18 -7 41 12 35 30 48 31 48 6z
+m-485 -70 c-10 -16 -25 -3 -25 22 0 20 1 20 16 5 9 -9 13 -21 9 -27z m407 -88
+c2 -3 -9 -7 -24 -9 -23 -2 -28 1 -29 19 0 12 -2 30 -4 40 -2 12 5 8 25 -13 16
+-17 30 -34 32 -37z m-572 41 c0 -8 -5 -12 -10 -9 -6 4 -8 11 -5 16 9 14 15 11
+15 -7z m-157 -46 c6 -42 -2 -49 -21 -18 -9 15 -10 26 -1 41 13 25 15 24 22
+-23z m47 32 c0 -5 -4 -10 -10 -10 -5 0 -10 5 -10 10 0 6 5 10 10 10 6 0 10 -4
+10 -10z m590 -36 c0 -8 -4 -14 -10 -14 -5 0 -10 9 -10 21 0 11 5 17 10 14 6
+-3 10 -13 10 -21z m-537 -25 c-5 -5 -9 3 -11 19 -1 24 0 25 9 9 7 -11 7 -23 2
+-28z m107 20 c0 -11 -4 -18 -10 -14 -5 3 -7 12 -3 20 7 21 13 19 13 -6z m1585
+-32 c0 -26 -20 -25 -23 2 -3 16 1 22 10 19 7 -3 13 -12 13 -21z m-1897 -43 c1
+-14 6 -33 11 -42 9 -18 4 -42 -8 -42 -10 0 -31 46 -31 68 0 14 17 42 25 42 0
+0 2 -11 3 -26z m57 7 c3 -5 1 -12 -5 -16 -5 -3 -10 1 -10 9 0 18 6 21 15 7z
+m187 -8 c10 -9 18 -23 18 -32 -1 -19 -29 -72 -30 -55 0 7 -9 14 -20 17 -14 3
+-20 14 -20 32 0 19 4 26 14 22 10 -4 12 0 9 14 -6 23 4 24 29 2z m73 -32 c3
+-5 1 -12 -5 -16 -5 -3 -10 1 -10 9 0 18 6 21 15 7z m1385 -67 c0 -9 -5 -12
+-12 -8 -27 15 -38 27 -32 35 8 13 44 -9 44 -27z m-1552 -8 c7 1 8 0 3 -2 -6
+-3 -8 -11 -6 -17 17 -56 15 -67 -7 -67 -48 1 -73 50 -52 105 6 14 9 14 28 -3
+11 -11 27 -18 34 -16z m109 2 c-3 -8 -6 -5 -6 6 -1 11 2 17 5 13 3 -3 4 -12 1
+-19z m105 -62 c-16 -30 -17 -30 -20 -8 -3 18 -7 21 -17 12 -10 -8 -14 -4 -18
+16 -3 18 -1 22 6 15 18 -18 24 -12 19 22 l-4 32 25 -29 c25 -29 25 -30 9 -60z
+m-515 58 c10 -28 -13 -37 -25 -9 -10 21 -9 25 4 25 8 0 17 -7 21 -16z m373
+-49 c0 -8 -4 -17 -10 -20 -6 -4 -10 5 -10 20 0 15 4 24 10 20 6 -3 10 -12 10
+-20z m-320 -16 c0 -24 -12 -24 -27 0 -10 15 -10 21 0 24 18 6 27 -2 27 -24z
+m-110 -5 c0 -8 -5 -12 -10 -9 -6 4 -8 11 -5 16 9 14 15 11 15 -7z m220 12 c0
+-3 -4 -8 -10 -11 -5 -3 -10 -1 -10 4 0 6 5 11 10 11 6 0 10 -2 10 -4z m1790
+-38 c0 -30 0 -31 -20 -13 -19 17 -19 19 -2 31 23 18 22 18 22 -18z m-1950 -34
+c0 -8 -5 -12 -10 -9 -6 4 -8 11 -5 16 9 14 15 11 15 -7z m100 6 c0 -5 -2 -10
+-4 -10 -3 0 -8 5 -11 10 -3 6 -1 10 4 10 6 0 11 -4 11 -10z m301 -16 c9 -11 8
+-21 -1 -44 -16 -39 -26 -38 -33 3 -3 17 -8 40 -12 49 -5 13 -2 15 14 11 11 -3
+26 -11 32 -19z m1259 -51 c0 -30 -20 -73 -35 -73 -6 0 -19 15 -27 34 -16 32
+-16 35 9 71 l26 38 13 -24 c7 -13 13 -34 14 -46z m-1873 35 c-3 -8 -6 -5 -6 6
+-1 11 2 17 5 13 3 -3 4 -12 1 -19z m2082 -63 c1 -50 -12 -59 -41 -28 -28 31
+-29 47 -2 88 l18 28 13 -29 c7 -16 12 -42 12 -59z m-1686 38 c7 -43 3 -53 -24
+-53 -10 0 -28 -9 -39 -20 -11 -11 -23 -20 -27 -20 -5 0 -9 -11 -10 -25 -1 -14
+-8 -34 -16 -46 -14 -20 -16 -18 -27 38 -6 32 -12 64 -13 72 -2 14 115 89 139
+90 6 1 14 -15 17 -36z m95 9 c14 -9 16 -159 1 -167 -9 -6 -59 56 -59 75 0 7 9
+28 21 46 11 19 18 38 14 44 -7 12 5 13 23 2z m-535 -39 c-6 -14 -8 -14 -14 3
+-12 30 -10 37 5 24 8 -6 12 -19 9 -27z m777 -88 c-6 -19 -13 -35 -15 -35 -3 0
+-15 16 -29 36 -24 35 -24 38 -9 70 l16 34 24 -36 c22 -31 23 -39 13 -69z
+m-313 53 c-3 -8 -6 -5 -6 6 -1 11 2 17 5 13 3 -3 4 -12 1 -19z m385 -50 c-13
+-13 -26 8 -17 30 6 16 7 16 17 -1 7 -13 7 -22 0 -29z m908 2 c0 -5 -2 -10 -4
+-10 -3 0 -8 5 -11 10 -3 6 -1 10 4 10 6 0 11 -4 11 -10z m-845 -53 c17 -33 17
+-35 -1 -65 -10 -18 -21 -32 -24 -31 -3 0 -15 13 -28 30 l-24 29 22 35 c12 19
+25 35 29 35 4 0 16 -15 26 -33z m-265 -59 l0 -32 -16 23 c-14 19 -14 25 -3 32
+19 12 19 13 19 -23z m-220 -19 c0 -6 -4 -7 -10 -4 -5 3 -10 11 -10 16 0 6 5 7
+10 4 6 -3 10 -11 10 -16z m436 -96 c-11 -12 -27 13 -20 32 7 17 8 17 17 -3 6
+-12 7 -25 3 -29z m-52 -44 c-8 -13 -24 -1 -24 18 0 13 3 13 15 3 8 -7 12 -16
+9 -21z m196 16 c0 -8 -4 -15 -10 -15 -5 0 -7 7 -4 15 4 8 8 15 10 15 2 0 4 -7
+4 -15z m-93 -61 c17 -4 -4 -54 -23 -54 -9 0 -34 48 -34 66 0 2 34 -4 57 -12z
+m-57 -20 c0 -8 -4 -14 -10 -14 -5 0 -10 9 -10 21 0 11 5 17 10 14 6 -3 10 -13
+10 -21z m60 -60 c0 -8 -5 -12 -10 -9 -6 4 -8 11 -5 16 9 14 15 11 15 -7z m103
+-40 c18 -24 18 -25 -7 -55 l-26 -31 0 26 c0 14 0 27 0 29 -1 1 -5 19 -9 39 -8
+32 -7 35 8 26 9 -5 24 -21 34 -34z m364 14 c-3 -8 -6 -5 -6 6 -1 11 2 17 5 13
+3 -3 4 -12 1 -19z m-247 -69 c0 -20 -15 -26 -24 -10 -8 13 4 42 15 35 5 -3 9
+-14 9 -25z m-63 -64 c0 -8 -4 -12 -9 -9 -5 3 -6 10 -3 15 9 13 12 11 12 -6z"/>
+<path d="M210 982 c0 -45 3 -82 6 -82 5 0 68 35 83 46 3 2 -42 62 -81 109 -4
+5 -8 -28 -8 -73z"/>
+<path d="M1440 1001 c-7 -15 -7 -21 0 -21 12 0 25 28 17 36 -3 3 -10 -4 -17
+-15z"/>
+</g>
+</svg>

Software/data_src/static/img/site.webmanifest

@@ -0,0 +1,19 @@
+{
+    "name": "",
+    "short_name": "",
+    "icons": [
+        {
+            "src": "/android-chrome-192x192.png",
+            "sizes": "192x192",
+            "type": "image/png"
+        },
+        {
+            "src": "/android-chrome-256x256.png",
+            "sizes": "256x256",
+            "type": "image/png"
+        }
+    ],
+    "theme_color": "#ffffff",
+    "background_color": "#ffffff",
+    "display": "standalone"
+}

Software/data_src/static/js/dtc_table.js

@@ -0,0 +1,221 @@
+const jsonFilePath = "static/dtc_table.json";
+
+var dtcState = {};
+
+async function processDTCNotifications(dtcArray) {
+  // Entferne DTCs aus dtcState, die nicht im dtcArray enthalten sind
+  for (var key in dtcState) {
+    if (!dtcArray.some((dtc) => parseInt(dtc.split(",")[1]) == key)) {
+      delete dtcState[key];
+    }
+  }
+
+  if (dtcArray.length === 0 || dtcArray[0] == "0") {
+    dtcState = {};
+    return;
+  }
+
+  for (var i = 0; i < dtcArray.length; i++) {
+    var dtcInfo = dtcArray[i].split(",");
+    var errorCode = parseInt(dtcInfo[1]);
+    var activity = parseInt(dtcInfo[3]);
+    var severity = parseInt(dtcInfo[2]);
+
+    try {
+      var { title, description } = await getDescriptionForDTCNumber(errorCode);
+
+      switch (severity) {
+        case 1:
+          severity = "info";
+          break;
+        case 2:
+          severity = "warning";
+          break;
+        case 3:
+          severity = "danger";
+          break;
+      }
+
+      if (dtcState[errorCode]) {
+        // Überprüfen, ob sich der Zustand von "previous" auf "active" geändert hat
+        if (activity !== dtcState[errorCode].activity) {
+          dtcState[errorCode].activity = activity;
+          if (activity === 1) showNotification(description, severity);
+        }
+      } else {
+        // DTC ist neu, Zustand speichern und wenn active, Benachrichtigung anzeigen
+        dtcState[errorCode] = { activity: activity };
+        if (activity === 1) showNotification(description, severity);
+      }
+    } catch (error) {
+      console.error("Error processing DTC:", error);
+    }
+  }
+}
+
+function getDescriptionForDTCNumber(number) {
+  return new Promise((resolve, reject) => {
+    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;
+          resolve({ title, description });
+        } else {
+          // Wenn die Nummer nicht gefunden wurde, geben Sie einen Fehler zurück
+          reject(`Beschreibung für Nummer ${number} nicht gefunden.`);
+        }
+      })
+      .catch((error) => {
+        // Im Fehlerfall geben Sie den Fehler zurück
+        reject(error);
+      });
+  });
+}
+
+async function showDTCModal(event) {
+  var dtc = parseInt(event.currentTarget.getAttribute("data-dtc"));
+  var debugval = event.currentTarget.getAttribute("data-debugval");
+  var modal = $("#dtcModal");
+
+  try {
+    var { title, description } = await getDescriptionForDTCNumber(dtc);
+
+    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();
+    }
+  } catch (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");
+  }
+
+  // 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 || dtcArray[0] == "0") {
+    // Verstecke das Tabellen-Div, wenn keine DTC vorhanden sind
+    tablediv.hidden = true;
+    table.innerHTML = "";
+    return;
+  }
+
+  // Prüfen, ob sich der Inhalt der Tabelle geändert hat
+  var tableContentChanged = false;
+  for (var i = 0; i < dtcArray.length; i++) {
+    var dtcInfo = dtcArray[i].split(",");
+    var errorCode = parseInt(dtcInfo[1]);
+    var activity = parseInt(dtcInfo[3]);
+
+    if (!dtcState[errorCode] || dtcState[errorCode].activity !== activity) {
+      tableContentChanged = true;
+      break;
+    }
+  }
+
+  if (!tableContentChanged) {
+    return;
+  }
+
+  // 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,42 @@
+$(document).ready(function () {
+  // Event-Listener für Navbar-Links
+  $(".navbar-nav a").on("click", function () {
+    $(".navbar-collapse").collapse("hide");
+  });
+
+  // Event-Listener für Passwort zeigen/verborgen
+  $("#show_hide_password a").on("click", function (event) {
+    event.preventDefault();
+    var inputField = $("#show_hide_password input");
+    var icon = $("#show_hide_password i");
+    if (inputField.attr("type") == "text") {
+      inputField.attr("type", "password");
+      icon.addClass("fa-eye-slash");
+      icon.removeClass("fa-eye");
+    } else if (inputField.attr("type") == "password") {
+      inputField.attr("type", "text");
+      icon.removeClass("fa-eye-slash");
+      icon.addClass("fa-eye");
+    }
+  });
+
+  // Event-Listener für Datei-Upload
+  $(".custom-file-input").on("change", function (e) {
+    var fileName = document.getElementById("fw-update-file").files[0].name;
+    var nextSibling = e.target.nextElementSibling;
+    nextSibling.innerText = fileName;
+  });
+
+  // Event-Listener für Live-Debug-Eingabe
+  $('#livedebug-in').on('keydown', function(event) {
+    if (event.key === 'Enter' || event.keyCode === 13) {
+      event.preventDefault(); // Verhindert, dass die Enter-Taste die Standardaktion ausführt (z.B. Absenden eines Formulars)
+      
+      const command = $('#livedebug-in').val(); // Den Befehl aus dem Eingabefeld holen
+      websocket_sendDebugCommand(command); // Den Befehl an die Funktion übergeben
+
+      $('#livedebug-in').val(''); // Leert das Eingabefeld
+      $('#livedebug-in').focus(); // Setzt den Fokus zurück auf das Eingabefeld
+    }
+  });
+});

Software/data_src/static/js/websocket.js

@@ -0,0 +1,273 @@
+var gateway = `ws://${window.location.hostname}/ws`;
+var websocket;
+
+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...");
+  websocket = new WebSocket(gateway);
+  websocket.onopen = onOpen;
+  websocket.onclose = onClose;
+  websocket.onmessage = onMessage; // <-- add this line
+}
+
+function initButtons() {
+  var elements = document.getElementsByClassName("btn-wsevent");
+
+  if (elements.length > 0) {
+    for (var i = 0; i < elements.length; i++) {
+      let element = elements[i];
+      element.addEventListener("click", sendButton);
+    }
+  }
+}
+
+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) {
+  console.log("Connection opened");
+}
+
+function onClose(event) {
+  console.log("Connection closed");
+  setTimeout(initWebSocket, 1000);
+  overlay.style.display = "flex";
+}
+
+function sendButton(event) {
+  var targetElement = event.target;
+
+  if (
+    targetElement.classList.contains("confirm") &&
+    window.confirm("Sicher?") == false
+  )
+    return;
+
+  websocket_sendevent("btn-" + targetElement.id, targetElement.value);
+}
+
+function onMessage(event) {
+  var data = event.data;
+
+  if (data.startsWith("NOTIFY:")) {
+    var notify_data = data.slice(7).split(";")[1];
+    var notify_type = data.slice(7).split(";")[0];
+    showNotification(notify_data, notify_type);
+  } else if (data.startsWith("DEBUG:")) {
+    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);
+  } else if (data.startsWith("DTC:")) {
+    const dtcs = data.slice(4);
+    const dtcArray = dtcs.trim() !== "" ? dtcs.split(";").filter(Boolean) : [];
+
+    processDTCNotifications(dtcArray);
+    fillDTCTable(dtcArray);
+  } else if (data.startsWith("MAPPING_STATUS:")) {
+    const data_sliced = data.slice(15);
+    statusMapping = createMapping(data_sliced);
+  } else if (data.startsWith("MAPPING_STATIC:")) {
+    const data_sliced = data.slice(15);
+    staticMapping = createMapping(data_sliced);
+    console.log(staticMapping);
+  } else if (data.startsWith("STATUS:")) {
+    const data_sliced = data.slice(7);
+    const result = processDataString(data_sliced, statusMapping);
+    fillValuesToHTML(result);
+  } else if (data.startsWith("STATIC:")) {
+    const data_sliced = data.slice(7);
+    const result = processDataString(data_sliced, staticMapping);
+    fillValuesToHTML(result);
+    console.log(result);
+    overlay.style.display = "none";
+  }
+}
+
+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 websocket_sendevent(element_id, element_value) {
+  websocket.send(element_id + ":" + element_value);
+}
+
+function websocket_sendDebugCommand(command) {
+  websocket.send("debug-in:" + command);
+}
+
+function do_resize(textbox) {
+  var maxrows = 15;
+  var minrows = 3;
+  var txt = textbox.value;
+  var cols = textbox.cols;
+
+  var arraytxt = txt.split("\n");
+  var rows = arraytxt.length;
+
+  for (i = 0; i < arraytxt.length; i++)
+    rows += parseInt(arraytxt[i].length / cols);
+
+  if (rows > maxrows) textbox.rows = maxrows;
+  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 if (element.tagName === "DIV" || element.tagName === "SPAN") {
+          if (element.classList.contains("format-time")) {
+            element.innerText = formatTime(dataset[key]);
+          } else if (element.classList.contains("faction-logo")) {
+            // Faction-Logo-Logik
+            updateFactionLogo(element, dataset[key]);
+          } else {
+            element.innerText = dataset[key];
+          }
+        } else {
+          // Standardmäßig für Textfelder und andere Elemente
+          element.value = dataset[key];
+        }
+      }
+    }
+    // Aktualisiere den <title>-Tag, wenn der Schlüssel 'devicename' im dataset vorhanden ist
+    if (key === "devicename") {
+      document.title = dataset[key];
+    }
+  }
+}
+
+function formatTime(seconds) {
+  var hrs = Math.floor(seconds / 3600);
+  var mins = Math.floor((seconds % 3600) / 60);
+  var secs = seconds % 60;
+
+  return (
+    String(hrs).padStart(2, "0") +
+    ":" +
+    String(mins).padStart(2, "0") +
+    ":" +
+    String(secs).padStart(2, "0")
+  );
+}
+
+function updateFactionLogo(element, faction) {
+  const glowClass = "glow-active-faction";
+  var factionClass = "faction" + faction;
+  if (element.classList.contains(factionClass)) {
+    element.classList.add(glowClass);
+  } else {
+    element.classList.remove(glowClass);
+  }
+}
+
+// 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 + "%";
+}
+
+function showNotification(message, type) {
+  // Erstellen Sie ein Bootstrap-Alert-Element
+  var alertElement = $(
+    '<div class="alert alert-' +
+      type +
+      ' alert-dismissible fade show notification" role="alert">' +
+      "<strong>" +
+      message +
+      "</strong>" +
+      '<button type="button" class="close" data-dismiss="alert" aria-label="Close">' +
+      '<span aria-hidden="true">&times;</span>' +
+      "</button>" +
+      "</div>"
+  );
+
+  // Fügen Sie das Alert-Element dem Container hinzu
+  $("#notification-container").append(alertElement);
+
+  // Nach 5 Sekunden das Alert-Element ausblenden
+  setTimeout(function () {
+    alertElement.alert("close");
+  }, 5000);
+}

Software/git_rev_macro.py

@@ -1,8 +0,0 @@
-import subprocess
-
-revision = (
-    subprocess.check_output(["git", "rev-parse", "--short=10", "HEAD"])
-    .strip()
-    .decode("utf-8")
-)
-print("-DGIT_REV='\"%s\"'" % revision)

Software/include/common.h

@@ -3,22 +3,31 @@
 #define _COMMON_H_
 
 #include <stdint.h>
+#include <stddef.h>
 
 #define Q(x) #x
 #define QUOTE(x) Q(x)
+#define SET_BIT(value, bitPosition) ((value) |= (1U << (bitPosition)))
 
 #define TRUE 1
 #define FALSE 0
 
-#define HOST_NAME "AirsoftTimer_%08X"
+#ifndef DEVICE_NAME
+#define HOST_NAME "AirsoftTimer"
+#else
+#define HOST_NAME DEVICE_NAME
+#endif
+
+#define SHUTDOWN_DELAY_MS 5000
+#define STARTUP_DELAY_MS 20000
 
 #define GPIO_LORA_TX D3
 #define GPIO_LORA_RX D4
 #define GPIO_LORA_AUX D0
 
-#define GPIO_7SEG_EN_FAC1 D5
+#define GPIO_7SEG_EN_FAC1 D7
 #define GPIO_7SEG_EN_FAC2 D6
-#define GPIO_7SEG_EN_FAC3 D7
+#define GPIO_7SEG_EN_FAC3 D5
 #define GPIO_7SEG_CLK D8
 
 #define I2C_IO_BTN_FAC1 0
@@ -41,17 +50,24 @@
 #define OTA_DELAY 50 // ticks -> 10ms / tick
 #endif
 
-#ifndef ADMIN_PASSWORD
+typedef enum eSystem_Status
-#error "You need to define ADMIN_PASSWORD for OTA-Update"
+{
-#endif
+  sysStat_Init,
-#ifndef WIFI_PASSWORD
+  sysStat_Startup,
-#error "You must define an WIFI_PASSWORD for OTA-Update"
+  sysStat_Normal,
-#endif
+  sysStat_Error,
-#ifndef WIFI_SSID
+  sysStat_Shutdown
-#error "You must define an WIFI_SSID for OTA-Update"
+} tSystem_Status;
-#endif
+
-#ifndef WIFI_AP_PASSWORD
+typedef enum batteryType_e
-#error "You must define an WIFI_AP_PASSWORD for Standalone AP-Mode"
+{
-#endif
+  BATTERY_UNDEFINED,
+  BATTERY_LIPO_2S,
+  BATTERY_LIPO_3S
+} batteryType_t;
+
+// String representation of SpeedSource enum
+extern const char *BatteryString[];
+extern const size_t BatteryString_Elements;
 
 #endif

Software/include/debugger.h

@@ -0,0 +1,51 @@
+/**
+ * @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"
+
+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];
+
+enum LogLevel
+{
+    LOG_INFO,
+    LOG_WARN,
+    LOG_ERROR
+};
+
+void initDebugger();
+void Debug_pushMessage(const char *format, ...);
+void SetDebugportStatus(DebugPorts_t port, DebugStatus_t status);
+void Debug_Process();
+void Debug_ProcessCommand(uint8_t *command);
+#endif

Software/include/dtc.h

@@ -0,0 +1,39 @@
+/**
+ * @file dtc.h
+ *
+ * @brief Header file for handling Diagnostic Trouble Codes (DTC) in the DE-Timer application.
+ *
+ * This file provides definitions and functions for handling Diagnostic Trouble Codes (DTC)
+ * in the DE-Timer 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 12
+
+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 DE-Timer application.
+ *
+ * This file contains definitions for Diagnostic Trouble Codes (DTC) in the DE-Timer 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-05-30 21:56:51.
+ *
+ * @author Marcel Peterkau
+ * @date   30.05.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_BAT_CRITICAL               1
+#define DTC_BAT_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_BATMNON_FOUND           10
+#define DTC_NO_LORA_FOUND              11
+#define DTC_EEPROM_CFG_SANITY          12
+#define DTC_EEPROM_MIGRATE_FAILED      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_BAT_CRITICAL              , DTC_CRITICAL }, // Akku ist komplett leer. Den Akku aufladen!
+    { DTC_BAT_LOW                   , DTC_WARN     }, // Akku ist unter der Warnschwelle. Den Akku demnächst aufladen
+    { 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_BATMNON_FOUND          , DTC_CRITICAL }, // Es wurde keine Akkuüberwachung über I2C gefunden, Prüfen sie die Hardware!
+    { DTC_NO_LORA_FOUND             , DTC_CRITICAL }, // Es konnte keine Verbindung zum LoRa-Transceiver hergestellt werden. Prüfen Sie die Hardware auf Defekte
+    { DTC_EEPROM_CFG_SANITY         , DTC_WARN     }, // Ein oder mehrer Einstellungswerte sind ausserhalb plausibler Werte. Prüfen Sie Ihre Einstellungen
+    { DTC_EEPROM_MIGRATE_FAILED     , DTC_CRITICAL }, // Es wurde ein altes EEPROm Image erkannt, konnte aber nicht migriert werden. EEPROM manuell zurück setzen und neue Einstellunge speichern.
+    { 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: 313d59949b074024df3c5d796f65e3bd518e34f0bb171185c30f008f21c19d30

Software/include/eeprom.h

@@ -0,0 +1,107 @@
+/**
+ * @file eeprom.h
+ *
+ * @brief Header file for configuration settings and EEPROM operations in the DE-Timer application.
+ *
+ * This file defines configuration settings for the DE-Timer project, including default values,
+ * EEPROM structures, and functions for EEPROM operations. It also defines enums for different Battery Types.
+ * Additionally, it includes functions for EEPROM handling such as storing, retrieving, and formatting configuration data.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
+#ifndef _EEPROM_H_
+#define _EEPROM_H_
+
+#include <Arduino.h>
+#include <Wire.h>
+#include <I2C_eeprom.h>
+#include "dtc.h"
+#include "common.h"
+
+#define I2C_EE_ADDRESS 0x50
+#define EEPROM_STRUCTURE_REVISION 4 // Increment this version when changing EEPROM structures
+#define EEPROM_SIZE_BYTES I2C_DEVICESIZE_24LC256
+
+typedef enum Factions_e
+{
+  NONE,
+  FACTION_1,
+  FACTION_2,
+  FACTION_3
+} Factions_t;
+
+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
+{
+  uint32_t writeCycleCounter;
+  uint32_t faction_1_timer;
+  uint32_t faction_2_timer;
+  uint32_t faction_3_timer;
+  Factions_t activeFaction;
+  uint32_t checksum;
+} persistenceData_t;
+
+// Structure for configuration settings stored in EEPROM
+typedef struct
+{
+  uint8_t EEPROM_Version;
+  batteryType_t batteryType;
+  bool active_faction_on_reboot;
+  char Faction_1_Name[33];
+  char Faction_2_Name[33];
+  char Faction_3_Name[33];
+  char wifi_client_ssid[33];
+  char wifi_client_password[64];
+  bool wifi_autoconnect;
+  uint32_t checksum;
+} configData_t;
+
+// Default configuration settings
+const configData_t ConfigData_defaults = {
+    2,               // EEPROM_Version (incerease this if anything on Layout changes!)
+    BATTERY_LIPO_3S, // batteryType
+    false,           // active_faction_on_reboot
+    "FACTION 1",     // Faction_1_Name
+    "FACTION 2",     // Faction_2_Name
+    "FACTION 3",     // Faction_3_Name
+    QUOTE(WIFI_SSID_CLIENT),
+    QUOTE(WIFI_PASSWORD_CLIENT),
+    true,
+    0 // checksum
+};
+
+boolean 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);
+void writeSequentialToEEPROM(uint16_t memoryAddress, uint16_t length);
+void writeZeroToEEPROM(uint16_t memoryAddress, uint16_t length);
+
+extern configData_t ConfigData;
+extern persistenceData_t PersistenceData;
+extern uint16_t eePersistenceMarker;
+#endif // _CONFIG_H_

Software/include/globals.h

@@ -0,0 +1,46 @@
+#ifndef _GLOBALS_H_
+#define _GLOBALS_H_
+
+#include <Arduino.h>
+#include "eeprom.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 */
+  EERequest_t requestEEAction = EE_IDLE;         /**< EEPROM-related request */
+  char DeviceName[25];                           /**< Device name */
+  char DeviceNameId[sizeof(DeviceName) + 8];     /**< Device name plus 8 chars chipID */
+  char FlashVersion[10];                         /**< Flash version */
+  uint16_t eePersistanceAdress;                  /**< EEPROM persistence address */
+  bool hasDTC;
+  int loadvoltage_mV = 0;
+  int battery_level = 0;
+  bool timer_disabled = false;
+  bool toggle_wifi = false;
+} 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 = {
+    FW_MAJOR, FW_MINOR,   // Firmware_Version
+    FL_MAJOR, FL_MINOR,   // Required Flash Version
+    GIT_REV // Git-Hash-String
+};
+
+/**
+ * @brief Initializes global variables.
+ */
+void initGlobals();
+
+#endif // _GLOBALS_H_

Software/include/lora_net.h

@@ -0,0 +1,27 @@
+#ifndef _LORA_NET_H_
+#define _LORA_NET_H_
+
+#include <Arduino.h>
+
+#ifdef LORA_FEATURE_ENABLED
+#include <LoRa_E220.h>
+#elif defined(FEATURE_ENABLE_UARTLORA)
+#include <SoftwareSerial.h>
+#endif
+
+// local includes
+#include "lora_messages.h"
+#include "debugger.h"
+#include "defaults.h"
+#include "config.h"
+#include "globals.h"
+#include "dtc.h"
+#include "common.h"
+
+#define FREQUENCY_868
+
+bool InitLoRa(void (*MPinHelper)(int, int));
+void LoRa_Process();
+void sendStatus_LoRa();
+
+#endif

Software/include/sanitycheck.h

@@ -0,0 +1,75 @@
+#ifndef _SANITYCHECK_H_
+#define _SANITYCHECK_H_
+
+// Utility macros for handling quotes
+#define Q(x) #x
+#define QUOTE(x) Q(x)
+
+// Utility macros for checking string lengths
+#define STRING_LENGTH_CHECK(str, max_length) (sizeof(str) <= (max_length) + 1)
+#define IS_ALPHANUMERIC(c) ((((c) >= '0') && ((c) <= '9')) || (((c) >= 'A') && ((c) <= 'Z')) || (((c) >= 'a') && ((c) <= 'z')))
+#define IS_PRINTABLE_ASCII(c) ((c) >= 32 && (c) <= 126)
+#define IS_VALID_WIFI_CHAR(c) (IS_PRINTABLE_ASCII(c))
+#define IS_ALPHANUMERIC_HELPER(str, i) (i >= sizeof(str) - 1 || IS_ALPHANUMERIC(str[i]))
+#define IS_PRINTABLE_ASCII_HELPER(str, i) (i >= sizeof(str) - 1 || IS_PRINTABLE_ASCII(str[i]))
+#define IS_VALID_WIFI_CHAR_HELPER(str, i) (i >= sizeof(str) - 1 || IS_VALID_WIFI_CHAR(str[i]))
+#define IS_ALPHANUMERIC_IMPL(str, i) (IS_ALPHANUMERIC_HELPER(str, i) && IS_ALPHANUMERIC_HELPER(str, i+1) && IS_ALPHANUMERIC_HELPER(str, i+2) && IS_ALPHANUMERIC_HELPER(str, i+3) && IS_ALPHANUMERIC_HELPER(str, i+4) && IS_ALPHANUMERIC_HELPER(str, i+5) && IS_ALPHANUMERIC_HELPER(str, i+6) && IS_ALPHANUMERIC_HELPER(str, i+7) && IS_ALPHANUMERIC_HELPER(str, i+8) && IS_ALPHANUMERIC_HELPER(str, i+9) && IS_ALPHANUMERIC_HELPER(str, i+10) && IS_ALPHANUMERIC_HELPER(str, i+11) && IS_ALPHANUMERIC_HELPER(str, i+12) && IS_ALPHANUMERIC_HELPER(str, i+13) && IS_ALPHANUMERIC_HELPER(str, i+14) && IS_ALPHANUMERIC_HELPER(str, i+15) && IS_ALPHANUMERIC_HELPER(str, i+16))
+#define IS_PRINTABLE_ASCII_IMPL(str, i) (IS_PRINTABLE_ASCII_HELPER(str, i) && IS_PRINTABLE_ASCII_HELPER(str, i+1) && IS_PRINTABLE_ASCII_HELPER(str, i+2) && IS_PRINTABLE_ASCII_HELPER(str, i+3) && IS_PRINTABLE_ASCII_HELPER(str, i+4) && IS_PRINTABLE_ASCII_HELPER(str, i+5) && IS_PRINTABLE_ASCII_HELPER(str, i+6) && IS_PRINTABLE_ASCII_HELPER(str, i+7) && IS_PRINTABLE_ASCII_HELPER(str, i+8) && IS_PRINTABLE_ASCII_HELPER(str, i+9) && IS_PRINTABLE_ASCII_HELPER(str, i+10) && IS_PRINTABLE_ASCII_HELPER(str, i+11) && IS_PRINTABLE_ASCII_HELPER(str, i+12) && IS_PRINTABLE_ASCII_HELPER(str, i+13) && IS_PRINTABLE_ASCII_HELPER(str, i+14) && IS_PRINTABLE_ASCII_HELPER(str, i+15) && IS_PRINTABLE_ASCII_HELPER(str, i+16) && IS_PRINTABLE_ASCII_HELPER(str, i+17) && IS_PRINTABLE_ASCII_HELPER(str, i+18) && IS_PRINTABLE_ASCII_HELPER(str, i+19) && IS_PRINTABLE_ASCII_HELPER(str, i+20) && IS_PRINTABLE_ASCII_HELPER(str, i+21) && IS_PRINTABLE_ASCII_HELPER(str, i+22) && IS_PRINTABLE_ASCII_HELPER(str, i+23) && IS_PRINTABLE_ASCII_HELPER(str, i+24))
+#define IS_ALPHANUMERIC_STRING(str) (IS_ALPHANUMERIC_IMPL(str, 0))
+#define IS_PRINTABLE_ASCII_STRING(str) (IS_PRINTABLE_ASCII_IMPL(str, 0))
+#define IS_VALID_WIFI_STRING(str) (IS_VALID_WIFI_CHAR_HELPER(str, 0) && IS_VALID_WIFI_CHAR_HELPER(str, 1) && IS_VALID_WIFI_CHAR_HELPER(str, 2) && IS_VALID_WIFI_CHAR_HELPER(str, 3) && IS_VALID_WIFI_CHAR_HELPER(str, 4) && IS_VALID_WIFI_CHAR_HELPER(str, 5) && IS_VALID_WIFI_CHAR_HELPER(str, 6) && IS_VALID_WIFI_CHAR_HELPER(str, 7) && IS_VALID_WIFI_CHAR_HELPER(str, 8) && IS_VALID_WIFI_CHAR_HELPER(str, 9) && IS_VALID_WIFI_CHAR_HELPER(str, 10) && IS_VALID_WIFI_CHAR_HELPER(str, 11) && IS_VALID_WIFI_CHAR_HELPER(str, 12) && IS_VALID_WIFI_CHAR_HELPER(str, 13) && IS_VALID_WIFI_CHAR_HELPER(str, 14) && IS_VALID_WIFI_CHAR_HELPER(str, 15) && IS_VALID_WIFI_CHAR_HELPER(str, 16) && IS_VALID_WIFI_CHAR_HELPER(str, 17) && IS_VALID_WIFI_CHAR_HELPER(str, 18) && IS_VALID_WIFI_CHAR_HELPER(str, 19) && IS_VALID_WIFI_CHAR_HELPER(str, 20) && IS_VALID_WIFI_CHAR_HELPER(str, 21) && IS_VALID_WIFI_CHAR_HELPER(str, 22) && IS_VALID_WIFI_CHAR_HELPER(str, 23) && IS_VALID_WIFI_CHAR_HELPER(str, 24) && IS_VALID_WIFI_CHAR_HELPER(str, 25) && IS_VALID_WIFI_CHAR_HELPER(str, 26) && IS_VALID_WIFI_CHAR_HELPER(str, 27) && IS_VALID_WIFI_CHAR_HELPER(str, 28) && IS_VALID_WIFI_CHAR_HELPER(str, 29) && IS_VALID_WIFI_CHAR_HELPER(str, 30) && IS_VALID_WIFI_CHAR_HELPER(str, 31) && IS_VALID_WIFI_CHAR_HELPER(str, 32))
+
+// ADMIN_PASSWORD check
+#ifndef ADMIN_PASSWORD
+    #error "You need to define ADMIN_PASSWORD for OTA-Update"
+#else
+    _Static_assert(STRING_LENGTH_CHECK(QUOTE(ADMIN_PASSWORD), 16), "ADMIN_PASSWORD must be at most 16 characters long");
+#endif
+
+// WIFI_AP_SSID check
+#ifndef WIFI_AP_SSID
+    #warning "No WIFI_AP_SSID defined. Using DeviceName"
+    #define WIFI_AP_SSID DEVICE_NAME
+#else
+    _Static_assert(STRING_LENGTH_CHECK(QUOTE(WIFI_AP_SSID), 32), "WIFI_AP_SSID must be at most 32 characters long");
+    _Static_assert(IS_VALID_WIFI_STRING(QUOTE(WIFI_AP_SSID)), "WIFI_AP_SSID must contain only valid WiFi characters");
+#endif
+
+// WIFI_PASS_SEED check
+#ifndef WIFI_PASS_SEED
+    #error "You must define an WIFI_PASS_SEED for Standalone AP-Mode"
+#else
+    _Static_assert(STRING_LENGTH_CHECK(QUOTE(WIFI_PASS_SEED), 16), "WIFI_PASS_SEED must be at most 16 characters long");
+    _Static_assert(IS_ALPHANUMERIC_STRING(QUOTE(WIFI_PASS_SEED)), "WIFI_PASS_SEED must contain only alphanumeric characters (a-z, A-Z, 0-9)");
+#endif
+
+// DEVICE_NAME check
+#ifndef DEVICE_NAME
+    #error "You must define DEVICE_NAME"
+#else
+    _Static_assert(STRING_LENGTH_CHECK(QUOTE(DEVICE_NAME), 24), "DEVICE_NAME must be at most 24 characters long");
+    _Static_assert(IS_VALID_WIFI_STRING(QUOTE(DEVICE_NAME)), "DEVICE_NAME must contain only valid WiFi characters");
+#endif
+
+// Mutual exclusion check for LoRa features
+#if defined(FEATURE_ENABLE_UARTLORA) && defined(FEATURE_ENABLE_LORA)
+    #error "You cannot enable LoRa and UART-Protocol at the same time!"
+#endif
+
+// WIFI_CLIENT checks
+#ifdef FEATURE_ENABLE_WIFI_CLIENT
+    #ifndef WIFI_PASSWORD_CLIENT
+        #error "You must define an WIFI_PASSWORD_CLIENT for OTA-Update"
+    #else
+        _Static_assert(STRING_LENGTH_CHECK(QUOTE(WIFI_PASSWORD_CLIENT), 63), "WIFI_PASSWORD_CLIENT must be at most 63 characters long");
+    #endif
+
+    #ifndef WIFI_SSID_CLIENT
+        #error "You must define an WIFI_SSID_CLIENT for OTA-Update"
+    #else
+        _Static_assert(STRING_LENGTH_CHECK(QUOTE(WIFI_SSID_CLIENT), 32), "WIFI_SSID_CLIENT must be at most 32 characters long");
+        _Static_assert(IS_VALID_WIFI_STRING(QUOTE(WIFI_SSID_CLIENT)), "WIFI_SSID_CLIENT must contain only valid WiFi characters");
+    #endif
+#endif
+
+#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-06-06 18:52:33.
+ *
+ * @author Marcel Peterkau
+ * @date   06.06.2024
+ */
+
+#ifndef _STRUCT2JSON_H_
+#define _STRUCT2JSON_H_
+
+#include <Arduino.h>
+#include <ArduinoJson.h>
+
+#include "eeprom.h"
+
+void generateJsonObject_ConfigData(JsonObject data);
+void generateJsonObject_PersistenceData(JsonObject data);
+
+
+#endif /* _STRUCT2JSON_H_ */
+
+// CODEGENERATOR_CHECKSUM: 3a3fd3024dd9dd769ff5d62f61b3ba1b781b7d06e7568a1ddac56d193dba9ee5

Software/include/utilities.h

@@ -0,0 +1,48 @@
+#ifndef UTILITIES_H
+#define UTILITIES_H
+
+#include <Arduino.h>
+
+/**
+ * @brief Validates whether a given string contains only characters allowed in WiFi SSIDs and passwords.
+ *
+ * This function checks each character in the provided string to ensure
+ * that it contains only characters allowed in WiFi SSIDs and passwords.
+ * It considers characters from 'A' to 'Z', 'a' to 'z', '0' to '9', as well as
+ * the following special characters: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ *
+ * @param string Pointer to the string to be validated.
+ * @param size Size of the string including the null-terminator.
+ * @return true if the string contains only allowed characters or is NULL,
+ *         false otherwise.
+ */
+bool validateWiFiString(char *string, size_t size);
+
+/**
+ * @brief Copies a string to a buffer, replacing invalid WiFi SSID characters with a placeholder.
+ *
+ * This function checks each character in the provided input string to ensure
+ * that it contains only characters allowed in WiFi SSIDs and passwords. If a character
+ * is invalid, it replaces it with a placeholder character (e.g., '_').
+ * It considers characters from 'A' to 'Z', 'a' to 'z', '0' to '9', as well as
+ * the following special characters: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ *
+ * @param input Pointer to the input string to be validated and copied.
+ * @param buffer Pointer to the buffer where the output string will be copied.
+ * @param bufferSize Size of the buffer including the null-terminator.
+ */
+void sanitizeWiFiString(const char *input, char *buffer, size_t bufferSize);
+
+/**
+ * @brief Generates a device-specific password based on a seed and the ESP8266 Chip ID.
+ *
+ * This function combines a given seed with the unique Chip ID of the ESP8266 device to create a device-specific password.
+ * The resulting password is stored in the provided character buffer.
+ *
+ * @param seed The seed string used for password generation. Should be up to 16 characters long.
+ * @param passwordBuffer The character buffer where the generated password will be stored.
+ * @param bufferLength The length of the password buffer. Should be large enough to hold the generated password and null terminator.
+ */
+void GenerateDeviceSpecificPassword(const char* seed, char* passwordBuffer, size_t bufferLength);
+
+#endif // UTILITIES_H

Software/include/webui.h

@@ -0,0 +1,49 @@
+/**
+ * @file webui.h
+ *
+ * @brief Header file for the web-based user interface (WebUI) in the DE-Timer 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"
+
+typedef enum
+{
+    info,
+    success,
+    warning,
+    error
+} NotificationType_t;
+
+void initWebUI();
+void Webserver_Process();
+void Webserver_Shutdown();
+
+void Websocket_PushLiveDebug(String Message);
+void Websocket_PushNotification(String Message, NotificationType_t type);
+
+#endif // _WEBUI_H_

Software/lib/EByte LoRa E220 library/LoRa_E220.cpp

@@ -274,7 +274,7 @@ bool LoRa_E220::begin(){
 
     this->serialDef.stream->setTimeout(100);
     Status status = setMode(MODE_0_NORMAL);
-    return status==E220_SUCCESS;
+    return status;
 }
 
 /*

Software/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "pio-build-tools",
+  "private": true,
+  "devDependencies": {
+    "html-minifier": "^4.0.0",
+    "terser": "^5.0.0",
+    "clean-css-cli": "^5.0.0"
+  }
+}

Software/platformio.ini

@@ -16,44 +16,49 @@ extra_configs =
 platform = espressif8266
 framework = arduino
 board = d1_mini
+
+custom_firmware_version = 1.09
+custom_flash_version = 1.09
+
+upload_protocol = esptool
+upload_speed = 921600
+;upload_port = 10.0.0.1
+;upload_flags =
+;  --port=8266
+;  --auth=${wifi_cred.admin_password}
+
+build_flags=
+  -DATOMIC_FS_UPDATE
+  ;-DFEATURE_ENABLE_WIFI_CLIENT
+  ;-DFEATURE_ENABLE_LORA
+  -DFEATURE_ENABLE_UARTLORA
+  -DWIFI_AP_IP_GW=10,0,0,1
+  -DADMIN_PASSWORD=${wifi_cred.admin_password}
+  -DWIFI_SSID_CLIENT=${wifi_cred.wifi_ssid_client}
+  -DWIFI_PASSWORD_CLIENT=${wifi_cred.wifi_password_client}
+  -DWIFI_PASS_SEED=${wifi_cred.wifi_pass_seed}
+  -DDEVICE_NAME='"Dark Emergency Timer"'
+
+;build_type = debug
+
 board_build.filesystem = littlefs
-;board_build.f_flash = 80000000L
+board_build.ldscript = eagle.flash.4m1m.ld
-;board_build.ldscript = eagle.flash.4m1m.ld
+extra_scripts = 
+  post:codegen/prepare_littlefs.py
+  pre:codegen/run_pre.py
 
 monitor_filters = esp8266_exception_decoder
 monitor_speed = 115200
 
-upload_protocol = esptool
+lib_ldf_mode = deep
-upload_speed = 921600
-;upload_port = 10.0.1.48
-;upload_protocol = espota
-;upload_flags =  
-;   --auth=${wifi_cred.admin_password}
-
-build_type = debug
-build_flags=
-  !python git_rev_macro.py
-  -DSERIAL_DEBUG
-  ;-DWIFI_CLIENT
-  ;-DCAPTIVE
-  -DWIFI_AP_IP_GW=10,0,1,1
-  -DADMIN_PASSWORD=${wifi_cred.admin_password}
-  -DWIFI_SSID=${wifi_cred.wifi_ssid}
-  -DWIFI_PASSWORD=${wifi_cred.wifi_password}
-  -DWIFI_AP_PASSWORD=${wifi_cred.wifi_ap_password}
-  -DDEVICE_NAME='"Dark Emergency Timer"'
-  -DFACTION_1_NAME='"GOF"'
-  -DFACTION_2_NAME='"MILIZ"'
-  -DFACTION_3_NAME='"KGG"'
-
 lib_deps = 
 	;xreef/EByte LoRa E220 library@^1.0.6   ; made Lib local, due to changes for I2C-controller M0,M1-Pins
 	sstaub/Ticker@^4.4.0
   robtillaart/PCF8574 @ ^0.3.7
 	adafruit/Adafruit INA219 @ ^1.1.1
-    plerup/EspSoftwareSerial @ 6.8.5  ; needed exactly this Version as newer ones have Problems with compiling
+  akj7/TM1637 Driver @ ^2.1.2
-    smougenot/TM1637@0.0.0-alpha+sha.9486982048
+  sstaub/Ticker @ ^4.4.0
-    me-no-dev/ESPAsyncTCP @ ^1.2.2
+  robtillaart/I2C_EEPROM @ ^1.8.2
-    robtillaart/I2C_EEPROM @ ^1.5.2
+  esphome/ESPAsyncWebServer-esphome @ ^3.2.2
   sandeepmistry/LoRa @ ^0.8.0
-    bblanchon/ArduinoJson @ ^6.19.4
+  bblanchon/ArduinoJson @ ^7.0.4

Software/src/common.cpp

@@ -0,0 +1,9 @@
+#include "common.h"
+
+const char *BatteryString[] = {
+    "Undefined",
+    "LiPo 2S",
+    "LiPo 3S"
+    };
+
+const size_t BatteryString_Elements = sizeof(BatteryString) / sizeof(BatteryString[0]);

Software/src/config.cpp

@@ -1,261 +0,0 @@
-#include "config.h"
-
-I2C_eeprom ee(0x50, EEPROM_SIZE_BYTES);
-
-configData_t ConfigData;
-persistenceData_t PersistenceData;
-const uint16_t eeVersion = 1; // inc
-boolean eeAvailable = false;
-
-const uint16_t persistencemarker_Adress = 0; // sizeof 4
-const uint16_t startofConfig_Adress = 16;
-const uint16_t startofPersistence_Adress = startofConfig_Adress + sizeof(ConfigData) + (sizeof(ConfigData) % 16);
-
-boolean checkEEPROMavailable();
-
-void InitEEPROM()
-{
-  ee.begin();
-  if (!checkEEPROMavailable())
-  {
-    globals.systemStatus = sysStat_Error;
-    MaintainDTC(DTC_NO_EEPROM_FOUND, true);
-    return;
-  }
-  GetConfig_EEPROM();
-
-  if (ConfigData.EEPROM_Version != eeVersion)
-  {
-    FormatConfig_EEPROM();
-    globals.systemStatus = sysStat_Error;
-    MaintainDTC(DTC_EEPROM_VERSION_BAD, true);
-    return;
-  }
-
-  if (getPersistanceAddress() > ee.getDeviceSize())
-  {
-    FormatPersistence_EEPROM();
-    globals.systemStatus = sysStat_Error;
-    MaintainDTC(DTC_EEPROM_PDS_MARKER_INVALID, true);
-    return;
-  }
-  GetPersistence_EEPROM();
-}
-
-void EEPROM_Process()
-{
-
-  switch (globals.requestEEAction)
-  {
-  case EE_CFG_SAVE:
-    StoreConfig_EEPROM();
-    globals.requestEEAction = EE_IDLE;
-    break;
-  case EE_CFG_LOAD:
-    GetConfig_EEPROM();
-    globals.requestEEAction = EE_IDLE;
-    break;
-  case EE_PDS_SAVE:
-    StorePersistence_EEPROM();
-    globals.requestEEAction = EE_IDLE;
-    break;
-  case EE_PDS_LOAD:
-    GetPersistence_EEPROM();
-    globals.requestEEAction = EE_IDLE;
-    break;
-  case EE_IDLE:
-  default:
-    globals.requestEEAction = EE_IDLE;
-  }
-}
-
-void StoreConfig_EEPROM()
-{
-  ConfigData.checksum = 0;
-  ConfigData.checksum = Checksum_EEPROM((uint8_t *)&ConfigData, sizeof(ConfigData));
-  if (!checkEEPROMavailable())
-    return;
-
-  ee.updateBlock(startofConfig_Adress, (uint8_t *)&ConfigData, sizeof(ConfigData));
-}
-
-void GetConfig_EEPROM()
-{
-  if (!checkEEPROMavailable())
-    return;
-
-  ee.readBlock(startofConfig_Adress, (uint8_t *)&ConfigData, sizeof(ConfigData));
-
-  uint32_t checksum = ConfigData.checksum;
-  ConfigData.checksum = 0;
-
-  if (Checksum_EEPROM((uint8_t *)&ConfigData, sizeof(ConfigData)) != checksum)
-  {
-    MaintainDTC(DTC_EEPROM_CFG_BAD, true);
-    FormatConfig_EEPROM();
-  }
-  ConfigData.checksum = checksum;
-}
-
-uint32_t getPersistanceAddress()
-{
-  uint32_t eePersistenceMarker;
-  ee.readBlock(persistencemarker_Adress, (uint8_t *)&eePersistenceMarker, sizeof(eePersistenceMarker));
-  return eePersistenceMarker;
-}
-
-void updatePersistanceAddress(uint32_t adress)
-{
-  ee.updateBlock(persistencemarker_Adress, (uint8_t *)&adress, sizeof(adress));
-}
-
-void StorePersistence_EEPROM()
-{
-  if (PersistenceData.writeCycleCounter >= EEPROM_ENDURANCE)
-    MovePersistencePage_EEPROM(false);
-  else
-    PersistenceData.writeCycleCounter++;
-
-  PersistenceData.checksum = 0;
-  PersistenceData.checksum = Checksum_EEPROM((uint8_t *)&PersistenceData, sizeof(PersistenceData));
-
-  if (!checkEEPROMavailable())
-    return;
-
-  ee.updateBlock(getPersistanceAddress(), (uint8_t *)&PersistenceData, sizeof(PersistenceData));
-}
-
-void GetPersistence_EEPROM()
-{
-  if (!checkEEPROMavailable())
-    return;
-
-  ee.readBlock(getPersistanceAddress(), (uint8_t *)&PersistenceData, sizeof(PersistenceData));
-
-  uint32_t checksum = PersistenceData.checksum;
-  PersistenceData.checksum = 0;
-
-  if (Checksum_EEPROM((uint8_t *)&PersistenceData, sizeof(PersistenceData)) != checksum)
-  {
-    MaintainDTC(DTC_EEPROM_PDS_BAD, true);
-    FormatPersistence_EEPROM();
-  }
-  PersistenceData.checksum = checksum;
-}
-
-void FormatConfig_EEPROM()
-{
-  configData_t defaults;
-  ConfigData = defaults;
-  ConfigData.EEPROM_Version = eeVersion;
-  StoreConfig_EEPROM();
-}
-
-void FormatPersistence_EEPROM()
-{
-  persistenceData_t defaults;
-  PersistenceData = defaults;
-  updatePersistanceAddress(startofPersistence_Adress);
-  StorePersistence_EEPROM();
-}
-
-void MovePersistencePage_EEPROM(boolean reset)
-{
-  if (!checkEEPROMavailable())
-    return;
-
-  if (reset)
-  {
-    updatePersistanceAddress(startofPersistence_Adress);
-  }
-  else
-  {
-    uint32_t newPersistenceMarker = getPersistanceAddress() + sizeof(PersistenceData);
-
-    // check if we reached the End of the EEPROM and Startover at the beginning
-    if ((newPersistenceMarker + sizeof(PersistenceData)) > ee.getDeviceSize())
-    {
-      MaintainDTC(DTC_EEPROM_WORNOUT, true);
-      return;
-    }
-    else
-    {
-      updatePersistanceAddress(newPersistenceMarker);
-      PersistenceData.writeCycleCounter = 0;
-    }
-  }
-}
-
-uint32_t GetEESize()
-{
-  return ee.getDeviceSize();
-}
-
-uint32_t Checksum_EEPROM(uint8_t const *data, size_t len)
-{
-  if (data == NULL)
-    return 0;
-  uint32_t crc, mask;
-  crc = 0xFFFFFFFF;
-
-  while (len--)
-  {
-    crc ^= *data++;
-    for (uint8_t k = 0; k < 8; k++)
-    {
-      mask = -(crc & 1);
-      crc = (crc >> 1) ^ (0xEDB88320 & mask);
-    }
-  }
-  return ~crc;
-}
-
-void dumpEEPROM(uint16_t memoryAddress, uint16_t length)
-{
-#define BLOCK_TO_LENGTH 16
-
-  if (length > ee.getDeviceSize())
-    length = ee.getDeviceSize();
-
-  if (memoryAddress + length > ee.getDeviceSize())
-    return;
-
-  if (!checkEEPROMavailable())
-    return;
-
-  char ascii_buf[BLOCK_TO_LENGTH + 1];
-  sprintf(ascii_buf, "%*s", BLOCK_TO_LENGTH, "ASCII");
-  Serial.print(PSTR("\nAddress "));
-  for (int x = 0; x < BLOCK_TO_LENGTH; x++)
-    Serial.printf("%3d", x);
-
-  memoryAddress = memoryAddress / BLOCK_TO_LENGTH * BLOCK_TO_LENGTH;
-  length = (length + BLOCK_TO_LENGTH - 1) / BLOCK_TO_LENGTH * BLOCK_TO_LENGTH;
-
-  for (unsigned int i = 0; i < length; i++)
-  {
-    int blockpoint = memoryAddress % BLOCK_TO_LENGTH;
-    if (blockpoint == 0)
-    {
-      ascii_buf[BLOCK_TO_LENGTH] = 0;
-      Serial.printf("  %s", ascii_buf);
-      Serial.printf("\n0x%05X:", memoryAddress);
-    }
-    ascii_buf[blockpoint] = ee.readByte(memoryAddress);
-    Serial.printf(" %02X", ascii_buf[blockpoint]);
-    if (ascii_buf[blockpoint] < 0x20 || ascii_buf[blockpoint] > 0x7E)
-      ascii_buf[blockpoint] = '.';
-    memoryAddress++;
-  }
-  Serial.println();
-}
-
-boolean checkEEPROMavailable()
-{
-  if (!ee.isConnected())
-  {
-    MaintainDTC(DTC_NO_EEPROM_FOUND, true);
-    return false;
-  }
-  return true;
-}

Software/src/config.h

@@ -1,69 +0,0 @@
-#ifndef _CONFIG_H_
-#define _CONFIG_H_
-
-#include <Arduino.h>
-#include <Wire.h>
-#include <I2C_eeprom.h>
-
-#include "globals.h"
-#include "dtc.h"
-
-#define EEPROM_SIZE_BYTES I2C_DEVICESIZE_24LC01
-#define EEPROM_ENDURANCE 1000000
-
-typedef enum
-{
-  NONE,
-  FACTION_1,
-  FACTION_2,
-  FACTION_3
-} factions_t;
-
-typedef struct
-{
-  uint32_t writeCycleCounter = 0;
-  uint32_t faction_1_timer = 0;
-  uint32_t faction_2_timer = 0;
-  uint32_t faction_3_timer = 0;
-  factions_t activeFaction = NONE;
-  uint32_t checksum = 0;
-} persistenceData_t;
-
-typedef enum
-{
-  BATTERY_UNDEFINED,
-  BATTERY_LIPO_2S,
-  BATTERY_LIPO_3S
-} batteryType_t;
-
-const char BatteryString[][10]{
-  "Undefined",
-  "LiPo 2S",
-  "LiPo 3S"
-};
-
-typedef struct
-{
-  uint8_t EEPROM_Version = 1;
-  batteryType_t batteryType = BATTERY_UNDEFINED;
-  uint32_t checksum = 0;
-} configData_t;
-
-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 getPersistanceAddress();
-void updatePersistanceAddress(uint32_t adress);
-uint32_t GetEESize();
-
-extern configData_t ConfigData;
-extern persistenceData_t PersistenceData;
-#endif // _CONFIG_H_

Software/src/debugger.cpp

@@ -0,0 +1,612 @@
+/**
+ * @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"
+#include <map>
+#include <functional>
+#include <vector>
+#include "utilities.h"
+#include <pgmspace.h>
+
+DebugStatus_t DebuggerStatus[dbg_cntElements];
+
+void processCmdDebug(String command);
+void Debug_formatCFG();
+void Debug_formatPersistence();
+void Debug_printSystemInfo();
+void Debug_printWifiInfo();
+void Debug_CheckEEPOM(bool autocorrect);
+void Debug_dumpConfig();
+void Debug_dumpPersistance();
+void Debug_ShowDTCs();
+void Debug_dumpGlobals();
+void Debug_printHelp();
+void Debug_Reboot();
+void Debug_setBatteryType(int batterytype);
+const char *uint32_to_binary_string(uint32_t num);
+
+/**
+ * @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;
+            Serial.write(inputChar);
+            break;
+
+        case 0x1B: // Esc
+            inputBuffer[0] = 0;
+            inputCnt = 0;
+            InputProcessed = CMD_ABORT;
+            break;
+
+        case 0x20 ... 0x7E: // it's a real letter or sign and not some control-chars
+            inputBuffer[inputCnt] = inputChar;
+            inputCnt++;
+            Serial.write(inputChar);
+            break;
+
+        default:
+            break;
+        }
+
+        // Check for input buffer overflow
+        if (inputCnt >= sizeof(inputBuffer) - 1)
+        {
+            inputBuffer[sizeof(inputBuffer) - 1] = '\0';
+            inputCnt = 0;
+            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;
+    }
+
+    if (InputProcessed != IDLE)
+        Serial.print(">");
+
+    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\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\n", sDebugPorts[port]);
+}
+
+void Debug_log(LogLevel level, const char *format, ...)
+{
+    if ((DebuggerStatus[dbg_Serial] == enabled) || (DebuggerStatus[dbg_Webui] == enabled))
+    {
+        char buff[128];
+        va_list arg;
+        va_start(arg, format);
+        vsnprintf(buff, sizeof(buff), format, arg);
+        va_end(arg);
+
+        if (DebuggerStatus[dbg_Serial] == enabled)
+        {
+            Serial.print(buff);
+        }
+        if (DebuggerStatus[dbg_Webui] == enabled)
+        {
+            Websocket_PushLiveDebug(String(buff));
+        }
+    }
+}
+
+/**
+ * @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[128]; // Buffer to hold the formatted message
+        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));
+        }
+    }
+}
+
+// === splitArgs Helper ===
+std::vector<String> splitArgs(const String &input)
+{
+    std::vector<String> tokens;
+    int start = 0, end = 0;
+    while ((end = input.indexOf(' ', start)) != -1)
+    {
+        tokens.push_back(input.substring(start, end));
+        start = end + 1;
+    }
+    if (start < input.length())
+        tokens.push_back(input.substring(start));
+    return tokens;
+}
+
+// === getArg helper ===
+String getArg(const std::vector<String> &args, size_t index, const String &defaultVal = "")
+{
+    if (index < args.size())
+        return args[index];
+    return defaultVal;
+}
+
+// === Command Handler Map ===
+typedef std::function<void(const String &args)> DebugCmdHandler;
+
+static const std::map<String, DebugCmdHandler> &getCmdMap()
+{
+    static const std::map<String, DebugCmdHandler> cmdMap = {
+        {"help", [](const String &)
+         {
+             Debug_log(LOG_INFO, "Available commands:\n");
+             for (const auto &entry : getCmdMap())
+                 Debug_log(LOG_INFO, " - %s\n", entry.first.c_str());
+         }},
+        {"sysinfo", [](const String &)
+         { Debug_printSystemInfo(); }},
+        {"netinfo", [](const String &)
+         { Debug_printWifiInfo(); }},
+        {"formatCFG", [](const String &)
+         { Debug_formatCFG(); }},
+        {"formatPDS", [](const String &)
+         { Debug_formatPersistence(); }},
+        {"checkEE", [](const String &)
+         { Debug_CheckEEPOM(false); }},
+        {"checkEEfix", [](const String &)
+         { Debug_CheckEEPOM(true); }},
+        {"dumpEE1k", [](const String &)
+         { dumpEEPROM(0, 1024); }},
+        {"dumpEE", [](const String &args)
+         {
+             int start = 0, len = EEPROM_SIZE_BYTES;
+             auto tokens = splitArgs(args);
+             if (tokens.size() >= 2)
+             {
+                 start = tokens[0].toInt();
+                 len = tokens[1].toInt();
+             }
+             dumpEEPROM(start, len);
+         }},
+        {"resetPageEE", [](const String &)
+         { MovePersistencePage_EEPROM(true); }},
+        {"dumpCFG", [](const String &)
+         { Debug_dumpConfig(); }},
+        {"dumpPDS", [](const String &)
+         { Debug_dumpPersistance(); }},
+        {"saveEE", [](const String &)
+         { globals.requestEEAction = EE_ALL_SAVE; }},
+        {"dumpGlobals", [](const String &)
+         { Debug_dumpGlobals(); }},
+        {"sdbg", [](const String &)
+         { SetDebugportStatus(dbg_Serial, enabled); }},
+        {"dtc_show", [](const String &)
+         { Debug_ShowDTCs(); }},
+        {"dtc_clear", [](const String &)
+         { ClearAllDTC(); }},
+        {"dtc_crit", [](const String &)
+         { MaintainDTC(DTC_FAKE_DTC_CRIT, true, millis()); }},
+        {"dtc_warn", [](const String &)
+         { MaintainDTC(DTC_FAKE_DTC_WARN, true, millis()); }},
+        {"dtc_info", [](const String &)
+         { MaintainDTC(DTC_FAKE_DTC_INFO, true, millis()); }},
+        {"notify_error", [](const String &)
+         { Websocket_PushNotification("Debug Error Notification", error); }},
+        {"notify_warning", [](const String &)
+         { Websocket_PushNotification("Debug Warning Notification", warning); }},
+        {"notify_success", [](const String &)
+         { Websocket_PushNotification("Debug Success Notification", success); }},
+        {"notify_info", [](const String &)
+         { Websocket_PushNotification("Debug Info Notification", info); }},
+        {"reboot", [](const String &)
+         { Debug_Reboot(); }},
+        {"toggle_wifi", [](const String &)
+         { globals.toggle_wifi = true; }},
+        {"dtc_add", [](const String &args)
+         {
+             auto tokens = splitArgs(args);
+             if (!tokens.empty())
+             {
+                 int code = tokens[0].toInt();
+                 MaintainDTC((DTCNum_t)code, true, millis());
+             }
+         }},
+        {"set_battery", [](const String &args)
+         {
+             auto tokens = splitArgs(args);
+             if (!tokens.empty())
+             {
+                 int batteryType = tokens[0].toInt();
+                 Debug_setBatteryType(batteryType);
+             }
+         }}};
+    return cmdMap;
+}
+
+void processCmdDebug(String input)
+{
+    input.trim();
+    int splitIndex = input.indexOf(' ');
+    String command = splitIndex == -1 ? input : input.substring(0, splitIndex);
+    String args = splitIndex == -1 ? "" : input.substring(splitIndex + 1);
+
+    auto &cmdMap = getCmdMap();
+    auto it = cmdMap.find(command);
+    if (it != cmdMap.end())
+        it->second(args);
+    else
+        Debug_log(LOG_WARN, "Unknown command: '%s'\n", command.c_str());
+}
+
+/**
+ * @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 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 resetting to default\n");
+    FormatPersistence_EEPROM();
+}
+
+/**
+ * @brief Prints system information and status to the debug output.
+ */
+void Debug_printSystemInfo()
+{
+    Debug_pushMessage("Hostname: %s\n", globals.DeviceNameId);
+
+    FlashMode_t ideMode = ESP.getFlashChipMode();
+    Debug_pushMessage("Sdk version: %s\n", ESP.getSdkVersion());
+    Debug_pushMessage("Core Version: %s\n", ESP.getCoreVersion().c_str());
+    Debug_pushMessage("Boot Version: %u\n", ESP.getBootVersion());
+    Debug_pushMessage("Boot Mode: %u\n", ESP.getBootMode());
+    Debug_pushMessage("CPU Frequency: %u MHz\n", ESP.getCpuFreqMHz());
+    Debug_pushMessage("Reset reason: %s\n", ESP.getResetReason().c_str());
+    Debug_pushMessage("Flash Size: %d\n", ESP.getFlashChipRealSize());
+    Debug_pushMessage("Flash Size IDE: %d\n", ESP.getFlashChipSize());
+    Debug_pushMessage("Flash ide mode:  %s\n", (ideMode == FM_QIO ? "QIO" : ideMode == FM_QOUT ? "QOUT"
+                                                                        : ideMode == FM_DIO    ? "DIO"
+                                                                        : ideMode == FM_DOUT   ? "DOUT"
+                                                                                               : "UNKNOWN"));
+    Debug_pushMessage("OTA-Pass: %s\n", QUOTE(ADMIN_PASSWORD));
+    Debug_pushMessage("Git-Revision: %s\n", constants.GitHash);
+    Debug_pushMessage("Sw-Version: %d.%02d\n", constants.FW_Version_major, constants.FW_Version_minor);
+
+    Debug_pushMessage("globals.systemStatus: %d\n", globals.systemStatus);
+    Debug_pushMessage("globals.resumeStatus: %d\n", globals.resumeStatus);
+    Debug_pushMessage("globals.systemStatustxt: %s\n", globals.systemStatustxt);
+    Debug_pushMessage("globals.requestEEAction: %d\n", globals.requestEEAction);
+    Debug_pushMessage("globals.DeviceName: %s\n", globals.DeviceName);
+    Debug_pushMessage("globals.FlashVersion: %s\n", globals.FlashVersion);
+    Debug_pushMessage("globals.eePersistanceAdress: %u\n", globals.eePersistanceAdress);
+    Debug_pushMessage("globals.hasDTC: %d\n", globals.hasDTC);
+    Debug_pushMessage("globals.loadvoltage_mV: %d\n", globals.loadvoltage_mV);
+    Debug_pushMessage("globals.battery_level: %d\n", globals.battery_level);
+    Debug_pushMessage("globals.timer_disabled: %d\n", globals.timer_disabled);
+}
+
+/**
+ * @brief Dumps the current configuration parameters to the debug output.
+ */
+void Debug_dumpConfig()
+{
+    Debug_pushMessage("batteryType: %d\n", ConfigData.batteryType);
+    Debug_pushMessage("Faction_1_Name: %s\n", ConfigData.Faction_1_Name);
+    Debug_pushMessage("Faction_1_Name: %s\n", ConfigData.Faction_2_Name);
+    Debug_pushMessage("Faction_1_Name: %s\n", ConfigData.Faction_3_Name);
+    Debug_pushMessage("active_faction_on_reboot: %d\n", ConfigData.active_faction_on_reboot);
+    Debug_pushMessage("wifi_autoconnect: %d\n", ConfigData.wifi_autoconnect);
+    Debug_pushMessage("wifi_client_ssid: %s\n", ConfigData.wifi_client_ssid);
+    Debug_pushMessage("wifi_client_password: %s\n", ConfigData.wifi_client_password);
+    Debug_pushMessage("EEPROM_Version: %d\n", ConfigData.EEPROM_Version);
+    Debug_pushMessage("checksum: 0x%08X\n", ConfigData.checksum);
+}
+
+/**
+ * @brief Dumps the global variables and their values to the debug output.
+ */
+void Debug_dumpGlobals()
+{
+    Debug_pushMessage("systemStatus: %d\n", globals.systemStatus);
+    Debug_pushMessage("battery_level: %d\n", globals.battery_level);
+    Debug_pushMessage("loadvoltage_mV: %d\n", globals.loadvoltage_mV);
+    Debug_pushMessage("requestEEAction: %d\n", globals.requestEEAction);
+    Debug_pushMessage("DeviceName: %s\n", globals.DeviceName);
+    Debug_pushMessage("FlashVersion: %s\n", globals.FlashVersion);
+    Debug_pushMessage("eePersistanceAdress: %d\n", globals.eePersistanceAdress);
+    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\n", PersistenceData.writeCycleCounter);
+    Debug_pushMessage("activeFaction: %d\n", PersistenceData.activeFaction);
+    Debug_pushMessage("faction_1_timer: %d\n", PersistenceData.faction_1_timer);
+    Debug_pushMessage("faction_2_timer: %d\n", PersistenceData.faction_2_timer);
+    Debug_pushMessage("faction_3_timer: %d\n", PersistenceData.faction_3_timer);
+    Debug_pushMessage("checksum: %d\n", PersistenceData.checksum);
+    Debug_pushMessage("PSD Adress: 0x%04X\n", globals.eePersistanceAdress);
+}
+
+/**
+ * @brief Prints information related to WiFi to the debug output.
+ */
+void Debug_printWifiInfo()
+{
+    char buffer[33];
+    GenerateDeviceSpecificPassword(QUOTE(WIFI_PASS_SEED), buffer, sizeof(buffer));
+    Debug_pushMessage("IP Adress: %s\n", WiFi.localIP().toString().c_str());
+    Debug_pushMessage("WiFi AP Pw: %s\n", buffer);
+}
+
+void Debug_setBatteryType(int batterytype)
+{
+
+    switch (batterytype)
+    {
+    case 2:
+        ConfigData.batteryType = BATTERY_LIPO_2S;
+        break;
+    case 3:
+        ConfigData.batteryType = BATTERY_LIPO_3S;
+        break;
+    default:
+        ConfigData.batteryType = BATTERY_UNDEFINED;
+        break;
+    }
+
+    Debug_pushMessage("Set BatteryType to : %d\n", batterytype);
+    globals.requestEEAction = EE_CFG_SAVE;
+}
+
+/**
+ * @brief Checks the EEPROM data integrity by calculating and comparing checksums.
+ *        Prints the result to the debug output.
+ */
+void Debug_CheckEEPOM(bool autocorrect)
+{
+    // Check PersistenceData EEPROM checksum
+    uint32_t checksum = PersistenceData.checksum;
+    PersistenceData.checksum = 0;
+
+    if (Checksum_EEPROM((uint8_t *)&PersistenceData, sizeof(PersistenceData)) == checksum)
+    {
+        Debug_pushMessage("PersistenceData EEPROM Checksum OK\n");
+    }
+    else
+    {
+        Debug_pushMessage("PersistenceData EEPROM Checksum BAD\n");
+    }
+
+    PersistenceData.checksum = checksum;
+
+    // Check ConfigData EEPROM checksum
+    checksum = ConfigData.checksum;
+    ConfigData.checksum = 0;
+
+    if (Checksum_EEPROM((uint8_t *)&ConfigData, sizeof(ConfigData)) == checksum)
+    {
+        Debug_pushMessage("ConfigData EEPROM Checksum OK\n");
+    }
+    else
+    {
+        Debug_pushMessage("ConfigData EEPROM Checksum BAD\n");
+    }
+    ConfigData.checksum = checksum;
+
+    uint32_t sanitycheck = ConfigSanityCheck(autocorrect);
+
+    if (sanitycheck == 0)
+    {
+        Debug_pushMessage("ConfigData Sanity Check OK\n");
+    }
+    else
+    {
+        Debug_pushMessage("ConfigData Sanity Check BAD: %s\n", uint32_to_binary_string(sanitycheck));
+    }
+}
+
+/**
+ * @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
+
+            // Determine DTC status
+            if (DTCStorage[i].active == DTC_ACTIVE)
+                strcpy(buff_active, "active");
+            else if (DTCStorage[i].active == DTC_PREVIOUS)
+                strcpy(buff_active, "previous");
+            else
+                strcpy(buff_active, "none");
+
+            // Display DTC information
+            Debug_pushMessage("%s   %7d   %8s   %8d\n", buff_timestamp, DTCStorage[i].Number, buff_active);
+        }
+    }
+}
+
+/**
+ * @brief Initiates a system reboot by setting the system status to shutdown.
+ *
+ * This function sets the global system status to `sysStat_Shutdown`,
+ * which will trigger a system reboot sequence.
+ */
+void Debug_Reboot()
+{
+    globals.systemStatus = sysStat_Shutdown;
+}
+
+/**
+ * @brief Processes a debug command.
+ *
+ * This function takes a pointer to a debug command and processes it by
+ * passing it to the `processCmdDebug` function. The command is expected
+ * to be a string, so it is cast to `const char *` before being processed.
+ *
+ * @param command Pointer to the debug command, expected to be a null-terminated string.
+ */
+void Debug_ProcessCommand(uint8_t *command)
+{
+    processCmdDebug((const char *)command);
+}
+
+/**
+ * @brief Convert a uint32_t value to a binary string with nibbles separated by a space.
+ *
+ * This function takes a uint32_t value and converts it to a binary string
+ * representation. The binary string is stored in a static buffer and returned
+ * as a const char pointer. Each nibble (4 bits) in the binary representation
+ * is separated by a space. The buffer is overwritten on subsequent calls to
+ * this function.
+ *
+ * @param num The uint32_t value to convert.
+ * @return A pointer to a const char string containing the binary representation
+ * of the input number with nibbles separated by a space.
+ */
+const char *uint32_to_binary_string(uint32_t num)
+{
+    static char binary_str[65]; // 32 bits + 31 spaces + null terminator
+    int i, j;
+    for (i = 31, j = 0; i >= 0; i--, j++)
+    {
+        binary_str[j] = ((num >> i) & 1) ? '1' : '0';
+        if (i % 4 == 0 && i != 0)
+        {
+            binary_str[++j] = ' '; // Insert space after every nibble
+        }
+    }
+    binary_str[j] = '\0'; // Null terminator
+    return binary_str;
+}

Software/src/dtc.cpp

@@ -1,70 +1,121 @@
+/**
+ * @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, boolean active)
+// 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)
             {
-                Serial.printf("DTC gone active: %d", DTC_no);
+                Debug_pushMessage("DTC gone active: %d, DebugVal: %d\n", DTC_no, DebugValue);
                 DTCStorage[i].timestamp = millis();
                 DTCStorage[i].active = DTC_ACTIVE;
+                DTCStorage[i].debugVal = DebugValue;
             }
+            // If the DTC is not active anymore, update its status to previous
             if (!active && DTCStorage[i].active == DTC_ACTIVE)
             {
-                Serial.printf("DTC gone previous: %d", DTC_no);
+                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)
             {
-                Serial.printf("new DTC registered: %d", DTC_no);
+                Debug_pushMessage("new DTC registered: %d, DebugVal: %d\n", DTC_no, DebugValue);
                 DTCStorage[i].Number = DTC_no;
                 DTCStorage[i].timestamp = millis();
                 DTCStorage[i].active = DTC_ACTIVE;
-                return;
+                DTCStorage[i].debugVal = DebugValue;
+                return; // New DTC registered, exit the function
             }
         }
     }
 }
 
-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;
@@ -83,3 +134,63 @@ DTCNums_t getlastDTC(boolean only_active)
 
     return pointer >= 0 ? DTCStorage[pointer].Number : DTC_LAST_DTC;
 }
+
+/**
+ * @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)
+{
+    for (int i = 0; i < DTC_LAST_DTC; i++)
+    {
+        if (dtc_definitions[i].code == targetCode)
+        {
+            return dtc_definitions[i].severity;
+        }
+    }
+    return DTC_NONE;
+}
+
+/**
+ * @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 (lastDTC < DTC_LAST_DTC)
+    {
+        globals.hasDTC = true;
+
+        if (getSeverityForDTC(lastDTC) == DTC_CRITICAL && globals.systemStatus != sysStat_Shutdown)
+        {
+            if (globals.systemStatus != sysStat_Error)
+            {
+                preserverSysStatusError = globals.systemStatus;
+            }
+            globals.systemStatus = sysStat_Error;
+        }
+    }
+    else
+    {
+        globals.hasDTC = false;
+
+        if (globals.systemStatus == sysStat_Error)
+        {
+            globals.systemStatus = preserverSysStatusError;
+        }
+    }
+}

Software/src/dtc.h

@@ -1,39 +0,0 @@
-#ifndef _DTC_H_
-#define _DTC_H_
-
-#include <Arduino.h>
-
-#define MAX_DTC_STORAGE 6
-
-typedef enum DTCNums_e
-{
-  DTC_NO_EEPROM_FOUND,
-  DTC_EEPROM_CFG_BAD,
-  DTC_EEPROM_PDS_BAD,
-  DTC_EEPROM_VERSION_BAD,
-  DTC_EEPROM_WORNOUT,                 // this will happen if the EEPROM-cells are all overwritten 1 million times!
-  DTC_EEPROM_PDS_MARKER_INVALID,      // This happens if the Marker of the PersistanceData was pointing to an EE-Adress bigger than the used EEPROM-IC
-  DTC_LAST_DTC
-} DTCNums_t;
-
-typedef enum DTCActive_e
-{
-  DTC_ACTIVE,
-  DTC_PREVIOUS,
-  DTC_NONE
-} DTCActive_t;
-
-typedef struct DTCEntry_s
-{
-  DTCNums_t Number;
-  uint32_t timestamp;
-  DTCActive_t active;
-} DTCEntry_t;
-
-void MaintainDTC(DTCNums_t DTC_no, boolean active);
-void ClearDTC(DTCNums_t DTC_no);
-void ClearAllDTC();
-DTCNums_t getlastDTC(boolean only_active);
-
-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_BAT_CRITICAL;   DTC_CRITICAL;              Akku leer;  Akku ist komplett leer. Den Akku aufladen!
+    2;                   DTC_BAT_LOW;       DTC_WARN;           Akku niedrig;  Akku ist unter der Warnschwelle. Den Akku demnächst aufladen
+    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_BATMNON_FOUND;   DTC_CRITICAL;  Keine Akkuüberwachung;  Es wurde keine Akkuüberwachung über I2C gefunden, Prüfen sie die Hardware!
+   11;             DTC_NO_LORA_FOUND;   DTC_CRITICAL; LoRa-Transceiver Error;  Es konnte keine Verbindung zum LoRa-Transceiver hergestellt werden. Prüfen Sie die Hardware auf Defekte
+   12;         DTC_EEPROM_CFG_SANITY;       DTC_WARN;     Config-Validierung;  Ein oder mehrer Einstellungswerte sind ausserhalb plausibler Werte. Prüfen Sie Ihre Einstellungen
+   13;     DTC_EEPROM_MIGRATE_FAILED;   DTC_CRITICAL;       EEPROM-Migration;  Es wurde ein altes EEPROm Image erkannt, konnte aber nicht migriert werden. EEPROM manuell zurück setzen und neue Einstellunge speichern.
+   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/eeprom.cpp

@@ -0,0 +1,460 @@
+/**
+ * @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 "eeprom.h"
+#include "debugger.h"
+#include "globals.h"
+#include "utilities.h"
+
+// Instance of I2C_eeprom for EEPROM access
+I2C_eeprom ee(I2C_EE_ADDRESS, EEPROM_SIZE_BYTES);
+
+// Configuration and persistence data structures
+configData_t ConfigData;
+persistenceData_t PersistenceData;
+
+// EEPROM version identifier
+const uint16_t eeVersion = EEPROM_STRUCTURE_REVISION;
+
+// Flag indicating whether EEPROM is available
+boolean eeAvailable = false;
+
+// Offsets within EEPROM for ConfigData and PersistenceData
+const uint16_t startofConfigData = 16;
+const uint16_t startofPersistence = 16 + sizeof(ConfigData) + (sizeof(ConfigData) % 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.
+ */
+boolean InitEEPROM()
+{
+  Wire.begin();
+  ConfigData = ConfigData_defaults;
+  PersistenceData = {0};
+  ee.begin();
+  return 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)
+  {
+  case EE_CFG_SAVE:
+    StoreConfig_EEPROM();
+    globals.requestEEAction = EE_IDLE;
+    Debug_pushMessage("Stored EEPROM CFG\n");
+    break;
+  case EE_CFG_LOAD:
+    GetConfig_EEPROM();
+    globals.requestEEAction = EE_IDLE;
+    Debug_pushMessage("Loaded EEPROM CFG\n");
+    break;
+  case EE_CFG_FORMAT:
+    FormatConfig_EEPROM();
+    globals.requestEEAction = EE_IDLE;
+    GetConfig_EEPROM();
+    Debug_pushMessage("Formatted EEPROM CFG\n");
+    break;
+  case EE_PDS_SAVE:
+    StorePersistence_EEPROM();
+    globals.requestEEAction = EE_IDLE;
+    Debug_pushMessage("Stored EEPROM PDS\n");
+    break;
+  case EE_PDS_LOAD:
+    GetPersistence_EEPROM();
+    globals.requestEEAction = EE_IDLE;
+    Debug_pushMessage("Loaded EEPROM PDS\n");
+    break;
+  case EE_PDS_FORMAT:
+    FormatPersistence_EEPROM();
+    globals.requestEEAction = EE_IDLE;
+    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("Formatted EEPROM ALL\n");
+    break;
+  case EE_ALL_SAVE:
+    StorePersistence_EEPROM();
+    StoreConfig_EEPROM();
+    globals.requestEEAction = EE_IDLE;
+    Debug_pushMessage("Stored EEPROM ALL\n");
+    break;
+  case EE_IDLE:
+  default:
+    globals.requestEEAction = EE_IDLE;
+  }
+}
+
+/**
+ * @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()
+{
+  // Berechnung der Prüfsumme
+  ConfigData.checksum = 0;
+  ConfigData.checksum = Checksum_EEPROM((uint8_t *)&ConfigData, sizeof(ConfigData));
+
+  // Überprüfung, ob der EEPROM verfügbar ist
+  if (!checkEEPROMavailable())
+    return;
+
+  // Byteweise in den EEPROM schreiben
+  uint8_t *dataPtr = (uint8_t *)&ConfigData;
+  for (uint16_t i = 0; i < sizeof(ConfigData); i++)
+  {
+    ee.writeByte(startofConfigData + i, dataPtr[i]);
+  }
+
+  // Sanity Check der Konfiguration
+  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())
+    return;
+
+  ee.readBlock(startofConfigData, (uint8_t *)&ConfigData, sizeof(ConfigData));
+
+  uint32_t checksum = ConfigData.checksum;
+  ConfigData.checksum = 0;
+
+  MaintainDTC(DTC_EEPROM_CFG_BAD, (Checksum_EEPROM((uint8_t *)&ConfigData, sizeof(ConfigData)) != checksum));
+
+  ConfigData.checksum = checksum;
+
+  uint32_t ConfigSanityCheckResult = ConfigSanityCheck(true);
+
+  MaintainDTC(DTC_EEPROM_CFG_SANITY, (ConfigSanityCheckResult > 0), ConfigSanityCheckResult);
+}
+
+/**
+ * @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)
+    MovePersistencePage_EEPROM(false);
+  else
+    PersistenceData.writeCycleCounter++;
+
+  PersistenceData.checksum = 0;
+  PersistenceData.checksum = Checksum_EEPROM((uint8_t *)&PersistenceData, sizeof(PersistenceData));
+
+  if (!checkEEPROMavailable())
+    return;
+
+  // Byteweise in den EEPROM schreiben
+  uint8_t *dataPtr = (uint8_t *)&PersistenceData;
+  for (uint16_t i = 0; i < sizeof(PersistenceData); i++)
+  {
+    ee.writeByte(globals.eePersistanceAdress + i, dataPtr[i]);
+  }
+}
+
+/**
+ * @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())
+    return;
+
+  ee.readBlock(0, (uint8_t *)&globals.eePersistanceAdress, sizeof(globals.eePersistanceAdress));
+  // if we got the StartAdress of Persistance and it's out of Range - we Reset it and store defaults
+  // otherwise we Read from eeprom and check if everything is correct
+  if (globals.eePersistanceAdress < startofPersistence || globals.eePersistanceAdress > ee.getDeviceSize())
+  {
+    MovePersistencePage_EEPROM(true);
+    FormatPersistence_EEPROM();
+    MaintainDTC(DTC_EEPROM_PDSADRESS_BAD, true);
+  }
+  else
+  {
+    ee.readBlock(globals.eePersistanceAdress, (uint8_t *)&PersistenceData, sizeof(PersistenceData));
+
+    uint32_t checksum = PersistenceData.checksum;
+    PersistenceData.checksum = 0;
+
+    MaintainDTC(DTC_EEPROM_PDS_BAD, (Checksum_EEPROM((uint8_t *)&PersistenceData, sizeof(PersistenceData)) != checksum));
+
+    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");
+  ConfigData = ConfigData_defaults;
+  ConfigData.EEPROM_Version = eeVersion;
+  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");
+  PersistenceData = {0};
+  // 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);
+  PersistenceData.writeCycleCounter = 0;
+
+  // 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;
+  }
+
+  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 = 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
+
+  if (!checkEEPROMavailable())
+    return;
+
+  char ascii_buf[BLOCK_TO_LENGTH + 1] = {0};
+  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)
+    {
+      if (i > 0) // Ensure we don't print an empty ASCII buffer on the first iteration
+      {
+        ascii_buf[BLOCK_TO_LENGTH] = 0;
+        Debug_pushMessage("  %s", ascii_buf);
+      }
+      Debug_pushMessage("\n0x%05X:", memoryAddress);
+      memset(ascii_buf, ' ', BLOCK_TO_LENGTH); // Clear the ASCII buffer with spaces
+    }
+
+    // Read and print each byte
+    uint8_t byte = ee.readByte(memoryAddress);
+    ascii_buf[blockpoint] = (byte >= 0x20 && byte <= 0x7E) ? byte : '.';
+    Debug_pushMessage(" %02X", byte);
+
+    memoryAddress++;
+  }
+
+  // Print remaining ASCII buffer
+  ascii_buf[BLOCK_TO_LENGTH] = 0;
+  Debug_pushMessage("  %s\n", ascii_buf); // Final ASCII line
+}
+
+/**
+ * @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())
+  {
+    // Trigger DTC for no EEPROM found
+    MaintainDTC(DTC_NO_EEPROM_FOUND, true);
+    return 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 (!validateWiFiString(ConfigData.wifi_client_ssid, sizeof(ConfigData.wifi_client_ssid)))
+  {
+    SET_BIT(setting_reset_bits, 0);
+    if (autocorrect)
+      strncpy(ConfigData.wifi_client_ssid, ConfigData_defaults.wifi_client_ssid, sizeof(ConfigData.wifi_client_ssid));
+  }
+
+  if (!validateWiFiString(ConfigData.wifi_client_password, sizeof(ConfigData.wifi_client_password)))
+  {
+    SET_BIT(setting_reset_bits, 1);
+    if (autocorrect)
+      strncpy(ConfigData.wifi_client_password, ConfigData_defaults.wifi_client_password, sizeof(ConfigData.wifi_client_password));
+  }
+  // Return the bitmask indicating which settings need to be reset
+  return setting_reset_bits;
+}
+
+
+/**
+ * @brief Write sequential numbers to a portion of EEPROM.
+ *
+ * This function writes sequential numbers starting from 0 to a specified portion of EEPROM.
+ * If the number reaches 255, it wraps around and starts again from 1.
+ *
+ * @param memoryAddress Starting address in EEPROM.
+ * @param length Number of bytes to write.
+ */
+void writeSequentialToEEPROM(uint16_t memoryAddress, uint16_t length)
+{
+  if (!checkEEPROMavailable())
+    return;
+
+  uint8_t value = 0;
+  for (uint16_t i = 0; i < length; i++)
+  {
+    ee.writeByte(memoryAddress + i, value);
+    value = (value == 255) ? 1 : value + 1;
+  }
+}
+
+/**
+ * @brief Write 0 to a portion of EEPROM.
+ *
+ * This function writes 0 to a specified portion of EEPROM.
+ *
+ * @param memoryAddress Starting address in EEPROM.
+ * @param length Number of bytes to write.
+ */
+void writeZeroToEEPROM(uint16_t memoryAddress, uint16_t length)
+{
+  if (!checkEEPROMavailable())
+    return;
+
+  for (uint16_t i = 0; i < length; i++)
+  {
+    ee.writeByte(memoryAddress + i, 0);
+  }
+}

Software/src/globals.cpp

@@ -0,0 +1,11 @@
+#include "globals.h"
+
+Globals_t globals;
+
+void initGlobals()
+{
+  globals.systemStatus = sysStat_Startup;
+  globals.requestEEAction = EE_IDLE;
+  globals.systemStatustxt[0] = 0;
+  globals.toggle_wifi = false;
+}

Software/src/globals.h

@@ -1,36 +0,0 @@
-#ifndef _GLOBALS_H_
-#define _GLOBALS_H_
-
-#include <Arduino.h>
-
-typedef enum eSystem_Status
-{
-  sysStat_Startup,
-  sysStat_Normal,
-  sysStat_Error,
-  sysStat_Shutdown
-} tSystem_Status;
-
-typedef enum eEERequest
-{
-  EE_IDLE,
-  EE_CFG_SAVE,
-  EE_CFG_LOAD,
-  EE_PDS_SAVE,
-  EE_PDS_LOAD
-} tEERequest;
-
-typedef struct Globals_s
-{
-  char DeviceName[33];
-  char DeviceName_ID[43];
-  tSystem_Status systemStatus = sysStat_Startup;
-  tSystem_Status resumeStatus = sysStat_Startup;
-  eEERequest requestEEAction = EE_IDLE;
-  float loadvoltage = 0;
-  int battery_level = 0;
-} Globals_t;
-
-extern Globals_t globals;
-
-#endif

Software/src/lora_net.cpp

@@ -0,0 +1,373 @@
+#include "lora_net.h"
+
+#ifdef FEATURE_ENABLE_LORA
+LoRa_E220 e220ttl(GPIO_LORA_TX, GPIO_LORA_RX, GPIO_LORA_AUX, 3, 4); // Arduino RX <-- e220 TX, Arduino TX --> e220 RX AUX M0 M1
+void printParameters(struct Configuration configuration);
+void printModuleInformation(struct ModuleInformation moduleInformation);
+#elif defined(FEATURE_ENABLE_UARTLORA)
+SoftwareSerial SerialLoRa(GPIO_LORA_RX, GPIO_LORA_TX); // RX, TX
+void Parse_LoRa_UartCommand(char input[], int size);
+#endif
+
+bool InitLoRa(void (*MPinHelper)(int, int))
+{
+    bool returnval = false;
+
+#ifdef FEATURE_ENABLE_LORA
+
+    e220ttl.setMPins = MPinHelper;
+    returnval = e220ttl.begin();
+
+    if (returnval == true)
+    {
+        ResponseStructContainer c;
+        c = e220ttl.getConfiguration();
+        // It's important get configuration pointer before all other operation
+        Configuration configuration = *(Configuration *)c.data;
+        Serial.println(c.status.getResponseDescription());
+        Serial.println(c.status.code);
+
+        ResponseStructContainer cMi;
+        cMi = e220ttl.getModuleInformation();
+        // It's important get information pointer before all other operation
+        // ModuleInformation mi = *(ModuleInformation *)cMi.data;
+
+        Serial.println(cMi.status.getResponseDescription());
+        Serial.println(cMi.status.code);
+
+        //	----------------------- DEFAULT TRANSPARENT WITH RSSI -----------------------
+        configuration.ADDL = 0x02;
+        configuration.ADDH = 0x00;
+
+        configuration.CHAN = 23;
+
+        configuration.SPED.uartBaudRate = UART_BPS_9600;
+        configuration.SPED.airDataRate = AIR_DATA_RATE_010_24;
+        configuration.SPED.uartParity = MODE_00_8N1;
+
+        configuration.OPTION.subPacketSetting = SPS_200_00;
+        configuration.OPTION.RSSIAmbientNoise = RSSI_AMBIENT_NOISE_ENABLED;
+        configuration.OPTION.transmissionPower = POWER_22;
+
+        configuration.TRANSMISSION_MODE.enableRSSI = RSSI_ENABLED;
+        configuration.TRANSMISSION_MODE.fixedTransmission = FT_FIXED_TRANSMISSION;
+        configuration.TRANSMISSION_MODE.enableLBT = LBT_ENABLED;
+        configuration.TRANSMISSION_MODE.WORPeriod = WOR_2000_011;
+
+        // Set configuration changed and set to not hold the configuration
+        ResponseStatus rs = e220ttl.setConfiguration(configuration, WRITE_CFG_PWR_DWN_LOSE);
+        Serial.println(rs.getResponseDescription());
+        Serial.println(rs.code);
+        c.close();
+
+        printParameters(configuration);
+    }
+    else
+    {
+        MaintainDTC(DTC_NO_LORA_FOUND, DTC_WARN, true);
+    }
+#elif defined(FEATURE_ENABLE_UARTLORA)
+    SerialLoRa.begin(9600);
+    returnval = true;
+#endif
+    return returnval;
+}
+
+void LoRa_Process()
+{
+#ifdef FEATURE_ENABLE_LORA
+    if (e220ttl.available() > 1)
+    {
+        ResponseContainer rc = e220ttl.receiveMessageRSSI();
+        // If something goes wrong, print error
+        if (rc.status.code != 1)
+        {
+            Serial.println(rc.status.getResponseDescription());
+        }
+        else
+        {
+            // Print the data received
+            Serial.println(rc.status.getResponseDescription());
+            Serial.println(rc.data);
+            Serial.print("RSSI: ");
+            Serial.println(rc.rssi, DEC);
+        }
+    }
+#elif defined(FEATURE_ENABLE_UARTLORA)
+
+    static char packageInput[32];
+    static bool packageReceived = false;
+    static unsigned int bufferPtr = 0;
+    int receivedSize = 0;
+
+    while (SerialLoRa.available() && !packageReceived)
+    {
+        char c = SerialLoRa.read();
+
+        // CR ignorieren (falls CRLF)
+        if (c == '\r')
+        {
+            continue;
+        }
+
+        if (c == '\n')
+        {
+            // Zeilenende: String sauber terminieren, Größe setzen
+            packageInput[bufferPtr] = '\0';
+            receivedSize = bufferPtr;
+            bufferPtr = 0;
+            packageReceived = true;
+            Debug_pushMessage("Got LoRa UART: %s\n", packageInput);
+            break;
+        }
+
+        // Optional: in Uppercase wandeln (macht Kommandos robust)
+        if (c >= 'a' && c <= 'z')
+            c = (char)(c - 'a' + 'A');
+
+        // Erlaubte Zeichen (Ziffern, Großbuchstaben, Space, Komma, Punkt, Semikolon)
+        bool allowed =
+            (c >= '0' && c <= '9') ||
+            (c >= 'A' && c <= 'Z') ||
+            (c == ' ' || c == ',' || c == '.' || c == ';');
+
+        if (allowed)
+        {
+            if (bufferPtr < sizeof(packageInput) - 1)
+            {
+                packageInput[bufferPtr++] = c;
+                packageInput[bufferPtr] = '\0'; // immer NUL-terminiert halten
+            }
+            else
+            {
+                Debug_pushMessage("Buffer overflow. Resetting buffer.\n");
+                bufferPtr = 0;
+            }
+        }
+        else
+        {
+            Debug_pushMessage("Invalid character received: %c\n", c);
+        }
+    }
+
+    if (packageReceived)
+    {
+        // Hinweis: receivedSize ist jetzt strlen(packageInput), ohne \n/\r
+        Parse_LoRa_UartCommand(packageInput, receivedSize);
+        packageReceived = false;
+    }
+
+#endif
+}
+
+void sendStatus_LoRa()
+{
+#ifdef FEATURE_ENABLE_LORA
+    struct
+    {
+        MessageType_t type = "STATUS";
+        MessageStatus_t status;
+    } __attribute__((packed)) sendStatus;
+
+    sendStatus.status.nodeid = 0x0002;
+    sendStatus.status.millis = millis();
+    sendStatus.status.faction_active = 1;
+    sendStatus.status.faction_1_timer = 0xBBBBBBBB;
+    sendStatus.status.faction_2_timer = 0xCCCCCCCC;
+    sendStatus.status.faction_3_timer = 0xDDDDDDDD;
+
+    ResponseStatus rs = e220ttl.sendFixedMessage(0xFF, 0xFF, 23, (byte *)&sendStatus, sizeof(sendStatus));
+    Serial.println(rs.getResponseDescription());
+
+#elif defined(FEATURE_ENABLE_UARTLORA)
+
+    SerialLoRa.print(PersistenceData.faction_1_timer);
+    SerialLoRa.write(";");
+    SerialLoRa.print(PersistenceData.faction_2_timer);
+    SerialLoRa.write(";");
+    SerialLoRa.print(PersistenceData.faction_3_timer);
+    SerialLoRa.write(";");
+    SerialLoRa.print(PersistenceData.activeFaction);
+    SerialLoRa.write(";");
+    SerialLoRa.print(globals.battery_level);
+    SerialLoRa.write('\n');
+
+#endif
+}
+
+#ifdef FEATURE_ENABLE_LORA
+
+void printParameters(struct Configuration configuration)
+{
+    Serial.println("----------------------------------------");
+
+    Serial.print(F("HEAD : "));
+    Serial.print(configuration.COMMAND, HEX);
+    Serial.print(" ");
+    Serial.print(configuration.STARTING_ADDRESS, HEX);
+    Serial.print(" ");
+    Serial.println(configuration.LENGHT, HEX);
+    Serial.println(F(" "));
+    Serial.print(F("AddH : "));
+    Serial.println(configuration.ADDH, HEX);
+    Serial.print(F("AddL : "));
+    Serial.println(configuration.ADDL, HEX);
+    Serial.println(F(" "));
+    Serial.print(F("Chan : "));
+    Serial.print(configuration.CHAN, DEC);
+    Serial.print(" -> ");
+    Serial.println(configuration.getChannelDescription());
+    Serial.println(F(" "));
+    Serial.print(F("SpeedParityBit     : "));
+    Serial.print(configuration.SPED.uartParity, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.SPED.getUARTParityDescription());
+    Serial.print(F("SpeedUARTDatte     : "));
+    Serial.print(configuration.SPED.uartBaudRate, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.SPED.getUARTBaudRateDescription());
+    Serial.print(F("SpeedAirDataRate   : "));
+    Serial.print(configuration.SPED.airDataRate, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.SPED.getAirDataRateDescription());
+    Serial.println(F(" "));
+    Serial.print(F("OptionSubPacketSett: "));
+    Serial.print(configuration.OPTION.subPacketSetting, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.OPTION.getSubPacketSetting());
+    Serial.print(F("OptionTranPower    : "));
+    Serial.print(configuration.OPTION.transmissionPower, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.OPTION.getTransmissionPowerDescription());
+    Serial.print(F("OptionRSSIAmbientNo: "));
+    Serial.print(configuration.OPTION.RSSIAmbientNoise, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.OPTION.getRSSIAmbientNoiseEnable());
+    Serial.println(F(" "));
+    Serial.print(F("TransModeWORPeriod : "));
+    Serial.print(configuration.TRANSMISSION_MODE.WORPeriod, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.TRANSMISSION_MODE.getWORPeriodByParamsDescription());
+    Serial.print(F("TransModeEnableLBT : "));
+    Serial.print(configuration.TRANSMISSION_MODE.enableLBT, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.TRANSMISSION_MODE.getLBTEnableByteDescription());
+    Serial.print(F("TransModeEnableRSSI: "));
+    Serial.print(configuration.TRANSMISSION_MODE.enableRSSI, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.TRANSMISSION_MODE.getRSSIEnableByteDescription());
+    Serial.print(F("TransModeFixedTrans: "));
+    Serial.print(configuration.TRANSMISSION_MODE.fixedTransmission, BIN);
+    Serial.print(" -> ");
+    Serial.println(configuration.TRANSMISSION_MODE.getFixedTransmissionDescription());
+
+    Serial.println("----------------------------------------");
+}
+#endif
+#ifdef FEATURE_ENABLE_UARTLORA
+#include <ctype.h>
+
+static void rstrip(char *s)
+{
+    size_t n = strlen(s);
+    while (n && (s[n - 1] == '\r' || s[n - 1] == '\n' || isspace((unsigned char)s[n - 1])))
+    {
+        s[--n] = '\0';
+    }
+}
+static void lstrip(char *s)
+{
+    size_t i = 0, n = strlen(s);
+    while (i < n && isspace((unsigned char)s[i]))
+        i++;
+    if (i)
+        memmove(s, s + i, n - i + 1);
+}
+
+void Parse_LoRa_UartCommand(char input[], int size)
+{
+    Debug_pushMessage("Start parsing, size: %d\n", size);
+
+    // Auf mehreren Delimitern splitten: ;, CR, LF, Tabs/Spaces
+    const char *delims = ";\r\n\t ";
+    char *ptr;
+
+    // erstes Token (Kommando)
+    ptr = strtok(input, delims);
+    if (!ptr)
+    {
+        Debug_pushMessage("No command token\n");
+        return;
+    }
+
+    char command[16];
+    strncpy(command, ptr, sizeof(command) - 1);
+    command[sizeof(command) - 1] = '\0';
+    lstrip(command);
+    rstrip(command);
+
+    // zweites Token (optional: Wert)
+    ptr = strtok(NULL, delims);
+    char value[16] = {0};
+    if (ptr)
+    {
+        strncpy(value, ptr, sizeof(value) - 1);
+        value[sizeof(value) - 1] = '\0';
+        lstrip(value);
+        rstrip(value);
+    }
+
+    Debug_pushMessage("Parsed LoRa UART Command: %s  Value: %s\n", command, value);
+
+    if (!strcmp(command, "ENABLE"))
+    {
+        globals.timer_disabled = false;
+        Debug_pushMessage("Enabled by LoRa\n");
+    }
+    else if (!strcmp(command, "DISABLE"))
+    {
+        globals.timer_disabled = true;
+        Debug_pushMessage("Disabled by LoRa\n");
+    }
+    else if (!strcmp(command, "RESET"))
+    {
+        PersistenceData.activeFaction = NONE;
+        PersistenceData.faction_1_timer = 0;
+        PersistenceData.faction_2_timer = 0;
+        PersistenceData.faction_3_timer = 0;
+        Debug_pushMessage("Reset by LoRa\n");
+    }
+    else if (!strcmp(command, "TMRSTP"))
+    {
+        PersistenceData.activeFaction = NONE;
+    }
+    else if (!strcmp(command, "TMR1"))
+    {
+        PersistenceData.faction_1_timer = atol(value);
+    }
+    else if (!strcmp(command, "TMR2"))
+    {
+        PersistenceData.faction_2_timer = atol(value);
+    }
+    else if (!strcmp(command, "TMR3"))
+    {
+        PersistenceData.faction_3_timer = atol(value);
+    }
+    else if (!strcmp(command, "EFAC1"))
+    {
+        PersistenceData.activeFaction = FACTION_1;
+    }
+    else if (!strcmp(command, "EFAC2"))
+    {
+        PersistenceData.activeFaction = FACTION_2;
+    }
+    else if (!strcmp(command, "EFAC3"))
+    {
+        PersistenceData.activeFaction = FACTION_3;
+    }
+    else
+    {
+        Debug_pushMessage("Unknown command: %s\n", command);
+    }
+}
+#endif

Software/src/oled_display.cpp

@@ -1,42 +0,0 @@
-#include "oled_display.h"
-
-Adafruit_SSD1306 display(SCREEN_WIDTH, SCREEN_HEIGHT, &Wire, OLED_RST);
-
-void OLED_Init()
-{
-
-    // reset OLED display via software
-    pinMode(OLED_RST, OUTPUT);
-    digitalWrite(OLED_RST, LOW);
-    delay(20);
-    digitalWrite(OLED_RST, HIGH);
-
-    // initialize OLED
-    Wire.begin(OLED_SDA, OLED_SCL);
-    if (!display.begin(SSD1306_SWITCHCAPVCC, 0x3c, false, false))
-    { // Address 0x3C for 128x32
-        Serial.println(F("SSD1306 allocation failed"));
-    }
-
-    display.clearDisplay();
-    display.setTextColor(WHITE);
-    display.setTextSize(1);
-    display.setCursor(0, 0);
-    display.print("DISPLAY INIT");
-    display.display();
-}
-
-void OLED_Process()
-{
-
-    display.clearDisplay();
-    display.setCursor(0, 0);
-    display.printf("LiPo: %d%%\n", globals.battery_level);
-    display.print(PersistenceData.activeFaction == FACTION_1 ? "> " : "  ");
-    display.printf("%-5s: %02d:%02d:%02d\n", FACTION_1_NAME, PersistenceData.faction_1_timer / 3600, (PersistenceData.faction_1_timer / 60) % 60, PersistenceData.faction_1_timer % 60);
-    display.print(PersistenceData.activeFaction == FACTION_2 ? "> " : "  ");
-    display.printf("%-5s: %02d:%02d:%02d\n", FACTION_2_NAME, PersistenceData.faction_2_timer / 3600, (PersistenceData.faction_2_timer / 60) % 60, PersistenceData.faction_2_timer % 60);
-    display.print(PersistenceData.activeFaction == FACTION_3 ? "> " : "  ");
-    display.printf("%-5s: %02d:%02d:%02d\n", FACTION_3_NAME, PersistenceData.faction_3_timer / 3600, (PersistenceData.faction_3_timer / 60) % 60, PersistenceData.faction_3_timer % 60);
-    display.display();
-}

Software/src/oled_display.h

@@ -1,20 +0,0 @@
-#ifndef _OLED_DISPLAY_H_
-#define _OLED_DISPLAY_H_
-
-#include <Arduino.h>
-#include <Wire.h>
-#include <Adafruit_GFX.h>
-#include <Adafruit_SSD1306.h>
-#include "globals.h"
-#include "config.h"
-
-#define OLED_SDA 4
-#define OLED_SCL 15
-#define OLED_RST 16
-#define SCREEN_WIDTH 128 // OLED display width, in pixels
-#define SCREEN_HEIGHT 64 // OLED display height, in pixels
-
-void OLED_Init();
-void OLED_Process();
-
-#endif

Software/src/struct2json.cpp

@@ -0,0 +1,41 @@
+/**
+ * @file struct2json.cpp
+ *
+ * @brief Implementation file for converting structs to JSON objects.
+ *
+ * @note This file is auto-generated by a script on 2024-06-06 18:52:33.
+ *
+ * @author Marcel Peterkau
+ * @date   06.06.2024
+ */
+
+
+#include "struct2json.h"
+
+void generateJsonObject_ConfigData(JsonObject data)
+{
+    data["EEPROM_Version"] = ConfigData.EEPROM_Version;
+    data["batteryType"] = ConfigData.batteryType;
+    data["active_faction_on_reboot"] = ConfigData.active_faction_on_reboot;
+    data["Faction_1_Name"] = ConfigData.Faction_1_Name;
+    data["Faction_2_Name"] = ConfigData.Faction_2_Name;
+    data["Faction_3_Name"] = ConfigData.Faction_3_Name;
+    data["wifi_client_ssid"] = ConfigData.wifi_client_ssid;
+    data["wifi_client_password"] = ConfigData.wifi_client_password;
+    data["wifi_autoconnect"] = ConfigData.wifi_autoconnect;
+    data["checksum"] = ConfigData.checksum;
+    }
+
+void generateJsonObject_PersistenceData(JsonObject data)
+{
+    data["writeCycleCounter"] = PersistenceData.writeCycleCounter;
+    data["faction_1_timer"] = PersistenceData.faction_1_timer;
+    data["faction_2_timer"] = PersistenceData.faction_2_timer;
+    data["faction_3_timer"] = PersistenceData.faction_3_timer;
+    data["activeFaction"] = PersistenceData.activeFaction;
+    data["checksum"] = PersistenceData.checksum;
+    }
+
+
+
+// CODEGENERATOR_CHECKSUM: 3a3fd3024dd9dd769ff5d62f61b3ba1b781b7d06e7568a1ddac56d193dba9ee5

Software/src/utilities.cpp

@@ -0,0 +1,126 @@
+#include "utilities.h"
+
+/**
+ * @brief Validates whether a given string contains only characters allowed in WiFi SSIDs and passwords.
+ *
+ * This function checks each character in the provided string to ensure
+ * that it contains only characters allowed in WiFi SSIDs and passwords.
+ * It considers characters from 'A' to 'Z', 'a' to 'z', '0' to '9', as well as
+ * the following special characters: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ *
+ * @param string Pointer to the string to be validated.
+ * @param size Size of the string including the null-terminator.
+ * @return true if the string contains only allowed characters or is NULL,
+ *         false otherwise.
+ */
+bool validateWiFiString(char *string, size_t size)
+{
+    if (string == NULL)
+        return false;
+
+    for (size_t i = 0; i < size; i++)
+    {
+        char c = string[i];
+        if (c == '\0')
+        {
+            // Reached the end of the string, all characters were valid WiFi characters.
+            return true;
+        }
+        if (!((c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z') ||
+              (c >= '0' && c <= '9') || c == '!' || c == '"' || c == '#' ||
+              c == '$' || c == '%' || c == '&' || c == '\'' || c == '(' ||
+              c == ')' || c == '*' || c == '+' || c == ',' || c == '-' ||
+              c == '.' || c == '/' || c == ':' || c == ';' || c == '<' ||
+              c == '=' || c == '>' || c == '?' || c == '@' || c == '[' ||
+              c == '\\' || c == ']' || c == '^' || c == '_' || c == '`' ||
+              c == '{' || c == '|' || c == '}' || c == '~' || c == ' '))
+        {
+            // Found a character that is not a valid WiFi character.
+            return false;
+        }
+    }
+    // If the loop completes without finding a null terminator, the string is invalid.
+    return false;
+}
+
+/**
+ * @brief Copies a string to a buffer, replacing invalid WiFi SSID characters with a placeholder.
+ *
+ * This function checks each character in the provided input string to ensure
+ * that it contains only characters allowed in WiFi SSIDs and passwords. If a character
+ * is invalid, it replaces it with a placeholder character (e.g., '_').
+ * It considers characters from 'A' to 'Z', 'a' to 'z', '0' to '9', as well as
+ * the following special characters: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ *
+ * @param input Pointer to the input string to be validated and copied.
+ * @param buffer Pointer to the buffer where the output string will be copied.
+ * @param bufferSize Size of the buffer including the null-terminator.
+ */
+void sanitizeWiFiString(const char *input, char *buffer, size_t bufferSize)
+{
+    if (input == NULL || buffer == NULL || bufferSize == 0)
+        return;
+
+    size_t i;
+    for (i = 0; i < bufferSize - 1; i++) // Leave space for null-terminator
+    {
+        char c = input[i];
+        if (c == '\0')
+        {
+            // Reached the end of the input string, terminate the buffer
+            buffer[i] = '\0';
+            return;
+        }
+        if (!((c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z') ||
+              (c >= '0' && c <= '9') || c == '!' || c == '"' || c == '#' ||
+              c == '$' || c == '%' || c == '&' || c == '\'' || c == '(' ||
+              c == ')' || c == '*' || c == '+' || c == ',' || c == '-' ||
+              c == '.' || c == '/' || c == ':' || c == ';' || c == '<' ||
+              c == '=' || c == '>' || c == '?' || c == '@' || c == '[' ||
+              c == '\\' || c == ']' || c == '^' || c == '_' || c == '`' ||
+              c == '{' || c == '|' || c == '}' || c == '~' || c == ' '))
+        {
+            // Replace invalid character with placeholder
+            buffer[i] = '_';
+        }
+        else
+        {
+            // Copy valid character to buffer
+            buffer[i] = c;
+        }
+    }
+    // Null-terminate the buffer
+    buffer[i] = '\0';
+}
+
+/**
+ * @brief Generates a device-specific password based on a seed and the ESP8266 Chip ID.
+ *
+ * This function combines a given seed with the unique Chip ID of the ESP8266 device to create a device-specific password.
+ * The resulting password is stored in the provided character buffer.
+ *
+ * @param seed The seed string used for password generation. Should be up to 16 characters long.
+ * @param passwordBuffer The character buffer where the generated password will be stored.
+ * @param bufferLength The length of the password buffer. Should be large enough to hold the generated password and null terminator.
+ */
+void GenerateDeviceSpecificPassword(const char* seed, char* passwordBuffer, size_t bufferLength) {
+    uint32_t chipId = ESP.getChipId();
+    char chipIdStr[9]; // 8 characters + null terminator
+    snprintf(chipIdStr, sizeof(chipIdStr), "%08X", chipId);
+
+    char combined[33]; // seed (16) + chipId (8) + null terminator (1)
+    strncpy(combined, seed, 16);
+    strncat(combined, chipIdStr, 8);
+
+    // Simple hash function for demonstration
+    unsigned long hash = 5381;
+    int c;
+    char *str = combined;
+
+    while ((c = *str++)) {
+        hash = ((hash << 5) + hash) + c; // hash * 33 + c
+    }
+
+    snprintf(passwordBuffer, bufferLength, "%08X%08X", hash, hash);
+    passwordBuffer[bufferLength - 1] = '\0'; // Ensure null termination
+}

Software/src/webui.cpp

@@ -1,209 +1,826 @@
+/**
+ * @file webui.cpp
+ *
+ * @brief Implementation file for web-based user interface (WebUI) functions in the DE-Timer application.
+ *
+ * This file contains the implementation of functions related to the initialization and processing of the
+ * web-based user interface (WebUI). It includes the setup of LittleFS, handling of firmware version checks,
+ * initialization of mDNS, setup of web server routes, and handling of various HTTP events.
+ *
+ * @author Marcel Peterkau
+ * @date   09.01.2024
+ */
+
 #include "webui.h"
 
 AsyncWebServer webServer(80);
 
-typedef enum
+const char *PARAM_MESSAGE = "message";
-{
+
-  RESPMSG_HIDE,
+batteryType_t batterytypePreselect; /**< Preselect Memory for change Batterytype */
-  RESPMSG_SUCCESS,
-  RESPMSG_INFO,
-  RESPMSG_WARNING,
-  RESPMSG_DANGER
-} statusResponseMessage_Type_t;
-char StatusResponseMessage[64];
-statusResponseMessage_Type_t StatusResponseMessage_Type = RESPMSG_INFO;
 
 String processor(const String &var);
-void WebserverPOST_Callback(AsyncWebServerRequest *request);
 void WebserverNotFound_Callback(AsyncWebServerRequest *request);
-void Webserver_Callback(AsyncWebServerRequest *request);
+void WebserverFirmwareUpdate_Callback(AsyncWebServerRequest *request, const String &filename, size_t index, uint8_t *data, size_t len, bool final);
-void WebserverCommands_Callback(String input);
+void WebserverEERestore_Callback(AsyncWebServerRequest *request, const String &filename, size_t index, uint8_t *data, size_t len, bool final);
+void WebServerEEJSON_Callback(AsyncWebServerRequest *request);
+void GetFlashVersion(char *buff, size_t buff_size);
 
+AsyncWebSocket webSocket("/ws");
+
+void WebsocketEvent_Callback(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len);
+void Websocket_HandleMessage(void *arg, uint8_t *data, size_t len);
+void Websocket_RefreshClientData_DTCs(uint32_t client_id);
+void Websocket_RefreshClientData_Status(uint32_t client_id, bool send_mapping = false);
+void Websocket_RefreshClientData_Static(uint32_t client_id, bool send_mapping = false);
+void Websocket_HandleButtons(uint8_t *data);
+void Websocket_HandleSettings(uint8_t *data);
+void parseWebsocketString(char *data, char *identifierBuffer, size_t identifierBufferSize, char *valueBuffer, size_t valueBufferSize);
+int findIndexByString(const char *searchString, const char *const *array, int arraySize);
+
+/**
+ * @brief Initializes the web-based user interface (WebUI) for the DE-Timer application.
+ *
+ * This function sets up the necessary components for the WebUI, including mounting LittleFS,
+ * performing flash version checks, initializing mDNS, and configuring the web server with
+ * routes and event handlers. If any errors occur during setup, appropriate diagnostic messages
+ * are pushed to the debugging system, and potential error conditions are recorded as Diagnostic
+ * Trouble Codes (DTCs).
+ *
+ * @note This function should be called during the initialization phase of the application.
+ */
 void initWebUI()
 {
+  // Attempt to mount LittleFS
   if (!LittleFS.begin())
   {
-    Serial.println("An Error has occurred while mounting LittleFS");
+    Debug_pushMessage("An Error has occurred while mounting LittleFS\n");
+    MaintainDTC(DTC_FLASHFS_ERROR, true);
     return;
   }
 
+  // Retrieve the flash version
+  GetFlashVersion(globals.FlashVersion, sizeof(globals.FlashVersion));
+
+  // Compare the flash version with the required version
+  char buffer[6];
+  snprintf(buffer, sizeof(buffer), "%d.%02d", constants.Required_Flash_Version_major, constants.Required_Flash_Version_minor);
+  if (strcmp(globals.FlashVersion, buffer))
+  {
+    MaintainDTC(DTC_FLASHFS_VERSION_ERROR, true);
+  }
+
+  // Initialize mDNS and add service
+  MDNS.begin(globals.DeviceNameId);
+  MDNS.addService("http", "tcp", 80);
+
+  // Set up WebSocket event handler and attach to web server
+  webSocket.onEvent(WebsocketEvent_Callback);
+  webServer.addHandler(&webSocket);
+
+  // Serve static files and define routes
   webServer.serveStatic("/static/", LittleFS, "/static/").setCacheControl("max-age=360000");
+  webServer.serveStatic("/index.htm", LittleFS, "/index.htm").setCacheControl("max-age=360000");
   webServer.on("/", HTTP_GET, [](AsyncWebServerRequest *request)
                { request->redirect("/index.htm"); });
   webServer.onNotFound(WebserverNotFound_Callback);
-  webServer.on("/index.htm", HTTP_GET, Webserver_Callback);
+  webServer.on("/eejson", HTTP_GET, WebServerEEJSON_Callback);
-  webServer.on("/index.htm", HTTP_POST, WebserverPOST_Callback);
+  webServer.on(
+      "/doUpdate", HTTP_POST, [](AsyncWebServerRequest *request) {}, WebserverFirmwareUpdate_Callback);
+  webServer.on(
+      "/eeRestore", HTTP_POST, [](AsyncWebServerRequest *request) {}, WebserverEERestore_Callback);
 
+  // Start the web server
   webServer.begin();
 }
 
-String processor(const String &var)
+/**
+ * @brief Processes the web server functionality for the DE-Timer application.
+ *
+ * This function performs periodic processing tasks for the web server, including cleaning up
+ * WebSocket clients and refreshing client data when WebSocket connections are active. It ensures
+ * that WebSocket client data related to Diagnostic Trouble Codes (DTCs) and system status is
+ * updated at regular intervals.
+ *
+ * @note This function should be called in the main loop of the application.
+ */
+void Webserver_Process()
 {
-  if (var == "SHOW_DTC_TABLE")
+  static uint32_t previousMillis = 0;
-    return globals.systemStatus == sysStat_Error ? "" : "hidden";
 
-  if (var == "SHOW_RESP_MESSAGE")
+  webSocket.cleanupClients();
-    return StatusResponseMessage_Type != RESPMSG_HIDE ? "" : "hidden";
 
-  if (var == "RESP_MESSAGE_TYPE")
+  if ((webSocket.count() > 0) && (millis() - previousMillis >= 10000))
   {
-    switch (StatusResponseMessage_Type)
+    Websocket_RefreshClientData_DTCs(0);
-    {
+    Websocket_RefreshClientData_Status(0);
-    case RESPMSG_SUCCESS:
+    previousMillis = millis();
-      return "success";
-    case RESPMSG_INFO:
-      return "info";
-    case RESPMSG_WARNING:
-      return "warning";
-    case RESPMSG_DANGER:
-      return "danger";
-    default:
-      return "info";
   }
 }
 
-  if (var == "RESP_MESSAGE")
+/**
-    return String(StatusResponseMessage);
+ * @brief Shuts down the web server functionality for the DE-Timer application.
-
+ *
-  if (var == "BAT_REMAIN_CAPACITY")
+ * This function closes all WebSocket connections and terminates the web server. It is intended
-    return String(globals.battery_level);
+ * to be called when the application is being shut down or when there is a need to deactivate the
-
+ * web server.
-  if (var == "DEVICE_NAME")
+ *
-    return String(globals.DeviceName);
+ * @details This function ensures a graceful shutdown of the web server by closing all active
-
+ *          WebSocket connections and ending the web server instance.
-  if (var == "BAT_VOLTAGE")
+ *
-    return String(globals.loadvoltage);
+ * @note This function should be called before shutting down the application to properly
-
+ *       deactivate the web server.
-  if (var == "DTC_TABLE")
+ */
+void Webserver_Shutdown()
 {
-    String temp;
+  if (webSocket.count() > 0)
-    char buff_timestamp[16]; // Format: DD-hh:mm:ss:xxx
+    webSocket.closeAll();
-
+  webServer.end();
-    for (uint32_t i = 0; i < MAX_DTC_STORAGE; i++)
-    {
-      if (DTCStorage[i].Number > 0)
-      {
-        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
-
-        temp = "<tr><td>" + String(buff_timestamp);
-        temp = temp + "</td><td>" + String(DTCStorage[i].Number) + "</td><td>";
-
-        if (DTCStorage[i].active == DTC_ACTIVE)
-          temp = temp + "active";
-        else if (DTCStorage[i].active == DTC_PREVIOUS)
-          temp = temp + "previous";
-        else
-          temp = temp + "none";
-
-        temp = temp + "</td></tr>";
-      }
-    }
-    return temp;
-  }
-
-  if (var == "PLACEHOLDER")
-    return "placeholder";
-
-  if (var == "POINTS_FAC_1")
-  {
-    char buff[12];
-    snprintf(buff, 12, "%3d:%02d:%02d", PersistenceData.faction_1_timer / 3600, (PersistenceData.faction_1_timer / 60) % 60, PersistenceData.faction_1_timer % 60);
-    return String(buff);
-  }
-
-  if (var == "POINTS_FAC_2")
-  {
-    char buff[12];
-    snprintf(buff, 12, "%3d:%02d:%02d", PersistenceData.faction_2_timer / 3600, (PersistenceData.faction_2_timer / 60) % 60, PersistenceData.faction_2_timer % 60);
-    return String(buff);
-  }
-
-  if (var == "POINTS_FAC_3")
-  {
-    char buff[12];
-    snprintf(buff, 12, "%3d:%02d:%02d", PersistenceData.faction_3_timer / 3600, (PersistenceData.faction_3_timer / 60) % 60, PersistenceData.faction_3_timer % 60);
-    return String(buff);
-  }
-
-  if (var == "STATUS_FAC_1")
-    return PersistenceData.activeFaction == FACTION_1 ? "ACTIVE" : "INACTIVE";
-
-  if (var == "STATUS_FAC_2")
-    return PersistenceData.activeFaction == FACTION_2 ? "ACTIVE" : "INACTIVE";
-
-  if (var == "STATUS_FAC_3")
-    return PersistenceData.activeFaction == FACTION_3 ? "ACTIVE" : "INACTIVE";
-
-  if (var == "NAME_FAC_1")
-    return FACTION_1_NAME;
-
-  if (var == "NAME_FAC_2")
-    return FACTION_2_NAME;
-
-  if (var == "NAME_FAC_3")
-    return FACTION_3_NAME;
-
-  if (var == "TITLE")
-    return DEVICE_NAME;
-
-  if (var == "BATTERY_LEVEL")
-  {
-    return String(globals.battery_level);
-  }
-  if (var == "BATTERY_TYPE")
-  {
-    return String(BatteryString[ConfigData.batteryType]);
-  }
-  if (var == "BATTERY_VOLTAGE")
-  {
-    return String(globals.loadvoltage);
-  }
-
-  return String();
-}
-
-void Webserver_Callback(AsyncWebServerRequest *request)
-{
-  request->send(LittleFS, "/index.htm", "text/html", false, processor);
-  StatusResponseMessage_Type = RESPMSG_HIDE;
-}
-
-void WebserverPOST_Callback(AsyncWebServerRequest *request)
-{
-  int paramsNr = request->params();
-  for (int i = 0; i < paramsNr; i++)
-  {
-    AsyncWebParameter *p = request->getParam(i);
-    if (p->name() == "commandInput")
-      WebserverCommands_Callback(p->value());
-  }
-  request->send(LittleFS, "/index.htm", "text/html", false, processor);
 }
 
+/**
+ * @brief Callback function for handling HTTP 404 (Not Found) errors on the web server.
+ *
+ * This function is invoked when an HTTP request results in a 404 error (Not Found). It sends
+ * a simple "Not found" text response with an HTTP status code of 404.
+ *
+ * @param request Pointer to the AsyncWebServerRequest object representing the HTTP request.
+ */
 void WebserverNotFound_Callback(AsyncWebServerRequest *request)
 {
   request->send(404, "text/html", "Not found");
 }
 
-void WebserverCommands_Callback(String input)
+/**
+ * @brief Reads the flash version information from a file in LittleFS.
+ *
+ * This function reads the flash version information stored in a file named "version" in the
+ * LittleFS filesystem. It opens the file, reads the content until a carriage return ('\r') is
+ * encountered, and stores the result in the provided buffer. The buffer is null-terminated.
+ *
+ * @param buff Pointer to the buffer where the flash version information will be stored.
+ * @param buff_size Size of the buffer.
+ */
+void GetFlashVersion(char *buff, size_t buff_size)
 {
-  String command = input.substring(0, input.indexOf(' '));
+  File this_file = LittleFS.open("version", "r");
-  command.toUpperCase();
+  if (!this_file)
-  StatusResponseMessage_Type = RESPMSG_HIDE;
+  { // failed to open the file, retrn empty result
-
+    buff[0] = '\0';
-  if (command == "RESET")
+    return;
+  }
+  if (this_file.available())
   {
-    strcpy(StatusResponseMessage, "Counter Reset done");
+    int bytes_read;
-    StatusResponseMessage_Type = RESPMSG_SUCCESS;
+    bytes_read = this_file.readBytesUntil('\r', buff, buff_size - 1);
+    buff[bytes_read] = '\0';
+  }
+  this_file.close();
+}
 
+/**
+ * @brief Callback function for handling firmware updates via the web server.
+ *
+ * This function is invoked during the firmware update process when a new firmware file
+ * is received. It handles the update process using the ESPAsyncHTTPUpdate library. The update
+ * process involves checking the firmware type, initializing the update, writing data, and finalizing
+ * the update. If the update is successful, it triggers a system shutdown.
+ *
+ * @param request   Pointer to the AsyncWebServerRequest object.
+ * @param filename  The name of the file being updated.
+ * @param index     The index of the file being updated.
+ * @param data      Pointer to the data buffer.
+ * @param len       The length of the data buffer.
+ * @param final     Boolean indicating if this is the final chunk of data.
+ */
+void WebserverFirmwareUpdate_Callback(AsyncWebServerRequest *request, const String &filename, size_t index, uint8_t *data, size_t len, bool final)
+{
+
+  if (!index)
+  {
+    Debug_pushMessage("Update\n");
+    size_t content_len = request->contentLength();
+    int cmd = (filename.indexOf(".fs") > -1) ? U_FS : U_FLASH;
+    Update.runAsync(true);
+    if (!Update.begin(content_len, cmd))
+    {
+      Update.printError(Serial);
+    }
+  }
+
+  if (Update.write(data, len) != len)
+  {
+    Update.printError(Serial);
+  }
+  else
+  {
+    Debug_pushMessage("Progress: %d%%\n", (Update.progress() * 100) / Update.size());
+  }
+
+  if (final)
+  {
+    AsyncWebServerResponse *response = request->beginResponse(302, "text/plain", "Please wait while the device reboots");
+    response->addHeader("Refresh", "20");
+    response->addHeader("Location", "/");
+    request->send(response);
+    if (!Update.end(true))
+    {
+      Update.printError(Serial);
+    }
+    else
+    {
+      Debug_pushMessage("Update complete\n");
+      globals.systemStatus = sysStat_Shutdown;
+    }
+  }
+}
+
+/**
+ * @brief Callback function for handling EEPROM restore via the web server.
+ *
+ * This function is invoked during the EEPROM restore process when a new EEPROM file
+ * is received. It handles the restore process by reading the data from the received file,
+ * deserializing the JSON data, and updating the configuration and persistence data accordingly.
+ * If the restore is successful, it triggers a system shutdown.
+ *
+ * @param request   Pointer to the AsyncWebServerRequest object.
+ * @param filename  The name of the file being restored.
+ * @param index     The index of the file being restored.
+ * @param data      Pointer to the data buffer.
+ * @param len       The length of the data buffer.
+ * @param final     Boolean indicating if this is the final chunk of data.
+ */
+void WebserverEERestore_Callback(AsyncWebServerRequest *request, const String &filename, size_t index, uint8_t *data, size_t len, bool final)
+{
+  bool ee_done = false;
+  static bool validext = false;
+  static char *buffer = NULL;
+  static uint32_t read_ptr = 0;
+  DeserializationError error;
+
+  if (!index)
+  {
+    validext = (filename.indexOf(".ee.json") > -1);
+    if (validext)
+    {
+      buffer = (char *)malloc(1536);
+      read_ptr = 0;
+      if (buffer == NULL)
+        Debug_pushMessage("malloc() failed for EEPROM-Restore\n");
+    }
+  }
+
+  if (buffer != NULL)
+  {
+    memcpy(buffer + read_ptr, data, len);
+    read_ptr = read_ptr + len;
+  }
+
+  if (final)
+  {
+    if (buffer != NULL)
+    {
+      Serial.print(buffer);
+      JsonDocument json;
+      error = deserializeJson(json, buffer);
+      if (error)
+      {
+        Debug_pushMessage("deserializeJson() failed: %s\n", error.f_str());
+      }
+      else
+      {
+
+        ConfigData.batteryType = (batteryType_t)json["config"]["batteryType"].as<int>();
+        ConfigData.active_faction_on_reboot = json["config"]["active_faction_on_reboot"].as<bool>();
+        strncpy(ConfigData.Faction_1_Name, json["config"]["Faction_1_Name"].as<const char *>(), sizeof(ConfigData.Faction_1_Name));
+        strncpy(ConfigData.Faction_2_Name, json["config"]["Faction_2_Name"].as<const char *>(), sizeof(ConfigData.Faction_2_Name));
+        strncpy(ConfigData.Faction_3_Name, json["config"]["Faction_3_Name"].as<const char *>(), sizeof(ConfigData.Faction_3_Name));
+        strncpy(ConfigData.wifi_client_ssid, json["config"]["wifi_client_ssid"].as<const char *>(), sizeof(ConfigData.wifi_client_ssid));
+        strncpy(ConfigData.wifi_client_password, json["config"]["wifi_client_password"].as<const char *>(), sizeof(ConfigData.wifi_client_password));
+
+        PersistenceData.writeCycleCounter = json["persis"]["writeCycleCounter"].as<uint16_t>();
+        PersistenceData.activeFaction = (Factions_t)json["persis"]["activeFaction"].as<int>();
+        PersistenceData.faction_1_timer = json["persis"]["faction_1_timer"].as<uint32_t>();
+        PersistenceData.faction_2_timer = json["persis"]["faction_2_timer"].as<uint32_t>();
+        PersistenceData.faction_3_timer = json["persis"]["faction_3_timer"].as<uint32_t>();
+        PersistenceData.checksum = json["persis"]["checksum"].as<uint32_t>();
+
+        ee_done = true;
+      }
+    }
+
+    free(buffer);
+
+    AsyncWebServerResponse *response = request->beginResponse(302, "text/plain", "Please wait while the device reboots");
+    response->addHeader("Refresh", "20");
+    response->addHeader("Location", "/");
+    request->send(response);
+
+    if (ee_done)
+    {
+      Debug_pushMessage("Update complete\n");
+      globals.systemStatus = sysStat_Shutdown;
+    }
+  }
+}
+
+/**
+ * @brief Callback function for handling EEPROM JSON request via the web server.
+ *
+ * This function is invoked when a request for EEPROM JSON data is received. It constructs a JSON
+ * response containing information about the firmware, configuration, and persistence data.
+ *
+ * @param request Pointer to the AsyncWebServerRequest object.
+ */
+void WebServerEEJSON_Callback(AsyncWebServerRequest *request)
+{
+  AsyncResponseStream *response = request->beginResponseStream("application/json");
+  JsonDocument json;
+  JsonObject info = json["info"].to<JsonObject>();
+
+  char buffer[16];
+
+  info["DeviceNameId"] = globals.DeviceNameId;
+  sprintf(buffer, "%d.%02d", constants.Required_Flash_Version_major, constants.Required_Flash_Version_minor);
+  info["FW-Version"] = buffer;
+  info["FS-Version"] = globals.FlashVersion;
+  snprintf_P(buffer, sizeof(buffer), "%s", constants.GitHash);
+  info["Git-Hash"] = buffer;
+
+  JsonObject config = json["config"].to<JsonObject>();
+  generateJsonObject_ConfigData(config);
+  JsonObject persis = json["persis"].to<JsonObject>();
+  generateJsonObject_PersistenceData(persis);
+
+  JsonObject eepart = json["eepart"].to<JsonObject>();
+  sprintf(buffer, "0x%04X", globals.eePersistanceAdress);
+  eepart["PersistanceAddress"] = buffer;
+
+  serializeJsonPretty(json, *response);
+
+  response->addHeader("Content-disposition", "attachment; filename=backup.ee.json");
+
+  request->send(response);
+}
+
+/**
+ * @brief Callback function for handling WebSocket events.
+ *
+ * This function is invoked when events occur in the WebSocket communication, such as client connection,
+ * disconnection, reception of data, and others. It dispatches the events to the appropriate handlers.
+ *
+ * @param server Pointer to the AsyncWebSocket object.
+ * @param client Pointer to the AsyncWebSocketClient object representing the WebSocket client.
+ * @param type Type of WebSocket event.
+ * @param arg Event-specific argument.
+ * @param data Pointer to the received data (if applicable).
+ * @param len Length of the received data.
+ */
+void WebsocketEvent_Callback(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len)
+{
+  switch (type)
+  {
+  case WS_EVT_CONNECT:
+    Debug_pushMessage("WebSocket client #%u connected from %s\n", client->id(), client->remoteIP().toString().c_str());
+    Websocket_RefreshClientData_Status(client->id(), true);
+    Websocket_RefreshClientData_Static(client->id(), true);
+    Websocket_RefreshClientData_DTCs(client->id());
+    break;
+  case WS_EVT_DISCONNECT:
+    Debug_pushMessage("WebSocket client #%u disconnected\n", client->id());
+    break;
+  case WS_EVT_DATA:
+    Websocket_HandleMessage(arg, data, len);
+    break;
+  case WS_EVT_PONG:
+  case WS_EVT_ERROR:
+    break;
+  }
+}
+
+/**
+ * @brief Handles WebSocket messages received from clients.
+ *
+ * This function processes WebSocket messages, such as starting or stopping debugging,
+ * and provides appropriate responses.
+ *
+ * @param arg Pointer to the WebSocket frame information.
+ * @param data Pointer to the received data.
+ * @param len Length of the received data.
+ */
+void Websocket_HandleMessage(void *arg, uint8_t *data, size_t len)
+{
+  AwsFrameInfo *info = (AwsFrameInfo *)arg;
+  if (info->final && info->index == 0 && info->len == len && info->opcode == WS_TEXT)
+  {
+    data[len] = 0;
+    Debug_pushMessage("Websocket-Message (len: %d): %s\n", len, (char *)data);
+
+    if (strncmp((char *)data, "btn-", strlen("btn-")) == 0)
+    {
+      Websocket_HandleButtons(data + strlen("btn-"));
+    }
+    else if (strncmp((char *)data, "set-", strlen("set-")) == 0)
+    {
+      Websocket_HandleSettings(data + strlen("set-"));
+    }
+    else if (strncmp((char *)data, "debug", strlen("debug")) == 0)
+    {
+      Debug_ProcessCommand(data - strlen("debug"));
+    }
+    else
+    {
+      Debug_pushMessage("Got unknown Websocket-Message '%s' from client\n", (char *)data);
+    }
+  }
+}
+
+/**
+ * @brief Handle button commands received via WebSocket.
+ *
+ * This function parses a WebSocket string representing button commands, extracts
+ * the identifier and value components, and performs corresponding actions based on
+ * the received commands.
+ *
+ * @param data The WebSocket data containing button commands.
+ */
+void Websocket_HandleButtons(uint8_t *data)
+{
+  char identifier[32];
+  char value[32];
+
+  parseWebsocketString((char *)data, identifier, sizeof(identifier), value, sizeof(value));
+  if (strcmp(identifier, "reset-timer") == 0)
+  {
+    PersistenceData.activeFaction = NONE;
     PersistenceData.faction_1_timer = 0;
     PersistenceData.faction_2_timer = 0;
     PersistenceData.faction_3_timer = 0;
-    PersistenceData.activeFaction = NONE;
+  }
+  else if (strcmp(identifier, "debugstart") == 0)
+  {
+    SetDebugportStatus(dbg_Webui, enabled);
+  }
+  else if (strcmp(identifier, "debugstop") == 0)
+  {
+    SetDebugportStatus(dbg_Webui, disabled);
+  }
+  else if (strcmp(identifier, "settingssave") == 0)
+  {
+    ConfigData.batteryType = batterytypePreselect;
+    globals.requestEEAction = EE_CFG_SAVE;
+  }
+  else if (strcmp(identifier, "reboot") == 0)
+  {
+    globals.systemStatus = sysStat_Shutdown;
+  }
+  else if (strcmp(identifier, "faction1") == 0)
+  {
+    PersistenceData.activeFaction = FACTION_1;
+  }
+  else if (strcmp(identifier, "faction2") == 0)
+  {
+    PersistenceData.activeFaction = FACTION_2;
+  }
+  else if (strcmp(identifier, "faction3") == 0)
+  {
+    PersistenceData.activeFaction = FACTION_3;
+  }
+  else
+  {
+    Debug_pushMessage("Got unknown Button-id '%s' from ws-client\n", identifier);
   }
 }
+
+/**
+ * @brief Handle settings commands received via WebSocket.
+ *
+ * This function parses a WebSocket string representing settings commands, extracts
+ * the identifier and value components, and updates the system settings accordingly.
+ *
+ * @param data The WebSocket data containing settings commands.
+ */
+void Websocket_HandleSettings(uint8_t *data)
+{
+  char identifier[32];
+  char value[63];
+
+  parseWebsocketString((char *)data, identifier, sizeof(identifier), value, sizeof(value));
+
+  if (strcmp(identifier, "active_faction_on_reboot") == 0)
+  {
+    ConfigData.active_faction_on_reboot = value[0] == '1' ? true : false;
+  }
+  else if (strcmp(identifier, "name_faction1") == 0)
+  {
+    strncpy(ConfigData.Faction_1_Name, value, sizeof(ConfigData.Faction_1_Name));
+  }
+  else if (strcmp(identifier, "name_faction2") == 0)
+  {
+    strncpy(ConfigData.Faction_2_Name, value, sizeof(ConfigData.Faction_2_Name));
+  }
+  else if (strcmp(identifier, "name_faction3") == 0)
+  {
+    strncpy(ConfigData.Faction_3_Name, value, sizeof(ConfigData.Faction_3_Name));
+  }
+  else if (strcmp(identifier, "batterytype") == 0)
+  {
+    int index = findIndexByString(value, BatteryString, BatteryString_Elements);
+    batterytypePreselect = (batteryType_t)index;
+  }
+  else if (strcmp(identifier, "wifi-ssid") == 0)
+  {
+    strncpy(ConfigData.wifi_client_ssid, value, sizeof(ConfigData.wifi_client_ssid));
+  }
+  else if (strcmp(identifier, "wifi-password") == 0)
+  {
+    strncpy(ConfigData.wifi_client_password, value, sizeof(ConfigData.wifi_client_password));
+  }
+  else
+  {
+    Debug_pushMessage("Got unknown Settings-id and value '%s' from ws-client\n", identifier);
+  }
+}
+
+/**
+ * @brief Pushes live debug messages to all WebSocket clients.
+ *
+ * This function sends a live debug message to all connected WebSocket clients.
+ *
+ * @param Message The debug message to be sent.
+ */
+void Websocket_PushLiveDebug(String Message)
+{
+  webSocket.textAll("DEBUG:" + Message);
+}
+
+/**
+ * @brief Refreshes client data related to Diagnostic Trouble Codes (DTCs) on WebSocket clients.
+ *
+ * This function constructs a DTC-related string and sends it to a specific WebSocket client or
+ * broadcasts it to all connected WebSocket clients.
+ *
+ * @param client_id The ID of the WebSocket client to which the data should be sent. If 0, the data
+ * will be broadcasted to all connected clients.
+ */
+void Websocket_RefreshClientData_DTCs(uint32_t client_id)
+{
+  String temp = "DTC:";
+
+  // Build DTC-String
+  if (globals.hasDTC != true)
+  {
+    temp.concat(String(DTC_NO_DTC) + ";");
+  }
+  else
+  {
+    for (uint32_t i = 0; i < MAX_DTC_STORAGE; i++)
+    {
+      if (DTCStorage[i].Number < DTC_LAST_DTC)
+      {
+        temp.concat(String(DTCStorage[i].timestamp) + ",");
+        temp.concat(String(DTCStorage[i].Number) + ",");
+        temp.concat(String(getSeverityForDTC(DTCStorage[i].Number)) + ",");
+        temp.concat(String(DTCStorage[i].active) + ",");
+        temp.concat(String(DTCStorage[i].debugVal) + ";");
+      }
+    }
+  }
+  if (client_id > 0)
+  {
+    webSocket.text(client_id, temp);
+  }
+  else
+  {
+    webSocket.textAll(temp);
+  }
+}
+
+/**
+ * @brief Refreshes client data related to system status and relevant parameters on WebSocket clients.
+ *
+ * This function constructs a status-related string and sends it to a specific WebSocket client or
+ * broadcasts it to all connected WebSocket clients. It also sends a mapping of the status parameters.
+ *
+ * @param client_id The ID of the WebSocket client to which the data should be sent. If 0, the data
+ * will be broadcasted to all connected clients.
+ * @param send_mapping Flag indicating whether to send the parameter mapping to the client(s).
+ */
+void Websocket_RefreshClientData_Status(uint32_t client_id, bool send_mapping)
+{
+  if (send_mapping)
+  {
+    const char mapping[] = "MAPPING_STATUS:"
+                           "batterylevel;"
+                           "systemstatus;"
+                           "activefaction;"
+                           "time_faction1;"
+                           "time_faction2;"
+                           "time_faction3;";
+
+    if (client_id > 0)
+      webSocket.text(client_id, mapping);
+    else
+      webSocket.textAll(mapping);
+
+    Debug_pushMessage("send MAPPING_STATUS WS-Client Data\n");
+  }
+
+  char dataString[200] = {0}; // Maximal 200 Zeichen für den Data-String
+
+  sprintf(dataString, "STATUS:%d;%s;%d;%ld;%ld;%ld;",
+          globals.battery_level,
+          globals.systemStatustxt,
+          PersistenceData.activeFaction,
+          PersistenceData.faction_1_timer,
+          PersistenceData.faction_2_timer,
+          PersistenceData.faction_3_timer);
+
+  if (client_id > 0)
+  {
+    webSocket.text(client_id, dataString);
+  }
+  else
+  {
+    webSocket.textAll(dataString);
+  }
+}
+
+/**
+ * @brief Refreshes client data related to static configuration parameters on WebSocket clients.
+ *
+ * This function constructs a static configuration-related string and sends it to a specific WebSocket client or
+ * broadcasts it to all connected WebSocket clients. It also sends a mapping of the static configuration parameters.
+ *
+ * @param client_id The ID of the WebSocket client to which the data should be sent. If 0, the data
+ * will be broadcasted to all connected clients.
+ * @param send_mapping Flag indicating whether to send the parameter mapping to the client(s).
+ */
+void Websocket_RefreshClientData_Static(uint32_t client_id, bool send_mapping)
+{
+
+  Debug_pushMessage("send STATIC WS-Client Data\n");
+  if (send_mapping)
+  {
+    const char mapping[] = "MAPPING_STATIC:"
+                           "devicename;"
+                           "active_faction_on_reboot;"
+                           "batteryType;"
+                           "name_faction1;"
+                           "name_faction2;"
+                           "name_faction3;"
+                           "wifi-ssid;"
+                           "wifi-pass;"
+                           "fw-version;"
+                           "flash-version;"
+                           "git-revision;";
+
+    if (client_id > 0)
+      webSocket.text(client_id, mapping);
+    else
+      webSocket.textAll(mapping);
+
+    Debug_pushMessage("send MAPPING_STATIC WS-Client Data\n");
+  }
+
+  char dataString[200] = {0}; // Maximal 200 Zeichen für den Data-String
+
+  sprintf(dataString, "STATIC:%s;%d;%d;%s;%s;%s;%s;%s;%d.%02d;%s;%s;",
+          globals.DeviceName,
+          ConfigData.active_faction_on_reboot,
+          ConfigData.batteryType,
+          ConfigData.Faction_1_Name,
+          ConfigData.Faction_2_Name,
+          ConfigData.Faction_3_Name,
+          ConfigData.wifi_client_ssid,
+          ConfigData.wifi_client_password,
+          constants.FW_Version_major,
+          constants.FW_Version_minor,
+          globals.FlashVersion,
+          constants.GitHash);
+
+  if (client_id > 0)
+  {
+    webSocket.text(client_id, dataString);
+  }
+  else
+  {
+    webSocket.textAll(dataString);
+  }
+}
+
+/**
+ * @brief Parse a WebSocket string into identifier and value components.
+ *
+ * This function takes a WebSocket string, separates it into identifier and value
+ * components using the ":" delimiter, and stores them in the specified buffers.
+ * If no ":" is found, the entire string is considered as the value, and the
+ * identifier buffer is set to an empty string.
+ *
+ * @param data The WebSocket string to parse.
+ * @param identifierBuffer The buffer to store the identifier component.
+ * @param identifierBufferSize The size of the identifier buffer.
+ * @param valueBuffer The buffer to store the value component.
+ * @param valueBufferSize The size of the value buffer.
+ */
+void parseWebsocketString(char *data, char *identifierBuffer, size_t identifierBufferSize,
+                          char *valueBuffer, size_t valueBufferSize)
+{
+  // Zerlegen des Strings anhand des Trennzeichens ":"
+  char *token = strtok(data, ":");
+
+  // Falls der erste Teil des Strings vorhanden ist
+  if (token != NULL)
+  {
+    // Kopieren des ersten Teils in den Buffer für Identifier
+    strncpy(identifierBuffer, token, identifierBufferSize - 1);
+    identifierBuffer[identifierBufferSize - 1] = '\0'; // Null-Terminierung sicherstellen
+
+    // Weitere Aufrufe von strtok, um den nächsten Teil zu erhalten
+    token = strtok(NULL, ":");
+
+    // Falls der zweite Teil des Strings vorhanden ist
+    if (token != NULL)
+    {
+      // Kopieren des zweiten Teils in den Buffer für Value
+      strncpy(valueBuffer, token, valueBufferSize - 1);
+      valueBuffer[valueBufferSize - 1] = '\0'; // Null-Terminierung sicherstellen
+    }
+    else
+    {
+      // Kein zweiter Teil vorhanden, setzen Sie den Buffer für Value auf leer
+      valueBuffer[0] = '\0';
+    }
+  }
+  else
+  {
+    // Der erste Teil des Strings fehlt, setzen Sie den Buffer für Identifier auf leer
+    identifierBuffer[0] = '\0';
+
+    // Der gesamte String wird als Value betrachtet
+    strncpy(valueBuffer, data, valueBufferSize - 1);
+    valueBuffer[valueBufferSize - 1] = '\0'; // Null-Terminierung sicherstellen
+  }
+}
+
+/**
+ * @brief Find the index of a string in an array.
+ *
+ * This function searches for the given string in the provided array and returns
+ * the index of the first occurrence. If the string is not found, it returns -1.
+ *
+ * @param searchString The string to search for in the array.
+ * @param array The array of strings to search within.
+ * @param arraySize The size of the array.
+ *
+ * @return The index of the first occurrence of the string in the array,
+ *         or -1 if the string is not found.
+ */
+int findIndexByString(const char *searchString, const char *const *array, int arraySize)
+{
+  // Durchlaufe das Array und vergleiche jeden String
+  for (int i = 0; i < arraySize; ++i)
+  {
+    if (strcmp(array[i], searchString) == 0)
+    {
+      // String gefunden, gib den Index zurück
+      return i;
+    }
+  }
+  // String nicht gefunden, gib -1 zurück
+  return -1;
+}
+
+/**
+ * @brief Pushes a notification to all WebSocket clients.
+ *
+ * This function sends a live debug message to all connected WebSocket clients.
+ *
+ * @param Message The debug message to be sent.
+ * @param type The type of notification (info, success, warning, error).
+ *             - Use NotificationType_t::info for informational messages.
+ *             - Use NotificationType_t::success for successful operation messages.
+ *             - Use NotificationType_t::warning for warning messages.
+ *             - Use NotificationType_t::error for error messages.
+ */
+void Websocket_PushNotification(String Message, NotificationType_t type)
+{
+  String typeString = "";
+  switch (type)
+  {
+  case info:
+    typeString = "info";
+    break;
+  case success:
+    typeString = "success";
+    break;
+  case warning:
+    typeString = "warning";
+    break;
+  case error:
+    typeString = "danger";
+    break;
+  }
+  webSocket.textAll("NOTIFY:" + typeString + ";" + Message);
+  Debug_pushMessage("Sending Notification to WebUI: %s\n", typeString);
+}

Software/src/webui.h

@@ -1,16 +0,0 @@
-#ifndef _WEBUI_H_
-#define _WEBUI_H_
-
-#include <Arduino.h>
-#include <FS.h>
-#include <LittleFS.h>
-#include <ESPAsyncTCP.h>
-#include <ESPAsyncWebServer.h>
-#include "config.h"
-#include "globals.h"
-#include "dtc.h"
-#include "defaults.h"
-
-void initWebUI();
-
-#endif

Software/wifi_credentials.example.ini

@@ -1,5 +1,5 @@
 [wifi_cred]
-wifi_ap_password = wifiappass
+admin_password = chainlube
-wifi_ssid = wifi-ssid
+wifi_pass_seed = wifiapseed
-wifi_password = wifi-pass
+wifi_ssid_client = wifi-ssid
-admin_password = ota-password
+wifi_password_client = ota-password