docs: Erstes vollständiges Dokumentations-Setup (Anwender-Wiki, Entwickler-Wiki, README.md, CHANGELOG.md)
- Docusaurus für Anwenderdokumentation (/docs) - Zweiter Docusaurus-Bereich für Entwickler-Wiki vorbereitet (/docs/entwickler) - README.md als Einstieg für Entwickler - CHANGELOG.md zur Nachverfolgung von Änderungen → Dokumentation und Projektstruktur jetzt vollständig nachvollziehbar versioniert.
This commit is contained in:
23
docusaurus/docs/analoge-eingaenge.md
Normal file
23
docusaurus/docs/analoge-eingaenge.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# 🔢 Analoge Eingänge
|
||||
|
||||
Die Seite zeigt alle analogen Messwerte des Systems (z. B. Spannung, Temperatur).
|
||||
|
||||
## 🌐 Anzeige
|
||||
|
||||
- 1–8 Kanäle mit Live-Werten
|
||||
- Verlaufskurven über 24h
|
||||
- Farbige Statusanzeige je nach Grenzwert
|
||||
|
||||
## ⚙️ Einstellbare Parameter (im Modal)
|
||||
|
||||
- **Name**: Kanalbezeichnung (frei wählbar)
|
||||
- **Offset**: Korrekturwert zur Verschiebung
|
||||
- **Faktor**: Skalierung der Messung
|
||||
- **Intervall**: Messintervall in Sekunden
|
||||
|
||||
## 🔄 Simulation (im Testmodus)
|
||||
|
||||
- Eingabefeld für simulierte Werte
|
||||
- Aktivierung des Testmodus erforderlich
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
19
docusaurus/docs/digitale-ausgaenge.md
Normal file
19
docusaurus/docs/digitale-ausgaenge.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# 🔌 Digitale Ausgänge
|
||||
|
||||
Diese Seite zeigt die digitalen Schaltausgänge des Systems.
|
||||
|
||||
## 🔧 Steuerung
|
||||
|
||||
- Jeder Ausgang (1–4) ist einzeln schaltbar
|
||||
- Statusanzeige: aktiv (grün), inaktiv (grau)
|
||||
- Beschriftung durch Benutzer möglich
|
||||
|
||||
## ⚙️ Zusätzliche Funktionen
|
||||
|
||||
- Automatische Rücksetzung nach Zeit (wenn aktiviert)
|
||||
- Logikverknüpfungen möglich (z. B. über Eingänge)
|
||||
- Anzeige historischer Schaltzustände (falls aktiviert)
|
||||
|
||||
**Hinweis:** Für Schaltaktionen ist ggf. ein Benutzer-Login erforderlich.
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
21
docusaurus/docs/digitale-eingaenge.md
Normal file
21
docusaurus/docs/digitale-eingaenge.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# ⚖️ Digitale Eingänge
|
||||
|
||||
Diese Seite zeigt alle digitalen Meldungseingänge des CPLv4.0 Systems.
|
||||
|
||||
## 🔧 Bearbeitbare Felder (per Klick auf den Stift)
|
||||
|
||||
- **Name**: Bezeichnung des Eingangs (z. B. "Türkontakt")
|
||||
- **Invertierung**: Eingang logisch umkehren
|
||||
- **Filterzeit**: Entprellzeit in Sekunden
|
||||
- **Zähler aktivieren**: Ermöglicht Ereigniszählung
|
||||
- **Gewichtung**: Relativer Einfluss auf Summenanzeige
|
||||
|
||||
## 🌐 Anzeige
|
||||
|
||||
- Eingänge mit aktuellem Status (grün/rot)
|
||||
- Zählerstand falls aktiv
|
||||
- Optionaler Tooltip mit Statusbeschreibung
|
||||
|
||||
**Hinweis:** Einstellungen werden sofort im System gespeichert.
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
29
docusaurus/docs/einstellungen.md
Normal file
29
docusaurus/docs/einstellungen.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# ⚙️ Einstellungen
|
||||
|
||||
Die Seite "Einstellungen" ermöglicht die Konfiguration zentraler Systemparameter.
|
||||
|
||||
## 🚀 Netzwerk
|
||||
|
||||
- **IP-Adresse, Subnetz, Gateway**: Direkteingabe der Netzwerkdaten
|
||||
- **NTP-Zeitserver**: z. B. `pool.ntp.org`
|
||||
- **Gerätezeit manuell setzen** (nur mit Admin-Rechten)
|
||||
|
||||
## 🔧 OPC UA
|
||||
|
||||
- Aktivieren/Deaktivieren der Schnittstelle
|
||||
- Benutzerverwaltung für sicheren Zugriff
|
||||
|
||||
## 📄 Datenbank
|
||||
|
||||
- **Löschen von Messdaten** (z. B. TDR, Meldungen)
|
||||
- **Reset einzelner Module** möglich
|
||||
- Admin-Rechte erforderlich
|
||||
|
||||
## 🏦 Admin-Funktionen
|
||||
|
||||
- Firmware-Update
|
||||
- Backup/Restore-Konfigurationen
|
||||
|
||||
**Hinweis:** Für sicherheitsrelevante Änderungen ist ein Admin-Login notwendig.
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
0
docusaurus/docs/entwickler/api-design.md
Normal file
0
docusaurus/docs/entwickler/api-design.md
Normal file
0
docusaurus/docs/entwickler/architektur.md
Normal file
0
docusaurus/docs/entwickler/architektur.md
Normal file
0
docusaurus/docs/entwickler/datenfluss.md
Normal file
0
docusaurus/docs/entwickler/datenfluss.md
Normal file
0
docusaurus/docs/entwickler/index.md
Normal file
0
docusaurus/docs/entwickler/index.md
Normal file
0
docusaurus/docs/entwickler/technik-notizen.md
Normal file
0
docusaurus/docs/entwickler/technik-notizen.md
Normal file
20
docusaurus/docs/index.md
Normal file
20
docusaurus/docs/index.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# 📘 CPLv4.0 Anwenderhilfe
|
||||
|
||||
Willkommen zur Benutzerhilfe der CPLv4.0 Weboberfläche. Diese Dokumentation richtet sich an Anwender und Techniker, die das System bedienen.
|
||||
|
||||
## 📅 Seitenübersicht
|
||||
|
||||
- [Übersicht / dashboard](uebersicht.md)
|
||||
- [Kabelüberwachung](kabelueberwachung.md)
|
||||
- [Digitale Eingänge / Meldungseingänge](digitale-eingaenge.md)
|
||||
- [Digitale Ausgänge / Schaltausgänge](digitale-ausgaenge.md)
|
||||
- [Analoge Eingänge / Messüberwachung](analoge-eingaenge.md)
|
||||
- [Meldungen /Berichte](meldungen.md)
|
||||
- [System](system.md)
|
||||
- [Einstellungen](einstellungen.md)
|
||||
|
||||
---
|
||||
|
||||
> ❌ Hinweis: Für einige Funktionen wird ein Admin-Login benötigt (z. B. Firmware-Update, Datenbank-Löschung).
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
32
docusaurus/docs/kabelueberwachung.md
Normal file
32
docusaurus/docs/kabelueberwachung.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# 🏠 Kabelüberwachung
|
||||
|
||||
Die Seite "Kabelüberwachung" zeigt bis zu 32 Slots in vier Gruppen. Sie dient zur Live-Überwachung der Kabelsysteme und bietet Zugriff auf alle Messwerte und Einstellungen.
|
||||
|
||||
## ⚙️ Einstellungen pro Slot
|
||||
|
||||
- **Kabelbezeichnung**: Freier Name für das zu überwachende Kabel
|
||||
- **Isolationsgrenzwert (MOhm)**: Wert, ab dem ein Alarm ausgelöst wird
|
||||
- **Schleifengrenzwert (kOhm)**: Schleifenwiderstand für Alarmdefinition
|
||||
- **Filterzeit (s)**: Zeitverzögerung vor Alarmanzeige
|
||||
- **Loggerintervall**: Messdaten-Speicherintervall (z. B. 5 Minuten)
|
||||
- **Display einschalten**: Aktiviert die lokale Anzeige am Gerät
|
||||
|
||||
## ⚡ Alarme
|
||||
|
||||
- **Erdschluss erkannt**: Isolation unter Grenzwert
|
||||
- **Aderbruch vermutet**: Schleifenmessung kritisch
|
||||
|
||||
## 🌐 Anzeige
|
||||
|
||||
- Statusanzeige in Farbe (grün, gelb, rot)
|
||||
- Tooltip mit Live-Werten beim Überfahren
|
||||
|
||||
**Hinweis:** Alle Änderungen müssen über den "Speichern"-Button bestätigt werden, um das System zu aktualisieren.
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Weitere Funktionen
|
||||
|
||||
👉 Für Details zur Entfernungsmessung siehe [📊 TDR-Einstellungen](tdr-einstellungen.md)
|
||||
|
||||
Die TDR-Funktion ist pro Slot aktivierbar und zeigt eine separate Kurvenanzeige mit Referenzvergleich.
|
||||
24
docusaurus/docs/meldungen.md
Normal file
24
docusaurus/docs/meldungen.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# 📅 Meldungen
|
||||
|
||||
Die Seite "Meldungen" zeigt alle gespeicherten Systemmeldungen in chronologischer Reihenfolge.
|
||||
|
||||
## 🔄 Filterfunktionen
|
||||
|
||||
- **Zeitraum (von / bis)**: Auswahl per Kalender
|
||||
- **Textfilter**: Suche nach bestimmten Meldungsinhalten
|
||||
- **Schaltflächen**: z. B. "Nur Alarme", "Nur TDR"
|
||||
|
||||
## 🔹 Farbliche Darstellung
|
||||
|
||||
- **Rot**: Alarmmeldung (z. B. Isolationsfehler)
|
||||
- **Gelb**: Warnung (z. B. Grenzwert nähert sich)
|
||||
- **Grau**: Info / normaler Status
|
||||
|
||||
## 🔧 Bedienung
|
||||
|
||||
- Tabelle mit Spalten: Zeit, Art, Inhalt
|
||||
- Sortierung nach Zeit, Art, Priorität
|
||||
|
||||
**Hinweis:** Nur sichtbar, wenn Daten vorhanden sind (z. B. aus Mock oder Live-Modus).
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
24
docusaurus/docs/system.md
Normal file
24
docusaurus/docs/system.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# ⚡ System
|
||||
|
||||
Die Seite "System" zeigt technische Statusinformationen wie Spannungen und Temperaturen des CPLv4.0 Geräts.
|
||||
|
||||
## 🔋 Spannungen
|
||||
|
||||
- +5V, +12V, -15V etc.
|
||||
- Live-Anzeige je nach Modul
|
||||
- Farbcode bei Grenzwertverletzung (z. B. rot bei Unterspannung)
|
||||
|
||||
## 🌡️ Temperaturen
|
||||
|
||||
- CPU-Temperatur
|
||||
- Temperatur des A/D-Wandlers (ADC)
|
||||
- Verlaufskurven über 24h
|
||||
|
||||
## 🧪 Weitere Messgrößen
|
||||
|
||||
- Watchdog-Status
|
||||
- CPU-Auslastung (optional)
|
||||
|
||||
**Hinweis:** Diese Werte dienen hauptsächlich zur Diagnose und Systemüberwachung.
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
23
docusaurus/docs/tdr-einstellungen.md
Normal file
23
docusaurus/docs/tdr-einstellungen.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# 📊 TDR-Einstellungen
|
||||
|
||||
Die TDR-Funktion (Time Domain Reflectometry) dient zur Entfernungsmessung von Leitungsfehlern.
|
||||
|
||||
## ⚙️ Einstellbare Parameter
|
||||
|
||||
- **Dämpfung (Attenuation)**: Signalstärke, typischerweise 0–20
|
||||
- **Geschwindigkeit (Speed)**: Ausbreitungsgeschwindigkeit des Signals in m/µs
|
||||
- **Triggerwert**: Empfindlichkeit des Auslösers
|
||||
- **TDR aktivieren/deaktivieren**: Schaltet die Funktion pro Slot ein oder aus
|
||||
|
||||
## 🔄 Hinweis zum Status
|
||||
|
||||
Beim Umschalten der TDR-Funktion erscheint eine Bestätigung. Nach Klick auf "OK" wird die Seite automatisch neu geladen, um den neuen Zustand korrekt darzustellen.
|
||||
|
||||
> Hinweis: Der Reload ist notwendig, da der UI-Zustand nicht automatisch aktualisiert wird.
|
||||
|
||||
## 🌐 Anzeige
|
||||
|
||||
- Sichtbare Kurvenanzeige bei aktivierter Funktion
|
||||
- Referenzkurvenvergleich im Slot-Modal
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
60
docusaurus/docs/uebersicht.md
Normal file
60
docusaurus/docs/uebersicht.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# 📊 Übersicht
|
||||
|
||||
Diese Seite dient als zentrale Einstiegsübersicht in das CPLv4.0 System. Sie fasst die wichtigsten Statusanzeigen, Netzwerkinformationen und Systemkomponenten auf einen Blick zusammen.
|
||||
|
||||
---
|
||||
|
||||
## 🔔 Letzte 20 Meldungen
|
||||
|
||||
| ID | Modul | Zeitstempel | Meldung | Status |
|
||||
| ----- | ----- | ------------------- | ----------------- | ------ |
|
||||
| 25068 | 02101 | 2025-04-22 04:56:28 | Isofehler gehend | 0 |
|
||||
| 25067 | 02101 | 2025-04-22 04:56:28 | Isofehler kommend | 1 |
|
||||
| ... | ... | ... | ... | ... |
|
||||
|
||||
> Zeigt die letzten 20 Meldungen sortiert nach Zeitstempel, inklusive Statuskennzeichnung.
|
||||
|
||||
---
|
||||
|
||||
## 🧱 Baugruppen-Statusübersicht
|
||||
|
||||
Die Übersicht zeigt alle 32 Steckplätze in vier Blöcken zu je 8 Modulen.
|
||||
Jedes Modul (z. B. `K705S FO`) zeigt visuell seinen aktuellen Zustand (blau, rot, grün).
|
||||
|
||||
Beispielhafte Legende:
|
||||
|
||||
- 🟥 = Fehler
|
||||
- 🟩 = betriebsbereit
|
||||
|
||||
---
|
||||
|
||||
## 🖧 Netzwerk- & Systeminformationen
|
||||
|
||||
| Parameter | Wert |
|
||||
| ----------------- | --------------------- |
|
||||
| **IP-Adresse** | 10.10.0.243 |
|
||||
| **Subnet-Maske** | 255.255.255.0 |
|
||||
| **Gateway** | 10.10.0.1 |
|
||||
| **OPC UA Status** | Server betriebsbereit |
|
||||
| **App-Version** | 0.02 |
|
||||
| **Web-Version** | 1.6.341 |
|
||||
|
||||
> Diese Informationen werden automatisch aus dem System gelesen und bieten eine schnelle Diagnosemöglichkeit.
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Weiterführende Bereiche
|
||||
|
||||
- [Kabelüberwachung](kabelueberwachung.md)
|
||||
- [Digitale Eingänge](digitale-eingaenge.md)
|
||||
- [Digitale Ausgänge](digitale-ausgaenge.md)
|
||||
- [Analoge Eingänge](analoge-eingaenge.md)
|
||||
- [TDR Einstellungen](tdr-einstellungen.md)
|
||||
- [Meldungen](meldungen.md)
|
||||
- [System](system.md)
|
||||
- [Einstellungen](einstellungen.md)
|
||||
|
||||
---
|
||||
|
||||
📅 **Letzte Aktualisierung:** 3. Mai 2025
|
||||
👨💼 **Bearbeiter:** Ismail Ali
|
||||
Reference in New Issue
Block a user