Documentation

Panel layout, rooms and 3D routing

Imported cards on horizontal DIN rails

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, a rail centered at Y = 100 mm puts the top at Y = 36.2 mm. The 35.4 mm dimension is the housing opening for the nominal 35 mm rail. The importer retains a nonzero article center offset and clip-on height. It applies the drawing-based center offset only to matching housings when the catalog center offset is zero. 8-pin terminal · 16-pin terminal · EK1100 housing

A card placed or moved within 4 mm of a free neighboring edge snaps flush to it on the same mounting plate. The placement preview shows the result. Cabinet artwork uses the assigned front view first, then an imported mounting representation. If those are absent, a vendor overview supplies an illustration fitted inside the physical footprint.

Enclosures with their devices at real size in 2D and 3D (in the spirit of EPLAN Pro Panel), virtual wiring through the ducts, drilling and NC data, enclosure climate, line-ups, rooms of the building with their floor-standing equipment and pipe runs, 19-inch racks and 3D routing of cables, tubes and pipes. The example projects conveyor, cabinet_lineup, electrical_room and pump_room show them.

The line-up of the cabinet_lineup example in 3D, door open, with rails, ducts, devices and routed wires

Enclosures and devices

Collision and boundary checks

Overlaps, outside the plate, too deep for the enclosure including a door clearance, mounted over a cutout, inside the clearance a device needs above and below from its part data (Clearance: 25 mm); where a device has a 3D model, the models are checked for penetration, not just their boxes.

Enclosure door

Command and signal devices (pushbuttons, lamps …) are placed on the door (front view Door); each gets its door cutouts (Ø22.5 by default or from the part data Door cutout: Ø30.5 / 92 x 68, otherwise its cutouts), placed where the part has them and turned with the device, checked against the free edge of the door (frame, hinges) and the device front (a cutout reaching beyond it is reported) and in 3D against the equipment of the mounting plate; their wires are routed over the hinge; the mounting layout page shows the plate and every face with items (door, side walls, rear wall, roof, bottom) side by side.

The door is hinged on the left or the right (Door hinge in the enclosure's properties, door_hinge of add_enclosure / set_enclosure, part data Door hinge: right of a maker's enclosure part): the door view shows the hinges and the handle on their sides, the 3D view opens the door about that edge, and the door wires run along the door to that edge, over the hinge loop and into the plate's edge on that side.

Restricted areas

An enclosure part can keep areas of its faces free (Restricted areas in the part's mounting data, imported with the enclosure packages of the Rittal configurator): placing areas take no devices, rails, ducts or busbars, cut-out areas no cutouts or holes, e.g. the hinges, the lock and the stiffening of the door, or the fixing points of the mounting plate. The faces show them hatched (placing areas rising, cut-out areas falling), in the editor and on the mounting layout pages, and the 3D view as translucent areas (placing blue, cut-out orange) that go with their wall or the door. The check reports an item lying in a placing area (Outside) and the cutouts and holes in a cut-out area (Manufacturing); touching an area's edge is allowed. The part editor lists them under Mounting data › Restricted areas (kind, face, place and size), where they are added, changed and removed.

Maker's enclosure models

An enclosure whose part is a maker's part (not one of the built-in catalog) with a 3D model of the enclosure's width and height, as the enclosure packages of the Rittal configurator bring it, shows that model in the 3D view and the 3D exports instead of the generic body, walls, door and plates. The door and what is mounted on it (hinge leaves, locks, seals), as the maker's macro marks them, are translucent and open with the door; a model without that mark opens its front 20 mm. The other triangles go with the wall whose plane they lie in (hidden with it when the walls in front are hidden) or stay inside (mounting plate, gland plate, flanges). Plinths, baying kits and 19-inch rails stay generic. The door opens on its hinge side (the Rittal AX is hinged on the right, see Enclosure door).

Drilling pattern and NC data

Rails, ducts and busbar holders get tapped holes along their length, devices screwed onto the plate get holes from their part data (Mounting holes: M5: 9,12; 69,72) or two default holes; NC export per enclosure and face as DXF or DWG (outline, one layer per hole diameter, cutouts, turned or rounded ones as their outline) or CSV (with the turn and corner radius of each cutout).

Virtual wiring and duct fill levels

Every schematic connection between placed devices is routed from its connection point (rotated devices, aux blocks, terminal by terminal) into the duct the terminal faces and through the cable duct network (shortest path) → wire list with lengths, wires shown in 2D / 3D.

Duct fill levels: cross sections of the routed wires (with insulation), cables and tubes against the cross section inside the duct (between its walls, base and cover) at its fullest stretch, on the mounting plate as on the walls, ceiling and floor of a room; ducts coloured green / orange / red in the front view, fill level in the duct properties, limit in the enclosure properties (70 % by default); report Duct fill levels, the check warns above the limit and hints above 80 % of it; when a duct is overfull, the wiring is routed again, thickest wires first, and wires take a detour (up to 10 × longer) around stretches they would fill above the limit; cables and tubes routed in 3D do the same around the stretches the wires and the cables before them already fill; the selected device shows its connection points.

Climate

IEC/TR 60890, in the enclosure properties: power loss of the placed devices from the tech data of their parts (Power loss: 7.5 W) plus an additional loss, effective surface by installation type (single, in a suite, free-standing, wall mounted, roof covered), material (heat transfer coefficient), ambient and allowed inside temperatures → inside temperature, filter fan air flow (corrected for the altitude of the site), air/air heat exchanger (W/K, when the degree of protection must be kept) or cooling unit output, heater output that also keeps the inside above the dew point of the ambient air (relative humidity); report Enclosure climate, the check warns when cooling is needed.

The heat map of the mounting plate stratifies the mean temperature and adds a plume above every device with power loss data; horizontal ducts hold plumes back (warm air gathers below them), fans and cooling units weaken them.

Heat map of a mounting plate beside the climate calculation of the enclosure

Line-ups

Enclosures bayed side by side with cable passages between them (cutouts in the facing side walls, or sides open to each other); the 3D view shows the whole line-up, wires run from one enclosure into the next. The room view shows all enclosures side by side at their places, each line-up at its position and turn set by hand or taken from the plant layout.

Rooms

Layout space › New room (plugin rooms): a room of the building with its floor plan, height and place in the plant. The floor plan is a rectangle or an outline of walls at right angles (L, U or T shaped rooms): Floor plan shows it from above, Draw walls draws it by clicking the corners (on a 50 mm grid, closed by clicking the first corner or Enter), walls are dragged to move them or get a length in the room's properties (commands set_room_outline, set_room_wall).

The check reports devices on a wall that are neither, rails or devices over a door or window, pipe runs across a door or window, items on the ceiling outside the floor plan, inner walls leaving the room, cabinets and floor-standing parts in the swing of a door or in an inner wall, floor-standing parts on the place of a cabinet or not made to stand on the floor, and cabinets and floor-standing parts outside the room (or across a wall), cabinets higher than its ceiling, wall penetrations that lead into no room. Rooms have no climate calculation and no NC data.

Several rooms stand at their places in the plant (Rear left corner of the room in its properties, commands add_room / set_room with x, z and angle). The floor plan of a room shows the rooms around it faintly with their names and cabinets (those beside it, not the ones on the levels above and below); a double-click opens one of them. Layout space › Show › All enclosures shows every room and cabinet at its place in 3D, with the routes between them.

The navigator (Enclosures and rooms) has the site at its root, above the buildings with their levels and rooms and the rooms outside buildings. A click on a room keeps the 3D view when it is shown and otherwise shows the room's floor plan. A click on the site shows the site plan of all buildings in the Layout space (the wheel zooms, dragging moves it, a click on a room opens its floor plan; in the edit mode Site › Move buildings a building is dragged to its place and R turns it by 90° about its middle, with its rooms, cabinets, stairs and roofs and the rooms standing in it without being on one of its levels) or, in the 3D view, all of the plant with its buildings, floor slabs, stairs and roofs; a click on a building shows the site plan with it highlighted. A level clicked while the 3D view is shown shows all rooms of that level side by side at their places, with the cabinets standing in them, the floor slabs and the stairs reaching the level (no roofs); a second click shows all of the plant again. The context menu of the site adds a building, draws the plot boundary or places the reference point, that of a building a level on top or a basement, that of a level a room on it.

Plot boundary and reference point

The plot (Layout space › Site, the context menu of the site, the Plot section of the Buildings pane; plugin buildings) is the parcel of land the plant stands on.

Buildings, levels and shafts

Layout space › Buildings (plugin buildings) manages the buildings of the plant; the pane lists them with their levels, shafts, stairs, roofs and the links between buildings, and draws a site plan of all rooms (one level highlighted), shafts, the stairs reaching the level shown (steps and walking line), the roofs (eaves, ridges and hips dashed) with their roof windows, and the links.

The check Buildings, levels and shafts reports rooms on levels that are gone, rooms higher than their level or overlapping on one level, levels overlapping each other, shafts joining no two rooms, cabinets and floor-standing parts standing in a shaft, links whose building entries are gone, stairs without valid levels, with a rise outside 140 - 200 mm or breaking the step rule (twice the rise and the going 590 - 650 mm), roof windows off their slope or across a ridge or hip, rooms the roof comes down to the floor of, cabinets higher than the sloped ceiling at their place and items on the walls or the ceiling above the slope, PV arrays off their roof or across a ridge, a hip or its edge, tilted on a pitched roof, over a roof window or over each other, freestanding PV arrays on each other, on a room or outside the plot boundary, and PV arrays whose device is missing or counts another number of modules or whose earthing busbar is missing, earth electrodes whose busbar is missing, earth rods inside the walls, lightning protection without earth electrode or with fewer down conductors than its class needs, air-termination rods off the roofs and PV arrays outside the protection of the air-termination system. Example 15 (plant_buildings) shows a main building with two levels and a shaft, a pump house linked by a cable trench through which a motor cable is routed, façade lights and a weather station on the roof; example 16 (office_building) adds an office building with an attic under a gable roof, a stair turned at a quarter landing, roof windows, a PV array of ten LONGi modules on rails and roof hooks in the rear slope with its inverter and the bonding busbar of its mounting on the attic's gable wall, a foundation earth electrode on the main earthing busbar, a ring earth electrode and a lightning protection system of class III with an air-termination rod, outlets and switches of Gira and MDT and a COSMO heating circuit manifold.

In 3D, Layout space › Show › Whole building shows the building of the room shown with all its levels and rooms, their floor slabs, the stairs and the roofs; All enclosures shows every building of the plant this way. Roofs and gable walls are seen from outside like the walls (translucent, or left out with Hide walls in front); Hide ceiling leaves out the ceilings and the roofs to look into the building. The plant in 3D draws the plot boundary on the ground and the reference point as a post.

Floor plan of the electrical_room example: L-shaped room, inner wall, door, window and the two cabinets

Floor plans on paper

Electrical floor plans are drawn on the architect's drawing of the building. A floor plan on paper goes under a level (Buildings pane, choose the level of the site plan, Floor plan…; command line import_floor_plan): a picture (PNG, JPEG, TIFF, GIF, WebP, BMP) or a page of a PDF file, a scan (also those of office scanners, which split a page into a background picture and black and white fax masks) or a drawing (its lines and filled areas; texts are not drawn). Of a PDF file with several pages the page is chosen in the pane. The site plan shows it under the level's rooms; the picture is kept in the project as a grey PNG (crate openecraft-scan reads the files, openecraft_core::panel::floorplan holds the rest).

How the rooms are found (openecraft_core::wallscan, pure image processing, no model): walls drawn filled, shaded or hatched (the way cut walls are drawn) at right angles to the edges of the sheet.

  1. Ink: a pixel clearly darker (10 levels) than the paper round it (the brightest level within the thickest wall, measured on the sheet shrunk; scans fade and yellow unevenly), after a 3 × 3 median that removes specks.
  2. Walls: the ink opened morphologically by the thinnest wall (90 mm): text, dimension lines, door swings and the lines of windows go, the filled walls stay. Of what is left only large parts away from the edges of the sheet are walls.
  3. Straight pieces: runs across a wall (a column of a wall along x) as thin as a wall that keep their place over at least twice their thickness; runs reaching over a piece (a wall meeting it, a blot of pencil on its side) carry it on.
  4. Openings: from the free end of a piece (not where another piece meets it) a ray along it in the rows of its middle to the next wall: as long as a door or window (0.5 … 5 m) in most rows. Ending at a wall across it (a door beside a corner) it is at most 1.5 m; wider only up to the next piece of the same wall (a window between two pieces). An opening whose two sides are joined anyway (a blot in a room) is none.
  5. Rooms: the free areas enclosed by the walls with the openings closed (those reaching the edge of the sheet are outside), at least 1 m². Their outline: cut along the lines where the border runs for at least 150 mm, the cells of these cuts mostly inside the room make up the floor plan (walls at right angles, no step shorter than 75 mm).
  6. Doors and windows: an opening between two rooms is a door; one to the outside a window when lines run through it along the wall (glass, frame, sill), else a door. A quarter circle of ink from one end of a door into a room is its swing.

On the scanned plans of a house from 1972 (1:50, 150 dpi, pencil) it finds the rooms of the ground floor with their doors and windows in half a second; walls drawn as two lines without filling, slanted or curved walls, and sheets scanned askew are not found yet. The rooms found are a start to check and correct: rooms joined by an opening without a drawn door are one room, and stairs or chimneys are walls.

Installation: outlets, switches, lights and their circuits

The installation plan of a level is drawn in the Buildings pane (choose the level of the site plan) on its floor plan; plugin installation, openecraft_core::installation.

House connection boxes

The enclosure system House connection box (house_connection, command add_enclosure with system house_connection) is the utility's box at the building entry: glass-fibre reinforced polyester (RAL 7035, IP54) with a hinged, sealable cover and a mounting plate, in two standard sizes (GEN.HAK-255X415X144 for NH00, GEN.HAK-410X720X185 for NH2). Its cover opens in the 3D view like the door of any enclosure. Inside go the NH fuse base (GEN.NH2-BASE-3P-400A, fed from below: the supply cable comes straight up to its line side through a gland in the bottom, the main cable leaves straight up through the top) and the PEN terminal block (GEN.TB-PEN-240-V). The example building_services hangs one on the wall above the cable entry, with the main earthing busbar (GEN.MET-BAR-10) and the lug of the foundation earth electrode (GEN.FE-LUG-V4A-10, symbol Earth electrode) beside it.

Distribution cabinets with component modules

A manufacturer's enclosure part that comes with its plinth says so in its data (Plinth: 200): a new enclosure of it stands on the plinth, which is drawn and exported but is no part of its own in the bill of materials (the Hager univers cabinet HAG.FR25S2, 1850 mm + 200 mm plinth, five fields, protection class II). Its mounting plate is placed by Mounting origin: 25/12.5/20 (the top left corner of the plate's front from the left, the top and the rear of the enclosure, mm; the plate keeps the same distance on the right and at the bottom), as the enclosure packages of the Rittal configurator give it (parts). A plate that is not centred also gives its size (Mounting size: 500 x 575; mounting_size of add_enclosure / set_enclosure). A maker's enclosure part that names its system (Enclosure system: compact) gets that system's walls and data but stays the part of the enclosure; only enclosures of the built-in catalog follow their size with the system's body. Distribution systems build the cabinet from component modules: a module the device stands on is an accessory mounted under the part (HAG.UE31E1B under the NH1 fuse switch disconnector HAG.LT153, HAG.UE31SS400 under the current transformers), so the device takes the module's footprint and depth and the part sits in front of it. The example pv_transformer_metering builds such a cabinet field by field after a real one: connection point zone and surge arrester, consumption metering with NH1 isolation on the busbar, transformer module above it, voltage paths and load break switch (power flows upwards through the field: the conductors run from one device straight into the next), the NA protection, the generation metering below the coupling switch and the busbars of the feeders; lifting eyes in the roof, the cables of the consumers through the bottom, the supply from below; the two meter cabinets of the distribution system operator with their test terminal blocks beside it. Cable entry flanges (part subgroup Cable entry, a membrane taking several large cables, such as the univers FZ402) are ways in for the 3D routing like cable glands. The example industrial_main_distribution bays two univers cabinets, open to each other, into the main distribution of an industrial plant: the aluminium supply cables on busbar terminals and through an entry flange in the bottom, the transformers of the metering in the supply busbar, a 185 mm busbar system through both cabinets with vertical NH fuse switch disconnector strips, the current transformers clipped in behind the measured ones, the coupling switches of the NA protection fed from busbar terminals. Neither has cable ducts: every conductor in them is laid by the 3D routing, so the high currents run over the bars and only what can be bent with its radius is a wire.

19-inch racks

The enclosure system 19-inch rack (rack19, Layout space › New enclosure, command add_rack or add_enclosure with system rack19) is a frame with a perforated door and two pairs of 19-inch mounting rails (IEC 60297) instead of a mounting plate; its standard sizes run from a 12 U wall rack to 47 U, and the rails are a part of the bill of materials (GEN.RK-RAIL-42U). Its rack units (1 U = 44.45 mm) are numbered from the bottom beside the rails in the front view and on the mounting layout page.

3D routing

Cables, tubes and (optionally) wires are routed through the line-up: in cable ducts, along routing paths drawn over the mounting plate, or freely around the devices; segregation of the classes power, control, signal and fluid, routing reservations, bend radii, cable bundles with their branches, shield terminations (shield clamp rail, pigtail) and their checks; routes can be frozen for production and stay as they are until they become invalid.

The wires of a cabinet with cable ducts on its mounting plate run through the ducts (layout setting Route wires in 3D routes them like cables instead). In a cabinet without cable ducts, and in a room, there is nothing to lay them in: every wire is routed in 3D from connection point to connection point. It leaves each connection point straight on in the direction the point gives, as far as its bend radius, and comes into the other one against the direction that one gives, never past it and back (through the box of its own device where the point lies inside it, such as the terminals of a switch on its module, never through another device that stands right before the point), keeps half its thickness clear of everything, bends with its radius only, and keeps apart from every other route and from itself (where its ends lie too close for its bend radius it runs round in a loop that never comes back across or alongside its own way, the bends at its corners and the nozzle it comes out of; where there is no such loop it is not routed); routes come together only where they come up to the same device, and there they lie side by side: a route never runs across another one it comes together with (it may only on its own way out of a connection point, or where it comes up to the device the other one ends at, and goes round it there too where that costs little). The straight way out of every connection point and cable entry stays free until its own route is laid, so that no other route runs across a terminal, and only a route out of a connection point right beside it shares it. Of the wires of a cabinet as thick as each other the shortest is routed first: between two devices the inner conductors lie nearest to them, the outer ones go round them. A wire that finds no such way is not drawn: it is reported as an error (… cannot be routed: no way that keeps half its thickness clear of everything and bends with its radius of … mm). The usual causes are a conductor too thick for the room between its ends (a busbar cross-section drawn as a wire: mount the devices on a busbar system instead), connection points that face away from each other, a terminal strip right below a switch, or two ends closer to each other than the bends between them need (a cable entry right below the box it leads into, two fittings one above the other with their ports on their sides). The messages pane jumps to a connection point of the wire or cable, and the 3D view shows a red note with the reason at each of its ends in place of the route.

The routing works on a grid (25 mm in a cabinet, 50 mm in a room); a connection point lies where it lies. The 3D view draws a route straight out of its connection point: its first corner lies on that line, the stretch after it leans over or comes back onto the grid on a slanting piece, short stretches in between are moved along. Where the way straight out of a point is barred and the route starts from the cell beside it, it needs room there for an S-bend of its radius onto that line (or to lean over to it), otherwise it is not routed. Ways that run together lie side by side on lanes; a way changes from lane to lane on a slanting piece of a stretch, never in a step at a corner, and a jog too short for the bends of its two corners is drawn as an S-curve of the bend radius. A cable ends on the bend of the corner before its cores part where it is cut there; the cores part within the box of their ends, and a core to a terminal behind others of its strip (one above the other on the bars) passes them in front of the device. Where two routes still cross each other right at a device they both come up to, the view lifts one over the other more sharply than their bend radius allows.

A cable between two cabinets that stand in no common room is routed in each of them to one of its cable entries (a note tells that the way between them is not part of the layout); every cable takes an entry of its own where there are enough that fit it. The cables through one cable entry flange go through its membrane (part data Cutout) side by side, each at a place of its own, the cable's thickness and a centimetre apart: the free place nearest to where the cable heads, the middle where none is free.

Between rooms, a route passes the wall penetrations, shafts and links between buildings that join them, through as few of them as possible: through the first room to a penetration, through the rooms between, through the last room to its end (its legs per room and cabinet in the routing list); its length includes the ways through the walls, shafts and links. Without such a penetration the route stays unrouted (no wall penetration leads from room to room). A route from a device of a room to the outside of the building ends at its nearest building entry, also from a device in a cabinet standing in the room (through the cabinet's gland and the room); of several wall penetrations joining the same two rooms the route takes the one with the shortest way.

In a room, routes run through its free space: around its walls, inner walls, the cabinets standing in it and the swing of its doors, preferring its cable ducts and pipe runs. Running horizontally through the open space of a room, more than 300 mm from its walls, its ceiling and what stands in it, costs ten times as much: pipes and cables keep to the walls and the ceiling and drop straight to a device standing in the room. Cables and pipes turn only after half their bend radius straight on (where there is such a way); of the ways that cost about the same, a route takes one whose bends keep their distance (a short stretch first or last). A route between a cabinet and a device in its room (or two cabinets of one room) runs in legs: through the cabinet to a cable gland on its roof, sides or rear (one of its own cabinet first, otherwise of the line-up; without one through the middle of the roof, which is reported), then through the room. A cable gland takes one cable: the free one whose clamping range fits the cable, nearest to where it heads; a cable entry flange takes as many as have places along its membrane. A cable that finds every gland of its cabinet taken is not routed and reported as an error (… every cable gland of … is taken by another cable. Add a cable gland for it). A cabinet hanging on a wall (its bottom above the floor) is also left through a gland in its bottom: below each such gland a shaft down to the floor and out to the front of the cabinet stays free for the routes. Frozen, such a route keeps its legs.

Flush-mounted in rooms. Every cable, wire and tube is laid in rooms surface-mounted (as above), flush-mounted in the wall or flush-mounted in the floor: as the routing rules say (Laying in rooms, command routing_rules with laying) or as set for it (route properties › Laying in rooms, command set_laying with its key). Flush-mounted it runs through the room in slots in its walls, Slot depth (30 mm unless set otherwise, slot_depth) behind their surface less half its thickness, along the middle lines of the installation zones (routing rules › Installation zones, command installation_zones): horizontal zones above the floor and below the ceiling, cut where doors and windows are and joined round the corners of the room, vertical ones beside the corners, doors and windows. A device on a wall is fed straight up or down from the nearest horizontal zone (or sideways from a vertical zone it lies in); a free end (a cable gland on top of a cabinet) goes to the nearest wall first. In the floor the line goes straight down the wall (or, low above the floor, straight down) and Depth in the floor (60 mm, floor_depth) below its surface along the zone in the floor. The zones are those of DIN 18015-3:2016 unless changed (German zones (DIN 18015-3) resets them): ZW-o 150 - 450 mm below the ceiling, ZW-u 150 - 450 mm above the floor, ZW-m 1000 - 1300 mm above the floor for rooms with worktops (off), ZS-t / ZS-f / ZS-e 100 - 300 mm beside doors, windows and corners, ZD-r 200 - 500 mm from the walls in the ceiling (shown, not routed through) and ZF, the same in the floor (the standard has no zones in the floor). A route the zones do not join stays unrouted (no way through the installation zones). Show › Installation zones shows the zones see-through on the walls in 3D and in the views of the walls, the one in the floor in the floor plan; Show › Open walls and floors sees through the walls and floor slabs in 3D, like Open cable ducts, to show the flush-mounted lines in them. Hoses, tubes and pipes end at the nozzles of the generated models of their devices (the suction and the pressure nozzle of a pump, the nozzles of a vessel, both ends of a valve or a fitting, the outlets of a manifold): the route comes to a point twice as far out of the nozzle as the pipe is thick (at least 30 mm) and goes on straight into it. A valve, meter or check valve in a pipe is taken as mounted the way round that brings both of its pipes nearer to where they come from. The example pump_room shows floor-standing pumps, a pipe run and the routes.

In a schematic, the context menu of a placed device shows it in the panel layout (its cabinet's mounting plate or door, the wall or floor plan of its room) or in the 3D view with the camera close to it (Show in panel layout, Show in 3D view).

The routes are part of the project's analysis. When a project is opened its analysis is built in the background: the editor shows a window with the step it is at (netlists, connections, panel wiring, 3D routing with the route it is at, duct fill, checks) and shows the project once it is ready.

The routed panel is the input of the wiring and mounting assistants and of the 3D exports (glTF, STEP, IGES, IFC, JT, Parasolid; see output and data exchange).

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

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