Documentation

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 installations through the parts server.

Parts database

A global parts database shared by all projects (product top group / group / subgroup tree, filter), with general, commercial (price, price unit, packaging, quantity unit), technical, mounting (dimensions, weight) data, accessories and a function template per part (e.g. coil A1/A2, main contacts, 13/14 NO). The database is stored in the app storage (desktop) / local storage (browser).

Graphics and 3D models

2D front view (SVG) and 3D model per part:

Parts with dimensions but without a model get a generated one by what they are: DIN rail devices with their terminals, toggle or display, terminals in their colours (PE green, N blue), PLC modules, fuse switch disconnectors, wall-mounted electronics with display, cable glands (hexagon body, neck and dome, in nickel-plated brass or polyamide by their material and colour), 19-inch devices and rack batteries, PV modules, pumps, motors, vessels, heat pumps, compressors, refrigeration dryers, valves with lever or actuator, pipe fittings, manifolds and air treatment units. Devices of the bundled catalogs are drawn after their product photos: Victron inverters with their black corner caps and orange band, the Cerbo GX and SmartShunt, the Lynx distributor, Pylontech rack batteries with handles and terminals, Hager fuse switch disconnectors, meters and modular devices, DEHN arresters with their plug-in modules, Beckhoff EtherCAT terminals, Phoenix Contact power supplies, Siemens motor protection switches and contactors. Generated models are painted (a colour per triangle, colors of the mesh); imported ones take the colour the 3D view gives the device. Floor-standing parts stand upright on the floor of a room.

Parts in the project

Import and export

Placing an EPLAN symbol

Open Import parts and select the EDZ or the vendor's article XML; a box at the bottom right tells the result (the part's number and description, or how many parts) and closes after a few seconds or on a click. On desktop, article XML can load a companion EMA from the same directory. Under Insert center → Devices, search for the part, select it, then select the variant before placing it. Each row has a preview and lists unresolved properties or library references. A loose EMA can also be opened using Import symbol library. Explicitly tagged multi-device windows can be placed as native macros.

The decoder reads PXF window macros, embedded drawing blocks, affine transforms, basic vector graphics, text and selected property fields. Its built-in SPECIAL mappings cover PLC and device contacts 13, 17 and 20, plug and bus contact forms 34, 35 and 37, two-sided form 22 with a common designation, and overview form 40. These forms use the contact drawings in the 2007 EPLAN IEC symbol overview, pp. 1–2. Physical XYZ connection points continue to belong to the panel model.

The importer reads local pin-slot and quoted plug/designation potential-transfer references. Reciprocal, unambiguous references between mapped static contacts on the same device create native bridges. One-way rules, missing targets, uncertain device identities and unsupported device behavior remain diagnostics. The importer keeps autoconnect breaks, cable/shield metadata, and connection definition points separately from wire segments. The source XML does not necessarily contain a routed source-to-target wire list. EPLAN connection point logic

Expand Unresolved placements for a part variant to view the master, source object, plug and terminal designations. For a file or a whole vendor folder, cargo run -p openecraft-edz --example inspect -- PATH --references streams JSON lines with native pins, outstanding references, connection controls and transfer status per representation. Coordinates on unresolved placements are insertion points. A verified native definition with key user:eplan-lib:LIBRARY:NUMBER:VARIANT supplies explicit pin anchors. Unregistered PDF artwork can be kept under user:pdf-review:LIBRARY:NUMBER for comparison and does not participate in mapping.

Partial variants can be inspected and placed. Missing master symbols, unsupported properties, placeholder states and other unhandled objects are reported. Embedded layer settings and explicit pen widths and predefined colors carry over. Custom palettes, exact dash patterns and fills can differ from EPLAN. Automatic reconstruction of a complete EPLAN project's wiring and 3D model conversion are outside the 2D decoder. Reimport refreshes unedited graphics with compatible endpoints. Local edits and existing pin geometries take precedence over a conflicting revision.

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

Wires, cables, potentials and numbering

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

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

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