From f69a520c596f321190d5a490d3475a42e07441d5 Mon Sep 17 00:00:00 2001 From: ISA Date: Mon, 31 Mar 2025 11:48:20 +0200 Subject: [PATCH] Readme.md erstellt --- config/webVersion.ts | 2 +- .../Diagramme/Redux-Aktivitaetsdiagramm.wsd | 0 .../Diagramme}/Redux-Prozessdiagramm.dot | 0 .../Diagramme}/Redux-Sequenzdiagramm.dot | 0 docs/Diagramme/tdrAbhaengigkeit.dot | 8 ++ .../Diagramme}/tdr_redux_diagram.dot | 0 docs/README.md | 102 ++++++++++++++++++ {draw.io => docs/draw.io}/test.drawio | 0 8 files changed, 111 insertions(+), 1 deletion(-) rename Diagramme/Redux-Aktivitaetsdiagramm.dot => docs/Diagramme/Redux-Aktivitaetsdiagramm.wsd (100%) rename {Diagramme => docs/Diagramme}/Redux-Prozessdiagramm.dot (100%) rename {Diagramme => docs/Diagramme}/Redux-Sequenzdiagramm.dot (100%) create mode 100644 docs/Diagramme/tdrAbhaengigkeit.dot rename {Diagramme => docs/Diagramme}/tdr_redux_diagram.dot (100%) create mode 100644 docs/README.md rename {draw.io => docs/draw.io}/test.drawio (100%) diff --git a/config/webVersion.ts b/config/webVersion.ts index da321a5..b6b4ad2 100644 --- a/config/webVersion.ts +++ b/config/webVersion.ts @@ -6,5 +6,5 @@ 2: Patch oder Hotfix (Bugfixes oder kleine Änderungen). */ -const webVersion = "1.6.189"; +const webVersion = "1.6.190"; export default webVersion; diff --git a/Diagramme/Redux-Aktivitaetsdiagramm.dot b/docs/Diagramme/Redux-Aktivitaetsdiagramm.wsd similarity index 100% rename from Diagramme/Redux-Aktivitaetsdiagramm.dot rename to docs/Diagramme/Redux-Aktivitaetsdiagramm.wsd diff --git a/Diagramme/Redux-Prozessdiagramm.dot b/docs/Diagramme/Redux-Prozessdiagramm.dot similarity index 100% rename from Diagramme/Redux-Prozessdiagramm.dot rename to docs/Diagramme/Redux-Prozessdiagramm.dot diff --git a/Diagramme/Redux-Sequenzdiagramm.dot b/docs/Diagramme/Redux-Sequenzdiagramm.dot similarity index 100% rename from Diagramme/Redux-Sequenzdiagramm.dot rename to docs/Diagramme/Redux-Sequenzdiagramm.dot diff --git a/docs/Diagramme/tdrAbhaengigkeit.dot b/docs/Diagramme/tdrAbhaengigkeit.dot new file mode 100644 index 0000000..2301f45 --- /dev/null +++ b/docs/Diagramme/tdrAbhaengigkeit.dot @@ -0,0 +1,8 @@ +digraph TDRGraph { + Slot -> TDM [label="lädt TDM-Liste"]; + TDM -> TDR [label="liefert ID → TDR"]; + TDR -> "TDR Chart" [label="Daten für Chart"]; + Referenzkurve -> "TDR Chart" [label="wird überlagert"]; + TDR -> Referenzkurve [label="kann gesetzt werden"]; + Slot -> Referenzkurve [label="Slot-gebunden"]; +} diff --git a/Diagramme/tdr_redux_diagram.dot b/docs/Diagramme/tdr_redux_diagram.dot similarity index 100% rename from Diagramme/tdr_redux_diagram.dot rename to docs/Diagramme/tdr_redux_diagram.dot diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..4d8dcb2 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,102 @@ +# ⚡ CPLv4.0 – Frontend für das Kabelüberwachungssystem + +Das Frontend von CPLv4.0 stellt verschiedene Systeminformationen, Messdaten und Konfigurationen übersichtlich dar. +Die Benutzeroberfläche ist intuitiv und modular aufgebaut und bietet Zugriff auf digitale sowie analoge Ein-/Ausgänge, TDR-Messungen, Referenzkurven, Systemmeldungen und Einstellungen. + +--- + +## 🧭 Seitenübersicht + +### 🔹 **Header** + +- Zeigt den Namen der Station / des Geräts (CPL) +- Abmelden-Button für Admins + +### 🔹 **Footer** + +- Firmenname, Telefonnummer, E-Mail +- PDF-Handbücher (Anleitung) als Slider mit Download-Funktion + +--- + +### 🖥️ **/dashboard** – Übersicht + +- Letzten 20 Meldungen aus dem System +- Versionsinformationen (Frontend, Backend) +- Baugruppenträger mit Modulnamen und Statusanzeige (grün = OK, rot = Fehler) +- Netzwerk-Informationen: + - IP-Adresse + - Subnetzmaske + - Gateway + - OPC UA Status (in Betrieb oder offline) + - OPC UA Nodeset Name + +--- + +### 📡 **/kabelueberwachung** – Kabelüberwachung + +- Visualisierung der Slots (KUE 1–32) in 4 Racks +- Darstellung von: + - Isolationswiderstand + - Schleifenwiderstand + - TDR-Messkurven und Vergleich mit Referenzkurve + - Alarme (z. B. Erdschluss, Aderbruch) +- Einstellung pro Slot (via Zahnrad → Modal) + +--- + +### 🔌 **/einausgaenge** – Digitale Ein- und Ausgänge + +- Digitale Eingänge (1–32) mit Statusanzeige +- Digitale Ausgänge (1–4) mit Umschaltfunktion (Toggle) +- Modale für Beschreibung und Konfiguration + +--- + +### 🌡️ **/analogeEingaenge** + +- Tabelle mit analogen Eingangswerten (z. B. Temperatur, Spannung) +- Diagramm zur Visualisierung von Verlauf / Trends + +--- + +### 📝 **/meldungen** + +- Gesamte Meldungshistorie +- Anzeige von Statusfarbe, Zeit, Gewichtung, Nachricht, Quelle +- Pagination (10 Meldungen pro Seite) + +--- + +### ⚙️ **/einstellungen** + +- Allgemeine Systemeinstellungen +- OPC UA Konfiguration + - Benutzer, Verschlüsselung, Clients + - Verbindung & Nodeset-Verwaltung + +--- + +## 🔧 Technologien + +- **Next.js** (Pages Router) +- **React** (mit funktionalen Komponenten & Hooks) +- **Tailwind CSS** für responsives UI-Design +- **Redux Toolkit** zur Zustandverwaltung +- **Mockdaten** im Verzeichnis `public/CPLmockData/` +- **Iconify Icons** & **Bootstrap Icons** für UI-Darstellung + +--- + +## 🔧 Installation auf dem CPLv4.0 + +```bash +git clone http://10.10.0.12:3000/ISA/CPL_V4_Frontend +cd cplv4-frontend +npm install +npm run build + +Danach: +Inhalt des out-Verzeichnisses per FTP auf das CPL-Gerät kopieren +Ziel: B → WEBS Verzeichnis +``` diff --git a/draw.io/test.drawio b/docs/draw.io/test.drawio similarity index 100% rename from draw.io/test.drawio rename to docs/draw.io/test.drawio