329 lines
18 KiB
Markdown
329 lines
18 KiB
Markdown
- [Anwenderdoku zur Ermittlung der Kabellängen](#anwenderdoku-zur-ermittlung-der-kabellängen)
|
||
- [Installation des Programmes](#installation-des-programmes)
|
||
- [Allgemeine Informationen und Programmablauf](#allgemeine-informationen-und-programmablauf)
|
||
- [Informationen zu den Einzelprogrammen](#informationen-zu-den-einzelprogrammen)
|
||
- [Häufige Fagen](#häufige-fagen)
|
||
- [Ideen für "Umbau" der Programme](#ideen-für-umbau-der-programme)
|
||
|
||
|
||
# Anwenderdoku zur Ermittlung der Kabellängen
|
||
|
||
## Installation des Programmes
|
||
|
||
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 auch einfach mit allen Unterordnern gezippt und auf einem anderen Rechner ausgepackt 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.
|
||
|
||
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.
|
||
|
||
## Allgemeine 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 Bilddatei mit dem erstellten Anlagenmodell
|
||
- 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 erknü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
|
||
|
||
Vor dem Start des Programms muss sichergestellt werden, dass die Umgebungsvariablen korrekt gesetzt sind. Dies geschieht über den Aufruf der Datei `get_cmd.bat`. Die *Command-Shell* bleibt geöffnet.
|
||
|
||
Nun kann in dieser Konsole das Skript `getexdraw.bat` aufgerufen werden. Hierzu reicht das Eintippen des Programmnamens. **WICHTIG:** Nach dem Programmnamen **muss** die .dxf-Datei, welche für das Programm verwendet werden soll genannt werden. Diese **muss** im Order "Work" abgelegt sein! Ein Beispielafter Programmaufruf am Beispiel der "easy.dxf" sieht dementsprechend aus:
|
||
|
||
```text
|
||
C:\10-Develop\kabellaengen\bin> getexdraw.bat easy.dxf
|
||
```
|
||
|
||
Wenn das Programm korrekt gestartet wurde, wird der Nutzer in dem geöffnetem Fenster über den aktuellen Status infomiert. Die Ausgabe schreibt:
|
||
|
||
```text
|
||
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 folgendem. 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:
|
||
|
||
```text
|
||
usage: getpositions [-h] -f myfile.dxf [-s] [-r] [-w WRITE] [-c]
|
||
|
||
fetches the x/y positions from a dxf file
|
||
|
||
options:
|
||
-h, --help show this help message and exit
|
||
-f myfile.dxf, --filename myfile.dxf
|
||
which file should be fetched
|
||
-s, --sensors fetch all position of sensors, motors, actors and subdistributors
|
||
-r, --rack fetch all positions of all cable racks
|
||
-w WRITE, --write WRITE
|
||
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.
|
||
|
||
```json
|
||
{
|
||
"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:
|
||
|
||
```text
|
||
usage: routing.py [-h] -f my_positions.json [-c] [-g] [-w WRITE]
|
||
|
||
Berechne Wege von Sensoren zu Verteilern über Kabeltrassen
|
||
|
||
options:
|
||
-h, --help show this help message and exit
|
||
-f my_positions.json, --filename my_positions.json
|
||
file with all informations about positions gathered from getpositions
|
||
-c, --console Ausgabe auf Konsole
|
||
-g, --graph Zeichnet den Graphen der Anlage
|
||
-w WRITE, --write WRITE
|
||
erstellt Ausgabe-file für das Zeichnen von Kabeln in drawdxf
|
||
```
|
||
|
||
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 **S**ensor / **A**ktor / **U**nter**V**erteiler
|
||
- 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:
|
||
|
||
``` yaml
|
||
{
|
||
"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:
|
||
|
||
```text
|
||
usage: drawdxf [-h] -f myfile.json [-d myfile.dxf] [-n NEW]
|
||
|
||
draws a dxf file with the given cable coordinates
|
||
|
||
options:
|
||
-h, --help show this help message and exit
|
||
-f myfile.json, --filename myfile.json
|
||
this json file contains all cables and its coordinates which should be drawn. Saved with an unique timestamp
|
||
-d myfile.dxf, --dxf myfile.dxf
|
||
this dxf drawing will be copied and the new layer with the cables will be added
|
||
-n NEW, --new NEW create a new dxf file with cables in it. Name is basename and a timestamp
|
||
```
|
||
|
||
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.
|
||
|
||
|
||
|
||
## 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.
|
||
|
||
<img src="img\join_racks\join_racks_1.png" width="47.5%" style="display:inline-block; margin-right:5px;">
|
||
<img src="img\join_racks\join_racks_2.png" width="47.5%" style="display:inline-block;">
|
||
|
||
Sobald ein Schnittpunkt des Toleranzkreises mit einem angrenzenden Rack festgestellt wird, wird dieses Rack mit dem ausgehenden Rack verbunden.
|
||
|
||
<img src="img\join_racks\join_racks_3.png" width="47.5%" style="display:inline-block; margin-right:5px;">
|
||
<img src="img\join_racks\join_racks_4.png" width="47.5%" style="display:inline-block;">
|
||
|
||
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
|
||
<img src="img\connect_sensors_to_racks\connect_sensors_to_racks_1.png" width="47.5%" style="display:inline-block; margin-right:5px;">
|
||
<img src="img\connect_sensors_to_racks\connect_sensors_to_racks_2.png" width="47.5%" style="display:inline-block;">
|
||
|
||
|
||
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.
|
||
<img src="img\connect_sensors_to_racks\connect_sensors_to_racks_3.png" width="47.5%" style="display:inline-block; margin-right:5px;">
|
||
<img src="img\connect_sensors_to_racks\connect_sensors_to_racks_4.png" width="47.5%" style="display:inline-block;">
|
||
|
||
|
||
# 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
|
||
- 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
|
||
|