CAM Comment

CAM Comment CAM Comment

Menu location

CAM  Supplemental Commands  Comment

Workbenches

CAM

Default shortcut

None

Introduced in version

-

See also

CAM Stop, CAM Custom

Description

The CAM Comment CAM Comment command adds a Comment object to the Job. On post-processing the comment is written into the G-code program as a comment line, and can be read by people reading the file. Some machine controllers will also display comments on their display screens.

The comment is emitted as a parenthesized G-code comment, for example (Change to 6 mm end mill). Do not use a closing parenthesis inside the comment text. Post-Processors may reformat or strip comments depending on their settings.

Usage

  1. Select the CAM  Supplemental Commands  Comment option from the menu. The command is not on any toolbar and is only enabled once a Job exists in the active document. If the document contains several Jobs, a dialog asks which Job the comment is added to.

  2. The new Comment object is added to the Job’s Operations group.

  3. Write your comment in the Comment property.

Properties

Path

  • Comment (String): Comment or note for CNC program.

The Placement property is hidden.

Notes

  • Comment objects are simple G-code containers, not Operations: they have no Tool Controller, no depths and no Active property, and cannot be toggled with Toggle Operation.

Scripting

See also: FreeCAD Scripting Basics.

Example:

import FreeCAD, Path
import Path.Op.Gui.Comment
from PathScripts import PathUtils

obj = FreeCAD.ActiveDocument.addObject("Path::FeaturePython", "Comment")
Path.Op.Gui.Comment.Comment(obj)
Path.Op.Gui.Comment._ViewProviderComment(obj.ViewObject)
obj.Comment = "Start of roughing"
PathUtils.addToJob(obj)
FreeCAD.ActiveDocument.recompute()