docs: move user documentation to docs/user-guide as single source of truth
This commit is contained in:
64
docs/user-guide/ForUser-Dashboard.md
Normal file
64
docs/user-guide/ForUser-Dashboard.md
Normal file
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: Dashboard
|
||||
---
|
||||
|
||||
# 📊 Ü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](DigitaleEingaenge.md)
|
||||
- [Digitale Ausgänge](DigitaleAusgaenge.md)
|
||||
- [Analoge Eingänge](AnalogeEingaenge.md)
|
||||
- [TDR Einstellungen](tdr-einstellungen.md)
|
||||
- [Meldungen](Meldungen.md)
|
||||
- [System](System.md)
|
||||
- [Einstellungen](Einstellungen.md)
|
||||
|
||||
---
|
||||
|
||||
📅 **Letzte Aktualisierung:** 3. Mai 2025
|
||||
👨💼 **Bearbeiter:** Ismail Ali
|
||||
41
docs/user-guide/ForUser-DigitaleAusgaenge.md
Normal file
41
docs/user-guide/ForUser-DigitaleAusgaenge.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# 🔌 Digitale Ausgänge /Schaltausgänge
|
||||
|
||||
In diesem Modul können die **digitalen Schaltausgänge (1–4)** des Systems verwaltet werden. Jeder Ausgang repräsentiert eine digitale Steuerleitung, mit der z. B. Relais, Lampen oder andere Geräte ein- oder ausgeschaltet werden können.
|
||||
|
||||
## 🧩 Übersicht
|
||||
|
||||
Die Ausgänge werden tabellarisch dargestellt:
|
||||
|
||||
| Spalte | Beschreibung |
|
||||
| --------------- | ----------------------------------------------------------------- |
|
||||
| **Ausgang** | Nummer und Icon zur eindeutigen Kennzeichnung |
|
||||
| **Bezeichnung** | Benutzerdefinierter Name für den Ausgang (z. B. „Licht Relais 1“) |
|
||||
| **Schalter** | Interaktives Symbol zum Umschalten des Ausgangs (Ein/Aus) |
|
||||
| **Aktion** | Zahnradsymbol öffnet die Konfiguration für den jeweiligen Ausgang |
|
||||
|
||||
Der aktuelle Zustand wird farblich dargestellt:
|
||||
|
||||
- **Grün (EIN)**: Ausgang ist aktiv
|
||||
- **Grau (AUS)**: Ausgang ist deaktiviert
|
||||
|
||||
## ⚙️ Konfiguration
|
||||
|
||||
Durch Klick auf das Zahnrad öffnet sich ein Modal-Fenster mit folgenden Einstellmöglichkeiten:
|
||||
|
||||
| Feld | Beschreibung |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
| **Bezeichnung** | Frei wählbare Beschreibung (z. B. „Heizung Relais“) |
|
||||
| **Status** | Sofortiges Umschalten zwischen EIN (grün) und AUS (grau) |
|
||||
| **Speichern** | Änderungen werden gespeichert und sofort übernommen |
|
||||
|
||||
:::info
|
||||
Schaltbefehle werden direkt an das Backend gesendet und gespeichert. Eine visuelle Rückmeldung erfolgt im Modal.
|
||||
:::
|
||||
|
||||
## 🔁 Automatische Aktualisierung
|
||||
|
||||
Die Anzeige wird alle 10 Sekunden automatisch aktualisiert. Änderungen am Status oder an Bezeichnungen anderer Benutzer werden somit zeitnah übernommen.
|
||||
|
||||
## 🔒 Hinweise
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
73
docs/user-guide/ForUser-DigitaleEingaenge.md
Normal file
73
docs/user-guide/ForUser-DigitaleEingaenge.md
Normal file
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: Digitale Eingänge / Meldungseingänge
|
||||
---
|
||||
|
||||
## 🔍 Übersicht
|
||||
|
||||
Die Meldungseingänge dienen zur Überwachung von digitalen Signalen, wie z. B. Schaltkontakten, Alarmmeldungen oder Relaiszuständen. In der Benutzeroberfläche werden alle Eingänge tabellarisch in zwei Gruppen dargestellt:
|
||||
|
||||
- **Eingänge 1–16**
|
||||
- **Eingänge 17–32**
|
||||
|
||||
Jeder Eingang zeigt:
|
||||
|
||||
- seinen aktuellen **Zustand** (Ein/Aus),
|
||||
- seine individuelle **Bezeichnung**,
|
||||
- und ein **Bearbeitungssymbol** (Zahnrad) zur Konfiguration.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Einstellungen pro Eingang
|
||||
|
||||
Durch Klick auf das Zahnrad-Icon öffnet sich ein Einstellungsdialog (Modal) für den gewählten Eingang.
|
||||
|
||||
### Einstellbare Parameter:
|
||||
|
||||
| Parameter | Beschreibung |
|
||||
| ------------------- | ----------------------------------------------------------------------- |
|
||||
| **Name** | Frei definierbare Bezeichnung des Eingangs |
|
||||
| **Invertierung** | Umkehrung der Signalinterpretation (z. B. bei Öffnerkontakten sinnvoll) |
|
||||
| **Filterzeit (ms)** | Zeitverzögerung zur Unterdrückung kurzer Impulse (0–2000 ms) |
|
||||
| **Gewichtung** | Einflussstärke des Eingangs für Meldungsbewertungen (0–1000) |
|
||||
| **Zähler aktiv** | Aktiviert einen Zähler, der die Schaltvorgänge dieses Eingangs mitzählt |
|
||||
|
||||
---
|
||||
|
||||
## 🟢 Zustandssymbole
|
||||
|
||||
| Symbol | Bedeutung |
|
||||
| ------ | --------------- |
|
||||
| 🔴 ● | Eingang „Aus“ |
|
||||
| 🟢 ● | Eingang „Ein“ |
|
||||
| ✖ | Eingang inaktiv |
|
||||
|
||||
Beim Überfahren der Symbole wird ein Tooltip mit Detailinformationen eingeblendet.
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Zähler und Diagnose
|
||||
|
||||
- Der **Zählerstand** zeigt, wie oft der Eingang aktiviert wurde (z. B. bei Impulszählern).
|
||||
- Der Status „**Inaktiv**“ bedeutet, dass der Eingang derzeit keine gültigen Signale liefert oder vom System nicht erkannt wurde.
|
||||
|
||||
---
|
||||
|
||||
## 💾 Speichern und Rückmeldung
|
||||
|
||||
- Nach dem Anpassen der Parameter muss der Button **„Speichern“** betätigt werden.
|
||||
- Die Werte werden entweder lokal (Entwicklungsmodus) oder per CGI-Schnittstelle (Produktivsystem) an die CPL-Hardware übertragen.
|
||||
- Eine entsprechende Bestätigungsmeldung informiert über den Erfolg oder eventuelle Fehler.
|
||||
|
||||
---
|
||||
|
||||
## 📝 Hinweise
|
||||
|
||||
- Alle Eingänge werden regelmäßig aktualisiert (alle 10 Sekunden).
|
||||
- Es kann jeweils nur **ein Eingang gleichzeitig** im Modal bearbeitet werden.
|
||||
- Änderungen ohne Unterschied zum Ursprungszustand lösen keine Speicherung aus (Hinweis „⚠️ Keine Änderungen erkannt“).
|
||||
|
||||
---
|
||||
|
||||
## 📷 Beispielansicht
|
||||
|
||||

|
||||
77
docs/user-guide/ForUser-Einstellungen.md
Normal file
77
docs/user-guide/ForUser-Einstellungen.md
Normal file
@@ -0,0 +1,77 @@
|
||||
---
|
||||
title: ⚙️ Einstellungen
|
||||
---
|
||||
|
||||
## ⚙️ Übersicht
|
||||
|
||||
Im Menüpunkt **Einstellungen** befinden sich alle zentralen Konfigurationen für den Betrieb des CPL-Systems. Die Einstellungen sind in verschiedene Abschnitte unterteilt, die jeweils spezifische Funktionen abdecken.
|
||||
|
||||
---
|
||||
|
||||
## 🕒 NTP-Zeitsynchronisation
|
||||
|
||||
Hier kannst du die automatische Uhrzeitsynchronisation mit bis zu drei NTP-Servern konfigurieren.
|
||||
|
||||
| Feld | Beschreibung |
|
||||
| ------------------ | --------------------------------------------------- |
|
||||
| **NTP Server 1–3** | IP-Adresse oder Hostname der Zeitserver. |
|
||||
| **Zeitzone** | Textfeld für die Zeitzone (z. B. `Europe/Berlin`). |
|
||||
| **NTP aktiv** | Aktiviert/deaktiviert die automatische Zeitabfrage. |
|
||||
|
||||
> Änderungen werden durch Klick auf **„Speichern“** übernommen.
|
||||
|
||||
---
|
||||
|
||||
## 🌐 OPCUA-Schnittstelle
|
||||
|
||||
Diese Sektion erlaubt die Konfiguration der **OPCUA-Schnittstelle**, mit der Daten an externe Systeme übergeben werden können.
|
||||
|
||||
| Feld | Beschreibung |
|
||||
| --------------------- | ----------------------------------------------------------------- |
|
||||
| **Server aktivieren** | Startet oder stoppt den OPCUA-Server. |
|
||||
| **OPCUA Zustand** | Anzeige des aktuellen Systemstatus (z. B. Initialisiert, Fehler). |
|
||||
| **Nodeset Name** | Technischer Name für den OPCUA-Knotenbaum. |
|
||||
|
||||
> Die Verschlüsselung und Benutzerverwaltung sind aktuell deaktiviert, aber intern vorbereitet.
|
||||
|
||||
---
|
||||
|
||||
## 👤 Admin-Anmeldung
|
||||
|
||||
Nur autorisierte Personen dürfen systemkritische Änderungen vornehmen. Dafür ist ein Admin-Login erforderlich.
|
||||
|
||||
- Felder: Benutzername + Passwort
|
||||
- Nach erfolgreicher Anmeldung erscheint eine Bestätigung: „Login erfolgreich“
|
||||
- Button „Admin abmelden“ trennt die Sitzung
|
||||
|
||||
### 🔄 Firmware-Update für Kabelüberwachungsmodule
|
||||
|
||||
Nach erfolgreicher Anmeldung kann zusätzlich ein **Firmware-Update** für einzelne oder alle KÜE-Module (Kabelüberwachungseinheiten) durchgeführt werden.
|
||||
|
||||
- Der Update-Prozess wird über ein modales Fenster gestartet.
|
||||
- Es erscheint ein Bestätigungsdialog, bevor der Vorgang beginnt.
|
||||
- Nach erfolgreichem Update erfolgt eine Rückmeldung über das Ergebnis.
|
||||
|
||||
> ⚠️ Firmware-Updates sollten nur von autorisierten Fachpersonen durchgeführt werden. Während des Updates darf das Gerät nicht ausgeschaltet oder getrennt werden.
|
||||
|
||||
---
|
||||
|
||||
## 📦 Datenbank
|
||||
|
||||
Die Sektion „Database Settings“ ist vorbereitet, jedoch derzeit ausgeblendet. Spätere Funktionen könnten beinhalten:
|
||||
|
||||
- Backup leeren
|
||||
- Datenbankverbindung ändern
|
||||
- Konfigurationsständen
|
||||
|
||||
---
|
||||
|
||||
## 📘 Hinweise
|
||||
|
||||
- Änderungen wirken sich direkt auf den Systembetrieb aus.
|
||||
- Nach kritischen Änderungen empfiehlt sich ein Neustart des CPL-Geräts.
|
||||
- Achte bei der Eingabe von Servernamen oder IP-Adressen auf korrekte Schreibweise.
|
||||
|
||||
---
|
||||
|
||||
> 🔒 Die Systemseite ist aus Sicherheitsgründen nur mit Admin-Rechten vollständig nutzbar.
|
||||
147
docs/user-guide/ForUser-Kabelueberwachung.md
Normal file
147
docs/user-guide/ForUser-Kabelueberwachung.md
Normal file
@@ -0,0 +1,147 @@
|
||||
# 🏠 Kabelüberwachung
|
||||
|
||||
Die Seite **Kabelüberwachung** zeigt bis zu **32 Steckplätze (Slots)**, gruppiert in **vier Racks**, zur Live-Überwachung aller angeschlossenen Kabelmodule. Jeder Slot visualisiert den aktuellen Betriebsstatus, Alarmzustände, Messwerte und erlaubt den direkten Zugriff auf Konfiguration und Messkurven.
|
||||
|
||||
---
|
||||
|
||||

|
||||
|
||||
## ⚙️ Einstellungen pro Slot
|
||||
|
||||
Beim Klick auf das ⚙️ Zahnrad-Symbol oben rechts im Slot wird ein **Modal** geöffnet.
|
||||
Dieses enthält drei Reiter:
|
||||
|
||||
### 🛠️ KUE Einstellung
|
||||
|
||||
| Feld | Beschreibung |
|
||||
| ----------------------- | ------------------------------------------------------------- |
|
||||
| **Kabelbezeichnung** | Freitextname für das überwachte Kabel |
|
||||
| **Isolationsgrenzwert** | Schwellenwert (in MOhm) für Isolationsalarm |
|
||||
| **Schleifengrenzwert** | Schwellenwert (in kOhm) für Schleifenwiderstand |
|
||||
| **Filterzeit** | Zeitverzögerung (in Sekunden), bevor ein Alarm ausgelöst wird |
|
||||
| **Loggerintervall** | Intervall zur Datenspeicherung (z. B. alle 5 Minuten) |
|
||||
| **Display einschalten** | Aktiviert das lokale Display am Slot-Gerät (z. B. KÜ705-FO) |
|
||||
|
||||
---
|
||||
|
||||
### 📶 TDR-Einstellungen
|
||||
|
||||
Die **TDR-Funktion** (Time Domain Reflectometry) dient der **Lokalisation von Kabelfehlern**.
|
||||
Sie ist **pro Slot aktivierbar** und bietet folgende Einstellungen:
|
||||
|
||||
| Einstellung | Beschreibung |
|
||||
| -------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| **TDR-Funktion** | Aktiviert/deaktiviert **sofort** die TDR-Messung. Ein Bestätigungsdialog zeigt den Status (z. B. "TDR deaktiviert"). |
|
||||
| **TDR-Dämpfung (dB)** | Signalabschwächung zur Anpassung an Kabeltyp und -länge |
|
||||
| **Geschwindigkeit (m/μs)** | Wellenausbreitungsgeschwindigkeit im Kabelmaterial (z. B. 112 m/μs) |
|
||||
| **Trigger** | Empfindlichkeitsschwelle zur Fehlerortung (je kleiner, desto empfindlicher) |
|
||||
|
||||
**Bedienung:**
|
||||
|
||||
- **TDR-Funktion** ist ein Toggle – Änderungen wirken sofort.
|
||||
- **Dämpfung, Geschwindigkeit, Trigger** wirken **erst nach Klick** auf **„Einstellungen senden“**.
|
||||
- Die TDR-Messung kann später als Kurvendiagramm angezeigt werden (siehe unten).
|
||||
|
||||
---
|
||||
|
||||
### 🔁 Knotenpunkte-Anzeige
|
||||
|
||||
Der Reiter **Knotenpunkte** zeigt die konfigurierte Struktur eines Steckplatzes:
|
||||
|
||||
| Feld | Beschreibung |
|
||||
| -------------- | -------------------------------------------------- |
|
||||
| **Knoten** | Bezeichnung der Leitungsteilabschnitte (Line 1–10) |
|
||||
| **Verbindung** | Logische Verbindung (z. B. Link 1–2) |
|
||||
| **Länge** | Physikalische Länge der Kabelverbindung (in Meter) |
|
||||
|
||||
> Diese Daten sind **nur lesbar** (Read-Only) und dienen zur Orientierung. Änderungen erfolgen systemseitig oder über das Backend.
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Alarmanzeige und Fehlererkennung
|
||||
|
||||
Jeder Slot zeigt über zwei LEDs den Betriebs- und Alarmstatus an:
|
||||
|
||||
- 🟢 **Grün** – Betrieb OK
|
||||
- 🟡 **Gelb** – Warnung (z. B. Grenzwert erreicht)
|
||||
- 🔴 **Rot** – Aktiver Alarm
|
||||
|
||||
### Mögliche Alarmtypen:
|
||||
|
||||
| Alarmtyp | Beschreibung |
|
||||
| --------------- | ---------------------------------------------------------- |
|
||||
| **Aderbruch** | Schleifenwiderstand über Grenzwert – Leitungsunterbrechung |
|
||||
| **Erdschluss** | Isolationswert unter Grenzwert – möglicher Erdfehler |
|
||||
| **Kurzschluss** | Ungewöhnlich niedriger Widerstand |
|
||||
| **TDR-Alarm** | Auffällige Reflexion im Leitungssystem |
|
||||
| **Überlauf** | Datenfehler oder Kommunikationsproblem |
|
||||
|
||||
> Alarme sind **slotbezogen**, unterscheiden **kommend/gehend** und bleiben bis zur Quittierung oder Rückkehr in den Normalzustand sichtbar.
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Messungssteuerung (manuell)
|
||||
|
||||
Im unteren Bereich jedes Slots befindet sich ein **Kreispfeil-Icon** 🔄 (Reload-Symbol):
|
||||
|
||||
- Dieses startet **je nach aktivem Tab (Schleife oder TDR)** die entsprechende Messung manuell.
|
||||
- Die Buttons **„Schleife“** oder **„TDR“** oberhalb steuern, welcher Modus aktiv ist (hellblau markiert).
|
||||
- Die aktuelle Messung wird nach dem Klick auf **„Messkurve“** als Verlauf geöffnet.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## 📈 Messkurvenanzeige: Schleife und TDR
|
||||
|
||||
### Tab-Auswahl
|
||||
|
||||
- **Schleife** (Standard) zeigt den Schleifenwiderstand in `kOhm`
|
||||
- **TDR** zeigt die TDR-Reflexion mit möglicher Fehlerstelle
|
||||
- Aktiver Modus = **hellblau hinterlegt**
|
||||
|
||||
---
|
||||
|
||||
### 📊 Schleifen- oder Isolationsmessung
|
||||
|
||||
Beim Klick auf **„Messkurve“** wird ein detailliertes Diagramm geöffnet.
|
||||
|
||||
#### Steuerungsmöglichkeiten:
|
||||
|
||||
| Einstellung | Beschreibung |
|
||||
| ------------------ | ----------------------------------------------------------------------------------- |
|
||||
| **Von/Bis** | Zeitraum der Messung |
|
||||
| **Werteauflösung** | Auswahl zwischen **alle Werte**, **stündlich** und **täglich** |
|
||||
| **Messgröße** | Auswahl zwischen **Schleifenwiderstand (kOhm)** und **Isolationswiderstand (MOhm)** |
|
||||
| **Daten laden** | Erst nach Klick werden die Messkurven mit ausgewählten Parametern angezeigt |
|
||||
|
||||
> Tooltips zeigen Min/Max/Durchschnittswerte pro Zeitintervall.
|
||||
|
||||
---
|
||||
|
||||
### 📉 TDR-Messung
|
||||
|
||||
Wenn der Tab **TDR** aktiv ist und auf **„Messkurve“** geklickt wurde, wird eine TDR-Kurve dargestellt.
|
||||
|
||||
#### Darstellung:
|
||||
|
||||
- **TDR-Kurve** (blau) zeigt reflektierte Signale im Kabel
|
||||
- **Referenzkurve** (schwarz) dient dem Vergleich mit einer gespeicherten Referenz
|
||||
- **Fehlerstelle** (rot) wird automatisch markiert
|
||||
|
||||
#### Funktionen:
|
||||
|
||||
- Dropdown zur Auswahl der letzten Messungen inkl. Zeitstempel und Fehlerposition
|
||||
- Button **„TDR-Kurve als Referenz speichern“** ermöglicht Vergleich zukünftiger Messungen
|
||||
- Achsen:
|
||||
- **X-Achse** = Entfernung in Metern
|
||||
- **Y-Achse** = Signalpegel
|
||||
|
||||
---
|
||||
|
||||
## 📌 Zusammenfassung
|
||||
|
||||
- Die Kabelüberwachung erlaubt präzise Kontrolle jedes Slots.
|
||||
- Einstellungen, manuelle Messung und Fehlerdiagnose erfolgen direkt über die grafische UI.
|
||||
- Alle Aktionen (Alarme, Konfiguration, Messungen) sind **slotgenau**.
|
||||
- Die Darstellung ist intuitiv, modular aufgebaut und auch ohne Spezialwissen nutzbar.
|
||||
56
docs/user-guide/ForUser-Meldungen.md
Normal file
56
docs/user-guide/ForUser-Meldungen.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: 📜 Meldungen / Berichte
|
||||
---
|
||||
|
||||
## 📋 Übersicht
|
||||
|
||||
In der Ansicht **Meldungen** werden alle Systemereignisse des CPL-Systems aufgelistet – z. B. **Störungen**, **Informationen**, **Alarme** oder **Statusänderungen**.
|
||||
|
||||
Diese Berichte sind hilfreich zur Nachverfolgung von Ereignissen wie:
|
||||
|
||||
- Auslösung eines Isolations- oder Schleifenalarms
|
||||
- Aktivierung oder Deaktivierung von TDR-Messung
|
||||
- Änderungen an Einstellungen
|
||||
- Start/Neustart des CPL-Geräts
|
||||
|
||||
## 📅 Zeitraum filtern
|
||||
|
||||
Du kannst über zwei Datumsfelder einen Zeitraum auswählen:
|
||||
|
||||
- **Von-Datum**
|
||||
- **Bis-Datum**
|
||||
|
||||
Anschließend klickst du auf den Button **„Anzeigen“**, um alle Meldungen innerhalb des gewählten Zeitraums anzuzeigen.
|
||||
|
||||
Die Filterung erfolgt lokal (im Browser) oder über einen API-Aufruf – abhängig davon, ob du im Entwicklermodus (localhost) oder auf dem echten CPL arbeitest.
|
||||
|
||||
## 📊 Tabellenansicht
|
||||
|
||||
Nach dem Abruf werden die Meldungen tabellarisch dargestellt:
|
||||
|
||||
| Spalte | Bedeutung |
|
||||
| --------------- | ------------------------------------------------------------ |
|
||||
| **Status** | Farbcode (z. B. grün = Info, gelb = Warnung, rot = Alarm) |
|
||||
| **Zeitstempel** | Datum und Uhrzeit der Meldung |
|
||||
| **Gewicht** | Interner Schweregrad (z. B. 1 = niedrig, 3 = hoch) |
|
||||
| **Text** | Beschreibung des Ereignisses |
|
||||
| **Quelle** | Auslösendes Modul, Slot oder Subsystem (z. B. KUE, CPL, TDR) |
|
||||
|
||||
Falls im gewählten Zeitraum keine Meldungen vorhanden sind, erscheint eine entsprechende Hinweiszeile.
|
||||
|
||||
## 🔁 Seitenweise Navigation
|
||||
|
||||
Wenn sehr viele Meldungen angezeigt werden, ist eine **Seitennavigation (Pagination)** aktiv:
|
||||
|
||||
- **Zurück/Weiter** Button am unteren Rand
|
||||
- Anzeige der aktuellen Seite (z. B. Seite 1 von 4)
|
||||
|
||||
## 📝 Hinweise
|
||||
|
||||
- Die angezeigten Daten stammen direkt aus der **internen Datenbank des CPL-Geräts**.
|
||||
- In der Entwicklungsumgebung (localhost) werden sie ggf. aus Mock-Daten generiert.
|
||||
- Die Seite wird nicht automatisch aktualisiert – du kannst bei Bedarf neu filtern oder erneut auf **„Anzeigen“** klicken.
|
||||
|
||||
---
|
||||
|
||||
📌 Diese Funktion ist besonders nützlich für Wartungspersonal oder zur Analyse vergangener Ereignisse im System.
|
||||
76
docs/user-guide/ForUser-System.md
Normal file
76
docs/user-guide/ForUser-System.md
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
title: ⚙️ System
|
||||
---
|
||||
|
||||
## 🔌 Übersicht
|
||||
|
||||
In der **Systemseite** werden die aktuellen **Versorgungsspannungen** und **Temperaturen** des CPL-Systems überwacht. Diese Werte dienen der **Diagnose und Betriebssicherheit**.
|
||||
|
||||
Die Seite zeigt:
|
||||
|
||||
- **Live-Werte** aller Spannungen (+5V, +15V, -15V, -98V)
|
||||
- **Temperaturen** von CPU und ADC
|
||||
- **Verlauf** der Werte in einem **Liniendiagramm**
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Aktuelle Spannungswerte
|
||||
|
||||
Die folgenden Spannungen werden alle 5 Sekunden aktualisiert und als einzelne Kacheln dargestellt:
|
||||
|
||||
| Spannung | Beschreibung |
|
||||
| -------- | ------------------------------------------------ |
|
||||
| +5 V | Versorgung z. B. für digitale Logik |
|
||||
| +15 V | Versorgung z. B. für Relais oder Ausgänge |
|
||||
| -15 V | Versorgung z. B. für analoge Eingangsschaltungen |
|
||||
| -98 V | Hochspannung für Kabelmessung (z. B. Isolation) |
|
||||
|
||||
---
|
||||
|
||||
## 🌡️ Temperaturen
|
||||
|
||||
Die Temperaturüberwachung umfasst:
|
||||
|
||||
| Temperatur | Sensorposition |
|
||||
| ---------- | ---------------------- |
|
||||
| ADC Temp | Analog-Digital-Wandler |
|
||||
| CPU Temp | Zentrale CPU-Einheit |
|
||||
|
||||
Diese Daten helfen bei der **Früherkennung thermischer Probleme**.
|
||||
|
||||
---
|
||||
|
||||
## 📈 Verlauf als Diagramm
|
||||
|
||||
Es stehen zwei Diagramme zur Verfügung:
|
||||
|
||||
### 📊 Spannungsverlauf
|
||||
|
||||
- Zeigt alle vier Spannungen über die Zeit
|
||||
- Farblich hervorgehoben für bessere Unterscheidung
|
||||
- Live-Update bei laufendem Betrieb
|
||||
|
||||
### 🌡️ Temperaturverlauf
|
||||
|
||||
- Verlauf von CPU- und ADC-Temperatur
|
||||
- Nützlich zur Lastüberwachung und Klimatisierung
|
||||
|
||||
---
|
||||
|
||||
## 🔁 Aktualisierung
|
||||
|
||||
- Alle Werte werden **automatisch alle 5 Sekunden aktualisiert**
|
||||
- Historie wird lokal im Browser gespeichert
|
||||
- Keine Benutzerinteraktion erforderlich
|
||||
|
||||
---
|
||||
|
||||
## 📘 Hinweise
|
||||
|
||||
- Die Diagramme basieren auf `Chart.js` und bieten eine visuelle Darstellung der letzten Minuten.
|
||||
- Bei ungewöhnlichen Werten kann der Support kontaktiert oder das Gerät kontrolliert werden.
|
||||
- Diese Seite ist **read-only** – keine Änderungen möglich.
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ Die Spannungsversorgung ist sicherheitsrelevant. Änderungen an Hardware oder Konfiguration dürfen nur durch geschultes Personal erfolgen.
|
||||
23
docs/user-guide/ForUser-TDR-Einstellungen.md
Normal file
23
docs/user-guide/ForUser-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
|
||||
54
docs/user-guide/ForUser-analogeEingaenge.md
Normal file
54
docs/user-guide/ForUser-analogeEingaenge.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: 🔢 Analoge Eingänge /Messüberwachung
|
||||
---
|
||||
|
||||
# 🔢 Analoge Eingänge (Messüberwachung)
|
||||
|
||||
Die Seite **Analoge Eingänge** zeigt in tabellarischer Form alle erfassten Messwerte von bis zu acht analogen Kanälen (Spannung, Temperatur). Jeder Kanal ist mit seiner aktuellen Messung, einer Bezeichnung und einer Einheit dargestellt.
|
||||
|
||||
## 🌐 Anzeige & Interaktion
|
||||
|
||||
- Übersicht über 1–8 analoge Kanäle
|
||||
- **Live-Messwertanzeige** mit kontinuierlicher Aktualisierung
|
||||
- **Verlaufskurven** der letzten 24 Stunden mit Zoom-Funktion
|
||||
- Farbige Darstellung zur schnellen Erkennung von Grenzwertverletzungen
|
||||
|
||||
### Beispielhafte Spalten der Tabelle:
|
||||
|
||||
| Eingang | Messwert | Bezeichnung | Einheit | Aktion |
|
||||
| ------- | -------- | ----------- | ------- | ---------------- |
|
||||
| 1 | 3.25 | Temperatur | °C | ⚙️ Einstellungen |
|
||||
|
||||
## 📈 Verlauf & Diagramm
|
||||
|
||||
Durch Klick auf einen Eingang öffnet sich eine **Verlaufskurve**, die den Messwertverlauf der letzten 24 Stunden anzeigt. Die Daten werden automatisch geladen und im Diagramm (Chart.js) dargestellt.
|
||||
|
||||
- Interaktive Diagramme mit Zeitachse
|
||||
- Tooltip bei Mouseover für exakte Werte
|
||||
- Darstellung nach Zeit (Stundenformat)
|
||||
|
||||
## ⚙️ Einstellungen pro Kanal
|
||||
|
||||
Jeder Kanal kann individuell konfiguriert werden. Nach Klick auf das **Zahnrad-Symbol (⚙️)** öffnet sich ein Einstellungs-Modal mit folgenden Optionen:
|
||||
|
||||
| Feld | Beschreibung |
|
||||
| ----------------------- | -------------------------------------------------------------- |
|
||||
| **Bezeichnung** | Frei wählbarer Kanalname |
|
||||
| **Offset** | Verschiebung des Werts zur Kompensation systematischer Fehler |
|
||||
| **Faktor** | Skalierung zur Umrechnung des Rohwerts (z. B. für mV → °C) |
|
||||
| **Einheit** | Auswahl aus vordefinierten Einheiten (z. B. V, mA, °C, bar, %) |
|
||||
| **Loggerintervall (s)** | Intervall, in dem Werte im System gespeichert werden |
|
||||
|
||||
> ⚠️ **Hinweis:** Änderungen werden erst nach Klick auf **Speichern** übernommen. In der Entwicklungsumgebung erscheint eine Erfolgsmeldung, in der Produktionsumgebung wird der Wert sofort an das Gerät übertragen.
|
||||
|
||||
## 🔄 Simulation (nur im Testmodus)
|
||||
|
||||
Im lokalen Entwicklungsmodus (Mock-System) ist es möglich, manuell simulierte Werte einzugeben. Dadurch können Anzeige und Kurvenverlauf ohne physikalisches Signal getestet werden.
|
||||
|
||||
## 📚 Weitere Hinweise
|
||||
|
||||
- Die Einheiten und Messgrößen hängen von der physikalischen Konfiguration (z. B. Sensoren) ab.
|
||||
|
||||
---
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
29
docs/user-guide/Home.md
Normal file
29
docs/user-guide/Home.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# 📘 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](ForUser-Dashboard.md)
|
||||
- [Kabelüberwachung](ForUser-Kabelueberwachung.md)
|
||||
- [Digitale Eingänge / Meldungseingänge](ForUser-DigitaleEingaenge.md)
|
||||
- [Digitale Ausgänge / Schaltausgänge](ForUser-DigitaleAusgaenge.md)
|
||||
- [Analoge Eingänge / Messüberwachung](ForUser-AnalogeEingaenge.md)
|
||||
- [Meldungen / Berichte](ForUser-Meldungen.md)
|
||||
- [System](ForUser-System.md)
|
||||
- [Einstellungen](ForUser-Einstellungen.md)
|
||||
|
||||
---
|
||||
|
||||
## 👨💻 Entwickler-Dokumentation
|
||||
|
||||
- [Systemarchitektur](ForDev-Architektur.md)
|
||||
- [API-Design](ForDev-API-Design.md)
|
||||
- [OPC-UA Anbindung](ForDev-OPCUA-Anbindung.md)
|
||||
- [Technik-Notizen](ForDev-Technik-Notizen.md)
|
||||
|
||||
---
|
||||
|
||||
> ❌ Hinweis: Für einige Funktionen wird ein Admin-Login benötigt (z. B. Firmware-Update, Datenbank-Löschung).
|
||||
|
||||
**Letzte Aktualisierung:** 3. Mai 2025
|
||||
BIN
docs/user-guide/img/KabelueberwaachungEinstellungModal.png
Normal file
BIN
docs/user-guide/img/KabelueberwaachungEinstellungModal.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
docs/user-guide/img/SchleifenmessungTDRstarten.png
Normal file
BIN
docs/user-guide/img/SchleifenmessungTDRstarten.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
docs/user-guide/img/digitalInputs.png
Normal file
BIN
docs/user-guide/img/digitalInputs.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
Reference in New Issue
Block a user