CAM Adaptive: Difference between revisions

From FreeCAD Documentation
(update warning of incomplete content)
No edit summary
 
(39 intermediate revisions by 9 users not shown)
Line 2: Line 2:
<translate>
<translate>


<!--T:1-->
{{Docnav|[[Path_Drilling|Drilling]]|[[Path_Engrave|Engrave]]|[[Path_Workbench|Path]]|IconL=Path_Drilling.png|IconC=Path-Workbench.svg|IconR=Path-Engrave.png}}
{{Docnav
|[[CAM_Helix|Helix]]
|[[CAM_Slot|Slot]]
|[[CAM_Workbench|CAM]]
|IconL=CAM_Helix.svg
|IconR=CAM_Slot.svg
|IconC=Workbench_CAM.svg
}}


<!--T:2-->
{{GuiCommand|Name=Path Adaptive|Workbenches=[[Path Workbench|Path]]|MenuLocation=Path → Adaptive|Shortcut=|SeeAlso=}}
{{GuiCommand
|Name=CAM Adaptive
|MenuLocation=CAM → Adaptive
|Workbenches=[[CAM_Workbench|CAM]]
}}


==Description== <!--T:3-->
'''BE ADVISED: THIS WIKI PAGE IS NEW AND INCOMPLETE AS OF 16 JULY 2019.'''


<!--T:4-->
==Description==
The [[Image:CAM_Adaptive.svg|24px]] [[CAM_Adaptive|Adaptive]] tool uses an adaptive algorithm to create clearing and profiling paths that manage cutter engagement so that engagement and material removal never exceed a maximum value.


==Usage== <!--T:5-->
This tool creates an adaptive clearing and profiling path. The goal is to maintain a constant rate of material removal.


<!--T:6-->
==Usage==
Usage instructions for the [[CAM_Adaptive|Adaptive]] operation are presented here.


====Basic Operation==== <!--T:7-->
Usage instructions for the [[Path_Adaptive| Adaptive]] operation are presented here.


<!--T:8-->
====Basic Operation====
# Press the {{Button|[[Image:CAM_Adaptive.svg|16px]] [[CAM_Adaptive|Adaptive]]}} icon, or select the {{KEY|CAM}} → {{KEY|[[Image:CAM_Adaptive.svg|24px]] [[CAM_Adaptive|Adaptive]]}} from the top menu.

# Press the {{Button|[[Image:Path-Adaptive.svg|16px]] [[Path Adaptive|Adaptive]]}} icon, or select the [[Path Adaptive|Adaptive]] tool from the '''Path''' menu.
# Select the tool controller for the Operation from the Tool controller dialogue pop up window, if prompted.
# Select the tool controller for the Operation from the Tool controller dialogue pop up window, if prompted.
# Adjust the operation depths as needed in the Depths tab: Start Depth, Finish Depth, Step Down.
# Adjust the operation depths as needed in the Depths tab: Start Depth, Finish Depth, Step Down.
# Make adjustments in Heights tab if needed.
# Make adjustments in Heights tab if needed.
# Configure settings in the Operations tab:
# Configure settings in the Operations tab:
## ('''See the [[#Properties|Properties]] → Adaptive section below.''')
## ('''TO BE ADDED''')
## Set the Step Over value as a percentage of the diameter of the Tool.
## Set the Step Over value as a percentage of the diameter of the Tool.
# If you wish to preview the result before accepting the settings, click {{Button|Apply}}
# Click {{Button|OK}} button to confirm and generate paths.


=====Preliminary Notes About Adaptive Clearing===== <!--T:9-->
# If you wish to preview the result before accepting the settings, click Apply
# Click '''OK''' button to confirm and generate paths.


<!--T:10-->

=====Preliminary Notes About Adaptive Clearing=====
* Depending on the size and complexity of the area for the operation, is might be better to not recompute the operation after every property change; rather, consider:
* Depending on the size and complexity of the area for the operation, is might be better to not recompute the operation after every property change; rather, consider:
** deactivate the operation with the {{KEY|[[Image:Path_OpActive.svg|16px]] [[Path OpActive|Active]]}} toggle tool, make your changes to the operation's properties, then click the {{KEY|[[Image:Path_OpActive.svg|16px]] [[Path OpActive|Active]]}} icon again to re-activate the operation - which triggers a recompute internally.
** deactivate the operation with the {{KEY|[[Image:CAM_OpActiveToggle.svg|16px]] [[CAM_OpActiveToggle|Active]]}} toggle tool, make your changes to the operation's properties, then click the {{KEY|[[Image:CAM_OpActiveToggle.svg|16px]] [[CAM_OpActiveToggle|Active]]}} icon again to re-activate the operation - which triggers a recompute internally.
* The {{KEY|[[Image:Path-Adaptive.svg|16px]] [[Path Adaptive|Adaptive]]}} operation might contain a few bugs yet to be clearly identified. Please report bugs and issues in the [https://forum.freecadweb.org/viewforum.php?f=15 FreeCAD Path/CAM Forum].
* The {{KEY|[[Image:CAM_Adaptive.svg|16px]] [[CAM_Adaptive|Adaptive]]}} operation might contain a few bugs yet to be clearly identified. Please report bugs and issues in the [https://forum.freecadweb.org/viewforum.php?f=15 FreeCAD Path/CAM Forum].
* All tool shapes may not be respected with this operation. Check the FreeCAD forum for further details.
* All tool shapes may not be respected with this operation. Check the FreeCAD forum for further details.
* Should you choose to run the path simulator in the Path Workbench, it only uses the standard end mill to simulate paths. Therefore, you will not see tool-shape-specific material removal. Material removal is shown using the end mill shape.
* Should you choose to run the path simulator in the CAM Workbench, it only uses the standard end mill to simulate paths. Therefore, you will not see tool-shape-specific material removal. Material removal is shown using the end mill shape.


==Properties==
==Properties== <!--T:11-->
''' THIS SECTION IS NOT ACCURATE '''


<!--T:12-->
It needs to be updated as of 16 July 2019.
''' ''Note'' ''': The names of some Properties in this list differ a little from the same settings used in the Task Window Editor.


<!--T:13-->
The information provided was copied from the Path 3D Surface operation as a template and placeholder.
{{TitleProperty|Adaptive}}


<!--T:14-->
''' ''Note'' ''': Not all of these Properties are available in the Task Window Editor. Some are only accessible in the Data tab of the Properties View panel for this Operation.
* {{PropertyData|Force Inside-Out}}: Force plunging into material inside and clearing towards the edges
* {{PropertyData|Helix Angle}}: Helix ramp entry angle (degrees)
* {{PropertyData|Helix Cone Angle}}: Angle (degrees) of conical helix
* {{PropertyData|Helix Diameter Limit}}: Limit helix entry diameter, if limit larger than tool diameter or 0, tool diameter is used
* {{PropertyData|Keep Tool Down Ratio}}: Max length of keep tool down path compared to direct distance between points
* {{PropertyData|Lift Distance}}: Lift distance for rapid moves
* {{PropertyData|Operation Type}}: Type of adaptive operation: Clearing or Profiling
* {{PropertyData|Side}}: Side of selected faces that tool should cut: Inside or Outside
* {{PropertyData|Step Over}}: Percent of cutter diameter to step over on each pass
* {{PropertyData|Stock to Leave}}: How much stock to leave (i.e. for a separate finishing operation)
* {{PropertyData|Tolerance}}: Influences accuracy and performance
* {{PropertyData|Use Helix Arcs}}: Use Arcs (G2) for helix ramp


<!--T:15-->
====Algorithm====
{{TitleProperty|Base}}


<!--T:16-->
* {{PropertyData|Algorithm}}: The library to use to generate the path
Note: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the CAM Job model as needed.
* {{PropertyData|BoundBox}}: Should the operation be limited by the stock object or by the bounding box of the base object
* {{PropertyData|Drop Cutter Dir}}: The direction along which dropcutter lines are created
* {{PropertyData|Drop Cutter Extra Offset}}: Additional offset to the selected bounding box - use sub-properties to set values
** {{PropertyData|X}}: x distance value
** {{PropertyData|Y}}: y distance value
** {{PropertyData|Z}}: z distance value
* {{PropertyData|Layer Mode}}: The completion mode for the operation: single or multi-pass
* {{PropertyData|Scan Type}}: Planar: Flat, 3D surface scan. Rotational: 4th-axis rotational scan.

====Base====

Note: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the Path Job model as needed.


<!--T:17-->
* {{PropertyData|Placement}}: Overall placement[position and rotation] of the object - with respect to the origin (or origin of parent object container)
* {{PropertyData|Placement}}: Overall placement[position and rotation] of the object - with respect to the origin (or origin of parent object container)
** {{PropertyData|Angle}}: Angle in degrees applied to rotation of the object around Axis property value
** {{PropertyData|Angle}}: Angle in degrees applied to rotation of the object around Axis property value
** {{PropertyData|Axis}}: Axis(one or multiple) around which to rotate the object, set in sub-properties: x, y, z
** {{PropertyData|Axis}}: Axis (one or multiple) around which to rotate the object, set in sub-properties: X, Y, Z
*** {{PropertyData|X}}: x axis value
*** {{PropertyData|X}}: X axis value
*** {{PropertyData|Y}}: y axis value
*** {{PropertyData|Y}}: Y axis value
*** {{PropertyData|Z}}: z axis value
*** {{PropertyData|Z}}: Z axis value
** {{PropertyData|Position}}: Position of the object, set in sub-properties: x, y, z - with respect to the origin (or origin of parent object container)
** {{PropertyData|Position}}: Position of the object, set in sub-properties: X, Y, Z - with respect to the origin (or origin of parent object container)
*** {{PropertyData|X}}: x distance value
*** {{PropertyData|X}}: X distance value
*** {{PropertyData|Y}}: y distance value
*** {{PropertyData|Y}}: Y distance value
*** {{PropertyData|Z}}: z distance value
*** {{PropertyData|Z}}: Z distance value
* {{PropertyData|Label}}: User-provided name of the object (UTF-8)
* {{PropertyData|Label}}: User-provided name of the object (UTF-8)


<!--T:18-->
====Depth====
{{TitleProperty|Depth}}


<!--T:19-->
* {{PropertyData|Clearance Height}}: The height needed to clear clamps and obstructions
* {{PropertyData|Clearance Height}}: The height needed to clear clamps and obstructions
* {{PropertyData|Final Depth}}: Final Depth of Tool- lowest value in Z
* {{PropertyData|Final Depth}}: Final Depth of Tool- lowest value in Z
* {{PropertyData|Finish Depth}}: Maximum material removed on final pass.
* {{PropertyData|Safe Height}}: The above which Rapid motions are allowed.
* {{PropertyData|Safe Height}}: The above which Rapid motions are allowed.
* {{PropertyData|Start Depth}}: Starting Depth of Tool- first cut depth in Z
* {{PropertyData|Start Depth}}: Starting Depth of Tool- first cut depth in Z
* {{PropertyData|Step Down}}: Incremental Step Down of Tool
* {{PropertyData|Step Down}}: Incremental Step Down of Tool


<!--T:20-->
====Path====
{{TitleProperty|Path}}
* {{PropertyData|Active}}: make False, to prevent operation from generating code

<!--T:34-->
* {{PropertyData|Active}}: Make False, to prevent operation from generating code
* {{PropertyData|Comment}}: An optional comment for this Operation
* {{PropertyData|Comment}}: An optional comment for this Operation
* {{PropertyData|Cut Mode}}: The direction that the toolpath should go around the part: Climb(ClockWise) or Conventional(CounterClockWise)
* {{PropertyData|Tool Controller}}: Defines the Tool controller used in the Operation
* {{PropertyData|Tool Controller}}: Defines the Tool controller used in the Operation
* {{PropertyData|Cut Pattern}}: Clearing pattern to use
* {{PropertyData|Cutter Boundary}}: Identify cutter boundary for operation.
* {{PropertyData|User Label}}: User assigned label
* {{PropertyData|User Label}}: User assigned label


==Tasks Window Editor Layout== <!--T:21-->
====Surface====
* {{PropertyData|Depth Offset}}: Z-axis offset from the surface of the object
* {{PropertyData|Optimize}}: Enable optimization which removes unnecessary points from G-Code output
* {{PropertyData|Sample Interval}}: The Sample Interval. Small values cause long wait times
* {{PropertyData|Step Over}}: Step over percentage of the drop cutter path


<!--T:22-->
''Descriptions for these settings are provided in the Properties list above.''


<!--T:39-->
==Tasks Window Editor Layout==
''' THIS SECTION IS NOT ACCURATE '''

It needs to be updated as of 16 July 2019.

The information provided was copied from the Path 3D Surface operation as a template and placeholder.

''Descriptions for the settings are provided in the Properties list above.''
This section is simply a layout map of the settings in the window editor for the Operation.
This section is simply a layout map of the settings in the window editor for the Operation.


====Base Location====
===Base Geometry=== <!--T:23-->


<!--T:24-->
* '''Add''': adds selected element(s) which should be the base(s) for the path(s)
* '''Remove''': remove the selected item(s) in the Base Location list
* '''Add''': Adds selected element(s) which should be the base(s) for the path(s).
* '''Edit''': clear all items in the Base Location list
* '''Delete''': Delete the selected item(s) in the Base Geometry list.
* '''Clear''': Clear all items in the Base Geometry list.


====Depth====
===Depths=== <!--T:25-->


<!--T:26-->
* {{PropertyData|Start Depth}}
* {{PropertyData|Start Depth}}
* {{PropertyData|Final Depth}}
* {{PropertyData|Final Depth}}
* {{PropertyData|Finish Depth}}
* {{PropertyData|Step Down}}
* {{PropertyData|Step Down}}


====Height====
===Heights=== <!--T:27-->


<!--T:28-->
* {{PropertyData|Safe Height}}
* {{PropertyData|Safe Height}}
* {{PropertyData|Clearance Height}}
* {{PropertyData|Clearance Height}}


====Operation====
===Operation=== <!--T:29-->


<!--T:30-->
* {{PropertyData|Algorithm}}
* {{PropertyData|Tool Controller}}
* {{PropertyData|Tool Controller}}
* {{PropertyData|BoundBox}}
* {{PropertyData|Cut Region}} (Side)
* {{PropertyData|BoundBox extra offset X}}
* {{PropertyData|Operation Type}}
* {{PropertyData|BoundBox extra offset Y}}
* {{PropertyData|Step Over Percent}}
* {{PropertyData|Drop Cutter Direction}}
* {{PropertyData|Accuracy vs Performance}} (Tolerance)
* {{PropertyData|Depth Offset}}
* {{PropertyData|Helix Ramp Angle}}
* {{PropertyData|Sample Interval}}
* {{PropertyData|Helix Cone Angle}}
* {{PropertyData|Step Over}}
* {{PropertyData|Helix Max Diameter}} (Helix Diameter Limit)
* {{PropertyData|Optimize Output Enabled}}
* {{PropertyData|Lift Distance}}
* {{PropertyData|Keep Tool Down Ratio}}
* {{PropertyData|Stock to Leave}}
* {{PropertyData|Force Clearing Inside-Out}}
* {{PropertyData|Stop}}

==Known Issues== <!--T:35-->

<!--T:36-->
In case CAM Adaptive creates some unwanted paths, try with a {{PropertyData|Stock to Leave}} set to {{Value|0.001 mm}} or more. You can reduce the diameter of the tool by double that amount to keep the paths exact.

<!--T:37-->
A proposed bugfix is available (but no one is working on integrating it):

<!--T:38-->
https://github.com/FreeCAD/FreeCAD/pull/5276


==Resources==
==Resources== <!--T:31-->


<!--T:32-->
* Author's GitHub page for the original project: [https://github.com/kreso-t/FreeCAD_Mod_Adaptive_Path kreso-t/FreeCAD_Mod_Adaptive_Path]
* Author's GitHub page for the original project: [https://github.com/kreso-t/FreeCAD_Mod_Adaptive_Path kreso-t/FreeCAD_Mod_Adaptive_Path]
* Active topic in FreeCAD forums for Path Adaptive operation: [https://forum.freecadweb.org/viewtopic.php?f=15&t=30127 Adaptive Path/CAM Operation]
* Active topic in FreeCAD forums for Path Adaptive operation: [https://forum.freecadweb.org/viewtopic.php?f=15&t=30127 Adaptive Path/CAM Operation]




<!--T:33-->
{{Docnav|[[Path_Drilling|Drilling]]|[[Path_Engrave|Engrave]]|[[Path_Workbench|Path]]|IconL=Path_Drilling.png|IconC=Path-Workbench.svg|IconR=Path-Engrave.png}}
{{Docnav
|[[CAM_Helix|Helix]]
|[[CAM_Slot|Slot]]
|[[CAM_Workbench|CAM]]
|IconL=CAM_Helix.svg
|IconR=CAM_Slot.svg
|IconC=Workbench_CAM.svg
}}


</translate>
</translate>
{{CAM_Tools_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 12:19, 17 March 2024

CAM Adaptive

Menu location
CAM → Adaptive
Workbenches
CAM
Default shortcut
None
Introduced in version
-
See also
None

Description

The Adaptive tool uses an adaptive algorithm to create clearing and profiling paths that manage cutter engagement so that engagement and material removal never exceed a maximum value.

Usage

Usage instructions for the Adaptive operation are presented here.

Basic Operation

  1. Press the Adaptive icon, or select the CAM Adaptive from the top menu.
  2. Select the tool controller for the Operation from the Tool controller dialogue pop up window, if prompted.
  3. Adjust the operation depths as needed in the Depths tab: Start Depth, Finish Depth, Step Down.
  4. Make adjustments in Heights tab if needed.
  5. Configure settings in the Operations tab:
    1. (See the Properties → Adaptive section below.)
    2. Set the Step Over value as a percentage of the diameter of the Tool.
  6. If you wish to preview the result before accepting the settings, click Apply
  7. Click OK button to confirm and generate paths.
Preliminary Notes About Adaptive Clearing
  • Depending on the size and complexity of the area for the operation, is might be better to not recompute the operation after every property change; rather, consider:
    • deactivate the operation with the Active toggle tool, make your changes to the operation's properties, then click the Active icon again to re-activate the operation - which triggers a recompute internally.
  • The Adaptive operation might contain a few bugs yet to be clearly identified. Please report bugs and issues in the FreeCAD Path/CAM Forum.
  • All tool shapes may not be respected with this operation. Check the FreeCAD forum for further details.
  • Should you choose to run the path simulator in the CAM Workbench, it only uses the standard end mill to simulate paths. Therefore, you will not see tool-shape-specific material removal. Material removal is shown using the end mill shape.

Properties

Note : The names of some Properties in this list differ a little from the same settings used in the Task Window Editor.

Adaptive

  • DataForce Inside-Out: Force plunging into material inside and clearing towards the edges
  • DataHelix Angle: Helix ramp entry angle (degrees)
  • DataHelix Cone Angle: Angle (degrees) of conical helix
  • DataHelix Diameter Limit: Limit helix entry diameter, if limit larger than tool diameter or 0, tool diameter is used
  • DataKeep Tool Down Ratio: Max length of keep tool down path compared to direct distance between points
  • DataLift Distance: Lift distance for rapid moves
  • DataOperation Type: Type of adaptive operation: Clearing or Profiling
  • DataSide: Side of selected faces that tool should cut: Inside or Outside
  • DataStep Over: Percent of cutter diameter to step over on each pass
  • DataStock to Leave: How much stock to leave (i.e. for a separate finishing operation)
  • DataTolerance: Influences accuracy and performance
  • DataUse Helix Arcs: Use Arcs (G2) for helix ramp

Base

Note: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the CAM Job model as needed.

  • DataPlacement: Overall placement[position and rotation] of the object - with respect to the origin (or origin of parent object container)
    • DataAngle: Angle in degrees applied to rotation of the object around Axis property value
    • DataAxis: Axis (one or multiple) around which to rotate the object, set in sub-properties: X, Y, Z
      • DataX: X axis value
      • DataY: Y axis value
      • DataZ: Z axis value
    • DataPosition: Position of the object, set in sub-properties: X, Y, Z - with respect to the origin (or origin of parent object container)
      • DataX: X distance value
      • DataY: Y distance value
      • DataZ: Z distance value
  • DataLabel: User-provided name of the object (UTF-8)

Depth

  • DataClearance Height: The height needed to clear clamps and obstructions
  • DataFinal Depth: Final Depth of Tool- lowest value in Z
  • DataFinish Depth: Maximum material removed on final pass.
  • DataSafe Height: The above which Rapid motions are allowed.
  • DataStart Depth: Starting Depth of Tool- first cut depth in Z
  • DataStep Down: Incremental Step Down of Tool

Path

  • DataActive: Make False, to prevent operation from generating code
  • DataComment: An optional comment for this Operation
  • DataTool Controller: Defines the Tool controller used in the Operation
  • DataUser Label: User assigned label

Tasks Window Editor Layout

Descriptions for these settings are provided in the Properties list above.

This section is simply a layout map of the settings in the window editor for the Operation.

Base Geometry

  • Add: Adds selected element(s) which should be the base(s) for the path(s).
  • Delete: Delete the selected item(s) in the Base Geometry list.
  • Clear: Clear all items in the Base Geometry list.

Depths

  • DataStart Depth
  • DataFinal Depth
  • DataFinish Depth
  • DataStep Down

Heights

  • DataSafe Height
  • DataClearance Height

Operation

  • DataTool Controller
  • DataCut Region (Side)
  • DataOperation Type
  • DataStep Over Percent
  • DataAccuracy vs Performance (Tolerance)
  • DataHelix Ramp Angle
  • DataHelix Cone Angle
  • DataHelix Max Diameter (Helix Diameter Limit)
  • DataLift Distance
  • DataKeep Tool Down Ratio
  • DataStock to Leave
  • DataForce Clearing Inside-Out
  • DataStop

Known Issues

In case CAM Adaptive creates some unwanted paths, try with a DataStock to Leave set to 0.001 mm or more. You can reduce the diameter of the tool by double that amount to keep the paths exact.

A proposed bugfix is available (but no one is working on integrating it):

https://github.com/FreeCAD/FreeCAD/pull/5276

Resources