diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b728db --- /dev/null +++ b/README.md @@ -0,0 +1,86 @@ +# Rover Experiment Donau + +## Überblick +Das Projekt **rover_experiment_donau** untersucht die Wahrnehmung von Maschinen anhand von Messungen zu Licht, Ton und Temperatur, die durch einen Rover erfasst werden. Ziel ist die technische Aufzeichnung und Analyse von Umweltsignalen in einem experimentellen Kontext. + +**Link zum Artikel:** [https://donau2space.de/rover-experiment-an-der-donau-signal-aus-der-nacht/](https://donau2space.de/rover-experiment-an-der-donau-signal-aus-der-nacht/) + +**Git Repository:** [https://git.donau2space.de/Mika/rover_experiment_donau](https://git.donau2space.de/Mika/rover_experiment_donau) + +### 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 +Das Repository enthält mehrere Python-Skripte zur Initialisierung, Aufzeichnung und Analyse von Sensordaten: + +### 1. rover_startup +- **Art:** python_script +- **Ziel:** linux-userspace +- **Sprache:** Python +- **Zweck:** Initialisiert die Sensoren und bereitet den Rover auf Messungen vor. +- **API-Funktion:** + - `init_sensors()`: Initialisiert alle aktiven Sensoren und liefert eine Datenstruktur mit aktuellen Sensordaten. +- **Datenstruktur:** + - `SensorData`: Beinhaltet Felder `light`, `infrared`, `sound`, `core_temp`, `battery_status`. + +### 2. data_logging +- **Art:** python_script +- **Ziel:** linux-userspace +- **Sprache:** Python +- **Zweck:** Zeichnet während des Roverbetriebs fortlaufend Sensorwerte auf und speichert sie im Log-Format. +- **API-Funktion:** + - `log_data(SensorData)`: Speichert die übergebenen Sensordaten als neuen Logeintrag. +- **Datenstruktur:** + - `LogEntry`: Beinhaltet Felder `time`, `lux`, `dB`, `temperature`, `inference_score`. + +### 3. data_analysis +- **Art:** python_script +- **Ziel:** linux-userspace +- **Sprache:** Python +- **Zweck:** Führt Datenanalysen auf gespeicherten Sensordaten durch, um Muster und Anomalien zu identifizieren. +- **API-Funktion:** + - `analyze_data(List[LogEntry])`: Analysiert Logeinträge und liefert strukturierte Ergebnisse. +- **Datenstruktur:** + - `AnalysisResult`: Beinhaltet Felder `significant_patterns` und `anomaly_events`. + +## Installation & Nutzung +### Voraussetzungen +- Linux-System mit Python 3.8 oder höher +- Installierte Standardbibliotheken (`dataclasses`, `os`, `time`, `json`) + +### Installation +1. Repository klonen: + `git clone https://git.donau2space.de/Mika/rover_experiment_donau` +2. In das Projektverzeichnis wechseln: + `cd rover_experiment_donau` +3. Optional: Virtuelle Umgebung einrichten und aktivieren. +4. Abhängigkeiten installieren (sofern `requirements.txt` vorhanden): + `pip install -r requirements.txt` + +### Nutzung +1. **Rover initialisieren:** + `python3 rover_startup.py` +2. **Daten aufzeichnen:** + `python3 data_logging.py` +3. **Analyse durchführen:** + `python3 data_analysis.py` + +## Typische Use-Cases +- Erfassung von Sensorwerten in Außenumgebungen (Tag/Nacht-Vergleich) +- Detektion ungewöhnlicher Umweltveränderungen (Temperaturschwankungen, Geräuschspitzen) +- Entwicklung und Validierung von Auswertungsalgorithmen für Sensordaten + +## Struktur & mögliche Erweiterungen +- **/scripts** – Sammlung der Python-Module für Initialisierung, Logging und Analyse +- **/data** – Sammelverzeichnis für Logdateien und temporäre Messdaten +- **/analysis** – Berichte und Analyseergebnisse + +Erweiterungen: +- Implementierung zusätzlicher Sensortypen (z. B. chemische Sensoren) +- Integration eines Webinterfaces zur Live-Anzeige von Messwerten +- Automatisierter Datenexport an externe Analyseplattformen + +## Lizenz +Dieses Projekt steht unter der **MIT-Lizenz**. + +Alle Inhalte wurden per KI generiert. Die Nutzung und Weiterentwicklung erfolgt auf eigenes Risiko, es wird keine Gewährleistung übernommen. \ No newline at end of file