# Anwenderdoku zur Ermittlung der Kabellängen <!-- omit in toc -->

- [1. Installation des Programmes und Schnellstart-Guide](#1-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: *dxfdatei*\_cables.xlsx](#excel-datei-dxfdatei_cablesxlsx)
    - [Excel-Datei: *dxfdatei*\_BOM.xlsx](#excel-datei-dxfdatei_bomxlsx)
- [2. Anpassung des Verhaltens des Programms](#2-anpassung-des-verhaltens-des-programms)
  - [Verwendete Konfigurationsdateien](#verwendete-konfigurationsdateien)
  - [Zusammenfassung und Struktur der Konfigurationsdateien](#zusammenfassung-und-struktur-der-konfigurationsdateien)
    - [allgemein.cfg](#allgemeincfg)
    - [BMK.cfg](#bmkcfg)
    - [kabel.cfg](#kabelcfg)
    - [bezeichner.cfg](#bezeichnercfg)
- [3. Anwenderhinweise zur Layouterstellung](#3-anwenderhinweise-zur-layouterstellung)
  - [Verwendung der Layer](#verwendung-der-layer)
  - [Zeichnen von Kabeltrassen](#zeichnen-von-kabeltrassen)
  - [Attribute der Blöcke (Bauteile)](#attribute-der-blöcke-bauteile)
  - [Positionierung von Bauteilen](#positionierung-von-bauteilen)
- [4. Detaillierte Informationen zum Programmablauf und Code-Struktur](#4-detaillierte-informationen-zum-programmablauf-und-code-struktur)
  - [Zweck des Programms](#zweck-des-programms)
  - [Allgemeiner Programmablauf](#allgemeiner-programmablauf)
  - [Aufruf des Programms](#aufruf-des-programms)
  - [Ausgabe des Toolsets](#ausgabe-des-toolsets)
  - [Informationen zu den Einzelprogrammen](#informationen-zu-den-einzelprogrammen)
    - [Details zu `getpositions.py`](#details-zu-getpositionspy)
    - [Details zu `routing.py`](#details-zu-routingpy)
    - [Details zu `drawdxf.py`](#details-zu-drawdxfpy)
  - [Häufige Fagen](#häufige-fagen)
    - [Warum werden manche Kabeltrassen nicht mit anderen verbunden?](#warum-werden-manche-kabeltrassen-nicht-mit-anderen-verbunden)
    - [Warum verbindet das Programm den Sensor mit genau dieser Kabeltrasse?](#warum-verbindet-das-programm-den-sensor-mit-genau-dieser-kabeltrasse)
- [5. Fehlerfälle und Fehlerbehandlung](#5-fehlerfälle-und-fehlerbehandlung)
  - [Allgemeine Fehler und Warnungen (beide Workflows)](#allgemeine-fehler-und-warnungen-beide-workflows)
  - [Detaillierte Beschreibung der Warnungen (Warnings)](#detaillierte-beschreibung-der-warnungen-warnings)
    - [1. `missing_attributes` (Fehlende oder unvollständige Block-Attribute)](#1-missing_attributes-fehlende-oder-unvollständige-block-attribute)
    - [2. `tunnel_missing_length` (Fehlende Längenangabe bei Tunnel)](#2-tunnel_missing_length-fehlende-längenangabe-bei-tunnel)
    - [3. `mapping_warnings` (Probleme bei KENNZEICHNUNG-Zuordnung)](#3-mapping_warnings-probleme-bei-kennzeichnung-zuordnung)
      - [3a. "keine KENNZEICHNUNG vorhanden"](#3a-keine-kennzeichnung-vorhanden)
      - [3b. "Ungültiger Pfad in Kennzeichnung"](#3b-ungültiger-pfad-in-kennzeichnung)
    - [Zusammenfassung: Umgang mit Warnungen](#zusammenfassung-umgang-mit-warnungen)
  - [Cable Routing spezifische Fehler](#cable-routing-spezifische-fehler)
    - [Fehlertypen im Routing-Prozess](#fehlertypen-im-routing-prozess)
    - [Detail-Beschreibungen der Routing-Fehler](#detail-beschreibungen-der-routing-fehler)
      - [Equipment Connection Errors (ERR-Equipment-Connection)](#equipment-connection-errors-err-equipment-connection)
      - [Routing Errors (ERR-Routing)](#routing-errors-err-routing)
      - [Tunnel Connection Errors](#tunnel-connection-errors)
    - [Hinweise zur Excel-Fehlerausgabe (Cable Routing)](#hinweise-zur-excel-fehlerausgabe-cable-routing)
  - [I/O Conversion Workflow - Hinweise](#io-conversion-workflow---hinweise)
    - [Ausgabedateien bei Fehlern](#ausgabedateien-bei-fehlern)
    - [Wichtige Hinweise](#wichtige-hinweise)

# 1. 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

Das Programm bietet **drei Hauptworkflows**, die je nach Anwendungsfall eingesetzt werden:

### Workflow-Übersicht

| Workflow | Batch-Datei | Zweck | Ausgabe | Verwendete Configs |
| -------- | ----------- | ----- | ------- | ------------------ |
| **Cable Routing** | `getexdraw.bat` | Vollständige Kabelberechnung mit Längen und Stücklisten | `*_cables.dxf`, `*_cables.xlsx`, `*_BOM.xlsx` | `allgemein.cfg`, `BMK.cfg`, `kabel.cfg`, `bezeichner.cfg` |
| **I/O Conversion** | `ioconverter.bat` | Export von Gerätelisten für TIA Portal, WSCAD, etc. | `*-TIA.xlsx`, `*-WSCAD.xlsx`, u.a. | `allgemein.cfg`, `BMK.cfg` |
| **Translation** | `extract.bat` + `tr2dxf_<lang>.bat` | Textextraktion und Übersetzung von DXF-Inhalten | `*_texts.json`/`.xlsx`, `*_<lang>.dxf` | `allgemein.cfg`, `translation/*.cfg` |

**Hauptworkflow (Cable Routing):**
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:

```text
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.

### :exclamation: Hinweis :exclamation: <!-- omit in toc -->
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: <!-- omit in toc -->

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
- ERRORS-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): <!-- omit in toc -->
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 1 m, 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): <!-- omit in toc -->

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 1 m, gewinkelt |
> | UC01   | 722001330   | 2            |            | M12 Sensorleitung 1 m, gewinkelt |
> | UC01   | 725000015   |              | 12         | Steuerleitung MA, 4G1,5mm²       |

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

# 2. 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.

| Datei         | Inhalt                                                                                                                                                                                                                                          |
|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `allgemein.cfg` | Layernamen der Kabelpritschen<br>Layenamen der Unterverteiler<br>Layernamen der Tunnel<br>Layernamen der Sensoren / Aktoren<br>Toleranz der Verbindung zw. Sensor und Kabeltrasse<br>Toleranz des "Anpinnens" zweier Kabeltrassen untereinander |
| `BMK.cfg`       | Betriebsmittelkennzeichnung der Elemente, die im Routing berücksichtigt bzw. ignoriert werden sollen<br>Zuweisung der Kabelkennzeichnungen zur jeweiligen Betriebsmittelkennzeichnung<br>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                                                                                                                                               |

### :exclamation: Hinweis :exclamation: <!-- omit in toc -->

**Ä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]` <!-- omit in toc -->
**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]` <!-- omit in toc -->
**Was?** Layernamen, die Unterverteiler beinhalten.

| Layername (Beispiel)              |
|----------------------------------|
| 0-0_ILS_UNTERVERTEILER           |
| UNTERVERTEILER                   |

---

#### `[GetPos-Layer_Tunnel]` <!-- omit in toc -->
**Was?** Layernamen für Tunnel.

| Layername (Beispiel)         |
|-----------------------------|
| Busverteiler-Kennzeichnung |

---

#### `[GetPos-Layer_Equipment]` <!-- omit in toc -->
**Was?** Layernamen von Sensoren, Motoren, IOs etc.

| Layername (Beispiel)          |
|------------------------------|
| 0-0_ILS_MOTOR                |
| MOTOR                        |
| REALE_POSITION_IO            |

---

#### `[GetPos-Geom-Sensor]` <!-- omit in toc -->
**Was?** Geometrische Maße von Sensor-Markern zur Mittelpunktsberechnung.

| Attribut | Wert (Beispiel) |
|----------|-----------------|
| Breite   | 80              |
| Hoehe    | 90              |

---

#### `[Racks]` <!-- omit in toc -->
**Was?** Maximale Distanz (Toleranz) zwischen benachbarten Racks zum "Snappen".

| Attribut         | Wert (Beispiel) |
|------------------|-----------------|
| SnapTolerances   | 200             |

---

#### `[Sensoren]` <!-- omit in toc -->
**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]` <!-- omit in toc -->
**Was?** BMK-Kürzel, die beim Routing **berücksichtigt** werden.

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

---

#### `[Routing-Ignore]` <!-- omit in toc -->
**Was?** BMKs, die ignoriert werden (z.B. Schaltschrank-Innenleben).

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

---

#### `[Cable-Mapping]` <!-- omit in toc -->
**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]` <!-- omit in toc -->
**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]`) <!-- omit in toc -->
**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 <!-- omit in toc -->
**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]` <!-- omit in toc -->
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]` <!-- omit in toc -->
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.

## :exclamation: Hinweis :exclamation: <!-- omit in toc -->

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.**

# 3. 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.  

## :exclamation: Hinweis :exclamation: <!-- omit in toc -->

**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.

# 4. Detaillierte Informationen zum Programmablauf und Code-Struktur

## 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:

```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 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. 
![dxf von easy](img\easy_layout.png)

### Details zu `getpositions.py`

Hier die vorhandenen Schalter des Programms:

```text
usage: getpositions [-h] -f myfile.dxf [-s] [-r] [-w WRITE] [-c] [-e ERRORS] [-n]

fetches the x/y positions from a dxf file
```

Schalter:

| Schalter<br>(kurz) | Schalter<br>(lang) | Argument<br>(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, motors, 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                                                |
| `-e`               | `--errors`         | `myfile_errors.json`     | write an error file in case of double defined items in layout          |
| `-n`               | `--scan`           |                          | print all layer of racks, distributors and equipment not empty|


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
```

Schalter:

| Schalter<br>(kurz) | Schalter<br>(lang) | Argument<br>(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 **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.

![Graph von easy](img\graph_easy.svg)

- 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_todraw.json [-d myfile.dxf] [-n NEW] [-x myfile_cables.xlsx] [-o myfile.dxf] [-l]


draws a dxf file with the given cable coordinates
```

Schalter:

| Schalter<br>(kurz) | Schalter<br>(lang) | Argument<br>(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`    |
| `-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`                                                               |
| `-l`               | `--local`          |                           | using only local data for naming of article numbers. If not set: fetching names from SIVAS              |

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:

![easy_cables_allein](img\easy_cables.png)


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

### 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;">


# 5. Fehlerfälle und Fehlerbehandlung

## Allgemeine Fehler und Warnungen (beide Workflows)

Die folgende Tabelle zeigt alle möglichen Fehler- und Warnungstypen, die von `getpositions.py` erkannt werden. Diese gelten **für beide Workflows** (Cable Routing und I/O Conversion):

| Fehlertyp | Kategorie | Beschreibung | Ursache | Behebung |
|-----------|-----------|--------------|---------|----------|
| `double_ids` | Fehler | Mehrere Blöcke haben dieselbe ID (z.B. MA0062@1) | Doppelte Bauteile mit identischer Kennzeichnung und SPS-Präfix im Layout | IDs eindeutig vergeben oder doppelte Blöcke entfernen |
| `missing_attributes` | Warnung | Block hat fehlende oder unvollständige Attribute | Block enthält z.B. nur A, B, C, ARTINR aber keine SPS-, IO- oder KENNZEICHNUNG-Attribute | Fehlende Attribute im DXF-Block ergänzen (z.B. SPS, KENNZEICHNUNG) |
| `missing_distributors` | Fehler | Unterverteiler in KENNZEICHNUNG erwähnt aber nicht im Layout | Sensor verweist auf UV (z.B. UH01) in KENNZEICHNUNG, aber UV-Symbol fehlt im Layout | Unterverteiler-Block im Layout positionieren oder KENNZEICHNUNG korrigieren |
| `missing_sensors` | Fehler | Sensor/Aktor nicht gefunden | Sensor wird in Mappings referenziert, aber Block fehlt oder hat ungültige Attribute | Sensor-Block im Layout ergänzen oder fehlerhafte Attribute korrigieren |
| `missing_tunnel` | Fehler | Tunnel hat weniger als 2 Positionen | Tunnel-Eingang oder -Ausgang fehlt (TUNNEL-Block oder MTEXT mit Muster `TUNNEL<nr>-<länge>`) | Zweiten Tunnel-Eingang/Ausgang im Layout ergänzen |
| `overdefined_tunnel` | Fehler | Tunnel hat mehr als 2 Positionen | Mehr als zwei TUNNEL-Blöcke mit demselben Namen (z.B. TUNNEL2 dreimal) | Überzählige Tunnel-Positionen entfernen |
| `tunnel_missing_length` | Warnung | Tunnel-Block hat kein LAENGE-Attribut | LAENGE-Attribut fehlt in Tunnel-Block, Default-Länge (5m) wird verwendet | LAENGE-Attribut im Tunnel-Block ergänzen |
| `mapping_warnings` → `keine KENNZEICHNUNG vorhanden` | Warnung | KENNZEICHNUNG-Attribut fehlt komplett | Block hat kein KENNZEICHNUNG-Attribut | KENNZEICHNUNG-Attribut im Format `=<Anlage>+<UV>-<Karte>` ergänzen |
| `mapping_warnings` → `Ungültiger Pfad in Kennzeichnung` | Warnung | KENNZEICHNUNG hat falsches Format | Trennzeichen `+`, `-` oder `=` fehlen oder falsch positioniert | KENNZEICHNUNG-Format korrigieren (z.B. `=A01+UH01-KF1DQ04`) |
| `missing_sps_prefix` | Fehler | SPS-Präfix fehlt für Block-ID | Beim Zusammenführen von Blöcken fehlt der SPS-Präfix | SPS-Attribut in Block ergänzen |

## Detaillierte Beschreibung der Warnungen (Warnings)

Warnungen (Warnings) sind **nicht-kritische Probleme**, bei denen das Programm zwar fortfahren kann, aber das Ergebnis möglicherweise unvollständig oder fehlerhaft ist. Im Gegensatz zu Fehlern führen Warnungen nicht zum Abbruch, sollten aber trotzdem behoben werden, um die Qualität der Ausgabe zu gewährleisten.

### 1. `missing_attributes` (Fehlende oder unvollständige Block-Attribute)

**Was wird geprüft:**
- Jeder Block im Layout sollte mindestens zwei zusammengehörige Blöcke haben (z.B. einen für das Bauteil und einen für das Kabel)
- Blöcke müssen bestimmte Pflichtattribute enthalten (z.B. SPS, KENNZEICHNUNG, ARTINR)

**Wann tritt die Warnung auf:**
- Nur ein einzelner Block mit einer bestimmten ID gefunden wird
- Der Block hat fehlende Attribute (z.B. kein SPS-Präfix, keine KENNZEICHNUNG)
- Die Block-Zuordnung ist unvollständig

**Beispiel-Warnung:**
```json
"missing_attributes": {
  "BX0101": "Nur ein Block und/oder fehlende Attribute: dict_keys(['A', 'B', 'C', 'ARTINR'])"
}
```

**Mögliche Ursachen:**
- Block wurde nur einmal statt zweimal gezeichnet (Rahmen innen/außen fehlt)
- Attribute wie `SPS`, `KENNZEICHNUNG` oder `IO` wurden nicht ausgefüllt
- Block-Kopie beim Zeichnen vergessen

**Behebung:**
- Überprüfen Sie den betroffenen Block im DXF-Layout
- Ergänzen Sie fehlende Attribute (besonders SPS, KENNZEICHNUNG)
- Falls nötig, korrigieren Sie die Block-Struktur gemäß den Layoutrichtlinien

**Auswirkung:**
- Der betroffene Block wird **nicht verkabelt** und **nicht in die Ausgabe** übernommen
- Keine Kabellängenberechnung für dieses Bauteil
- Block erscheint nicht in der Stückliste

---

### 2. `tunnel_missing_length` (Fehlende Längenangabe bei Tunnel)

**Was wird geprüft:**
- Jeder Tunnel-Block sollte ein Attribut `LAENGE` haben, das die physische Länge des Tunnels angibt
- Alternativ kann die Länge über MTEXT-Eintrag (`TUNNEL<nr>-<länge>`) definiert werden

**Wann tritt die Warnung auf:**
- Ein Tunnel wurde gefunden, aber das `LAENGE`-Attribut fehlt oder ist leer
- Keine Längenangabe in der MTEXT-Beschriftung vorhanden

**Beispiel-Warnung:**
```json
"tunnel_missing_length": {
  "TUNNEL1": "Tunnel 'TUNNEL1' hat keine LAENGE-Angabe. Verwende Default-Länge: 5m"
}
```

**Mögliche Ursachen:**
- Das `LAENGE`-Attribut wurde beim Zeichnen des Tunnel-Blocks vergessen
- MTEXT-Beschriftung folgt nicht dem erwarteten Muster (`TUNNEL<nr>-<länge>`)
- Tunnel wurde aus älterer Layoutversion übernommen, wo Längenangaben noch nicht Pflicht waren

**Behebung:**
- Öffnen Sie den Tunnel-Block im DXF-Layout
- Fügen Sie das Attribut `LAENGE` hinzu und tragen Sie die tatsächliche Tunnel-Länge in Metern ein
- Alternativ: Verwenden Sie MTEXT im Format `TUNNEL1-12.5` (für 12,5 Meter)

**Auswirkung:**
- Es wird eine **Default-Länge von 5 Metern** verwendet
- Die Kabellängenberechnung kann dadurch **ungenau** sein
- In der Routing-Berechnung wird mit dem Default-Wert gearbeitet, was zu falschen Kabellängen führen kann

---

### 3. `mapping_warnings` (Probleme bei KENNZEICHNUNG-Zuordnung)

**Was wird geprüft:**
- Jeder Sensor/Aktor sollte ein Attribut `KENNZEICHNUNG` haben
- Die KENNZEICHNUNG muss dem Format `=<Anlage>+<UV>-<Karte>` entsprechen (z.B. `=AH01+UH02-KF1FDI7`)
- Die Zuordnung zu einem Unterverteiler muss eindeutig möglich sein

**Wann tritt die Warnung auf:**

#### 3a. "keine KENNZEICHNUNG vorhanden"
- Das Attribut `KENNZEICHNUNG` fehlt komplett im Block

**Beispiel-Warnung:**
```json
"mapping_warnings": {
  "MA0099": "keine KENNZEICHNUNG vorhanden"
}
```

**Ursachen:**
- Attribut wurde beim Erstellen des Blocks vergessen
- Block-Template war unvollständig
- Manuelle Bearbeitung hat das Attribut gelöscht

**Behebung:**
- Fügen Sie das Attribut `KENNZEICHNUNG` im Block hinzu
- Tragen Sie den korrekten Wert ein (z.B. `=A01+UH01-KF1DQ04`)

**Auswirkung:**
- Sensor/Aktor wird **nicht verkabelt**
- Keine Zuordnung zu einem Unterverteiler möglich
- Element erscheint nicht in der Kabelberechnung

---

#### 3b. "Ungültiger Pfad in Kennzeichnung"
- KENNZEICHNUNG ist vorhanden, aber das Format stimmt nicht
- Trennzeichen (`=`, `+`, `-`) fehlen oder sind falsch positioniert
- Es werden nicht genau drei Teile (Anlage, UV, Karte) erkannt

**Beispiel-Warnungen:**
```json
"mapping_warnings": {
  "BG3240": "Ungültiger Pfad in Kennzeichnung: UH01-KF1DQ04: +, - oder = fehlen an entsprechender Stelle, keine drei Teile sichtbar",
  "MA0062": "Ungültiger Pfad in Kennzeichnung: AH01+UH02"
}
```

**Mögliche Ursachen:**
- Falsches Format verwendet (z.B. `UH01-KF1DQ04` statt `=A01+UH01-KF1DQ04`)
- Trennzeichen fehlen (z.B. `AH01UH02KF1DQ04`)
- Nur Teile der Kennzeichnung eingetragen (z.B. nur `AH01+UH02` ohne Kartenangabe)
- Sonderzeichen oder Leerzeichen in der Kennzeichnung

**Behebung:**
- Korrigieren Sie die KENNZEICHNUNG im Block
- Verwenden Sie das korrekte Format: `=<Anlage>+<UV>-<Karte>`
- Beispiel: `=AH01+UH02-KF1FDI7`
- Achten Sie auf die **exakte Position** von `=`, `+` und `-`

**Auswirkung:**
- Sensor/Aktor wird **nicht verkabelt**
- Keine Zuordnung zu einem Unterverteiler möglich
- Element erscheint nicht in der Kabelberechnung

---

### Zusammenfassung: Umgang mit Warnungen

**Wichtig:** Auch wenn das Programm bei Warnungen fortfährt, sollten diese **nicht ignoriert** werden. Warnungen führen oft dazu, dass:
- Bauteile nicht verkabelt werden
- Kabellängen falsch berechnet werden
- Stücklisten unvollständig sind

**Empfohlene Vorgehensweise:**
1. Prüfen Sie nach jedem Programmlauf, ob eine `*_errors.json`-Datei erstellt wurde
2. Arbeiten Sie alle Warnungen systematisch ab
3. Führen Sie das Programm erneut aus, bis keine Warnungen mehr auftreten
4. Dokumentieren Sie wiederkehrende Probleme und passen Sie ggf. die Block-Templates an

---

## Cable Routing spezifische Fehler

Die folgenden Fehler treten **nur im Cable Routing Workflow** (`getexdraw.bat`) auf. Sie werden während der Routing- und Zeichnungsphase erkannt und in der Excel-Datei `*_cables.xlsx` als separate Worksheets ausgegeben.

### Fehlertypen im Routing-Prozess

| Fehlertyp | Ausgabe in Excel | Beschreibung | Ursache | Behebung |
|-----------|------------------|--------------|---------|----------|
| **Equipment Connection Errors** | `ERR-Equipment-Connection` | Sensoren, Aktoren oder Unterverteiler können nicht mit Kabeltrassen verbunden werden | Abstand zur nächsten Kabeltrasse überschreitet die konfigurierte Toleranz (Standard: 5000 mm) | Position des Elements anpassen oder Kabeltrasse näher zum Element verlegen; Toleranz in `allgemein.cfg` unter `[Sensoren]` → `ConnectionTolerances` erhöhen |
| **Routing Errors** | `ERR-Routing` | Kabelweg zwischen Unterverteiler und Sensor/Aktor kann nicht berechnet werden | Keine Verbindung im Graph zwischen Start- und Zielpunkt; UV oder Sensor nicht angebunden; fehlende Kabeltrasse | Kabeltrassen-Geometrie prüfen und Lücken schließen; fehlende Unterverteiler ergänzen; Equipment-Connection-Fehler beheben |
| **Tunnel Connection Errors** | `ERR-Equipment-Connection` | Tunnel-Eingang oder -Ausgang kann nicht mit Kabeltrassen verbunden werden | Tunnel-Position liegt zu weit von nächster Kabeltrasse entfernt | Tunnel-Position anpassen oder Kabeltrasse zum Tunnel verlegen |

### Detail-Beschreibungen der Routing-Fehler

#### Equipment Connection Errors (ERR-Equipment-Connection)

**Was wird geprüft:**
- Jedes Equipment-Element (Sensor, Aktor, Unterverteiler, Tunnel) muss innerhalb der konfigurierten Toleranz zu einer Kabeltrasse liegen
- Die Toleranz ist in `allgemein.cfg` unter `[Sensoren]` → `ConnectionTolerances` definiert (Standard: 3000 mm)

**Ausgabe in Excel:**
Das Worksheet `ERR-Equipment-Connection` enthält folgende Spalten:
- **Type**: Art des Elements (Sensor / Actuator, Subdistributor, Tunnel)
- **ID**: Bezeichner des Elements (z.B. MA0062, UH01)
- **x, y**: Koordinaten der Position im Layout

**Beispiel:**
| Type | ID | x | y |
|------|-----|------|------|
| Sensor / Actuator | MA0062 | 15000 | 8000 |
| Subdistributor | UC0105 | 2000 | 12000 |

**Mögliche Ursachen:**
- Element wurde zu weit entfernt von Kabeltrassen platziert
- Kabeltrasse endet vor dem Equipment
- Falscher Layer für Kabeltrassen verwendet (nicht in `allgemein.cfg` konfiguriert)
- `REALE_POSITION`-Attribut zeigt auf falsche Position

**Behebung:**
1. Öffnen Sie das Layout und navigieren Sie zu den angegebenen Koordinaten
2. Prüfen Sie den Abstand zur nächsten Kabeltrasse
3. Verschieben Sie entweder das Element näher zur Trasse oder verlängern Sie die Trasse
4. Alternativ: Erhöhen Sie die `ConnectionTolerances` in `allgemein.cfg` (nicht empfohlen für Produktivbetrieb)

**Auswirkung:**
- Element wird **nicht verkabelt**
- Keine Kabellängenberechnung für dieses Element
- Element erscheint nicht in der Kabelübersicht
- Folge-Fehler in `ERR-Routing` möglich

---

#### Routing Errors (ERR-Routing)

**Was wird geprüft:**
- Für jede Sensor-Unterverteiler-Verbindung muss ein Pfad im Kabeltrassen-Graph existieren
- Der Graph basiert auf den Kabeltrassen-Geometrien und den Equipment-Verbindungen

**Ausgabe in Excel:**
Das Worksheet `ERR-Routing` enthält folgende Spalten:
- **Subdistributor**: Unterverteiler-ID (z.B. UH01)
- **Sensor / Actuator**: Element-ID (z.B. MA0062)
- **Details**: Detaillierte Fehlerbeschreibung

**Mögliche Fehlermeldungen:**
- `"Distributor not found in given layout"` - UV in KENNZEICHNUNG erwähnt, aber nicht im Layout vorhanden
- `"Subdistributor and sensor / actuator not connected to racks"` - Beide Endpunkte nicht angebunden
- `"Sensor / actuator not connected to racks"` - Nur Sensor nicht angebunden (siehe ERR-Equipment-Connection)
- `"Subdistributor not connected to racks"` - Nur UV nicht angebunden (siehe ERR-Equipment-Connection)
- `"Failed routing (not caused by missing connection)"` - Andere Routing-Probleme (z.B. Lücke im Kabeltrassen-Netz)

**Beispiel:**
| Subdistributor | Sensor / Actuator | Details |
|----------------|-------------------|---------|
| UH01 | MA0062 | Sensor / actuator not connected to racks |
| UC0105 | - | Distributor not found in given layout |
| UH02 | BG3240 | Failed routing (not caused by missing connection) |

**Mögliche Ursachen:**
- Equipment-Connection-Fehler (siehe oben)
- Fehlende oder fehlerhafte KENNZEICHNUNG (Verweis auf nicht existierenden UV)
- Lücke im Kabeltrassen-Netz (zwei nicht verbundene Trassen-Abschnitte)
- Fehlende Kabeltrassen-Verbindung zwischen zwei Ebenen
- Tunnel nicht korrekt definiert

**Behebung:**
1. **Bei "Distributor not found in given layout":**
   - Prüfen Sie, ob der UV-Block im Layout vorhanden ist
   - Prüfen Sie die KENNZEICHNUNG der betroffenen Sensoren
   - Fügen Sie fehlenden UV hinzu oder korrigieren Sie die KENNZEICHNUNG

2. **Bei Connection-Fehlern:**
   - Beheben Sie zuerst die Equipment-Connection-Fehler aus `ERR-Equipment-Connection`
   - Führen Sie das Programm erneut aus

3. **Bei "Failed routing":**
   - Prüfen Sie visuell die Kabeltrassen zwischen UV und Sensor
   - Suchen Sie nach Lücken oder fehlenden Verbindungen
   - Prüfen Sie, ob alle Kabeltrassen auf den konfigurierten Layern liegen
   - Verwenden Sie die `--graph` Option von `routing.py` zur Visualisierung des Graphen

**Auswirkung:**
- Betroffene Kabelverbindung wird **nicht berechnet**
- Keine Kabellänge in der Ausgabe
- Kabel fehlt in Stückliste
- Kabel wird nicht in DXF gezeichnet

---

#### Tunnel Connection Errors

**Was wird geprüft:**
- Tunnel-Eingänge und -Ausgänge müssen wie normale Equipment-Elemente mit Kabeltrassen verbindbar sein
- Beide Tunnel-Positionen müssen innerhalb der ConnectionTolerances liegen

**Ausgabe in Excel:**
Tunnel-Connection-Fehler erscheinen im Worksheet `ERR-Equipment-Connection` mit Type = "Tunnel"

**Mögliche Ursachen:**
- Tunnel-Block wurde zu weit von Kabeltrasse positioniert
- Tunnel-Position falsch eingetragen (MTEXT oder Block-Attribut)
- Kabeltrasse endet vor Tunnel-Ein-/Ausgang

**Behebung:**
1. Prüfen Sie die Tunnel-Positionen im Layout
2. Verlängern Sie Kabeltrassen bis zu den Tunnel-Positionen
3. Korrigieren Sie ggf. die Tunnel-Positionen
4. Prüfen Sie, ob beide Tunnel-Enden (Ein- und Ausgang) definiert sind

**Auswirkung:**
- Tunnel kann nicht für Routing verwendet werden
- Kabelwege, die durch den Tunnel führen sollten, schlagen fehl
- Längere Kabelwege über alternative Routen (falls vorhanden)

---

### Hinweise zur Excel-Fehlerausgabe (Cable Routing)

Die Fehler-Worksheets in `*_cables.xlsx` erscheinen **nur**, wenn tatsächlich Fehler aufgetreten sind:
- **ERR-Equipment-Connection** - nur bei Connection-Fehlern
- **ERR-Routing** - nur bei Routing-Fehlern
- **ERR-Attributes** - nur bei Attribut-Fehlern (aus getpositions)

**Workflow zur Fehlerbehebung:**
1. Öffnen Sie `*_cables.xlsx` und prüfen Sie, welche ERR-Worksheets vorhanden sind
2. Beheben Sie **zuerst** die Equipment-Connection-Fehler
3. Führen Sie das Programm erneut aus
4. Beheben Sie verbleibende Routing-Fehler
5. Wiederholen Sie, bis keine ERR-Worksheets mehr erstellt werden

---

## I/O Conversion Workflow - Hinweise

Der **I/O Conversion Workflow** (`ioconverter.bat`) führt **keine Routing-Berechnungen** durch und erzeugt daher auch keine Routing-spezifischen Fehler. Es werden ausschließlich die **allgemeinen Fehler und Warnungen** aus `getpositions.py` gemeldet (siehe [Allgemeine Fehler und Warnungen](#allgemeine-fehler-und-warnungen-beide-workflows)).

### Ausgabedateien bei Fehlern

- `*_errors.json` - enthält alle Fehler und Warnungen aus getpositions
- `*_positionsconv.json` - Zwischenergebnis mit extrahierten Positionen
- `*_TIA.xlsx`, `*_WSCAD.xlsx`, etc. - werden auch bei Warnungen erzeugt, können aber unvollständig sein

### Wichtige Hinweise

- **Fehlende Attribute** führen dazu, dass Elemente in den Export-Dateien fehlen
- **Fehlende KENNZEICHNUNG** verhindert die korrekte Zuordnung zu Unterverteilern
- **Doppelte IDs** können zu falschen Einträgen in den Excel-Listen führen

**Empfehlung:** Beheben Sie alle Warnungen aus `*_errors.json`, bevor Sie die Export-Dateien an nachgelagerte Systeme (TIA Portal, WSCAD) übergeben.

