From 141220596d95baadaf7f30523bfebde53d2033dd Mon Sep 17 00:00:00 2001 From: lertlmaier Date: Fri, 13 Jun 2025 14:57:19 +0200 Subject: [PATCH] =?UTF-8?q?Aktualisierung=20der=20Doku.=20Was=20gibt=20Exc?= =?UTF-8?q?el=20aus=20Anf=C3=A4nge=20der=20Config-Doku?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/Anwenderdoku.md | 93 +++++++++++++++++++++++++++++++++++++++------ 1 file changed, 81 insertions(+), 12 deletions(-) diff --git a/doc/Anwenderdoku.md b/doc/Anwenderdoku.md index d582e1b..4a65459 100644 --- a/doc/Anwenderdoku.md +++ b/doc/Anwenderdoku.md @@ -1,8 +1,15 @@ -- [Anwenderdoku zur Ermittlung der Kabellängen](#anwenderdoku-zur-ermittlung-der-kabellängen) - - [Installation des Programmes und Schnellstart-Guide](#installation-des-programmes-und-schnellstart-guide) - - [Installation](#installation) - - [Schnellstart und Vewendung des Programms](#schnellstart-und-vewendung-des-programms) - - [Standardmäßige Ausgabe des Programms](#standardmäßige-ausgabe-des-programms) +# Anwenderdoku zur Ermittlung der Kabellängen + +- [Installation des Programmes und Schnellstart-Guide](#installation-des-programmes-und-schnellstart-guide) + - [Installation](#installation) + - [Schnellstart und Vewendung des Programms](#schnellstart-und-vewendung-des-programms) + - [Standardmäßige Ausgabe des Programms](#standardmäßige-ausgabe-des-programms) + - [.dxf-Datei: dxfdatei\_cables.dxf](#dxf-datei-dxfdatei_cablesdxf) + - [Excel-Datei: xxx\_cables.xlsx](#excel-datei-xxx_cablesxlsx) + - [Anpassung des Verhaltens des Programms:](#anpassung-des-verhaltens-des-programms) + - [allgemein.cfg](#allgemeincfg) + - [BMK.cfg](#bmkcfg) + - [kabel.cfg](#kabelcfg) - [Detaillierte Informationen und Programmablauf](#detaillierte-informationen-und-programmablauf) - [Zweck des Programms](#zweck-des-programms) - [Allgemeiner Programmablauf](#allgemeiner-programmablauf) @@ -18,12 +25,9 @@ - [Warum verbindet das Programm den Sensor mit genau dieser Kabeltrasse?](#warum-verbindet-das-programm-den-sensor-mit-genau-dieser-kabeltrasse) - [Ideen für "Umbau" der Programme](#ideen-für-umbau-der-programme) +# Installation des Programmes und Schnellstart-Guide -# Anwenderdoku zur Ermittlung der Kabellängen - -## Installation des Programmes und Schnellstart-Guide - -### Installation +## Installation Das Programm mit allen Quellen befindet sich auf dem hauseigenen git Server und kann mit einen beliebigen git client auf einem Anwenderrechner über ``` git clone http://gitea.schoenenberger.de/mistangl/kabellaengen.git``` geholt werden. Dieser Ordner kann auch einfach mit allen Unterordnern gezippt und auf einem anderen Rechner entpackt werden. @@ -35,7 +39,7 @@ Zur Installation des Kabeltools muss in dem geclonten Ordner `kabellaengen\bin` Ist Python installiert, werden per Doppelklick automatisch auf die `bin\install_py.bat` alle nötigen python Package heruntergeladen. Diese werden dann automatisch aus dem Netz in den .venv kopiert. -### Schnellstart und Vewendung des Programms +## Schnellstart und Vewendung des Programms Im auf dem Desktop erzeugten Ordner findet sich das eigentliche Programm *create_cables*. Um das Programm auszuführen, genügt es die zu verarbeitende .**dxf-Datei** per *Drag and Drop* auf das Programm zu ziehen. Das öffnen der *Command-Shell* bestätigt den Start des Programms und der Anwender wird über den Ablauf informiert. @@ -70,7 +74,8 @@ Drücken sie eine beliebige Taste . . . Das Drücken einer beliebigen Taste beendet das Programm und die Ausgabe kann verwendet werden. -### Standardmäßige Ausgabe des Programms +## Standardmäßige Ausgabe des Programms + In den Ordner auf dem Desktop in dem das Kabeltool liegt werden nach Beendigung der Berechnungen die Ausgabedateien abgelegt. Standardmäßig sind dies fünf Dateien, wovon letztlich drei für den Anwender bestimmt sind. In der nachfolgenden Liste steht der name *dxfdatei* stellvertretend für die eingegebene Datei des Benutzers. | Dateiname | Details | @@ -81,6 +86,70 @@ In den Ordner auf dem Desktop in dem das Kabeltool liegt werden nach Beendigung | `dxfdatei_positions` | **Zwischendatei** (nicht für Endnutzer bestimmt) | | `dxfdatei_todraw` | **Zwischendatei** (nicht für Endnutzer bestimmt) | +### .dxf-Datei: dxfdatei_cables.dxf + +Die standardmäßig erstellte und abgelegte Ausgabedatei `dxfdatei_cables.dxf` enthält die Kabelwege aller während des Programmablaufs behandelten Kabelverbindungen und kann beispielsweise als neues Layer in die .dxf-Datei der Anlage importiert werden. Neben den Kabelwegen werden auch die Kurzbezeichnungen (z.b. MA0060, BG3240, ...) sowie die Kürzel der Unterverteiler auf jeweils separaten Layern in die Zeichnungsdatei exportiert und ermöglichen damit die in sich schlüssige Verwendung dieser Datei. + +### Excel-Datei: xxx_cables.xlsx + +Die standardmäßig erstellte und abgelegte Ausgabedatei `dxfdatei_cables.xlsx` enthält im fehlerfreien Fall zwei Worksheets: + +1. **Length by ID**: zeigt die Kabel-ID, die tatsächliche Länge des Kabels, die Kabel-Atikelnummer und zuletzt den zugeörigen (aber gekürzten Bezeicher) für das Kabel: + +> | Cable-ID | True Length (m) | Cable-ArtNr | Cable-Name (short) | +> |-----------------|------------------|-------------|----------------------------------| +> | UC0101-BG3241 | 2,9213 | 722001332 | M12 St-0°/ M12 Bu-90° 3m | +> | UC0101-BG3240 | 7,1784 | 722001334 | M12 St-0°/ M12 Bu-90° 10m | +> | UC0101-BG3270 | 15,4686 | 722001336 | M12 St-0°/ M12 Bu-90° 20m | +> | UC0101-BG3260 | 27,4471 | 722001339 | M12 St-0°/ M12 Bu-90° 30m | +> | UH01-MA0062 | 10,3015 | 725000015 | 4G1,5mm², Steuerleitung | + +2. **Cables SIVAS**: zeigt die SIVAS-Nummer der Kabel und daneben die benötigte Anzahl an Kabeln in diesem Layout bzw. (für den Fall von Kabeln als Meterware, z.b. bei Motoren) die kummulierte benötigte Länge: + +> | Cable-ArtNr | Amount (pcs) | Cumm. Length (m) | +> |-------------|--------------|------------------| +> | 722001332 | 1 | | +> | 722001334 | 1 | | +> | 722001336 | 1 | | +> | 722001339 | 1 | | +> | 725000015 | | 11 | + +Für den Fall, dass während des Programmablaufs Fehler auftreten bzw. Fehler im Layout erkannt werden, werden diese in weitere Worksheets geschrieben. Diese Worksheets tragen das Präfix *ERR* + +- ERR-Equipment-Connection: + - Zeigt alle nicht mit den Kabeltrassen verbundenen Elemente (Sensoren / Aktoren / Unterverteiler) an + - Gibt neben dem Typen, den Bezeichner und die x, y-Koordinate des Elements zurück + - Verbindungsfehler möglicherweise aufgrund zu großen Abstandes zur nächsten Kabeltrasse +- ERR-Routing: + - Zeigt alle fehlgeschlagenen Kabelverbindungen an + - Fallunterscheidung: + - Unterverteiler nicht in Layout vorhanden: Unterverteiler ist in der Kennzeichnung der Sensor-Blöcke im Layout erwähnt aber nicht im Layout selbst positioniert. Es wird nur der betroffene Unterverteiler angezeigt. Keine explizite Auflistung aller damit ebenfalls nicht verbundenen Sensoren / Aktoren + - Unterverteiler **und** Sensor / Aktor nicht angebunden: Sowohl Sensor als auch Aktor sind nicht mit den Kabeltrassen verbunden. Beide damit auch in *ERR-Equipment-Conncetion* aufgeführt + - Unterverteiler nicht angebunden: siehe oben. + - Sensor / Aktor nicht angebunden siehe oben. +- ERR-Attributes: + - Zeigt alle Blöcke an, welche Fehler in deren Attributen aufweisen + - Mögliche Fehler: + - Kein Attribut "KENNZEICHNUNG": keine Zuweisung zu Unterverteiler möglich. Element wird nicht verkabelt und nicht gezeichnet. + - Ungültiger Pfad in "KENNZEICHNUNG": Eingegebenes Attribut in Kennzeichnung entspricht nicht dem normalen Muster. Element wird nicht verkabelt und nicht gezeichnet. + +## Anpassung des Verhaltens des Programms: + +Zum aktuellen Zeitpunkt verwendet bzw. berücksichtigt das Programm **drei** Konfigurationsdateien (Dateiendung .cfg). Diese steuern das verhalten des Programms und **können vom Nutzer bei Bedarf geändert** werden bzw. **müssen vom Nutzer im Falle von betrieblichen Ändeurngen aktualisiert werden** (z.B Änderung von Sachnummern), um die Funktion des Programms zu gewährleisten. In der folgenden Tabelle sind die Aufgaben bzw. inhalte der einzelnen Konfigurationsdateien aufgezeigt und in den darauffolgenden Abschnitten der jeweilige Aufbau und besonderheiten erläutert. + +| Datei | Inhalt | +|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allgemein.cfg | Layernamen der Kabelpritschen
Layenamen der Unterverteiler
Layernamen der Tunnel
Layernamen der Sensoren / Aktoren
Toleranz der Verbindung zw. Sensor und Kabeltrasse
Toleranz des "Anpinnens" zweier Kabeltrassen untereinander | +| BMK.cfg | Betriebsmittelkennzeichnung der Elemente, die im Routing berücksichtigt bzw. ignoriert werden sollen
Zuweisung der Kabelkennzeichnungen zur jeweiligen Betriebsmittelkennzeichnung
Längenanpassungen für einzelne Kabelkennzeichnungen | +| kabel.cfg | SIVAS-Nummern für die einzelnen längenabhängigen Kabel der jeweiligen Kabelkennzeichnung
Bezeichner für die jeweilige SIVAS-Nummer | +| | | + +### allgemein.cfg + +Nachfolgende Aufzählung zeigt die jeweiligen Blöcke der Konfigurationsdatei und dort einzutragene Informationen: +- h +### BMK.cfg +### kabel.cfg ## Detaillierte Informationen und Programmablauf