25 KiB
- Anwenderdoku zur Ermittlung der Kabellängen
- Ideen für "Umbau" der Programme
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.
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 |
|---|---|
dxfdatei_cables.dxf |
.dxf-Datei, nur mit Kabelwegen (z. B. für Import ins Original-Layout als eigenes Layer) |
dxfdatei_reduziert.dxf |
.dxf-Datei mit Kabelwegen und zusätzlich Kabeltrassen, Sensoren, Aktoren und Unterverteilern (in Beabeitung) |
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) |
Detaillierte Informationen und Programmablauf
Zweck des Programms
Dieses Toolset dient der automatisierten und komfortablen Ermittlung von Kabellängen zwischen Unterverteilern und deren zugeordneten Sensoren/Aktoren entlang definierter Kabeltrassen. Als Eingabe dient eine 2D-Layout-Zeichnung im .dxf-Format. Ausgaben sind u.a.:
- eine strukturierte
.json-Datei mit Kabellängen und Pfadkoordinaten - eine visuelle
.dxf-Datei mit eingezeichneten Kabelwegen - eine weitere .dxf-Datei mit einem reduzierten Layout (Kabeltrassen + Kabel + Unterverteiler)
- zukünftig: tabellarische Aufbereitung der Kabellängen mit SIVAS-Nummern (z. B.
.xlsx)
Allgemeiner Programmablauf
Das Toolset besteht aus drei zentralen Skripten, die automatisiert über ein Batch-Skript aufgerufen werden. Der interne Programmablauf ist folgender:
getpositions.py -> routing.py -> drawdxf.py
Das erste Programm extrahiert aus der .dxf-Datei sämtliche Informationen über die Positionen von Sensoren / Aktoren und Unterverteilern sowie den Kabeltrassen. Das zweite Programm baut aus den Informationen ein Modell der Anlage auf und verknüpft die Elemente entlang der kürzesten Wege. Das letzte Programm zeichnet eine neue .dxf-Datei, in welcher die Kabelwege von den Unterverteilern zu den Sensoren dargestellt sind.
Aufruf des Programms
Der einfachste Weg, das Toolset zu starten, ist per Drag-and-Drop. Hierfür muss lediglich die .dxf-Datei, für die die Kabelführung und -auswertung durchgeführt werden soll, auf die Verknüpfung namens Kabeltool gezogen werden. Es öffnet sich eine sogenannte Command-Shell, die den Benutzer über den aktuellen Zustand des Programmablaufs informiert.
Die Ausgabe schreibt:
C:\10-Develop\kabellaengen\bin>getexdraw.bat easy.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
done
Ausgabe des Toolsets
Alle drei oben genannten Teilprogramme erzeugen eine eigene Ausgabedatei. Die Ergebnisse der ersten beiden Programme dienen als Eingabe für die folgenden. Jedes der genutzten Programme besitzt eine eingebaute Hilfe, wenn man das Programm mit dem Schalter --help aufruft.
Die Ausgaben des letzten Teilprogrammes drawdxf.py sind für den Anwender bestimmt. Zu Informationszwecken können die Zwischenergebnisse im "Work"-Ordner geöffnet werden (genauere Informationen zu den Ausgaben in den jeweiligen Abschnitten zu den Teilprogrammen). Als wesentliche Ausgabe nach Aufruf des Gesamtprogramms dienen:
- Die .dxf-Datei mit den Kabelwegen:
NamederEingabedatei_cables.dxf - Die tabellarische Aufbereitung der Kabellängen mit zugehörigen Sachnummern für jeden Sensor / Aktor:
NamederEingabedatei_cables.xlsx
Informationen zu den Einzelprogrammen
Nachfolgend sind Infomationen zu den Einzelprogrammen aufgeführt. Diese enthalten teils wichtige Hinweise zur Aufbereitung der Eingabedateien, Informationen zu den einzelnen Ausgabedateien sowie immer ein Beispiel anhand eines einfachen Layouts easy.dxf. Dieses wird verwendet, um den Programmablauf beispielhaft zu zeigen. Nachfolgend ein Screenshot des Layouts für die weiteren Beispiele.
Details zu getpositions.py
Hier die vorhandenen Schalter des Programms:
usage: getpositions [-h] -f myfile.dxf [-s] [-r] [-w WRITE] [-c]
fetches the x/y positions from a dxf file
Schalter:
| Schalter (kurz) |
Schalter (lang) |
Argument (notwendig!) |
Hilfe |
|---|---|---|---|
-h |
--help |
show this help message and exit | |
-f |
--filename |
myfile.dxf |
file to be analyzed |
-s |
--sensors |
fetch all positions of sensors, actors and subdistributors | |
-r |
--rack |
fetch all positions of all cable racks | |
-w |
--write |
myfile_positions.json |
write results into a json file |
-c |
--console |
print results to output |
Das erste Programm im Ablauf bestimmt maßgeblich die Ausgaben der weiteren Programme und ist weiterhin maßgeblich von der Eingabedatei (.dxf-Datei der Anlage) abhängig.
Eine .dxf-Datei (mit standardisierten Merkmalen!) wird in getpositions.py eingelesen. Das Programm extrahiert aus der 2D-Zeichnungsdatei alle Anfangs- und Endpunkte der Kabeltrassen sowie alle Positionen der Sensoren / Aktoren und Unterverteiler innerhalb des 2D-Layouts der Anlage. Diese werden gesammelt und in einer temporären Datei abgespeichet (NamederEingabedatei.json ).
Bei der Erstellung der .dxf-Datei, welche vearbeitet werden soll, ist es wichtig, dass die Kabeltrassen konsistent auf den gleichen Layern gezeichnet werden und bei der Erstellung / Positionierung der Sensoren und Aktoren folgendes beachtet wird:
- Sensoren / Aktoren müssen als Block in der dxf Datei definiert sein und das Attribut "REALE_POSITION=x" enthalten. Das x dieses Attributs kann dann unabhängig von der Beschreibung im Kasten verschoben werden, so dass man dieses auf der echten Sensorposition verschieben kann. Das Kabel wird dann vom Unterverteiler bis zur Position des x erzeugt.
- Sensoren / Aktoren, die keine solche Markierung enthalten, werden auf die Mitte des Textblockes mit einem Kabel versehen
Die Ausgabe des Programms ist eine .json-Datei, welche strukturiert, in Textform die Informationen aus der Zeichnungsdatei weitergibt. Nachstehend ein Auszug der .json-Ausgabe des oben gezeigten Layouts.
{
"sensors": {
"BG3241": {
"IO": "BG3241",
"ID": "",
"VERW": "Jam detector",
"BEZEICHNUNG": "Stausensor 1 (ILS-CV M0108)",
"KENNZEICHNUNG": "=A01+UC0101-KF1DI1",
"SPS": "1",
"REALE_POSITION": "x",
"pos": [38.8, 1280.2]
},
"MA0062": {
"IO": "MA0062",
"ID": "",
"VERW": "CV-M0062_0,75",
"BEZEICHNUNG": "Motor MA0062",
"KENNZEICHNUNG": "=A01+UH01-KF1DQ04",
"TEXT-E": "Motor MA0062",
"SPS": "1",
"REALE_POSITION": "x",
"pos": [4967.0, 8072.5]
},
},
....
"distributors": {
"UC0101": [0.0, 4162.8]
},
"racks": {
"Rack_1": [
[4946.5, 15774.4],
[4946.5, 3879.4]
],
"Rack_2": [
[0.1, 57.6],
[0.1, 3777.6],
[14755.1, 3777.6]
],
"Rack_3": [
[185.1, 15865.5],
[12450.7, 15865.5]
]
},
"mapping": {
"UC0101": [
"BG3241",
"MA0062"
]
}
}
Die Ausgabedatei ist gegliedert in vier große Blöcke:
- Sensoren und Aktoren ("sensors"): Enthält alle Sensoren und Aktoren der Anlage mit allen zugewiesenen Informationen.
- Unterverteiler ("distributors"): Enthält die Positions-Infomation der Unterverteiler
- Kabeltrassen ("racks"): Enthält die Koordinaten der Anfangs und Endpunkte einer Kabeltrasse. Wenn Kabeltrasse als Polylinie gezeichnet ist, sind mehrere einzelsegmente aufgeführt (siehe bspw. "Rack_2")
- Zuweisung von UV zu Sensoren / Aktoren ("mapping"): Enthält die Zuweisung von einem Unterverteiler zu allen daran angeschlossenen Sensoren und Aktoren
Details zu routing.py
Hier die vorhandenen Schalter des Programms:
usage: routing.py [-h] -f my_positions.json [-c] [-g] [-w WRITE]
Berechne Wege von Sensoren zu Verteilern über Kabeltrassen
Schalter:
| Schalter (kurz) |
Schalter (lang) |
Argument (notwendig!) |
Hilfe |
|---|---|---|---|
-h |
--help |
show this help message and exit | |
-f |
--filename |
myfile_positions.json |
file positional information |
-c |
--console |
print result to output | |
-g |
--graph |
draw graph and display in separate window | |
-w |
--write |
myfile_todraw.json |
write results-file to use for cable-drawing |
Die .json-Ausgabe, welche oben in einem Auszug gezeigt ist, stellt die Daten der .dxf-Datei in einer maschinen- und menschenlesbarer Fassung dar. Die ausgegebenen Daten sind jedoch weiterhin im weitesten Sinne "Rohdaten", welche noch weiter behandelt werden müssen. In dem Einzelprogramm routing.py wird aus den Daten mithilfe der Funktionen, welche in plant.py implementiert sind, eine "virtuelle" Anlage (eng.: plant) aufgebaut. Als Eingabe dient lediglich die .json, welche von getpositions.py ausgegeben wird. Hauptfunktionen von routing.py bzw. plant.py sind:
- Aufbauen des "Grundgerüstes" der Anlage bestehend aus Kabeltrassen (Racks)
- Finden von Schnittpunkten einzelner Racks und Erstellung von expliziten Knoten dort
- Finden von "eigentlichen" Schnittpunkten und Anpinnen von nahezu verbundenen Racks aneinander
- Verknüpfen von Sensoren / Aktoren / Unterverteilern mit dem Grundgerüst der Anlage
- Finden des nächstgelegenen Racks zu jedem Sensor / Aktor / UnterVerteiler
- Erstellen eines Aufpunktes für die Strecke vom Rack zum S / A / UV
- Verknüpfen des jeweiligen S / A / UV mit dem Aufpunkt über den kürzesten Weg
- Erstellen eines Graphen (=mathematisches Modell für netzartige Struktur) zur Anwendung von Wegfindungs-Algorithmen zur Bestimmung der kürzesten Kabelwege von Sensor / Aktor zu Unterverteiler entlang der Racks
Die Ausgabe des Einzelprogramms routing.py ist im wesentlichen die Infomationen über die Kabel, welche von einem Sensor / Aktor zu dem zugehörigen Unterverteiler laufen. Die Informationen beinhalten den Pfad (= die einzelnen Koordinaten in x,y über welche der Pfad verläuft) und die Länge des Pfades (und damit die Länge des Kabels). Die Ausgabe erfolgt erneut in einer strukturierten .json-Datei. Die Ausgabedatei an dieser Stelle trägt stets den namen todraw.json. Sie dient als Eingabe für das Einzelprogramm drawdxf.py. Nachfolgend ein Ausschnitt der Ausgabedatei anhand des oben gezeigten Beispiels:
{
"kabel": [
{
"id": "UC0101-BG3241",
"coords": [
{"x": 0.0, "y": 4162.8},
{"x": 0.1, "y": 3777.6},
{"x": 0.1, "y": 1280.2},
{"x": 38.8, "y": 1280.2}],
"length": 2921.3,
"nodes": [31, 17, 18, 12]
},
....
{
"id": "UC0101-BG3240",
"coords": [
{"x": 0.0, "y": 4162.8},
{"x": 0.1, "y": 3777.6},
{"x": 2866.6, "y": 3777.6},
{"x": 4946.5, "y": 3777.6},
{"x": 4946.5, "y": 3879.4},
{"x": 4946.5, "y": 5609.0},
{"x": 4961.9, "y": 5609.0}],
"length": 7178.4,
"nodes": [31,17,15,29,21,7,14]
]
}
Die Ausgabedatei gliedert sich in die Blöcke, welche im Mapping (siehe Ausgabedatei unter getpositions.py) aufgeführt sind. Im obigen Beispiel sind demnach die Kabel von Unterverteiler UC0101 zu Sensor BG2341 bzw. von UC0101 zu BG2340 dargestellt. Neben der ID des Kabels ist aufgeführt:
- Die Knotenpunkt-Koordinaten entlang welchen das Kabel verläuft
- Die exakte Länge des Kabels
- Die Knotenpunkte (nodes) des Graphen, entlang welchen das Kabel verläuft
Als weitere Ausgabedatei kann in der Konfigurationsdatei routing.cfg die Ausgabe des Graphen eingestellt werden. Der Graph, welcher sich anhand des verwendeten Beispiels ergibt ist nachfolgend gezeigt. Die Knotenpunkte können zur einfachen Überprüfung der Kabelwege anhand des Graphen verwendet werden (ohne die Verwendung der teils unhandlichen Koordinaten x,y). Der Graph wird standardmäßig als Vektorgrafik (.svg) gespeichert, sodass ohne Qualitätsverlust an sich überlappende Knoten gezoomt werden kann, um diese genauer zu betrachten.
- Schwarze Linine stellen Racks dar
- Rote Linine sind Verbindungen zwischen Racks und Sensoren / Aktoren
- Blaue Linien sind Verbindungen von Unterverteilern zu Racks
Details zu drawdxf.py
Hier die vorhandenen Schalter des Programms:
usage: drawdxf [-h] -f myfile_todraw.json [-d myfile.dxf] [-n NEW] [-c myfile_reduced.dxf] [-x myfile_cables.xlsx] [-o myfile.dxf]
draws a dxf file with the given cable coordinates
Schalter:
| Schalter (kurz) |
Schalter (lang) |
Argument (notwendig!) |
Hilfe |
|---|---|---|---|
-f |
--filename |
myfile_todraw.json |
this json file contains all cables and its coordinates which should be drawn. Saved with a unique timestamp |
-d |
--dxf |
myfile.dxf |
this dxf drawing will be copied and the new layer with the cables will be added. Requires --origin |
-c |
--copy_layer |
myfile_reduced.dxf |
copy layers of racks, sensors, distributors into a new .dxf-file. Also contains cable paths. Requires --origin |
-n |
--new |
myfile_cables.dxf |
create a new dxf file only with cables in it. Name is basename and a timestamp |
-x |
--excel |
myfile_cables.xlsx |
create a xlsx file with cables data |
-o |
--origin |
myfile.dxf |
name of original .dxf file used by --dxf and --copy_layer |
Das letzte Einzelprogramm, welches in der Routine aufgerufen wird, dient der Erstellung einer eigenen .dxf-Datei, welche die Kabelwege dastellt. Diese .dxf Datei trägt stets den Namen der Eingabedatei mit der Ergänzung ..._cables.dxf. Die Datei kann als neue Layer in das bestehende Anlagen-Layout importiert werden, um die Kabelwege zu verifizieren. Die sich aus dem behandelten Beispiel ergebende Datei ist nachfolgend alleine sowie importiert in das Layout dargestellt:
Die in den Details zu getpositions.py beschriebene Handhabung der Verbindung der Sensoren / Aktoren wird ersichtlich:
- Sensoren mit einem Marker "x" zur genauen Positionierung werden an diesen verbunden (BG3260, BG3240, ...)
- Sensoren, welche über keinen Marker verfügen, werden anhand des Textblocks verbunden (z.B: BG3270)
- Die Unterverteiler werden stets auf die Mitte ihres Blocks verbunden.
Das letzte Programm gibt standardmäßig zudem eine Excel-Übersicht der Kabel zurück. Diese beinhaltet die jeweilige ID des Kabels ("von wo nach wo") und die tatsächliche (genaue) Länge des Kabels. Daneben ist die gerundete Länge (aktuell auf volle 10 m) aufgeführt. In einem weiteren Arbeitsblatt sind die Längen gesammelt aufgeführt (z.B. 10x 10m Kabel, 5x 20 m Kabel, 1x 50 m Kabel). In einer Fehlerübersicht sind fehlgeschlagene Verbindungen zwischen Sensoren / Aktoren / Unterverteilern zu Kabeltrassen aufgeführt. In einer weiteren Übersicht fehlgeschlagene Kabelverbindungen (Routings) und der Grund für das Fehlschlagen.
Häufige Fagen
Wo stelle ich ein, was das Toolset am Ende ausspuckt?
Hier müssen wir das mit der einzelnen Config noch implementieren
Warum werden manche Kabeltrassen nicht mit anderen verbunden?
Mittels der Methode join_racks(), welche innerhalb plant.py definiert ist und von routing.py aufgerufen wird, werden die Rack-Segmente, welche von getpositions.py übergeben werden, auf echte Schnittpunkte, sowie beinahe Schnittpunkte überprüft und an den jeweiligen Punkten verknüpft. Beinahe Schnittpunkte werden durch Entlanglaufen der einzelnen Racks und "Absuchen" eines Toleranzfeldes ermitteln.
Sobald ein Schnittpunkt des Toleranzkreises mit einem angrenzenden Rack festgestellt wird, wird dieses Rack mit dem ausgehenden Rack verbunden.
Sollten einzelne Kabeltrassen nicht miteinander verbunden werden, ist die eingestellte Toleranz in der Konfigurationsdatei sowie der tatsächliche Abstand des Endpunktes einer Kabeltrasse und der naheliegenden zu überprüfen. Die Toleranz muss stets größer sein als dieser Abstand. Bei zu groß gewählter Toleranz kann unerwünschtes Anpinnen von zu weit entfernten Kabeltrassen auftreten. Der Standardwert ist auf 200 zu setzen.
Warum verbindet das Programm den Sensor mit genau dieser Kabeltrasse?
Bei der Verbindung von Sensoren / Aktoren mit den Kabeltrassen findet noch keine Wegsuche zum zugehörigen Unterverteiler statt. Die Sensoren / Aktoren tragen darüber hinaus keinerlei Information, mit welcher Kabeltrasse sie verbunden werden sollen. Der Algorithmus sucht daher ausgehend von der Position des Sensors das am nahesten liegende Rack und stellt im Anschluss die kürzestmögliche verbindung zu einer Kabeltrasser her.
Situation: Horizontales und vetikales Rack (R1 bzw R2), Sensor (S). Erstellen eines Kreises um den Sensor und Überprüfung auf Schnittpunkte mit Kabeltrassen
Schritt 2: Bei Ausbleiben eines Schnittpunktes -> Vergrößern des Kreises. Bei Ermittlung eines Schnittpunktes -> Erzeugen eines Aufpunktes auf der geschnittenen Kabeltrasse und Verbinden von Sensor mit Kabeltrasse.
Ideen für "Umbau" der Programme
- Eine Config in der unter mehreren Blöcken ## Routing ##, ##Ausgabe## die einzelnen Schalter 1 / 0 gesetzt werden
- Getpositions läuft immer
- -> scheibt output in positions.json in work
- -> damit werden alte positions.json überschrieben und work ordner nicht zugemüllt
- Routing läuft immer -> schreibt output in routing.json
- wenn schalter in Config für Graph gesetzt ist wird Graph als .svg in work gespeichert
- Name der Datei eingabefile_graph.svg
- wenn schalter in Config für Graph gesetzt ist wird Graph als .svg in work gespeichert
- Drawdxf umbennen in sowas wie cables.py oder so
- Schalter steuern was alles ausgegeben wird (Excel, dxf, ... was könnte man noch machen)
- hier muss man entscheiden ob Cabel-dxf immer gleich heisst oder so wie Eingabefile (Gefahr der Zumüllung)
- selbes gilt für excel-File