Documentation

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.

Fluid power

Wires between the ports of fluid power and P&ID symbols are hoses / pipes in their own nets (not mixed with electrical potentials; a fluid port on an electrical net is an error), numbered apart from the wires (H1, H2 …), with medium, nominal size, colour and length, listed in the hose list.

Pneumatic circuit of the pneumatic_press example with cylinders, 5/2 valves, flow control valves and cross references to the solenoid coils

Process (P&ID)

P&ID symbols (ISO 10628: vessel, pumps, valves, heat exchanger, instruments) support pre-planning: instruments carry function letters and loop number (TIC 101), the PCT loops of the pre-planning (Tools › Fluid and process…) list their devices, and the PCT loop overview shows whether each loop is planned, in engineering or engineered in the schematic.

Pre-planning

Pre-planning (Devices › Pre-planning…): the plant as a tree of segments (plant, area, unit, …) with function and location inherited down the tree and the devices planned in them (tag, kind, description, power, voltage, part, page macro); the planned power per segment, segment templates, the state of every planned device against the schematic (planned, engineered, part differs; also a check and the report Pre-planning), schematic pages generated from the page macros of the devices not engineered yet, and the exchange as CSV / Excel (commands preplanning, add_segment, plan_device, …; tools import_preplanning, generate_preplanning_pages).

Single-line / multi-line engineering

Single-line / multi-line engineering (Devices › Single-line / multi-line…): devices are planned with single-line symbols (breaker, switch-disconnector, motor protection switch, fuse, overload relay, contactor, motor, transformer) on overview pages and engineered in the multi-line schematic; both share the device tag. The window lists each device as planned, engineered, not in the single-line diagram or not matching, and generates the schematic of a single-line page (3-pole power symbols, conductors, contactor coils) or a single-line diagram of the schematic's power devices (arranged from the supply to the loads). The check reports planned devices, mismatching symbols, connections of the single-line diagram missing in the schematic and differing function texts; Synchronize function texts fills empty ones from the other representation.

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

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