diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000..0fe773b --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,58 @@ +# nanoPSX Roadmap + +Die nächsten Entwicklungsschritte sind eine übersichtlichere Projektstruktur, +die gezielte Optimierung der eigenen Module und die dauerhafte Speicherung +der Messwerte auf einer SD-Karte. Alle drei Punkte sind offen; die Reihenfolge +entspricht der geplanten Priorität. + +## 1 Eigenen Projektcode strukturieren + +Ziel ist Code, den Menschen und KI leichter verstehen, ändern und prüfen können. +Der Umfang umfasst den selbst entwickelten Code im gesamten Projekt, einschließlich +Firmware, Serveranwendung, Werkzeugen und Tests. Herstellerbibliotheken, SDK und +unverändert übernommene Fremdkomponenten bleiben von der Umstrukturierung ausgenommen. + +- [ ] Eigene Module, übernommene Bibliotheken und generierte Dateien erfassen und eindeutig unterscheiden. +- [ ] Große Module nach klaren Verantwortlichkeiten in kleinere Dateien aufteilen; zusammengehörige Logik zusammenhalten. +- [ ] Benennung, Verzeichnisstruktur und öffentliche Schnittstellen vereinheitlichen. +- [ ] Initialisierung, Hardwarezugriff, Datenverarbeitung, Anzeige und Netzwerklogik klar zuordnen. +- [ ] Eine kompakte Architekturübersicht mit Einstiegspunkten, Zuständigkeiten, Abhängigkeiten und Datenflüssen ergänzen. +- [ ] Generierte EEZ-Dateien weiterhin aus ihrer Quelle erzeugen; Anpassungen an der Struktur im Exporter berücksichtigen. +- [ ] Nach jeder abgegrenzten Umstrukturierung Build und passende Tests ausführen; das bisherige Verhalten erhalten. + +**Ergebnis:** Kleine, verständliche Module mit klaren Aufgaben und dokumentierten +Schnittstellen. Zusätzliche Dateien entstehen dort, wo sie das Verständnis verbessern; +eine möglichst hohe Dateizahl ist kein eigenes Ziel. + +## 2 Logik und Effizienz der eigenen Module prüfen + +Jedes selbst entwickelte Modul einzeln durchgehen und untersuchen, ob seine Logik +einfacher, zuverlässiger oder sparsamer umgesetzt werden kann. + +- [ ] Aufgaben, Zustände, Datenflüsse und Fehlerfälle jedes eigenen Moduls nachvollziehen. +- [ ] CPU-Zeit, RAM- und Stackbedarf sowie unnötige Speicherallokationen untersuchen. +- [ ] Blockierende Aufrufe, Warteschlangen, Task-Zusammenspiel und gemeinsame Datenzugriffe prüfen. +- [ ] Wiederholte Berechnungen, doppelte Logik und unnötige Hardware-, Netzwerk- oder Flashzugriffe erkennen. +- [ ] Verbesserungen nach messbarem Nutzen priorisieren und in kleinen Schritten umsetzen. +- [ ] Vorher und nachher vergleichen und die relevanten Normal- und Fehlerfälle testen. + +**Ergebnis:** Nachvollziehbar effizientere Module. Messfrequenz, Messwertbedeutung, +Bedienung und bestehende Funktionen bleiben erhalten, sofern keine bewusste +Funktionsänderung vereinbart wird. + +## 3 Messwerte auf SD-Karte speichern + +Die Messwerte sollen zusätzlich zur InfluxDB-Übertragung dauerhaft lokal gespeichert +werden. Aktuell meldet die SD-Karteninitialisierung einen Timeout; dessen Ursache +muss vor der Integration des Datenloggers geklärt werden. + +- [ ] SD-Anbindung, Verdrahtung, Pull-ups und Initialisierung prüfen und den bestehenden Timeout beheben. +- [ ] Ein geeignetes Dateiformat für Zeitstempel, Sensortyp, Messwerte und Einheiten festlegen. +- [ ] Einen separaten Schreibpfad mit begrenztem Puffer und gebündelten Schreibvorgängen integrieren. +- [ ] Sensorerfassung, Display und InfluxDB-Übertragung unabhängig von langsamen SD-Zugriffen weiterlaufen lassen. +- [ ] Dateirotation, Speichergrenzen und Verhalten bei voller, fehlender oder entfernter Karte festlegen. +- [ ] Nicht verfügbare Messwerte und eine noch fehlende UTC-Zeit eindeutig kennzeichnen. +- [ ] Lesen und Auswerten der Dateien sowie Neustart, Schreibfehler und Unterbrechungen testen. + +**Ergebnis:** Dauerhaft gespeicherte und auswertbare Messdateien auf der SD-Karte. +Probleme mit der Karte werden angezeigt und verhindern den übrigen Gerätebetrieb nicht.