diff --git a/readme_md b/readme_md new file mode 100644 index 0000000..2fde5af --- /dev/null +++ b/readme_md @@ -0,0 +1,102 @@ +# Donau Data Listener + +## Überblick + +Das Experiment **donau_data_listener** untersucht die akustische Erfassung und Analyse von Umweltdaten an der Donau. Dabei werden Mikrofone eingesetzt, um Umgebungsgeräusche zu sammeln, die anschließend durch KI-gestützte Algorithmen nach Mustern untersucht werden. Ziel ist es, Zusammenhänge zwischen akustischen Signalen und Umweltparametern wie Wasserstand oder Bodenerschütterung zu erkennen. + +**Artikel:** [https://donau2space.de/donau-rauschen-der-daten-ki-hoert-dem-fluss-zu/](https://donau2space.de/donau-rauschen-der-daten-ki-hoert-dem-fluss-zu/) +**Git Repository:** [https://git.donau2space.de/Mika/donau_data_listener](https://git.donau2space.de/Mika/donau_data_listener) + +### Hinweis +Alle Inhalte wurden per KI generiert. +Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich und auf eigenes Risiko. +Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert. + +## Inhalt des Repositories + +Das Repository enthält mehrere Komponenten zur Datenerfassung, -verarbeitung und -visualisierung: + +### 1. Donau Listener (`donau_listener`) +**Art:** Python-Skript +**Ziel:** Linux Userspace +**Sprachen:** Python +**Zweck:** Aufnahme und Auswertung akustischer Umgebungsdaten. + +**API-Funktionen:** +- `start_recording(gain, threshold)` – Startet die akustische Erfassung mit Verstärkungs- und Schwellenwertsteuerung. +- `log_data(timestamp, water_level, ground_vibration, ai_label)` – Protokolliert verarbeitete Daten in strukturierter Form. + +**Datenstruktur:** +- `RecordingData` (JSON): timestamp, water_level, ground_vibration, ai_label. + +### 2. Data Visualization (`data_visualization`) +**Art:** Webanwendung (web_ui) +**Ziel:** Browser +**Sprachen:** HTML, CSS, JavaScript +**Zweck:** Darstellung und Analyse der von der KI ermittelten akustischen und physikalischen Daten in Diagrammform. + +**API-Funktionen:** +- `fetch_data()` – Ruft aktuelle Datensätze als JSON ab. +- `render_chart(data)` – Visualisiert die Analyseergebnisse im Browser. + +**Datenstruktur:** +- `VisualizationData` (JSON): time, water_level, ground_vibration, ai_label. + +**Verwendete Komponenten:** chart-css, chart.js + +### 3. Data Logging (`data_logging`) +**Art:** Python-Skript +**Ziel:** Linux-Demo +**Sprachen:** Python +**Zweck:** Speichern und Verarbeiten erfasster Umweltdaten in CSV-Format. + +**API-Funktionen:** +- `export_to_csv(data)` – Exportiert strukturierte Datensätze in eine Datei. + +**Datenstruktur:** +- `LogEntry` (JSON): timestamp, water_level, ground_vibration, ai_label. + +## Installation & Nutzung + +### Voraussetzungen +- Betriebsumgebung: Linux +- Python ≥ 3.9 +- Webserver (lokal oder remote) für den Visualisierungsteil + +### Python-Komponenten installieren +1. Repository klonen: + `git clone https://git.donau2space.de/Mika/donau_data_listener` +2. Abhängigkeiten installieren: + `pip install -r requirements.txt` + +### Start der Analyse +1. Datenerfassung starten: + `python donau_listener.py` +2. Datenprotokollierung nutzen: + `python data_logging.py` + +### Start der Webanwendung +1. Lokalen Webserver starten (z. B. via Python): + `python -m http.server 8080` +2. Browser öffnen: + `http://localhost:8080/data_visualization/index.html` + +## Typische Use-Cases +- Überwachung von Wasserstandsänderungen über akustische Signaturen. +- Untersuchung von Vibrationsmustern im Uferbereich. +- Kombinierte Analyse physikalischer und auditiver Messdaten. +- Visualisierung und Vergleich von Zeitreihen aus Feldmessungen. + +## Struktur & Erweiterbarkeit +Das Projekt ist modular aufgebaut: +- **Python-Skripte:** Datenerfassung, Logging und Formatierung. +- **Web-Frontend:** Visualisierungsschicht zur Darstellung von Analyseergebnissen. + +Zukünftige Erweiterungen: +- Integration zusätzlicher Sensorquellen (z. B. Temperatur, chemische Analysewerte) +- Erweiterte KI-Klassifikatoren für Echtzeitbewertung +- Erweiterte Schnittstellen für Datenaustausch mit externen Systemen + +## Lizenz +Dieses Projekt steht unter der **MIT-Lizenz**. +Jegliche Nutzung oder Weiterentwicklung erfolgt auf eigenes Risiko.