Repository navigation
Releases
Releases · idris-botics/stepscribe-cad
v2.1.0
v2.0.0
stepscribe 2.0.0 (2026-11-06)
This release is compared with 0.1.4, the previous release (tagged v0.1.4).
The first list is only what changes behaviour for people who already use stepscribe. Everything new is
listed in full under "Everything new in 2.0.0". The report schema stays 0.6.0 and is not tied to the package version.
Changes that alter existing behaviour
- Floating-part wording. A part with no fastener, pivot or joint evidence tying it to the rest used to be called "not connected to the ground link" (weak spot W001 and its risk phrase, the floating list of the kinematics text, and the matching interview question). It now says "has no fastener, pivot or joint evidence linking it to the ground link (it may still touch other parts)" where the file or the designer names the ground link, and "... linking it to the rest of the assembly" otherwise, because touching parts without such evidence are not "unconnected". Only these sentences change; a report that has such a finding differs from an older one in those strings alone (the same inputs were run through the code before and after: the only differing strings are these sentences).
- Contact kinds. Parts that touch at an edge or a point are reported as
edge_or_point("A touches at an edge or point B.") instead ofpointorline; the split was not reliably decidable. Older saved reports and cached exports withpointorlinestill load and are read asedge_or_point. - Image labels carry IDs only. No part name is drawn or captioned on any image, the basic set included (the assembly legend, the part-panel title, the link legend and the image descriptions used to carry names). The names stay in the Markdown text, labelled as data. The golden
two_plates_assembly_FULL.mdchanged for this reason. - Report schema 0.6.0 (unreleased, not tied to the package version) has new optional fields:
parts[].from_step,material_source: step_file,FastenerJoint.bore_pair, theKinematicModelheadline fields,KinJointdesigner fields,Understanding.kinematics_debugandload_path_note, new question kinds. A file that states none of this produces the samereport.jsonas before. - Headline wording and confidence. Every
Likely:headline now carries a confidence and its evidence; a chain of revolute joints readsLikely: 6-axis serial arm (confidence X; evidence ...)and its confidence is capped by the weakest joint; a single part's role phrase says "probably" from 0.60 and "possibly" from 0.30. - Fasteners. Pivot candidates and large coaxial bore pairs are no longer fasteners: they leave the "bolted to" relations, the fastener counts and the "fasteners missing?" questions and have their own sections in
02_assembly.md. - Hole edge distance is measured from the hole's side walls (a drill-point tip no longer counts).
- Hole edge distance for a counterbored or countersunk hole no longer counts the hole's own counterbore, countersink or the rounded mouth round it (a fillet at the mouth used to leave a corner touching the bore, so the distance read 0.0 mm). A counterbore with a flat in its wall (a D-shaped bore) is measured against that flat: the wall of the hole in the floor to the flat. Plain holes and plain round counterbores keep their numbers. A hole that read 0.0 mm (and so was skipped as breaking through the edge) can now appear as "too close to an edge", and some countersunk or counterbored holes on large parts report a larger distance than before.
- Process guesses. A part with complex or free-form geometry gets no process guess instead of a confident one.
- UI image sets. The page builds its pack with the chosen image set (basic, standard or full); the default is standard, so the UI now draws more images (hole map, three views, weak spots, ...) than before and takes longer on big files.
- CLI image set default stays
basic(today's images, apart from the IDs-only change above). - macOS. Free memory is read through
vm_stat; an unknown value caps the part-worker pool at 4 (it used to be unlimited).
Known limit
- Interference check. It reports measured overlaps. A very shallow overlap over a large mating face can be within modelling tolerance, and a part modelled inside a housing is reported as an overlap. Read the reported volume and contact area before drawing a conclusion.
Checked before release
- An old saved report (the pre-change report of a six-axis robot-arm model, schema 0.6.0 as written then) loads with the current models.
- Version strings: the package, the plugin, the marketplace entry and the two goldens all read 2.0.0;
tests/test_version_sites.pyfails if they disagree.
Everything new in 2.0.0
- Counterbore with a flat. A round counterbore that has one flat in its wall (a D-shaped bore) is described as such: "cbore dia 4.2 x 8.6 with a flat (3.6 across flats, flat 1.5 from the axis)", with the measured numbers in an optional
counterbore_flatfield of the hole inreport.json(absent for every other hole; schema stays 0.6.0). The axis-view image draws the across-flats dimension beside the hole label. Two or more flats (a double D, a hexagon) are not described.
Robot files from manufacturers (a six-axis industrial arm, for example): links, joints and a robot description.
- macOS: free memory is now read (
vm_stat), and an unknown value caps the pool.available_ram_bytes()returned nothing on macOS, so the worker count followed the CPU rule alone (up to 8 workers, each 0.4 GB or much more for a big part) and the bore split used a fixed rule. It now reads free + inactive + speculative pages times the page size from/usr/bin/vm_stat(2 s timeout; an empty or garbled answer, a timeout or a missing command gives no value, never an error) and the usual memory rule applies. When the value is not known on any OS, the pool is capped at 4 processes shared between the jobs instead of being unlimited. stepscribe --versionprints the package version (only the number) and exits;stepscribe versionstill prints the version with the OpenCASCADE build.- The JSON Schema of
report.jsonships in the wheel asstepscribe/schema/report.schema.json(the same bytes asschema/report.schema.jsonin the repository; the schema stays 0.6.0). A test builds the wheel and compares the two. - Install lines name the right package. The skill files, the MCP and robot-validation messages and the docs named the package without its
-cadsuffix, which on PyPI is a different project. They now saystepscribe-cad(pip install "stepscribe-cad[mcp]",stepscribe-cad[robot],stepscribe-cad[llm]), and a test fails if any file in the repository gets this wrong again. The 0.1.0 to 0.1.4 releases carry the wrong name in some messages and in the skill files; their PyPI project page and README were already right. - Names. An instance labelled only with an assembly-tree occurrence id (
NAUO4) now takes the product name (LINK3). - Links from names.
BASE,LINK<n>andAXIS<n>are found anywhere in a part name, with any prefix and a_body<k>suffix. With three or more numbered groups in a chain, bodies of one group are one link and different groups are never merged because they rest on each other. - Pivots and flanges. A coaxial hole stack that matches no screw size, at least 20 mm wide and as long as it is wide, is a pivot candidate (revolute about the bore) instead of a confidence-0 fastener that locked two links together. A large planar contact between two link groups is a revolute candidate about its normal; a bore that agrees raises the confidence, one that disagrees wins with a lower confidence and the flange reading is listed. Change the limits with
--pivot-min-diameterand--pivot-min-length-ratio; seedocs/kinematics.md. --debug-kinematics(onpackandexport) writesdata/kinematics_debug.mdand akinematics_debugsection inreport.json: for every contact, why it was merged or kept apart; for every unmatched hole stack, why it is not a fastener.- Designer input. A
kinematics:section indesign_context.yaml(base, and joints with type, axis, origin, range, positive direction) replaces what was detected and is marked "Confirmed by designer". New interview questions ask for the base link, the axis of joints known only from a flange, and the sign of positive motion. robot.jsonin the pack for a model with at least one revolute or prismatic joint: link frames, joint axes and origins, a DH-style table, mass and inertia per link (estimates), and joint limits only from the yaml.- Headline. A chain of revolute joints reads
Likely: 6-axis serial arm (confidence 0.70; evidence KJ1..KJ6, L0..L6), with the chain facts and a check of the usual 6-axis layout (a mismatch is written out and lowers the confidence; the confidence is capped by the weakest joint). Parts namedLINK<n>with no joint evidence read "Joint structure not determined", never "static structure". The overview, understanding file and single-file pack carry the same text. - Interview. For a robot the base link, the axis of flange-only joints, the sign of positive motion and the ranges come first. Answers are also written to the
kinematics:section, and undo removes them. --meshes(onpackandexport, robots only) also writesmeshes/: one visual and one collision binary STL per link, in metres, in the link frame, so mesh position plus link frame is the world position at the zero pose.robot.urdfthen has<visual>and<collision>per link. The collision mesh is a coarser tessellation within a triangle cap (--mesh-max-triangles, default 5000) and is always closed and consistently oriented: the deflection grows until both hold, and a link where none does gets the convex hull (numpy only), marked "collision: convex hull".--visual-triangle-cap Ncoarsens the visual meshes the same way (default...