Documentation

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.

Output / data exchange

PDF of all pages or a page selection (1-3, 5; also for the HTML print document; File › Print opens all or the current page in the browser with its print dialog) with bookmarks per page, clickable cross references and report rows (links to pages left out are dropped); texts beyond Latin-1 such as Polish, Czech, Turkish, Greek or Cyrillic are written with an embedded subset of the Ubuntu font, searchable and copyable, DXF (R12, layers by kind) and DWG (AutoCAD 2004, the same drawing) per page or all pages side by side, SVG per page, printable HTML, production wire list (CSV with wire numbers, ends, colour, cross-section, routed length, stripping length and termination of both ends (ferrule per DIN 46228-4, twin ferrule, ring, fork, pin, flat plug or receptacle terminal) with their parts, a twin ferrule named with the other wire and listed at the first of them, cable cores; panel wires sorted by cross-section, colour and length for wire processing machines; ferrules and terminals also in the BOM; with a UTF-8 byte order mark, as the report CSVs of the editor, so that spreadsheets show mm² and umlauts), report CSVs, PLC symbol tables, NC data of mounting plates, the panel layout in 3D as glTF 2.0 (viewers, web, PLM; metres, one node per enclosure and item, colours), STEP AP214 (MCAD; faceted solids with colours, millimetres, z up), IGES 5.3 (MCAD; B-rep solids with planar faces, open shells for non-closed meshes, colours and names), IFC4 (BIM; a distribution board per enclosure with its components as triangulated elements), JT (PLM viewers; tri-strip meshes per item, JT 8.1 layout) and Parasolid XT (MCAD such as SolidWorks, NX, Solid Edge, Onshape; transmit text of schema V13 in metres, every closed part a faceted solid body whose coplanar triangles are merged into planar faces, open meshes a sheet body) – walls, door, mounting plate, rails, ducts, busbars and devices with the 3D models of their parts. DXF / DWG import (File › Import › Import DXF / DWG as page…): old drawings as graphics on a new schematic page – lines, polylines, circles, arcs, ellipses, splines, texts, MTEXT, block references and dimensions, in their units, scaled down to the drawing area when they are larger. DWG files of AutoCAD R12 … 2018 are read (and written) with the pure Rust acadrust crate, also in the browser. EDZ files of the EPLAN Data Portal are read as parts (see parts management); their 2D window macros become symbols and their 3D macros the 3D models of the parts.

Enterprise integration

Enterprise integration (Tools › Enterprise integration…): one integration layer with connectors for ERP (item master and BOM, CSV), PDM (project and page metadata, JSON), PLM (engineering BOM, JSON), ECAD (components and netlist for PCB design, JSON), MCAD (device placement, CSV), procurement (order list per supplier, stock and pack sizes considered, CSV) and wiring machines (job list with cut length, stripping and ferrules, CSV). All connectors work in both directions and share one neutral field vocabulary: exports use the field codes as columns / keys, imports recognise the codes, common English and German column names (Material, Bestand, refdes …) and the column mapping of a profile (e.g. MATNR → erp_number for SAP). Imports are shown as a list of changes that are reviewed and taken over: ERP numbers, prices, stock and lead times, PLM item IDs, revisions and lifecycle states (obsolete parts in use are flagged by the check), PDM document numbers and states, part assignments from the ECAD system, device positions from the MCAD system, order confirmations, and the wire processing feedback as wiring marks. Each export stores the exported values, so values changed on both sides since are reported as conflicts and values the other system left unchanged never overwrite local edits. A neutral exchange file (openecraft.exchange/1, JSON) holds everything for systems without a connector; the exchange log is kept in the project.

Autodesk Vault

OpenECraft connects to Autodesk Vault Professional 2025.2 or newer through the Vault Data API (REST, /AutodeskDM/Services/api/vault/v2), so projects, documents and 3D models are exchanged with the PDM system directly instead of through files.

openecraft-cli vault_connect --url https://vault.example.com --user anna --password …
export OPENECRAFT_VAULT_URL=https://vault.example.com OPENECRAFT_VAULT_TOKEN=V:… OPENECRAFT_VAULT_ID=101
openecraft-cli vault_browse --query "Plant 1"
openecraft-cli -p plant.oec vault_upload --folder 42 --format step --comment "Panel layout"

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

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

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