Documentation

Wires, cables, potentials and numbering

How connections get their cable, colour, cross-section and number, and how devices, pages and wires are numbered.

Potential definitions

Potential definitions (Connections › Potentials…): kind (L, N, PE, DC +/−, signal), voltage, wire colour (IEC 60757 codes) and cross-section per potential; presets IEC 60204-1 (machinery, new projects) and IEC 60445 (phase colours). Wires without their own colour / cross-section take them from the potential of their connection (also behind terminals), otherwise from the project default for connections without a defined potential; cable cores keep the cable's values. The wire properties show the automatic value and where it comes from; the wire lists, panel wiring, duct fill, ferrules, harnesses and marking use it. The check reports GNYE outside protective conductors and PE in other colours, manual values that differ from the definition and potentials without definition. View › Wire colours (saved with the project) draws the wires in their colour on the schematic and in PDF / SVG export; two-colour wires such as GNYE are drawn dashed in their second colour.

Cables

Cable definitions (tag, type, cores, cross-section, length, part from the product group Cables). Wires are assigned to cores (several wires at once get the free cores in order, the wires of one connection share a core); cores and the cable tag are shown on the schematic, with a stroke across the wire where a cable definition line of the cable crosses it (else at 30 % of the wire). The core designation and the cable tag of a selected wire can be dragged into place and keep their offset from there; Reset in the wire properties (or update_wire with an empty core_offset / cable_offset) places them automatically again. Cable overview and cable diagram reports, cables in the BOM by length, checks for unknown cables, cores used twice or not in the cable.

Connection and cable definitions

Cable core labels keep clear of the definition line and their wire automatically. Layout checks estimated text areas, other cable labels, wires, nearby symbol graphics, pin/property/tag texts and free texts. It tries a bounded set of nearby positions in a deterministic order; it does not guarantee that every crowded drawing has a free place. Remaining conflicts have a red outline in the editor. Existing manual offsets retain their original meaning and are never silently reset.

This rendering change also applies to automatic labels in existing projects, including released pages and PDF/SVG exports. Releasing a page protects its data from edits; it does not freeze the renderer. Manual offsets keep their positions. For an unchanged record of an earlier release, keep the PDF exported at release. The editor calculates one page layout per frame and uses the actual drawn text areas for both selection and dragging. Multi-page exports reuse their project index.

Hover a core text or the cable tag beside a wire to see its drag target. Drag it directly to move only the text, without first selecting the wire; this also works with a previous multiple selection. Wire ends remain separate geometry handles. Released pages and projects opened read-only cannot be changed this way.

Select a cable definition and choose Align core labels… in its context menu, the Connections ribbon or its properties. Choose above/left or below/right and a minimum clearance. The page shows a preview; nothing changes until Apply. The crossed core labels of that cable on this page are aligned together, using a common clearance increased when needed to avoid obstacles. Applying deliberately replaces their manual positions in one undo step. Cable tag positions, wire geometry, cable/core assignments and other pages stay unchanged. If no clear placement is found, change the options or place the texts individually. Stored positions survive save/reopen and use the same rendering path for SVG/PDF export.

To rename a cable, right-click its definition line or label and choose Rename cable…. The same action is in the cable navigator and in the properties opened with F2 or a double-click. The dialog selects the full tag: type the new tag and press Enter, or press Escape to cancel. References on all pages follow the rename, which can be undone in one step. Duplicate tags and changes to released pages are rejected. Shared projects acquire the project and affected page locks before applying the change. Cancelling releases only the locks newly requested by the dialog, after their request finishes; locks protecting other local edits remain. The action is also in Connections › Cables. Automation can use rename_cable with cable (current full tag) and tag (new full tag). Older project servers are supported: if the session snapshot endpoint is absent, the editor combines the older snapshot with the session's lock status at the same revision. A newer revision during loading is retried instead of mixing states.

Drawing a cable definition previews the crossed wires and free cores. Its properties show assigned/unassigned counts and the assignment order, starting at the first point of the line. Reversing the line reverses the order for free cores; existing assignments keep their core. Cores already used elsewhere in the project are unavailable. The cable label (for example 4x1.5) describes the entered cable, not the number of crossings.

If there are too few free cores or a crossed wire already has a conflicting assignment, none of the pending wires is assigned. The line remains in the plan with a check warning and a correction hint in its properties. Edit the core list or select another cable, then choose Assign crossed wires. Existing assignments must be changed explicitly in the wire properties; another cable is never overwritten silently. The physical cable/core list is never enlarged automatically to make a mismatch disappear.

When creating a new cable is blocked by a conflicting assignment, only the definition line is kept: no unused cable is created. Select a cable in its properties after correcting the conflict. An imported core designation without a cable is also a conflict; clear or change it explicitly in the wire properties. The disabled Assign crossed wires button explains shortages and conflicts when hovered. Interactive previews reuse the session's assignment index; applying always checks the current project again.

Automation uses preview_cable_definition with page, two points and an optional cable for a read-only preview. apply_cable_definition takes page and the definition id, and reports changed plus its resulting assignment. add_cable_definition keeps its existing response fields and adds assignment, including counts, free cores, conflicts and ordered wire/core candidates.

A connection definition point on a wire sets number, colour and cross-section of the whole connection and the core of its wire; a cable definition line drawn across wires makes them cores of a cable (new cable with numbered cores, or a chosen one). The check reports points beside wires, contradicting or not applied points, and lines of unknown cables.

Connection symbols: T-junctions, corners, crossings and bridges

Three devices on one potential can be wired as A–B and A–C or as A–B and B–C; the netlist alone cannot tell them apart. A T-junction (Insert › Connections › T-junction, placed where three wires meet) stores this choice with the project, in the spirit of the connection symbols of EPLAN: its three ports are the stem (the direction of the junction: left, right, up or down) and the two arms of the bar across it. Four variants per direction name the source port and the order of the two targets:

VariantSourceFirst targetSecond target
1left / upper armthe other arm (straight on)the stem
2right / lower armthe other arm (straight on)the stem
3stemleft / upper armright / lower arm
4stemright / lower armleft / upper arm

The two physical wires of the connection run from the device at the source to the device at the first target and to the device at the second target. The device of a port is the first connection point along its wire, also across interruption points; where the wire reaches another T-junction it hands on its targets (when the wire comes in at its source) or its source. The connection list, the connection diagrams, the panel wiring, the harnesses and every other consumer of the connections use this result. Connections without a T-junction keep the schematic order as before, and a junction that does not fit its wires (not three wires, not one in its direction, a connection point on the spot) is ignored and reported by the check Connection symbols, as are two symbols on one point and a connection whose symbols wire it in a loop (more wires than its devices need, e.g. the sources of two T-junctions facing each other across a wire).

The symbol is a short diagonal from the source to the second target (the first target lies straight on); Representation › Dot draws the usual connection dot instead and keeps the routing. The properties pane shows the four variants as previews with the targets numbered, the direction, and the wires of the connection. Rotating or mirroring the drawing turns the junction with its wires. Connection symbols follow their wires: when a device or a drop moves along the rail, the T-junction slides with the drop; when the rail moves, its drops stretch and the junction stays on it; when the whole node moves the junction moves with it.

While a connection symbol tool is active, the Properties pane (shown again by the tool when it was closed) holds the routings of the next symbol to pick from, Tab cycles them and R (Rotate) turns the symbol. A symbol just placed is not selected, so these choices only affect the symbols still to place; a placed one is changed by selecting it. Where three wires meet already, a T-junction takes its direction from them and the chosen routing.

A corner (Insert › Connections › Corner) is the second connection symbol: two wires meeting at a right angle, with four orientations (Tab or R picks the next one while placing). It changes no routing; its use is automatic wiring: with Auto-connect on, placing a corner (or a T-junction) draws wires from connection points that face its free arms straight on (also from a T-junction on a wire running through it), and a symbol placed or moved so that a connection point faces a free arm is wired to it. So a corner at the meeting point of two connections wires both of them in. A corner that fits its wires is drawn as nothing but the bend; one without its two wires shows its arms in the error colour and is reported by the check.

A crossing (Insert › Connections › Crossing) connects the two wires crossing at its point, which stay unconnected without one. It is two T-junctions joined: each end of its straight line (vertical or horizontal) is wired straight on to the other end first and across to one arm second; the two variants decide which end takes the left / upper arm. In EPLAN's example, a vertical crossing of variant 2 leads a connection from above to the bottom first and to the left second, and one from below to the top first and to the right second. A bridge (Insert › Connections › Bridge) has four wires as well and is a star from the side the connection comes from to the three others: the opposite side first, then the left or upper, then the right or lower. Both can be drawn as a dot, keep their routing then, and turn with the drawing. Every symbol is a list of links between its arms; where a wire reaches another symbol, that symbol hands on the devices of the arms linked with the one the wire comes in at.

Commands: add_t_junction (direction from the wires there when not given), add_corner (arms from the wires there, e.g. down left), add_crossing (line vertical or horizontal, variant 1 or 2), add_bridge (direction the connection comes from), all with autoconnect to draw the wires to facing connection points, update_connection_symbol, list_connection_symbols (kind, routing, links and the wires of each). autoconnect takes the ids of connection symbols too.

Wire numbers

One number per connection (all its wire segments; the two sides of a terminal are separate connections). Automatic numbering: sequential, page/column (3.4.1) or by potential name (L1, +24V), with prefix and start value; manually set numbers are kept. Shown on the schematic, in the connection list and the panel wire list; checks for conflicting and duplicate numbers.

Numbering

Numbering (in the spirit of EPLAN's offline numbering): Devices › Device numbering… renumbers device tags per structure and identifying letter in schematic order (page, column, top to bottom) after a format: {letter}{n} (-K1), {letter}{page}.{n} (-K3.1), {letter}{page}{column} (-K34) or NFPA style {page}{column}{letter} (-34K), with start value, step, letters and scope, and a preview of the new tags; everything that refers to a tag follows (parts, strips, plugs, PLC data, panel layout, harnesses); tags of devices that are not placed (device list, panel layout) are not given to others. Home › Renumber pages… numbers pages with start and step, restarting per structure and keeping sub-pages (3.a; Home › New page › New sub-page inserts 3.1, 3.2, … after the current page). Page sections hold pages and subsections like directories (Home › New section, drag pages onto them in the Pages navigator); the page names carry the section numbers (2.3.1), follow when a section is renumbered or moved, and renumbering counts per section. The wire numbering gets a Format scheme with placeholders ({page}, {column}, {row}, {potential}, {kind}, {color}, {cross_section}, counter {n} counted per value of the rest), counter digits and step, and potential kinds that get no number (e.g. PE). Commands: renumber_devices, renumber_pages, set_wire_numbering.

This document in the repository

More documentation

Getting started: from the first page to the bill of materials

This tutorial walks through a small control circuit in OpenECraft: pages, symbols, wires, devices with parts, terminals, a PLC, the project check, reports, the panel layout and the output. Commands are written as Tab ›…

Read

Installation and building

Packages for Windows, Linux and macOS, the web version, and building from source.

Read

User interface

The editor's layout and the commands and keys of everyday work. New users start with the tutorial.

Read

Schematic editor

Pages, devices and their structure, live cross references, editing tools, navigators and project storage. The user interface lists the commands and keys.

Read

Symbols and libraries

The built-in symbol libraries (IEC, NFPA / JIC, GB, GOST, JIS, fluid power, P&ID, single-line) and the symbol editor for own symbols.

Read

Terminal strips, plugs, PLC and marking

Terminal strips with multi-level terminals and accessories, plugs, PLC cards with the exchange to PLC programming tools, and the markers for the workshop.

Read

Macros, configurator and table editing

Reuse of circuits as macros with variants and placeholders, pages generated by the configurator, and bulk changes in tables and spreadsheets.

Read

Parts management

The parts database shared by all projects (EPLAN style): commercial, technical and mounting data, function templates, connection points, 2D / 3D graphics and the import of manufacturer data. Parts are shared between…

Read

Reports, forms and the project check

Reports as windows, CSV / Excel or live report pages, title blocks and report forms (also graphical and own drawn forms), and the project check with its message management.

Read

Electrical sizing, calculations and verification

Conductor sizing, short circuit and protection coordination, load calculation, EMC, functional safety and rule sets – all part of the project check – and the inspection and test report of the installation.

Read

Panel layout, rooms and 3D routing

OpenECraft aligns the device's clip to the rail centerline. For Beckhoff's 12 × 100 × 68 mm EL I/O housings with 8 or 16 terminals, and the matching EK1100 coupler, the rail center is 63.8 mm from the top. For example…

Read

Wiring and mounting assistants

The panel layout as a checklist for the workshop, on a desktop or a tablet.

Read

Fluid power, process and plant engineering

Hoses and pipes in their own nets, electro-fluid links, PCT loops, the pre-planning of the plant and single-line / multi-line engineering.

Read

Wire harnesses

Harnesses with 3D topology, protections and fixings, KBL export, the harness interface for machines and nailboard drawings (Connections › Harnesses…). The example project conveyor has a door harness.

Read

Output and data exchange

PDF, DXF / DWG, SVG and 3D exports, DXF / DWG import, the enterprise integration layer (ERP, PDM, PLM, ECAD, MCAD, procurement, wiring machines) and Autodesk Vault.

Read

Revisions, review and change management

Revisions with locked pages and marked changes, the approval workflow, baselines with compare and merge, comments and redlining, and change requests.

Read

Command line, MCP server and plugins

Projects and the parts server without a window, for scripts and AI agents.

Read

Plugins

OpenECraft is extended through the openecraft-api crate. A plugin adds

Read

Parts server and parts manager

The data portal shared by all OpenECraft installations and the app that maintains it.

Read

Project server

Shared projects for a team: several users work on the same project, each page is locked by one of them.

Read

Access control of the servers

The parts server and the project server share one access model: users sign in with a local account or with a directory (Active Directory, OpenLDAP or another LDAP server), and what they may do comes from roles given to…

Read