Documentation

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.

IEC 60617 symbol library

IEC 60617 symbol library (~330 symbols): relay coils (AC, latching, polarized, timers, time switches, counters, over- / undervoltage relays), NO/NC/changeover contacts (early / late, passing, on- / off-delay), push / pull / key / foot / selector switches with spring return or latching and position diagrams, emergency stops with turn / pull / key reset, cam / roller / pressure / flow / level / bimetal switches, inductive, capacitive, magnetic and photoelectric sensors, fuses (LV HBC), fuse switches and disconnectors, disconnectors and switch-disconnectors, circuit breakers, RCDs, motor protection switches, overload relays, AC / DC / EC motors and fans, signal lamps, luminaires (L, N, PE), beacons, sirens, indicating, recording and integrating meters, current transformers, 1- and 3-phase transformers (vector groups) and autotransformers, rectifiers and converters, terminals, PLC inputs/outputs, potentials, interruption points, and electronics: resistors, capacitors (also polarized), diodes, Zener and photodiodes, LEDs, NPN / PNP transistors, N-channel MOSFET, thyristor, triac, NTC thermistor, photoresistor, optocoupler and bridge rectifier.

Installation plan symbols

Installation plan symbols (IEC 60617-11): 1-pole and two-way switches, dimmer, push button, lighting outlet, fluorescent luminaire, double socket outlet with PE, junction box, motion detector and distribution board, each with one connection point for the cable.

Symbol editor and libraries

Besides the IEC symbols there are NFPA / JIC symbols (30: coils, timer coils, contacts, timed and overload contacts, main contacts, push buttons, emergency stop, selector, foot, limit, float, pressure, temperature, flow and proximity switches, breakers, disconnects, fuses, pilot lights, horns, solenoids, control transformers, motors), fluid power symbols (ISO 1219: pumps, compressor, hydraulic motor, single and double acting cylinders, 3/2, 4/2 and 5/2 valves, non-return, relief, ball and flow control valves, pressure regulator, service unit, filter, accumulator, cooler, gauge, tank, silencer), single-line / overview symbols (cross references to the device, not part of the netlist) and black boxes / PLC boxes. National sets for China (GB), Russia and the CIS (GOST) and Japan (JIS) carry the device letters of GB/T 7159 (KM, KA, QF, SB, HL …), GOST 2.710 (KM, KK, QF, SB, HL …) and JIS C 0401 (MC, MCCB, PBS, PL, THR …), so placed devices are numbered -KM1, -MCCB1; they are drawn like the IEC symbols, which GB/T 4728 and JIS C 0617 adopt (the ESKD proportions of the GOST drawings are not reproduced). Own symbols are drawn in the symbol editor (lines, rectangles, circles, texts, tag / label fields, connection points on the 4 mm grid, function such as main function, contact, terminal, PLC point), or copied from a built-in symbol; they are stored in the project and exchanged as library files. A placed symbol of the library (an own or an imported EPLAN symbol) can be drawn larger or smaller: Scale in its properties (or update_symbol with scale, 0.1 to 10) scales its graphics and connection points, while its texts keep their size, so that imported symbols fit the drawing; the wires at its connection points follow.

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

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

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