Skip to content

About

Open source electrical CAE editor in Rust: schematics, reports and panel layout in 3D, for desktop and web

Resources

Stars

24 stars

Watchers

2 watching

Forks

Repository files navigation

OpenECraft

An open source electrical CAE editor written in Rust: device-oriented schematics, live reports and panel layout in 3D. One code base runs natively on Windows, Linux and macOS and in the browser (WebAssembly), built with egui / eframe.

The schematic editor with the ribbon, the page navigator and the power circuit of a star-delta starter

From the first schematic page to the panel in 3D, the wiring in the workshop and the documentation for the customer – in one project file, with a command line and an MCP server for scripts and AI agents.

New to OpenECraft? The tutorial walks from the first page to the bill of materials, and the example projects show the features step by step.

Highlights

Device-oriented schematics Coils and contacts form one device with live cross references and contact images; structure identifiers (=A1+CAB1-K1), page sections, macros with variants, a configurator. Schematic editor · Macros and configurator
Symbol libraries About 330 IEC 60617 symbols, NFPA / JIC, GB, GOST and JIS sets, fluid power (ISO 1219), P&ID, installation plans, single-line; own symbols in the symbol editor. Symbols
Wires, cables, potentials Potentials with colours and cross-sections, cables with cores, automatic wire, device and page numbering. Connections
Terminals, plugs, PLC Multi-level terminals with automatic accessories, plugs, PLC tag tables for TIA Portal, Studio 5000, TwinCAT, CODESYS and more, markers for the labeling software. Terminals, plugs, PLC
Reports and checks Live report pages, graphical terminal / cable / plug diagrams, own drawn forms, a project check with message management. Reports and checks
Panel layout in 3D Devices at real size, virtual wiring with duct fill levels, drilling and NC data, enclosure climate with a heat map, line-ups, rooms and 3D routing. Panel layout
In the workshop Wiring and mounting assistants as touch-friendly checklists with the current wire in 3D – a tablet becomes a wiring station. Assistants
Engineering calculations Conductor sizing, short circuit and selectivity, load calculation, EMC, ISO 13849-1 safety functions, rule sets. Calculations
Harnesses, fluid, plant Wire harnesses with KBL and nailboards; hoses, valve terminals and PCT loops; pre-planning and single-line / multi-line engineering. Harnesses · Fluid and process
Revisions and review Released pages, approval workflow, baselines with compare and merge, comments, redlining and PDF comments. Revisions and review
Parts A parts database with mounting data and 3D models (STEP, IGES, Parasolid, JT, IFC), BMEcat, EPLAN XML, EDZ and enclosure configurator (ZIP) import, a shared data portal. Parts · Parts server
Data exchange PDF, DXF / DWG, SVG; the panel as glTF, STEP, IGES, IFC, JT and Parasolid; ERP / PDM / PLM / ECAD / MCAD connectors, Autodesk Vault. Output and data exchange
Teams and automation Shared projects with page locks, roles and directory sign-in, browsable read only on the project server's web page; a command line, an MCP server for AI agents and plugins in any language. Project server · Command line and MCP · Plugins
20 languages English, German, French, Spanish and 16 more, switched while the editor runs; project texts translated for documentation per language. Languages

A look inside

Panel layout in 3D
Panel layout in 3D – two bayed enclosures with rails, ducts, busbars and door devices
Floor plan of an electrical room
Rooms – the floor plan of an L-shaped electrical room with inner wall, door, window and the line-up
Enclosure heat map
Enclosure climate – IEC/TR 60890 with a heat map of the mounting plate
Wiring assistant
Wiring assistant – the next wire highlighted in 3D, with its length and ferrule
Electro-pneumatic schematic
Fluid power – valves, cylinders and their solenoid coils linked to the schematic
Graphical terminal diagram
Graphical reports – terminal strips with end brackets, end plates and the targets of every terminal

Example projects

The start page and File › New list fourteen example projects; each builds on the one before and shows more of the features (command line: list_examples, new_project --example <name>). All of them pass the project check without errors or warnings.

Level Name Shows
1 lamp_circuit One schematic page: +24V / 0V potentials, push buttons, selector switch, lamps, fuse, wire colours, parts and bill of materials
2 self_holding_relay Relay with self-holding contact: coil and contacts as one device, cross references and contact image, terminal strip, page / column wire numbers, terminal diagram, connection list
3 star_delta_starter Power and control circuit on separate pages: main switch, motor protection, three interlocked contactors, on-delay timer, interruption points, potential colours, 7-core motor cable with cable overview and diagram
4 conveyor The demo project: PLC inputs and outputs, panel layout with rails, ducts and door devices, door harness
5 pneumatic_press Electro-pneumatics: service unit, valve terminal, 5/2 valves, flow control valves and cylinders linked with solenoid coils and position switches; hose list, fluid netlist, electro-fluid cross reference
6 pump_station Structure identifiers (=SUP, =P1, =P2, =PLC; +CAB1, +FLD), page sections, single-line diagram checked against the schematic, frequency converter, PLC cards with analog input, sensor plug, PLC assignment
7 engineering_workflow The conveyor after revision A: locked pages, the change marked since, review comments and redlining, change request, revision B in the approval workflow, baseline
8 cabinet_lineup The pump station in two bayed floor-standing enclosures (+CAB1, +CAB2): busbar system, rails and ducts, door devices and handles, filter fan and outlet filter, light, PE bar, gland plate with cable glands, cable passage, mounting layout pages, climate, duct fill, 3D routing list
9 electrical_room The line-up in its room +ER1: L-shaped floor plan, inner wall, door and window, the line-up at its place, wall rail with a socket outlet, wall-mounted emergency light (part marked for wall mounting), cable tray under the ceiling
10 pump_room The room of the line-up with its pumps: motors, pump and vessel standing on the floor (parts marked for floor mounting), ball valves and a gauge on the wall, a P&ID with DN25 water pipes routed in 3D along a pipe run, motor cables from the cabinets through glands in their roofs
11 building_services A building in two rooms joined by wall penetrations: supply cable and water main through building entries to the house connection box (an enclosure with a hinged cover: NH fuse base and PEN terminal block inside) and the remote controlled valve; main earthing busbar with main bonding conductor and the lug of the foundation earth electrode; main distribution with busbars, Hager NH fuse switch disconnectors NH000 / NH00 / NH2 and energy meters (direct and with current transformers); PLC and pump cabinets with EtherCAT I/O, tanks, booster pumps and pressure vessel; compressor with air receiver, refrigeration and membrane dryers, filter regulators and oilers at four outlets; heat pump with buffer tank, hot water distribution and circulation; temperature, pressure and level transmitters; PV strings with generator junction box, Victron Inverter RS and three MultiPlus-II on the wall, Cerbo GX, Pylontech US5000 in a 19-inch rack; sections in two levels, single-line diagram, sized wires, manufacturer parts of the parts server's catalogs
12 connector_handling Plug connectors with their parts: a proximity switch on M12 and a valve on M8 with the core colours of their field cables, a fan and its thermostat on GX16 / GX12 aviation connectors, a buzzer on a D-sub 9, an operator panel on a 10-core ribbon cable between two IDC sockets on box headers (core n on pin n); the plugs window shows each pin-out on the mating faces, plug diagram, cable reports
13 pv_transformer_metering The distribution cabinet of an apartment building with an 88 kWp PV system, after a Hager univers cabinet: supply on the busbars, surge arrester type 1 + 2 + 3, connection point zone; consumption and generation metering with NH1 fuse switch disconnectors and current transformers on univers N component modules (parts under their part), voltage paths, load break switch, meter cabinets with test terminal blocks; heat pump, sub-distribution and inverter feeders; no cable ducts: every conductor laid by the 3D routing from connection point to connection point; grid and system protection: voltage and frequency relay EU400, buffered 24 V supply, response delay, fire brigade switch, coupling switch h3+ with motor operator, undervoltage release and auxiliary switch built in; the cabinet with its plinth and lifting eyes
14 industrial_main_distribution The main low-voltage distribution of an industrial plant in two bayed Hager univers cabinets: two aluminium supplies on busbar terminals for Al through a cable entry flange, transformer metering in the supply busbar, isolated by NH3 strips with solid links (they protect nothing), power analyser Janitza UMG 604-PRO for the zero export of the battery storage, a 185 mm busbar system through both cabinets with Hager LVSG NH fuse switch disconnector strips: four measured feeders with LVZW current transformers clipped in behind the poles and Loxone energy meters (DC charging station, sub-distributions, air conditioning), heat pumps behind residual current devices of type B, PV inverters and battery storage behind two h3+ coupling switches with motor operators, undervoltage releases and auxiliary switches, fed from busbar terminals
15 plant_buildings The pump room in a plant of two buildings: main building with the electrical room on its ground level and the control room above, joined by a shaft; pump house with pump motor 2, linked by a cable trench between the building entries through which the motor cable is routed; façade lights on the outside walls and a weather station on the roof
16 office_building The plant of level 15 with an office building: office on the ground level, attic under a gable roof whose slopes cut its ceiling down to the knee wall, a stair turned at a quarter landing, roof windows, a PV array of LONGi modules on rails and roof hooks, its string cabled down to the inverter and its mounting earthed to a bonding busbar in the attic, foundation and ring earth electrodes and a lightning protection system of class III; Gira socket outlets, network outlet and switch, MDT KNX push button and room temperature controller at their mounting heights, a COSMO heating circuit manifold and a single-room control box

The projects are built in code (crates/openecraft-core/src/sample/), so they always match the current file format; Save as… writes one as an .oec file.

Getting started

Installers for Windows, Linux (deb, rpm, AppImage, Flatpak, snap, tar.gz) and macOS are on the releases page and are built by CI on every push; see installation and the changelog. From source, with a recent stable Rust toolchain:

cargo run --release -p openecraft
cd openecraft && trunk serve

The second command serves the web version on http://127.0.0.1:8080 (it needs rustup target add wasm32-unknown-unknown and cargo install trunk --locked).

Documentation

For Pages
Users Tutorial · User interface · Installation
Features Schematic editor · Symbols · Connections and numbering · Macros and configurator · Terminals, plugs, PLC · Reports and checks · Revisions and review · Parts · Panel layout · Wiring and mounting assistants · Calculations · Harnesses · Fluid and process · Output and data exchange
Administrators Parts server and parts manager · Project server · Access control
Automation Command line and MCP server · Plugins · Harness interface
Developers AGENTS.md (conventions) · Architecture · Code structure · Website · Releasing

Before a change is done, these must pass without warnings (CI runs them with -D warnings):

cargo test --workspace
cargo clippy --workspace --all-targets
cargo clippy -p openecraft -p openecraft-parts-manager -p openecraft-website --target wasm32-unknown-unknown

License

MIT (LICENSE-MIT) or Apache-2.0 (LICENSE-APACHE), at your option. The licenses of the libraries and fonts OpenECraft contains are listed in THIRD-PARTY-LICENSES.html, which comes with every package (the web version next to its page).

Trademarks

OpenECraft is an independent open source project. It is not affiliated with, endorsed or sponsored by EPLAN GmbH & Co. KG, Autodesk, Siemens or any other company named in it. EPLAN and EPLAN Electric P8 are trademarks of EPLAN GmbH & Co. KG; Autodesk, AutoCAD and Vault are trademarks of Autodesk, Inc.; Parasolid, JT and TIA Portal are trademarks of Siemens; all other product and company names are trademarks of their owners. They are used only to name the products and file formats OpenECraft works with. The bundled manufacturer catalogs (crates/openecraft-parts/catalogs/) are compiled from public data sheets; check the parts against the manufacturer's data before ordering.

About

Open source electrical CAE editor in Rust: schematics, reports and panel layout in 3D, for desktop and web

Resources

Stars

24 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages