Repository navigation
Releases
Releases · nilres/OpenECraft
OpenECraft 0.1.2
Immutable
release. Only release title and notes can be modified.
- Website with live demos:
website/is a page that presents the project and
runs it: the schematic editor and the panel in 3D as canvases, the project check,
the reports, a console with the commands of the command line and the exports, all
on one example project in the browser, in the 20 languages of the editor. It is
deployed as static files (cd website && trunk build --release) or with the Docker
imageghcr.io/nilres/openecraft-website, which serves the web editor at/editor/
as well (website); where the links of the page lead (web editor,
repository, downloads, documentation, issues) is set inconfig.jsor with
environment variables of the image (OPENECRAFT_EDITOR_URL, …). The 3D routing
of the examples comes with the page; that of a changed project is searched in a
worker, so the page stays usable meanwhile. The demos are the editor's own code: its
shell tables, document state and drawing views moved into the library crates
openecraft-shell,openecraft-sessionandopenecraft-canvas. - Legal notice on the website: the operator of a site sets a legal notice
(Impressum: name, address, email, phone, representative, register entry, VAT ID,
responsible person, further text) inlegalofconfig.jsor with the variables
OPENECRAFT_LEGAL_…of the Docker image; the footer then links to it, labelled in
the language of the page (website). The image
writesconfig.jswith a start script, so any character is allowed in a setting. - Website for search engines and link previews: the page has Open Graph and
Twitter card tags, structured data (SoftwareApplication), a translated title,
texts for the pictures of the gallery, which are WebP files of a fourteenth of the
size of the screenshots, and headings in order. With its public address
(OPENECRAFT_SITE_URLof the Docker image, orinstaller/docker/website-site.sh
on a page deployed by hand) it gets a canonical address, a preview image for links,
a sitemap and a robots.txt naming it
(website). - Automatic saving of shared projects: a project opened from the project server
is saved to it by itself, 30 seconds after a change and every 30 seconds while the
work goes on (Settings › Servers or the Project server pane: on / off, 10 to
600 s). Unfinished drags and text inputs are not sent, saves run one at a time and
release no locks;Ctrl+Sstill saves at once. The status bar and the pane show
Saved, Not saved yet, Saving…, Waiting for the server, Save failed and
Partly saved apart, with the time of the last save the server confirmed. During
an outage the changes wait, the local recovery copy is written at once (and named
only once it is written) and the save follows when the session goes on
(project server). - Properties and copies of server projects (#186): the project list of the
Project server pane selects a project; Properties… shows its properties as
saved on the server and changes them without opening the project (for who may
change the project data, while nobody has locked it; only the properties are
written, never the whole project). Copy project… shows the properties of the copy
at once: a free name on the server and the title, description, company, author,
date, revision and project properties of the original to adjust; Create and open
creates the copy from the saved state and opens it, Cancel leaves nothing on the
server. The original, its sessions, locks and access rights stay untouched; the
copy belongs to who created it and starts without the original's review records,
released revisions and baselines unless asked for. Unsaved changes of the open
project are asked about first; a project changed on the server meanwhile is
reported before the copy is made. The server records the project and revision a copy
was made from. Needs the updated project server. - View cube in the 3D views: the 3D view of the panel layout shows a view cube
in its top right corner and an axis triad (x red, y green, z blue) bottom left. A
click on a face, edge or corner of the cube turns the camera to look from there
(26 views, the corners isometric), a drag on it orbits; its buttons turn the view
by 90°, go back to the starting view or show everything. It replaces the buttons
of the standard views. The 3D previews of parts (part editor, data portal,
installation) have a small cube without labels and glide to the view clicked. - Who created and last changed a shared project: the project list of the
Project server pane and of the server's web page shows Created by, Last
changed by and Last changed for each project (created_by,created_at,
changed_by,changed_atofGET /api/v1/projects). The project server records
the signed-in user of the creation and of every save that changes the project;
opening, keeping a session alive and saving unchanged content do not count.
Projects of earlier versions show Unknown until their next change. - Docker image of the web editor:
ghcr.io/nilres/openecraft-webserves the
web editor with nginx on port 8080, built byinstaller/docker/Dockerfile
(targeteditor-web) and published with the server images;
installer/docker/compose.yamlstarts it with both servers
(installation). - Web page of the project server: started with
--web(or
OPENECRAFT_PROJECT_WEB=true,web = truein its configuration file), the project
server serves a web page with the projects the user may see and a read-only view of
each: the pages by section or by structure, the devices with their places and the
pages drawn as on paper, with the locks of the users working on them. Project
managers edit the permissions of their projects; administrators get an
administration area for the users, the access rights (access without sign-in,
roles, grants) and the directories (Active Directory, LDAP, with a test), and a
view of the open sessions (user, project, saves, locked pages) with the history of
the ended ones, which the server keeps insessions.jsonlof its data directory. The
server also offers the directories over its API (/api/v1/directories) and tells
the caller's user and rights in/api/v1/info. The page shares its sign-in, access
administration and styles with the parts server's data portal (new crate
openecraft-web), and its project views with the editor's navigator (new crate
openecraft-view). - Shared projects recover expired sessions (#183): the editor tells a server
that does not answer, an ended project session (expired, or the server restarted)
and an invalid sign-in apart. An ended session opens the project again with the
existing sign-in, without asking for the password; your unsaved changes are put
onto the server's current project and lock again, while changes another user
made meanwhile (or pages they removed) win and your version is kept in
Project server › Kept changes. After an invalid sign-in, signing in again in the
Project server pane continues the project. A failed save now shows the lost
connection at once; the pane and the status bar show the connection apart from
whether your changes are saved on the server, and a restored connection clears the
old connection error but not an unsaved failed save. Keep working on a local
copy ends the shared session and keeps the project with your changes locally. - Freestanding PV arrays: ground-mounted PV arrays on the plot, added in the
Buildings pane (Freestanding PV arrays) or clicked into the site plan: rows of
tilted tables with modules on top of each other, on rails over table beams on rammed
posts (genericGEN.PV-POST-RAMandGEN.PV-TABLE-BEAM), free of shade in winter.
Their modules and mounting go into the bill of materials, they have strings like the
arrays on the roofs, their leads run through a cable trench to the devices, and the
site plan and the 3D view draw them. Checked for arrays on each other, on a room and
outside the plot boundary. Commandsadd_pv_array/set_pv_arraywithout building
and roof, withstackandclearance
(panel layout). - Roofs picked in 3D: a click on a roof in the 3D view shows it in the Layout
properties, where a PV array or a roof window is added at the point clicked. The
PV array window adds a string to the array with + String beside its strings. - Shared saves one at a time (#182): a save to the project server waits for
the answer to the one before it (Save or Ctrl+S again sends the project as it is
then), and an answer marks only what its request sent as saved: edits or Undo
made while saving stay unsaved. Save and release keeps a page edited again
while saving and requests its lock again. Answers that arrive out of order no
longer take the project back to an older revision, a failed save sends and
releases nothing more, and closing or replacing a shared project ends its
session only after the save under way. The live project server tests run with
scripts/test-project-server-live.ps1(formerlytest-cable-rename.ps1). - Keep me signed in (#184): optional project-server sign-in persistence on
Windows using Credential Manager, separately for each server and account. The
editor validates the saved session and reads current account rights before
using it. Sign out preserves open work as a local recovery copy, removes the
remembered credential and ends the account session after pending project closes.
Change user keeps the remembered sign-in f...
OpenECraft 0.1.1
Immutable
release. Only release title and notes can be modified.
- PV arrays on roofs: rows of solar modules on every roof shape, parallel to a slope
on rails and roof hooks or on a flat roof tilted or east-west on ballasted mounting
bases. The mounting material (rails, connectors, roof hooks, end and middle clamps,
mounting bases, ballast, wind deflectors) follows from the modules and goes into the
bill of materials with them; it comes from a mounting system of the parts database
or from generic parts. New shipped catalogslongiandjinkowith PV modules; the
check reports arrays across a ridge or off the roof, over roof windows or each other.
Commandsadd_pv_array,set_pv_array(panel layout). - PV strings: the modules of a PV array in series and in parallel as strings on the
MPP trackers of inverters and charge controllers, with their highest, mean and lowest
voltage, currents and power at the design cell temperatures; the report PV strings
lists them, the check reports strings above the input voltage of their inverter or the
system voltage of their modules, outside the MPP range, beyond the trackers or their
currents. Commandsadd_pv_string,set_pv_string,pv_strings
(panel layout). - Doors and windows open either way or slide: hinges at the left or right, opening
into or out of the room, or a sliding leaf; drawn so in the floor plan and the wall
view, the check keeps the way of sliding doors free. Commandset_wall_opening,
opensforadd_wall_opening. - Site in the navigator: the site at the root above the buildings shows the site
plan of all buildings or the whole plant in 3D; a click on a room keeps the 3D view or
shows its floor plan; new buildings and levels from the context menus. - Flush-mounted cables, wires and tubes in rooms: each line is laid surface-mounted,
flush-mounted in the walls or in the floor (a project default in the routing rules,
set per line in its properties or withset_laying). Flush-mounted lines run in slots
of a configurable depth along the installation zones, preset to those of DIN 18015-3
and editable (installation_zones), or down into the floor and along its zone.
Show › Installation zones shows the zones see-through, Show › Open walls and
floors sees through walls and floor slabs to the lines in them
(panel layout). - Stairs and roofs of buildings: stairs from level to level, straight, turned once
or twice at quarter landings, with a half landing or spiral, their steps from the
difference in height; flat, shed, gable, hip and pyramid roofs with roof windows. A
roof lower than the ceilings below it slopes them, also on several levels: rooms get
different heights at different places, their walls end under the slope, and the
check reports cabinets and wall items above it. Show › Whole building shows a
building in 3D with its floor slabs, stairs and roofs. Commandsadd_stair,
set_stair,add_roof,set_roof,add_roof_window,set_roof_window
(panel layout). - Outlets, switches and heating circuit manifolds in rooms: Insert › Outlets,
switches, heating places socket outlets, data and antenna outlets, switches, push
buttons and room thermostats at their mounting heights, heating circuit manifolds
(2 - 12 circuits) and single-room control boxes; generic parts and the new shipped
catalogsgiraandcosmo, more KNX push buttons inmdt. Example 16
(office_building) shows them with a stair and a roof. - Rooms onto levels in the navigator: in Enclosures and rooms rooms are dragged
onto a level of a building to stand on it; a selected level takes the rooms made with
New room, and the context menu of a level offers New room on this level
(panel layout). - Updates in the editor: when it starts, the editor looks for a new release on
GitHub in the background, downloads it, checks it againstSHA256SUMSand installs
it: the Windows setup runs silently when the editor is closed (Restart and update
in the status bar starts it again afterwards), an AppImage and the macOS apps are
replaced at once; packages of a distribution are only told of the new version.
Without a connection nothing waits. File › Help › Check for updates looks at any
time; Settings › Updates andOPENECRAFT_NO_UPDATE_CHECKswitch the check at start
off (installation). - Docker images of the servers: the parts server and the project server are
published asghcr.io/nilres/openecraft-parts-serverand
ghcr.io/nilres/openecraft-project-serverwith every release (<version>,latest)
and every push to master (edge);installer/docker/compose.yamlstarts both
(installation). - Directed T-junctions (target tracing): Insert › Connections › T-junction
places a junction where three wires meet that names the device the two wires of the
connection start from and the order of their targets, with four directions and four
variants each as in the connection symbols of EPLAN; the connection list, diagrams,
panel wiring and harnesses follow it, connections without one keep the schematic
order. The junction can be drawn as a dot without losing its routing, turns and
mirrors with the drawing, is kept in the project file and the undo history, and is
checked against its wires (Connection symbols check). Commandsadd_t_junction,
update_connection_symbolandlist_connection_symbolsfor the command line and the
MCP server (#96). - Corners for automatic wiring: Insert › Connections › Corner places a connection
symbol with two arms at a right angle; with Auto-connect on, connection points that
face the free arms of a corner or a T-junction are wired to it when the symbol or the
device is placed or moved, so a corner at the meeting point of two connections wires
both of them in. Commandadd_corner(withautoconnect), andautoconnecttakes
connection symbols too (#96). - Directed crossings and bridges: Insert › Connections › Crossing connects the two
wires crossing at its point (unconnected without one) and leads each end of its
vertical or horizontal line straight on first and across second, in two variants;
Bridge leads a connection from one side to the three others, the opposite side
first. Both follow the connection symbols of EPLAN, can be drawn as a dot and keep
their routing, and the check reports a connection its symbols wire in a loop. Commands
add_crossingandadd_bridge(#96). - Editor: wires attached to moved items stay square: they slide along their rails,
or get a jog where they cannot. Connection definition points and cable definition
lines stay on their wires. - 3D routing in cabinets without cable ducts: their wires are no longer laid
along the mounting plate (through the devices and each other) but routed in 3D from
connection point to connection point, like the wires of a room: clear of everything
by half their thickness, bent with their radius only, each on a way of its own. A
wire that finds no such way is reported as an error instead of being drawn. - 3D routing: a route leaves a connection point that lies inside the box of its
device straight through that box, never through another device to the room behind
it; its last bend may lie where the straight way into
its end begins; the straight way out of every connection point and cable entry stays
free until its own route is laid; a cable between two cabinets that stand in no
common room is routed to a cable entry in each of them; every cable takes an entry of
its own; in the 3D view a cable passing from one cable duct into the next keeps under
the cover of the first. - Bend radius in the 3D view: ways laid side by side change lanes on a slanting
piece of a stretch instead of a step at the corner (which was rounded with a radius
of a millimetre or two); a route is drawn straight out of its connection points, its
first corners moved onto that line, instead of with a kink onto the routing grid; a
jog shorter than the bends of its corners is an S-curve of the bend radius also where
the stretches before and after it lean; bends are drawn as fine arcs, so that ways
round one corner are not pushed apart where only their drawn arcs met; a cable ends
on its bend where its cores part right behind a corner. - 3D routing, crossings: routes that come together lie side by side, a route no
longer runs across another one (only on its own way out of a connection point, or
where it comes up to the device the other one ends at, and there it goes round the
other one too where that costs little); the way out of a connection point is shared
only by a route out of a point right beside it; of the wires of a cabinet as thick
as each other the shortest is routed first, so that between two devices the inner
conductors lie nearest to them and the outer ones go round them. Two wires that
still cross right at a device are lifted over each other more sharply than their
radius allows. - Cable entry flanges: the cables through one flange go through its membrane 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) instead of all through its middle;
the cores of a cable part within the box of their ends, so that a core no longer
swings out past its terminal into the bars it sits on. - Busbar holders in the 3D view: drawn at the dri...
OpenECraft 0.1.0
Immutable
release. Only release title and notes can be modified.
The first release: an electrical CAE editor for Windows, Linux, macOS and the browser,
with a command line, an MCP server, a parts server and a project server.
- Schematics: device-oriented pages with live cross references and contact images,
structure identifiers, page sections, macros with variants and a configurator;
potentials, cables with cores and automatic wire, device and page numbering. - Symbols: about 330 IEC 60617 symbols, NFPA / JIC, GB, GOST and JIS sets, fluid
power (ISO 1219), P&ID, installation plans and single-line; a symbol editor. - Terminals, plugs, PLC: multi-level terminals with accessories, plugs, PLC tag
tables for TIA Portal, Studio 5000, TwinCAT, CODESYS and more, marker export. - Connectors: the plug window shows the pin-out of a plug on the mating faces of
both sides, coloured by the wires and cable cores at the pins (also as SVG export);
connector parts for M5, M8, M12 (signal, fieldbus, Ethernet and power codings),
M16, M23, M40, 7/8", GX aviation connectors, valve connectors, D-sub, DIN 41612,
IDC, wire-to-board housings, pluggable terminal blocks, RJ11 / RJ12 / RJ45, BNC,
heavy duty inserts, sealed connectors for mobile machines, CEE, appliance couplers,
mains, installation, PV and battery connectors; pin layouts with inner rings,
column numbering and free pin positions; ribbon and flat cables with a check of the
cores on IDC connectors; example project 12 shows them. - Reports and checks: live report pages, graphical terminal, cable and plug
diagrams, drawn forms, a project check with message management and a check for
open wire ends. - Editor: an EPLAN-style ribbon that folds groups into menus when space is short,
dockable panes per workspace with standard workspaces to return to their default
arrangement, an Insert center, a properties pane, key tips,
command search; unsaved changes are kept and asked for on every way out; released
and locked pages are read only but selectable; crossing selection, zoom commands,
contextual help (F1) and rebindable keys for every page action; pages and sections
are dragged in the Pages navigator with a drop marker and the resulting name shown. - Panel layout: devices at real size in 2D and 3D, virtual wiring with duct fill,
drilling and NC data, enclosure climate, line-ups, rooms and 3D routing; wiring and
mounting assistants for the workshop. In a room's floor plan cabinets turn in place,
cabinets in a bad place are drawn in the warning colour with the reason on hover,
inner walls end on the room walls, and the layout checks are shown below the view;
rooms and enclosures with content are deleted only after a question. Opening a project
analyses it in the background with a window showing the step and the route it is
at; the 3D routing searches several times faster and is kept while an edit changes
none of its routes; after an edit that does, it is searched in the background (the
status bar shows it, the 3D view keeps the earlier routes until then), so editing
a project with rooms no longer stalls the editor for seconds. Exports, reading 3D
model and parts files (STEP, IGES, Parasolid, EDZ, …) and the autosave run on another
thread too; the status bar shows what is running. Pipes and cables in a room keep to
its walls and ceiling instead of crossing it, and their bends keep the bend radius
apart. The 3D view is drawn by the graphics card (OpenGL 3 / WebGL 2, with a depth
buffer and anti-aliasing; Settings › Appearance switches it off), and drawn by the
processor it keeps what it shows between frames: large rooms turn smoothly. Moving in the
3D view: the wheel zooms at the pointer and walks on into a room, Shift+drag pans as the
right button does, a double-click turns the camera to what was clicked and closes in,
W A S D / the arrow keys and Q E move through it (Shift: faster), and a bar in the view
has the standard views (front, left, right, rear, top, isometric) and Fit (Home). Devices without a 3D
model of their own get a detailed, coloured one by what they are (pumps, vessels,
valves, heat pumps, inverters, rack batteries, …); devices of the bundled catalogs
(Victron, Pylontech, Hager, DEHN, Beckhoff, Phoenix Contact, Siemens) are drawn after
their product photos and wired to their real terminals: the Pylontech batteries
to the power terminals and ports on their front, the Victron devices from below,
the Cerbo GX at its row of connectors, Beckhoff terminals at their spring contacts,
surge arresters with the earth at the bottom, 19-inch devices at the rear; DIN rail
models have a screw at every connection point; terminal blocks are drawn slice by
slice with their stepped profile, wire entries, pushers or screws and marker fields
(generic terminals, end covers and end brackets sized after Phoenix Contact PT, PTPOWER,
D-ST, D-PT and CLIPFIX), between end plates and end brackets at both ends of every strip, and cable ducts with slotted walls and their
cover; cables in the 3D routing end at the
connection points their cores land on and part into their cores there; routes leave the devices they end at
instead of running through them; the routes of a class are searched on several threads
at once (with the same result), a selected cable or tube shows its properties like a
wire with its cores and the connection points they join (picked in the 3D view and on the plate); a cabinet opened from its room is fitted into the view. The 3D view hides the
walls in front of the camera or the
ceiling on request; the opacity of the walls is a setting. Wires are drawn in their
colours and, like cables and tubes, in their real thickness as round tubes bent round
their corners with their bend radius, from the plate up to their
connection points; cable cores are drawn with their cable. Routes keep half their
thickness from what is around them and turn where their bends have room, cables keep
out of cable ducts too small for them; View › Open cable ducts leaves out the covers
of the ducts. Wires, cables and tubes that run together lie side by side, each on a lane of its own
(in a cable duct packed in rows from its base, never over its cover), and where wires and cables pass
through the wall of a duct its fingers are left out; where they would still run inside or through each
other they are pushed apart, one over the other where they cross, inside the walls of their cabinet and
out of its devices. Wires on one terminal or on terminals closer than they are thick leave them
straight, side by side, instead of hooking round each other where they come out of a duct. The 3D
view lays them out on another thread, several times faster, with a progress box while it does (it
shows them as routed until then). Cables and tubes keep apart from each other in free air already when they are
routed. A cable duct too small for its wires to lie side by side is an error of the project check.
The fill level of a cable duct counts the cables and tubes routed through it as well as its wires,
against the cross section inside the duct, also for the ducts on the walls, ceiling and floor of a
room; cables and tubes keep out of the stretches of a duct they would fill above the limit.
A cable ends a little before the device and its cores part from there in smooth curves, each coming
into its connection point from the side its wires leave it; cables and wires run on through the cable
glands, wall penetrations and cable passages between cabinets and rooms in one piece, bent round
there; pipes and hoses end at the nozzles of the devices' models (suction and pressure nozzle of a
pump, the nozzles of a vessel, both ends of a valve), coming straight out of them; a valve, meter or
check valve in a pipe is taken as mounted with its inlet towards the pipe that feeds it. Cables
through one gland pass it side by side; the cores of a cable are as thick as its diameter tells and
part from their places round its axis. Wires in a cabinet without cable ducts leave their devices
in the direction of their connection points and run round the rows of devices instead of behind or
through them; wires leave their own devices over them, not through them. Wires, cables and pipes
laid side by side are pushed at most a few times their thickness from their routes.
The 3D routing measures the room around a route from the devices, walls, mounting
plate, door and room walls themselves (thin busbars and rails between the cells of its
grid included), so cables and pipes keep half their thickness from all of them, and
from each other, everywhere: a route that cannot is not routed, and the project check
reports it as an error that says to move its ends or make room for it. A route leaves
its device, cable gland, nozzle or wall penetration straight on for its bend radius,
runs two radii between two bends (the arcs of both fit between), turns only where its
arc keeps clear of everything too, changes lanes with an S-bend (checked and drawn as
one), and near its ends converges with the routes to the same end; the thickest cables
of a class are routed first. In a cabinet a cable enters and leaves a cable duct through
the slots of its walls, never through its base or its cover, lies in a duct over the rim
of its walls and under its cover, and keeps half its thickness off the ducts it runs
along outside them; in a 19-inch rack cables run along the space beside the mounting
rails and leave it for their devices; in a room, running through the open space costs
the more the farther from its surfaces, so cables and pipes keep close to the ceiling
and the walls. The 3D view holds wires and cables in that band of a duct where they
cross its walls (and leaves out the fingers they pass), cuts a duct's walls where
another duct joins it, and brings a wire down before the next duct instead of into it
throug...