Files
kabellaengen/doc/Anwenderdoku_kurz.md
T

26 KiB
Raw Blame History

Anwenderdoku zur Ermittlung der Kabellängen

Installation des Programmes und Schnellstart-Guide

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.

Danach muss auf dem Zielrechner (z.B. per Windows APP) Python 3.X installiert werden. Alternativ kann ein Python Interpreter von einem Netzlaufwerk verwendet werden. Der Pfad zu diesem Interpreter muss dann über eine Umgebungsvariable mit dem Namen NETWORK_INTERPRETER_PATH auf der Maschine gesetzt sein. Grundsätzlich wird eine lokale Installation eines Python Interpreters (von https://www.python.org/downloads/) empfohlen.

Zur Installation des Kabeltools muss in dem geclonten Ordner kabellaengen\bin die Datei install.bat als Administrator ausgeführt werden. Hierfür Rechtsklick auf die Datei und als Administrator ausführen. Es wird in der Folge ein Ordner auf dem Desktop des Computers mit dem namen Kabeltool erstellt. In diesem Ordner ist eine Verknüpfung create_cables.

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

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.

Die Ausgabe schreibt:

folgende Datei wurde uebergeben: Pfad\zu\meiner\dxfdatei.dxf
-- hole Positionen
reading file ..done
writing results to a json file ...
done
-- erzeuge Graph mit Routing
writing results to a json file ...
done
--zeichne Kabel in dxf Datei
creating new .dxf ..
done
copying layers (Racks, Subdistributors, ...) from original .dxf into new .dxf ..
done
creating new .dxf ..
done
creating excel file with cable information ..
done
C:\10-Develop\kabellaengen\work\dxfdatei_cables.dxf
C:\10-Develop\kabellaengen\work\dxfdatei_cables.xlsx
C:\10-Develop\kabellaengen\work\dxfdatei_positions.json
C:\10-Develop\kabellaengen\work\dxfdatei_reduziert.dxf
C:\10-Develop\kabellaengen\work\dxfdatei_todraw.json
        5 Datei(en) verschoben.
Drücken sie eine beliebige Taste . . . 

Das Drücken einer beliebigen Taste beendet das Programm und die Ausgabe kann verwendet werden.

Hinweis

Der Dateiname darf keine Leerzeichen oder Sonderzeichen enthalten. Verwende z.B. projekt_123.dxf statt mein projekt #1.dxf.

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 vier Dateien, wovon letztlich zwei für den Anwender bestimmt sind. In der nachfolgenden Liste steht der name dxfdatei stellvertretend für die eingegebene Datei des Benutzers.

Dateiname Details
dxfdatei_cables.dxf .dxf-Datei, mit Kabelwegen (z.B. für Import ins Original-Layout als eigenes Layer) und gezeichneten Racks (ggf. in 3D)
dxfdatei_cables.xlsx Excel-Datei mit Kabellängen, Längenübersicht und Fehler-Übersicht
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. Desweiteren werden die von dem Programm erkannten Kabeltrassen eingezeichnet und nummeriert. Sofern diese im Ursprungslayout dreidimensional angelegt wurden, wird auch das in der Ausgabe berücksichtigt.

Excel-Datei: dxfdatei_cables.xlsx

Die standardmäßig erstellte und abgelegte Ausgabedatei dxfdatei_cables.xlsx enthält im fehlerfreien Fall drei Worksheets:

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

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

Cables SIVAS:
zeigt die Längen der einzelnen Kabeltrassen-Segmente anhand deren Nummerierung innerhalb der dxf Datei. Diese Ausgabe dient der Überprüfung der benötigten Gesamtlänge der Kabeltrassen.

Erweiterte Ausgabe im Fehlerfall:

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.

Excel-Datei: dxfdatei_BOM.xlsx

Diese Datei enthält eine vollständige Stückliste (BOM) aller im Layout erkannten Komponenten also sowohl aller Sensoren/Aktoren als auch der Kabel, die zum Einsatz kommen. Die Datei besteht aus zwei Tabellenblättern:

1. BOM (Gesamtstückliste):

Zeigt für jede verwendete Artikelnummer den Namen laut bezeichner.cfg, die Gesamtanzahl bzw. Gesamtlänge und unterscheidet dabei automatisch zwischen Sensoren und Kabeln.

Art.-Number Amount (pcs) Length (m) Name (SIVAS)
722001330 3 M12 Sensorleitung 1m, gewinkelt
725000015 24 Steuerleitung MA, 4G1,5mm²
839220147 5 Reflexionslichttaster XYZ

Sensoren (bzw. andere Komponenten mit Artikelnr) werden über ihre Artikelnummer gezählt. Kabel werden sofern Meterware (z.B. Steuerleitungen für Motoren) über die summierte Länge dargestellt, andernfalls über Stückzahl.

2. BOM by UV (Stückliste pro Unterverteiler):

Dieses Worksheet gibt für jede Artikelnummer aus, welchem Unterverteiler (UV) sie zugeordnet ist und wie viele davon jeweils dorthin gehören. Kabelmeter werden wie im anderen Arbeitsblatt getrennt ausgewiesen.

UV Art.-Number Amount (pcs) Length (m) Name (SIVAS)
UH01 722001330 1 M12 Sensorleitung 1m, gewinkelt
UC01 722001330 2 M12 Sensorleitung 1m, gewinkelt
UC01 725000015 12 Steuerleitung MA, 4G1,5mm²

Hinweis: Diese Ansicht ist besonders nützlich zur vorbereitenden Bestellplanung pro UV.

Anpassung des Verhaltens des Programms:

Verwendete Konfigurationsdateien

Zum aktuellen Zeitpunkt verwendet bzw. berücksichtigt das Programm vier 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.

Hinweis

Die Einträge in den .cfg-Dateien müssen laufend gepflegt werden, wenn sich:

  • Layernamen in CAD-Dateien ändern
  • Neue BMK-Kürzel eingeführt werden
  • Neue SIVAS-Artikel hinzukommen

Nur so kann eine korrekte automatische Kabelberechnung und Zuordnung > gewährleistet werden.

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.cfg Speicherung der Bezeichner zu den SIVAS-Nummern sowie automatische Pflege fehlender Artikelnummern

Hinweis

Änderungen an den .cfg-Dateien werden erst beim nächsten Programmlauf wirksam. Stelle sicher, dass die Datei korrekt gespeichert wurde und keine doppelten Abschnitte enthält.

Zusammenfassung und Struktur der Konfigurationsdateien

Nachfolgende Aufzählung zeigt zeigt den Aufbau und Zweck der .cfg-Dateien für das Routing-Tool. Jeder Abschnitt ist dokumentiert mit:

  • Konfigurations-Block (Abschnittsname)
  • Beschreibung der Funktion
  • Beispielhafte Einträge

allgemein.cfg

Diese Datei steuert das Einlesen von Layern und definiert geometrische Toleranzen.

[GetPos-Layer_Racks]

Was? Layernamen, in denen Kabelpritschen (Racks) enthalten sind.

Layername (Beispiel)
PRITSCHE_200-60_OMNIFLO
0-0_ILS_Pritsche_200-60_Inbound
0-0_Omniflo_Pritsche_200-60_AMR

[GetPos-Layer_Distributors]

Was? Layernamen, die Unterverteiler beinhalten.

Layername (Beispiel)
0-0_ILS_UNTERVERTEILER
UNTERVERTEILER

[GetPos-Layer_Tunnel]

Was? Layernamen für Tunnel.

Layername (Beispiel)
Busverteiler-Kennzeichnung

[GetPos-Layer_Equipment]

Was? Layernamen von Sensoren, Motoren, IOs etc.

Layername (Beispiel)
0-0_ILS_MOTOR
MOTOR
REALE_POSITION_IO

[GetPos-Geom-Sensor]

Was? Geometrische Maße von Sensor-Markern zur Mittelpunktsberechnung.

Attribut Wert (Beispiel)
Breite 80
Hoehe 90

[Racks]

Was? Maximale Distanz (Toleranz) zwischen benachbarten Racks zum "Snappen".

Attribut Wert (Beispiel)
SnapTolerances 200

[Sensoren]

Was? Maximale Distanz zwischen Sensoren/Motoren und Racks für Verknüpfung.

Attribut Wert (Beispiel)
ConnectionTolerances 3000

BMK.cfg

Diese Datei steuert, welche Betriebsmittelkennzeichen (BMK) beim Routing berücksichtigt werden und welche Kabeltypen zugewiesen sind.

[Routing-Include]

Was? BMK-Kürzel, die beim Routing berücksichtigt werden.

Kürzel Bedeutung / Beispiel
MA Motoren
QM Ventile
BX Scanner

[Routing-Ignore]

Was? BMKs, die ignoriert werden (z.B. Schaltschrank-Innenleben).

Kürzel Beispielkomponente
FC Frequenzumrichter
QA Sicherungen / Schütze

[Cable-Mapping]

Was? Verknüpfung von BMKs zu Kabelgruppen (aus kabel.cfg).

BMK Zugewiesene Kabelgruppe(n)
MA MA
MB WD_Q
BX WF_B, WD_I
BG-829422026 WD_I-829422026

[Length-Adjustments]

Was? Korrektur von Kabellängen (z.B. vorkonfektionierte Sensorleitungen).

BMK Abzuziehende Länge (m)
BX 4

kabel.cfg

Diese Datei enthält die SIVAS-Nummern je Kabellänge und -typ, sowie die Bezeichnungen der SIVAS-Nummern.

Kabelgruppen (Beispiel: [WD_Q], [WD_I], [WF_B])

Was? Zuordnung von Kabellängen zu SIVAS-Sachnummern.

Länge (m) SIVAS-Nr. Beispielgruppe
1.0 722001300 WD_Q (Ventile)
2.5 722001338 WD_I (Sensoren)
5.0 726001045 WF_B (Scanner)

Sensorspezifische Gruppen

Was? Besondere Kabellisten für spezifische Sensor-Artikelnummern.

Gruppe Länge (m) SIVAS-Nr.
WD_I-829422026 5.0 722001353
WD_I-720002003 10.0 722001354

bezeichner.cfg

Diese Datei enthält Bezeichner zu den verwendeten SIVAS-Artikelnummern. Sie beinhaltet sowohl die Bezeichner (laut SIVAS) für die Bauteil-Artikelnummern als auch für die Kabel. Die Datei wird im Laufe eines Routing-Prozesses bei Bedarf angepasst und mittels einer SIVAS-Datenbankabfage (bei bestehender VPN-Verbindung bzw. im lokalen Firmennetz am Standort) erweitert.

[Sivasnummern]

Enthält die bekannten SIVAS-Artikelnummern mit zugehörigen Bezeichnern, z.B.:

Sivasnummer Bezeichner
725000015 4G1,5mm², Steuerleitung
722001300 Verb.-Leitung M12 St-0°/ M8 Bu-0° PUR UL/CSA 1m
722001301 Verb.-Leitung M12 St-0°/ M8 Bu-0° PUR UL/CSA 2m

[Missing]

Fehlende Nummern, die im Layout verwendet wurden, aber noch keinen Bezeichner besitzen. Diese werden automatisch per SIVAS-Datenbank ergänzt (sofern erreichbar). Hierzu wird im Kommandofeld eine entsprechende Benachrichtigung angezeigt.

Validierung der Konfigurationsdateien

Bevor das Routing beginnt, werden alle .cfg-Dateien automatisch auf Plausibilität und Konsistenz überprüft. Ziel ist es, fehlerhafte oder unvollständige Konfigurationen frühzeitig zu erkennen und entsprechende Warnungen auszugeben.

Diese Prüfung geschieht vollautomatisch im Hintergrund der Anwender muss nichts weiter tun. Falls Probleme erkannt werden, werden diese in der Konsole (bzw. dem Terminal-Fenster) protokolliert. Die Verarbeitung wird trotzdem fortgesetzt, allerdings können fehlerhafte Konfigurationen zu falschen Verkabelungen oder fehlenden Ausgaben führen.

Prüfkriterien im Detail:

  1. Vollständigkeit der Zuweisungen in BMK.cfg

    • Jeder Prefix aus [Routing-Include] muss in [Cable-Mapping] enthalten sein.
    • Fehlt eine Zuordnung, wird ein Fehler gemeldet:
      No Cable-Mapping for Prefix 'BX' within [Cable-Mapping]
  2. Existenz der referenzierten Sektionen in kabel.cfg

    • Jeder Eintrag in [Cable-Mapping] verweist auf eine oder mehrere Sektionen (z.B. WD_Q, WF_B), die in kabel.cfg existieren müssen.
    • Fehlt eine Sektion, wird gewarnt:
      Cable-Section 'WF_B' from Cable-Mapping is not defined in kabel.cfg
  3. Gültigkeit der Werte in [Length-Adjustments]

    • Jeder Wert muss eine nicht-negative Kommazahl (float ≥ 0.0) sein.
    • Ungültige oder negative Einträge verursachen entsprechende Warnungen:
      Invalid Value in Length-Adjustments for BX: 'abc' is not a valid float

Hinweis

Die Validierung dient als wichtige Schutzmaßnahme gegen fehlerhafte Eingaben oder veraltete Konfigurationsdateien. Es ist empfohlen, bei jeder Layoutanpassung oder Änderung von Komponenten auch die .cfg-Dateien zu prüfen und ggf. zu aktualisieren, um die Ricthigkeit der Ergebnisse sicherzustellen.

Anwenderhinweise zur Layouterstellung

Im nachfolgenden Abschnitt sind die wichtigsten Punkte zur Erstellung der Layoutzeichnungen aufgeführt. Die Beachtung dieser Hinweise stellt sicher, dass die automatische Auswertung durch das Programm fehlerfrei und zuverlässig erfolgen kann.

Hinweis

Dieser Abschnitt ist durch die Fachabteilung regelmäßig zu pflegen und analog zu Konfigurationsdateien stets aktuell zu halten.

Verwendung der Layer

  • Erfasst werden ausschließlich Elemente auf Layern, die in der Konfigurationsdatei (cfg) unter dem jeweiligen Abschnitt (GetPos-Layer_...) aufgeführt sind.
  • Nicht konfigurierte Layer oder falsch benannte Layer werden vollständig ignoriert.
  • Für jede Objektklasse (z.B. Racks, Sensoren, Unterverteiler) sollte ein eigener dedizierter Layer verwendet werden.
  • Layer-Namen dürfen keine Sonderzeichen oder Leerzeichen enthalten, und sollten eindeutig benannt sein.

Zeichnen von Kabeltrassen

  • Verbindungspunkte von Racks sollten präzise aneinander gezeichnet werden, idealerweise mit Fangmodi (Snapping) im CAD.
    • Das Programm erkennt und verbindet nahe beieinanderliegende Racks automatisch, jedoch nur mit begrenzter Toleranz.
    • Eine saubere Planung der Trassengeometrie erleichtert die automatische Graphenerstellung erheblich.
  • 2D-Kabeltrassen (LWPOLYLINE) sollten verwendet werden für Strecken in einer Ebene bzw. auf einer Höhe
  • 3D-Trassenführung bei Höhendifferenzen (z.B entlang von Förderern) erfolgt in drei Schritten:
    1. Untere Ebene als LWPOLYLINE mit Z=0.
    2. Obere Ebene als LWPOLYLINE mit Z=Erhebung (über DXF-Attribut Erhebung).
    3. Verbindung über 3DPOLYLINE, welche die Steigung darstellt.

Attribute der Blöcke (Bauteile)

  • Pro Bauteil darf nur ein Block vorhanden sein. Alle relevanten Informationen (z.B. Artikelnummer, Bezeichner, Position) müssen diesem einen Block als Attribute zugeordnet sein.
  • Keine übereinanderliegenden Blöcke!
    • In der Vergangenheit wurden häufig zwei Blöcke übereinandergelegt, um Kabel- und Sensorinformationen zu trennen. Dies ist künftig nicht mehr zulässig.
  • Beispiel für frühere Aufteilung (nicht mehr erlaubt):
    • Rahmen innen (Angaben zum Kabel):
      • A:
      • B: Kabel-ID
      • C: lange Nummer (?)
      • ArtiNr: Kabelartikelnummer
      • Beschr: Kabelname (SIVAS)
      • Menge, Position, Gruppe, Etikette, Auflöse, etc.
    • Rahmen außen (Angaben zum Bauteil selbst):
      • A:
      • B: Bauteil-Kurzbezeichnung
      • C: lange Nummer (?)
      • ArtiNr: Sensorartikelnummer
      • Beschr: Kurzbeschreibung
      • sowie gleiche Attribute wie oben.
    • Text
      • IO: Bauteil-Kurzbezeichnung
      • id
      • VERW
      • BEZEICHNUNG
      • TEXT-D, TEXT-E, TEXT-ES, TEXT-F
      • SPS
  • In Zukunft:
    • Ein einziger Block enthält alle Informationen des Bauteils.
    • Die Informationen zu den benötigten Kabeln werden allein vom Kabeltool bereitgestellt
    • Die konkrete Struktur der Attribute wird noch festgelegt (To Be Defined).
    • Ziel ist es, sowohl die Verarbeitung im System als auch die manuelle Pflege im Layout zu vereinfachen.

Positionierung von Bauteilen

  • In Zukunft wird das Attribut REALE_POSITION eingeführt. Damit kann die exakte physische Einbauposition eines Bauteils (z.B. Sensors) unabhängig von der tatsächlichen Platzierung des Blocks im Layout definiert werden.

    • Ermöglicht eine saubere, leserliche Platzierung der Blöcke im Plan z.B. seitlich der Anlage (dort wo Platz ist)
    • Der Block selbst kann damit optisch gut positioniert, aber technisch korrekt ausgewertet werden.
  • Bauteile ohne REALE_POSITION werden standardmäßig an der gezeichneten Blockposition verortet.

  • Anbindung an Kabeltrassen erfolgt immer zur nächstgelegenen Rack-Geometrie im definierten Toleranzbereich.

    • Wird ein Block zu weit entfernt vom Rack gezeichnet (bzw. REALE_POSITION liegt zu weit weg), erfolgt keine automatische Verbindung.
    • Die maximale Toleranz ist über die Konfiguration allgemein.cfg[tol_connect] steuerbar.
  • Es ist daher darauf zu achten, dass Bauteile (bzw. deren reale Positionen) räumlich korrekt und in sinnvoller Nähe zu den Kabeltrassen platziert sind.