Path Workbench

Introduction
The Path workbench is used to produce machine instructions for CNC machines from a FreeCAD 3D model. These produce real-world 3D objects on CNC machines such as mills, lathes, lasercutters, or similar. Typically, instructions are a G-Code dialect.



The FreeCAD Path Workbench workflow creates these machine instructions as follows:
 * A 3D model is the base object, typically created using one or more of the Part Design, Part or Draft Workbenches.
 * A Job is created in Path Workbench. This contains all the information required to generate the necessary G-Code to process the Job on a CNC mill: there is Stock material, the mill has a certain set of tools and it follows certain commands controlling speed and movements (usually G-Code).
 * Tools are selected as required by the Job Operations.
 * Milling paths are created using e.g. Contour and Pocket Operations. These Path objects use internal FreeCAD G-Code dialect, independent of the CNC machine.

Links for the impatient
Depending on your interest in the Path workbench there are different topics for further reading:


 * If you are a new new user trying to get familiar with Path, you might be interested in a fast walk-through tutorial.
 * If you have a special machine which cannot use one of the available postprocessors you may want to learn about post-processor customization
 * As an experienced user you may want to write a macro or automate a process might need to learn about scripting
 * Power users who want to streamline their workflow can learn about customization.
 * New developers who want to contribute to path might want to understand core concepts.

General concepts
The Path Workbench generates G-Code defining the paths required to mill the Project represented by the 3D model on the target mill—in [the Path Job Operations FreeCAD G-Code dialect], which is later translated to the appropriate dialect for the target CNC controller by selecting the appropriate Postprocessor. The G-Code is generated from directives and Operations contained in a Path Job. The Job Workflow lists these in the order they will be executed. The list is populated by adding Path Operations, Path Dressups, Path Partial Commands, and Path Modifications—from the Path Menu, or GUI buttons.

The Path Workbench provides a Tool Manager (Library, Tool-Table), and G-Code Inspection, and Simulation tools. It links the Postprocessor, and allows importing and exporting Job Templates.

The Path Workbench has external dependencies including:
 * 1) The FreeCAD 3D model units are defined in the Edit-> Preference...->General->Units tab's Units settings.  The Postprocessor configuration defines the final G-Code units.
 * 2) The Macro file path, and Geometric tolerances, are defined in the Edit->Preferences...->Path->Job Preferences  tab.
 * 3) Colors are defined in the Edit->Preferences...->Path->Path colors tab.
 * 4) Holding tag parameters are defined in the Edit->Preferences...->Path->Dressups tab.
 * 5) That the Base 3D model quality supports the Path WB requirements—passes Check Geometry.

FreeCAD Path Workbench internal G-Code dialect represents Feed rates in Units/Second—what the G-Code Inspection tool will show. The Postprocessor is configured to generate the appropriate Feed rates—either in Units/Second or Units/Minute for the target mill.

Path Commands
These commands are used for seting up a CNC project and manage your templates.


 * [[Image:Path-3DPocket.png|32px]] 3D Pocket: Creates a path for a 3D pocket
 * [[Image:Path-3DSurface.png|32px]] 3D Surface: Creates a path for a 3D surface
 * [[Image:Path_Array.png|32px]] Array: Creates an array by duplicating a selected path
 * [[Image:Path_Comment.png|32px]] Comment: Inserts a comment in the G-code of a path
 * Path-CompleteLoop.png Complete Loop: Completes a loop from two selected edges
 * Path_Contour.png Contour: Creates a path of the contour of the base object
 * [[Image:Path_Copy.png|32px]] Copy: Copies a selected path object
 * [[Image:Path_Custom.png|32px]] Custom: Inserts custom G-code


 * [[Image:Path_Dressup.png|32px]] Dogbone Dressup: Adds a dogbone dressup modification to a selected path
 * [[Image:Path_Dressup.png|32px]] Dragknife Dressup: Adds a dragknife dressup modification to a selected path


 * [[Image:Path_Drilling.png|32px]] Drilling: Performs a drilling cycle
 * [[Image:Path-Engrave.png|32px]] Engrave: Creates a engraving path
 * [[Image:Path-ExportTemplate.png|32px]] Export Template: Export the current job as a template


 * [[Image:Path-Face.png|32px]] Mill Face: Creates a surfacing path
 * [[Image:Path-Area.png|32px]] Feature area: Creates a feature area from selected objects
 * [[Image:Path-Area-Workplane.png|32px]] Feature area: Creates a feature area workplane
 * [[Image:Path_Fixture.png|32px]] Fixture: Changes the fixture position


 * Path_Inspect.png G-Code Inspector: Shows the G-code for checking
 * [[Image:Path_GcodeFromShape.png|32px]] Gcode From a Shape: Creates a path object from a selected Part object
 * [[Image:Path-Helix.png|32px]] Helix: Creates a helical path
 * [[Image:Path_Hop.png|32px]] Hop: Creates a "hop" movement by raising the tool vertically before translating it horizontally
 * [[Image:Path-Job.png|32px]] Job: Creates a new CNC job
 * [[Image:Path_Pocket.png|32px]] Pocket: Creates a pocketing operation from one ore more selected pocket(s)
 * [[Image:Path_PostProcess.png|32px]] Post Process: Exports a project to G-code
 * [[Image:Path-Profile-Edges.png|32px]] Profile from Edges: Creates a profiling path from selected edges
 * [[Image:Path-Profile-Face.png|32px]] Profile from Face: Creates a profiling path from a selected face
 * [[Image:Path_Dressup.png|32px]] Ramp Entry Dressup: Adds ramp entry dressup modification to a selected path
 * Path_Sanity.png Path Errors: Checks the selected Job for missing values
 * [[Image:Path_SelectionPlane.png|32px]] Plane: Changes the working plane of the machine
 * [[Image:Path_SimpleCopy.png|32px]] Simple Copy: Creates a non-parametric copy of a selected path object
 * Path_Simulator.png Simulator: Shows the milling operation like it's done on the machine
 * [[Image:Path_Stop.png|32px]] Stop: Inserts a full stop of the machine
 * [[Image:Path_Dressup.png|32px]] Tag Dressup: Adds a holding tag dressup modification to a selected path
 * [[Image:Path_ToolLenthOffset.png|32px]] Tool Length Offset: Changes the offset of the current tool
 * [[Image:Path_EditToolsTable.png|32px]] Tool Manager: Edit the Tool Manager

Scripting
The Path workbench offers a broad python scripting API. With it, you can create and modify paths from python scripts, or extend the available functionality of the workbench.