Add README.md

README.md

@@ -0,0 +1,97 @@
+# Robot Night Logging
+
+## Überblick
+Experiment zur Analyse der Leistung eines Linienfolgers bei Nacht unter verschiedenen Bedingungen, einschließlich IR-Gain-Test und Materialvergleich.
+
+**experiment_key:** robot_night_logging
+
+Link zum Artikel: [https://donau2space.de/roboter-ueber-dem-wasser/](https://donau2space.de/roboter-ueber-dem-wasser/)
+
+Git Repository: [https://git.donau2space.de/Mika/robot_night_logging](https://git.donau2space.de/Mika/robot_night_logging)
+
+## Hinweis
+Alle Inhalte wurden per KI generiert.
+
+Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich auf eigenes Risiko. Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert.
+
+## Inhalt des Repositories
+
+Dieses Repository besteht aus drei zentralen Komponenten:
+
+### 1. ir_gain_test
+**Art:** python_script  
+**Ziel:** Linux Userspace  
+**Sprachen:** Python  
+**Zweck:** Analyse von IR-Gain-Werten und deren Auswirkungen auf die Sensorik des Roboters.  
+**API-Funktionen:**
+- **analyze_ir_gain(gain_values, intensity_data)** → Erstellt einen Analysebericht über das Sensorverhalten unter verschiedenen Verstärkungswerten.
+
+**Datenstruktur:** intensity_data (JSON)
+- timestamp
+- gain_value
+- intensity
+
+### 2. data_logging
+**Art:** python_script  
+**Ziel:** Linux Userspace  
+**Sprachen:** Python  
+**Zweck:** Erfassung und Protokollierung von Telemetriedaten während der Tests.  
+**API-Funktionen:**
+- **log_data(data)** → Protokolliert Dateneinträge und gibt den Erfolgsstatus zurück.
+
+**Datenstruktur:** log_entry (JSON)
+- timestamp
+- temperature
+- wind_speed
+- error_rate
+
+### 3. data_visualization
+**Art:** web_ui  
+**Ziel:** Webbrowser  
+**Sprachen:** HTML, CSS, JavaScript  
+**Zweck:** Visualisierung der gesammelten Telemetriedaten über eine Web-Schnittstelle.  
+**Routen:**
+- **GET /data** → Liefert die gesammelten Telemetriedaten zur Anzeige im Frontend.
+
+## Installation & Nutzung
+
+### Voraussetzungen
+- Python ≥ 3.9
+- Webserver (z. B. nginx oder Apache)
+- Optional: Virtuelle Umgebung zur Paketverwaltung
+
+### Installation
+1. Repository klonen:
+   - `git clone https://git.donau2space.de/Mika/robot_night_logging`
+2. Abhängigkeiten installieren:
+   - `pip install -r requirements.txt`
+3. Web-Dateien bereitstellen:
+   - Inhalte von `/data_visualization` in den Webserver-Wurzelordner kopieren.
+
+### Starten der Anwendung
+- Python-Skripte für Analyse und Logging über die Linux-Shell ausführen:
+  - `python ir_gain_test.py`
+  - `python data_logging.py`
+- Webinterface im Browser öffnen (z. B. `http://localhost:8080`)
+
+## Typische Use-Cases
+- Test des Linienfolgers bei Nacht mit variierenden IR-Gain-Werten
+- Vergleich der Sensordaten bei unterschiedlichen Oberflächenmaterialien
+- Echtzeit-Logging und nachträgliche Auswertung der Telemetriedaten
+- Webbasierte Visualisierung der Testprotokolle
+
+## Struktur & Erweiterbarkeit
+Das Repository ist modular aufgebaut:
+- **analysis/**: Python-Analyseskripte
+- **logging/**: Datenerfassung und -speicherung
+- **web/**: Visualisierungsoberfläche
+
+Erweiterungen sind möglich durch:
+- Ergänzung weiterer Sensoranalysefunktionen in `ir_gain_test`
+- Neue Datenquellen im Logging-Modul
+- Anpassung des Frontends für zusätzliche Kennzahlen
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+Alle Inhalte wurden automatisiert erstellt; Nutzung erfolgt auf eigene Gefahr.