kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Draft ADR-008 for normalizing Heights and depths terminology

Browse Source
This commit is contained in:
sliptonic
2025-11-16 10:27:55 -06:00
parent 1ff464f1b9
commit f4592b4a82
1 changed files with 58 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
src/Mod/CAM/Roadmap/ADR/ADR-008.md Normal file
View File

@@ -0,0 +1,58 @@
# ADR-008: Terminology for heights and depths offsets
## Status
DRAFT
## Context
To properly and safely configure a CAM job and operations, the user must indicate at which height the cutting tool can operate.
There are numerous related concepts and the nomenclature for them is not consistent within the CAM/CNC industry.
Users are often confused by the terminology employed within FreeCAD's CAM workbench and this results in support issues and proposals for change.
This ADR describes the terminology to be used within the CAM workbench and how those concepts should be employed within operations, dressups, and post processors.
## Decision
1) All offsets (heights and depths) are relative to the job origin.
2) All offsets will use The term 'Height'.
3) The term 'Depth' is now deprecated and should not be used. It should be removed from documentation and task panels as soon as possible.
4) The following offsets are to be used.
### Clearance
The clearance offset is the height above the job origin at which the cutting tool can safely move laterally at any time.
It is assumed to be above all clamps, stock, model, and other obstacles.
The clearance offset should be consistent across all operations.
All operations will begin with a rapid move to the clearance height followed by a rapid move the X/Y coordinates of the start point.
All operations will end with a rapid move to the clearance height.
### Retract
The retract offset is the height to which the cutter will move laterally between cutting passes. At the retract height, the cutter is assumed
to be able to move at rapid speed anywhere within the operation's working envelope
### Feed
The feed offset is the height from which entry moves will begin. A rapid move vertically from retract height to feed height will be assumed safe.
### Start
Start offset is the nominal highest cutting point in the operation.
### Final
Final offset is the nominal lowest cutting point in the operation. The actual lowest cutting point may differ from the final offset due to "stock to leave" settings and other configuration options.
## Consequences
Any use of heights and depths nomenclature should be revised at the earliest opportunity.
Wiki and other documentatin should be revised as soon as possible.
Heights and Depths tabs should be consolidated into a single tab.
Unit tests should ensure that all operations begin and end with the correct entry and exit moves.