Documentation

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.

Macros

Save a selection (window macro) or a whole page (page macro) into a macro library (stored with the application, JSON import / export). Window macros are placed with the mouse (ghost preview, devices get new tags), page macros insert a page. Copied macros carry custom symbol definitions, device assignments and referenced catalog parts. Previews resolve those bundled definitions before insertion. Inserting into another project preserves existing catalog entries and local symbol edits. Placeholders such as {MOTOR} in tags, texts, function texts and designations are filled from value sets when inserting. Variants: a macro can hold the same function in several versions (A, B, … – e.g. direct on line and star-delta); save a selection under the name of an existing macro with another variant, choose the variant when inserting. Macro boxes: placed window macros remember their macro, variant, placeholder values and items (dashed frame on screen, View › Macro boxes); Macros › Macro boxes › Update changed macros replaces the content of boxes whose macro changed in the library, a box edited on the page is saved back into the library (command list_macro_boxes, tool update_macro_boxes).

Configurator

Configurator (Project data › Configurator…): options with their choices (e.g. STARTER = DOL / SD) and rules that insert a page macro in a variant with placeholder values (NAME=Pump; POWER={POWER}) when their condition holds (STARTER=DOL & LINE!=2, LINE=1|2). Generate pages replaces the pages generated before (marked in the page properties, switch off to keep one); option values fill {OPTION} placeholders; problems (unknown macro, variant or option) stop it.

Editing in tables

Editing in tables (Project data › Edit in table…): devices (tag, function text, description, part), connections (wire number, colour, cross-section, cable, core), terminals (strip, number, function text) and the inspection and test report (the results, one row per circuit; its data and visual inspection, one row per value) as rows; filter, edit cells in place, fill a column or find and replace in the filtered rows; CSV export / import for changes in a spreadsheet (rows by key, only changed cells are applied); rows on released pages stay unchanged. Renaming a device moves its strip, plug and PLC card data along. The round trip also works with Excel files (.xlsx: export, change, import); report tables export as Excel workbooks from the Reports window and with report --format xlsx --path … (bold, frozen header row with filter, numbers as numbers, codes such as 007 kept as text).

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

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