/**
Copyright (C) 2012-2025 by Autodesk, Inc.
All rights reserved.
HAAS post processor configuration.
$Revision: 44166 e813d608ccd22fb0949f73fcdb773b434407b131 $
$Date: 2025-02-19 11:52:14 $
FORKID {11A65633-41C0-2317-AD33-7E4AF333EDEB}
*/
// >>>>> INCLUDED FROM generic_posts/haas.cps
description = "HAAS (pre-NGC)";
vendor = "Haas Automation";
vendorUrl = "https://www.haascnc.com";
legal = "Copyright (C) 2012-2025 by Autodesk, Inc.";
certificationLevel = 2;
minimumRevision = 45917;
longDescription = "Generic post for use with all common HAAS mills like the DM, VF, Office Mill, and Mini Mill series. This post is for the pre-Next Generation Control. By default positioning moves will be output as high feed G1s instead of G0s. You can turn on the property 'useG0' to force G0s but be careful as the CNC will follow a dogleg path rather than a direct path.";
extension = "nc";
programNameIsInteger = true;
setCodePage("ascii");
capabilities = CAPABILITY_MILLING | CAPABILITY_MACHINE_SIMULATION;
tolerance = spatial(0.002, MM);
minimumChordLength = spatial(0.25, MM);
minimumCircularRadius = spatial(0.01, MM);
maximumCircularRadius = spatial(1000, MM);
minimumCircularSweep = toRad(0.01);
maximumCircularSweep = toRad(355);
allowHelicalMoves = true;
allowedCircularPlanes = undefined; // allow any circular motion
allowSpiralMoves = true;
allowFeedPerRevolutionDrilling = true;
highFeedrate = (unit == MM) ? 5000 : 500;
probeMultipleFeatures = true;
// user-defined properties
properties = {
writeVersion: {
title : "Write version",
description: "Write the version number in the header of the code.",
group : "formats",
type : "boolean",
value : false,
scope : "post"
},
useTiltedWorkplane: {
title : "Use DWO",
description: "Specifies that the Dynamic Work Offset feature (G254/G255) should be used.",
group : "multiAxis",
type : "boolean",
value : false,
scope : "post"
},
preloadTool: {
title : "Preload tool",
description: "Preloads the next tool at a tool change (if any).",
group : "preferences",
type : "boolean",
value : true,
scope : "post"
},
gotChipConveyor: {
title : "Use chip transport",
description: "Enable to turn on chip transport at start of program.",
group : "configuration",
type : "boolean",
value : false,
scope : "post"
},
optionalStop: {
title : "Optional stop",
description: "Specifies that optional stops M1 should be output at tool changes.",
group : "preferences",
type : "boolean",
value : true,
scope : "post"
},
separateWordsWithSpace: {
title : "Separate words with space",
description: "Adds spaces between words if 'yes' is selected.",
group : "formats",
type : "boolean",
value : true,
scope : "post"
},
useRadius: {
title : "Radius arcs",
description: "If yes is selected, arcs are output using radius values rather than IJK.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
},
useG0: {
title : "Use G0",
description: "Specifies that G0s should be used for rapid moves when moving along a single axis.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
},
safePositionMethod: {
title : "Safe Retracts",
description: "Select your desired retract option. 'Clearance Height' retracts to the operation clearance height.",
group : "homePositions",
type : "enum",
values : [
{title:"G28", id:"G28"},
{title:"G53", id:"G53"},
{title:"Clearance Height", id:"clearanceHeight"}
],
value: "G53",
scope: "post"
},
useSmoothing: {
title : "Use G187",
description: "G187 smoothing mode.",
group : "preferences",
type : "enum",
values : [
{title:"Off", id:"-1"},
{title:"Automatic", id:"9999"},
{title:"Rough", id:"1"},
{title:"Medium", id:"2"},
{title:"Finish", id:"3"}
],
value: "-1",
scope: "post"
},
homePositionCenter: {
title : "Home position center",
description: "Enable to center the part along X at the end of program for easy access. Requires a CNC with a moving table.",
group : "homePositions",
type : "boolean",
value : true,
scope : "post"
},
optionallyCycleToolsAtStart: {
title : "Optionally cycle tools at start",
description: "Cycle through each tool used at the beginning of the program when block delete is turned off.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
},
measureTools: {
title : "Optionally measure tools at start",
description: "Measure each tool used at the beginning of the program when block delete is turned off.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
},
forceHomeOnIndexing: {
title : "Force XY home position on indexing",
description: "Move XY to their home positions on multi-axis indexing.",
group : "homePositions",
type : "boolean",
value : false,
scope : "post"
},
toolBreakageTolerance: {
title : "Tool breakage tolerance",
description: "Specifies the tolerance for which tool break detection will raise an alarm.",
group : "preferences",
type : "spatial",
value : 0.1,
scope : "post"
},
safeStartAllOperations: {
title : "Safe start all operations",
description: "Write optional blocks at the beginning of all operations that include all commands to start program.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
},
fastToolChange: {
title : "Fast tool change",
description: "Skip spindle off, coolant off, and Z retract to make tool change quicker.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
},
useG95forTapping: {
title : "Use G95 for tapping",
description: "use IPR/MPR instead of IPM/MPM for tapping",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
},
useG73Retract: {
title : "G73 cycles include accumulated depth",
description: "Use G73 Q K format for accumulated depth support.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
},
setting34: {
title : "Feed rate calculation diameter",
description: "Defines the part diameter in inches that the control uses to calculate feed rates (Setting 34).",
group : "multiAxis",
type : "spatial",
range : [0.1, 9999],
value : 1,
scope : "post"
},
showSequenceNumbers: {
title : "Use sequence numbers",
description: "'Yes' outputs sequence numbers on each block, 'Only on tool change' outputs sequence numbers on tool change blocks only, and 'No' disables the output of sequence numbers.",
group : "formats",
type : "enum",
values : [
{title:"Yes", id:"true"},
{title:"No", id:"false"},
{title:"Only on tool change", id:"toolChange"}
],
value: "true",
scope: "post"
},
sequenceNumberStart: {
title : "Start sequence number",
description: "The number at which to start the sequence numbers.",
group : "formats",
type : "integer",
value : 10,
scope : "post"
},
sequenceNumberIncrement: {
title : "Sequence number increment",
description: "The amount by which the sequence number is incremented by in each block.",
group : "formats",
type : "integer",
value : 5,
scope : "post"
},
showNotes: {
title : "Show notes",
description: "Enable to output notes for operations.",
group : "formats",
type : "boolean",
value : false,
scope : "post"
},
singleResultsFile: {
title : "Create single results file",
description: "Set to false if you want to store the measurement results for each probe / inspection toolpath in a separate file",
group : "probing",
type : "boolean",
value : true,
scope : "post"
},
useClampCodes: {
title : "Use clamp codes",
description: "Specifies whether clamp codes for rotary axes should be output. For simultaneous toolpaths rotary axes will always get unclamped.",
group : "multiAxis",
type : "boolean",
value : true,
scope : "post"
},
usePeckTapping: {
title : "Use Peck for tapping",
description: "Software version 100.23.000.1201 now supports Q-peck parameter for peck tapping cycles.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
}
};
// wcs definiton
wcsDefinitions = {
useZeroOffset: false,
wcs : [
{name:"Standard", format:"G", range:[54, 59]},
{name:"Extended", format:"G154 P", range:[1, 99]}
]
};
// old machines only support 4 digits
var oFormat = createFormat({minDigitsLeft:5, decimals:0});
var nFormat = createFormat({decimals:0});
var gFormat = createFormat({prefix:"G", decimals:0});
var mFormat = createFormat({prefix:"M", decimals:0});
var hFormat = createFormat({prefix:"H", decimals:0});
var diameterOffsetFormat = createFormat({prefix:"D", decimals:0});
var probeWCSFormat = createFormat({prefix:"S", decimals:0, type:FORMAT_REAL});
var probeExtWCSFormat = createFormat({prefix:"S154.", minDigitsLeft:2, decimals:0});
var xyzFormat = createFormat({decimals:(unit == MM ? 3 : 4), type:FORMAT_REAL});
var rFormat = xyzFormat; // radius
var abcFormat = createFormat({decimals:3, type:FORMAT_REAL, scale:DEG});
var feedFormat = createFormat({decimals:(unit == MM ? 2 : 3), type:FORMAT_REAL});
var feedPerRevFormat = createFormat({decimals:(unit == MM ? 3 : 4), type:FORMAT_REAL});
var inverseTimeFormat = createFormat({decimals:3, type:FORMAT_REAL});
var pitchFormat = createFormat({decimals:(unit == MM ? 3 : 4), type:FORMAT_REAL});
var toolFormat = createFormat({decimals:0});
var rpmFormat = createFormat({decimals:0});
var secFormat = createFormat({decimals:3, type:FORMAT_REAL}); // seconds - range 0.001-1000
var milliFormat = createFormat({decimals:0}); // milliseconds // range 1-9999
var taperFormat = createFormat({decimals:1, scale:DEG});
var peckFormat = createFormat({decimals:(unit == MM ? 3 : 4), type:FORMAT_REAL});
var xOutput = createOutputVariable({onchange:function() {state.retractedX = false;}, prefix:"X"}, xyzFormat);
var yOutput = createOutputVariable({onchange:function() {state.retractedY = false;}, prefix:"Y"}, xyzFormat);
var zOutput = createOutputVariable({onchange:function() {state.retractedZ = false;}, prefix:"Z"}, xyzFormat);
var aOutput = createOutputVariable({prefix:"A"}, abcFormat);
var bOutput = createOutputVariable({prefix:"B"}, abcFormat);
var cOutput = createOutputVariable({prefix:"C"}, abcFormat);
var feedOutput = createOutputVariable({prefix:"F"}, feedFormat);
var inverseTimeOutput = createOutputVariable({prefix:"F", control:CONTROL_FORCE}, inverseTimeFormat);
var pitchOutput = createOutputVariable({prefix:"F", control:CONTROL_FORCE}, pitchFormat);
var sOutput = createOutputVariable({prefix:"S", control:CONTROL_FORCE}, rpmFormat);
var peckOutput = createVariable({prefix:"Q", force:true}, peckFormat);
// circular output
var iOutput = createOutputVariable({prefix:"I", control:CONTROL_FORCE}, xyzFormat);
var jOutput = createOutputVariable({prefix:"J", control:CONTROL_FORCE}, xyzFormat);
var kOutput = createOutputVariable({prefix:"K", control:CONTROL_FORCE}, xyzFormat);
var gMotionModal = createOutputVariable({onchange:function() {if (skipBlocks) {forceModals(gMotionModal);}}}, gFormat); // modal group 1 // G0-G3, ...
var gPlaneModal = createOutputVariable({onchange:function() {if (skipBlocks) {forceModals(gPlaneModal);} forceModals(gMotionModal);}}, gFormat); // modal group 2 // G17-19
var gAbsIncModal = createOutputVariable({onchange:function() {if (skipBlocks) {forceModals(gAbsIncModal);}}}, gFormat); // modal group 3 // G90-91
var gFeedModeModal = createOutputVariable({}, gFormat); // modal group 5 // G93-94
var gUnitModal = createOutputVariable({}, gFormat); // modal group 6 // G20-21
var gCycleModal = createOutputVariable({}, gFormat); // modal group 9 // G81, ...
var gRetractModal = createOutputVariable({control:CONTROL_FORCE}, gFormat); // modal group 10 // G98-99
var gWorkplaneModal = createOutputVariable({onchange:function() {state.twpIsActive = gWorkplaneModal.getCurrent() == 254;}}, gFormat); // G254-G255
var gRotationModal = createOutputVariable({
onchange: function () {
if (probeVariables.probeAngleMethod == "G68") {
probeVariables.outputRotationCodes = true;
}
}
}, gFormat); // modal group 16 // G68-G69
var fourthAxisClamp = createOutputVariable({}, mFormat);
var fifthAxisClamp = createOutputVariable({}, mFormat);
var skipBlocks = false;
var settings = {
coolant: {
// samples:
// {id: COOLANT_THROUGH_TOOL, on: 88, off: 89}
// {id: COOLANT_THROUGH_TOOL, on: [8, 88], off: [9, 89]}
// {id: COOLANT_THROUGH_TOOL, on: "M88 P3 (myComment)", off: "M89"}
coolants: [
{id:COOLANT_FLOOD, on:8},
{id:COOLANT_MIST},
{id:COOLANT_THROUGH_TOOL, on:88, off:89},
{id:COOLANT_AIR, on:83, off:84},
{id:COOLANT_AIR_THROUGH_TOOL, on:73, off:74},
{id:COOLANT_SUCTION},
{id:COOLANT_FLOOD_MIST},
{id:COOLANT_FLOOD_THROUGH_TOOL, on:[88, 8], off:[89, 9]},
{id:COOLANT_OFF, off:9}
],
singleLineCoolant: false, // specifies to output multiple coolant codes in one line rather than in separate lines
},
smoothing: {
roughing : 1, // roughing level for smoothing in automatic mode
semi : 2, // semi-roughing level for smoothing in automatic mode
semifinishing : 2, // semi-finishing level for smoothing in automatic mode
finishing : 3, // finishing level for smoothing in automatic mode
thresholdRoughing : toPreciseUnit(0.5, MM), // operations with stock/tolerance above that threshold will use roughing level in automatic mode
thresholdFinishing : toPreciseUnit(0.05, MM), // operations with stock/tolerance below that threshold will use finishing level in automatic mode
thresholdSemiFinishing: toPreciseUnit(0.1, MM), // operations with stock/tolerance above finishing and below threshold roughing that threshold will use semi finishing level in automatic mode
differenceCriteria: "level", // options: "level", "tolerance", "both". Specifies criteria when output smoothing codes
autoLevelCriteria : "stock", // use "stock" or "tolerance" to determine levels in automatic mode
cancelCompensation: false // tool length compensation must be canceled prior to changing the smoothing level
},
retract: {
cancelRotationOnRetracting: true, // specifies that rotations (G68) need to be canceled prior to retracting
methodXY : "G53", // special condition, overwrite retract behavior per axis
methodZ : undefined, // special condition, overwrite retract behavior per axis
useZeroValues : ["G28", "G30"], // enter property value id(s) for using "0" value instead of machineConfiguration axes home position values (ie G30 Z0)
homeXY : {onIndexing:false, onToolChange:false, onProgramEnd:{axes:[X, Y]}} // Specifies when the machine should be homed in X/Y. Sample: onIndexing:{axes:[X, Y], singleLine:false}
},
parametricFeeds: {
firstFeedParameter : 100, // specifies the initial parameter number to be used for parametric feedrate output
feedAssignmentVariable: "#", // specifies the syntax to define a parameter
feedOutputVariable : "F#" // specifies the syntax to output the feedrate as parameter
},
unwind: {
method : 1, // 1 (move to closest 0 (G28)) or 2 (table does not move (G92))
codes : [gFormat.format(28), gAbsIncModal.format(91)], // formatted code(s) that will (virtually) unwind axis (G90 G28), (G92), etc.
workOffsetCode: "", // prefix for workoffset number if it is required to be output
useAngle : "true", // 'true' outputs angle with standard output variable, 'prefix' uses 'anglePrefix', 'false' does not output angle
anglePrefix : [], // optional prefixes for output angles specified as ["", "", "C"], use blank string if axis does not unwind
resetG90 : true // set to 'true' if G90 needs to be output after the unwind block
},
machineAngles: { // refer to https://cam.autodesk.com/posts/reference/classMachineConfiguration.html#a14bcc7550639c482492b4ad05b1580c8
controllingAxis: ABC,
type : PREFER_PREFERENCE,
options : ENABLE_ALL
},
workPlaneMethod: {
useTiltedWorkplane : false, // specifies that tilted workplanes should be used (ie. G68.2, G254, PLANE SPATIAL, CYCLE800), can be overwritten by property
eulerConvention : undefined, // specifies the euler convention (ie EULER_XYZ_R), set to undefined to use machine angles for TWP commands ('undefined' requires machine configuration)
eulerCalculationMethod: "standard", // ('standard' / 'machine') 'machine' adjusts euler angles to match the machines ABC orientation, machine configuration required
cancelTiltFirst : true, // cancel tilted workplane prior to WCS (G54-G59) blocks
forceMultiAxisIndexing: false, // force multi-axis indexing for 3D programs
optimizeType : undefined // can be set to OPTIMIZE_NONE, OPTIMIZE_BOTH, OPTIMIZE_TABLES, OPTIMIZE_HEADS, OPTIMIZE_AXIS. 'undefined' uses legacy rotations
},
subprograms: {
initialSubprogramNumber: 90000, // specifies the initial number to be used for subprograms. 'undefined' uses the main program number
minimumCyclePoints : 5, // minimum number of points in cycle operation to consider for subprogram
format : oFormat, // the format to use for the subprogam number format
// objects below also accept strings with "%currentSubprogram" as placeholder. Sample: {files:["%"], embedded:"N" + "%currentSubprogram"}
files : {extension:extension, prefix:undefined}, // specifies the subprogram file extension and the prefix to use for the generated file
startBlock : {files:["%" + EOL + "O"], embedded:["N"]}, // specifies the start syntax of a subprogram followed by the subprogram number
endBlock : {files:[mFormat.format(99) + EOL + "%"], embedded:[mFormat.format(99)]}, // specifies the command to for the end of a subprogram
callBlock : {files:[mFormat.format(98) + " P"], embedded:[mFormat.format(97) + " P"]} // specifies the command for calling a subprogram followed by the subprogram number
},
comments: {
permittedCommentChars: " abcdefghijklmnopqrstuvwxyz0123456789.,=_-+:/'*#\"[]<>{}!@$|~^&?;%", // letters are not case sensitive, use option 'outputFormat' below. Set to 'undefined' to allow any character
prefix : "(", // specifies the prefix for the comment
suffix : ")", // specifies the suffix for the comment
outputFormat : "ignoreCase", // can be set to "upperCase", "lowerCase" and "ignoreCase". Set to "ignoreCase" to write comments without upper/lower case formatting
maximumLineLength : 80 // the maximum number of characters allowed in a line, set to 0 to disable comment output
},
probing: {
macroCall : gFormat.format(65), // specifies the command to call a macro
probeAngleMethod : undefined, // supported options are: OFF, AXIS_ROT, G68, G54.4. 'undefined' uses automatic selection
probeAngleVariables : {x:"#185", y:"#186", r:"#194", baseParamG54x4:26000, baseParamAxisRot:5200, method:1}, // specifies variables for the angle compensation macros, method 0 = Fanuc, 1 = Haas
allowIndexingWCSProbing: false // specifies that probe WCS with tool orientation is supported
},
maximumSequenceNumber: 99999, // the maximum sequence number (Nxxx), use 'undefined' for unlimited
programNumber : {min:1, max:99999, reserved:[9010, 9019]} // specifies the program number range and reserved numbers
};
// fixed settings
var forceResetWorkPlane = false; // enable to force reset of machine ABC on new orientation
// collected state
var maximumCircularRadiiDifference = toPreciseUnit(0.005, MM);
var measureTool = false;
var homePositionCenter = false;
var toolChecked = false; // specifies that the tool has been checked with the probe
/**
Returns the matching HAAS tool type for the tool.
*/
function getHaasToolType(toolType) {
switch (toolType) {
case TOOL_DRILL:
case TOOL_REAMER:
return 1; // drill
case TOOL_TAP_RIGHT_HAND:
case TOOL_TAP_LEFT_HAND:
return 2; // tap
case TOOL_MILLING_FACE:
case TOOL_MILLING_SLOT:
case TOOL_BORING_BAR:
return 3; // shell mill
case TOOL_MILLING_END_FLAT:
case TOOL_MILLING_END_BULLNOSE:
case TOOL_MILLING_TAPERED:
case TOOL_MILLING_DOVETAIL:
case TOOL_MILLING_RADIUS:
return 4; // end mill
case TOOL_DRILL_SPOT:
case TOOL_MILLING_CHAMFER:
case TOOL_DRILL_CENTER:
case TOOL_COUNTER_SINK:
case TOOL_COUNTER_BORE:
case TOOL_MILLING_THREAD:
case TOOL_MILLING_FORM:
return 5; // center drill
case TOOL_MILLING_END_BALL:
case TOOL_MILLING_LOLLIPOP:
return 6; // ball nose
case TOOL_PROBE:
return 7; // probe
default:
error(localize("Invalid HAAS tool type."));
return -1;
}
}
function getHaasProbingType(toolType, use9023) {
switch (getHaasToolType(toolType)) {
case 3:
case 4:
return (use9023 ? 23 : 1); // rotate
case 1:
case 2:
case 5:
case 6:
case 7:
return (use9023 ? 12 : 2); // non rotate
case 0:
return (use9023 ? 13 : 3); // rotate length and dia
default:
error(localize("Invalid HAAS tool type."));
return -1;
}
}
function writeToolCycleBlock(tool) {
writeBlock("T" + toolFormat.format(tool.number), mFormat.format(6)); // get tool
writeBlock(mFormat.format(0)); // wait for operator
}
function prepareForToolCheck() {
onCommand(COMMAND_STOP_SPINDLE);
onCommand(COMMAND_COOLANT_OFF);
// cancel TCP so that tool doesn't follow tables
disableLengthCompensation(false, "TCPC OFF");
if (getCurrentDirection().length != 0) {
setWorkPlane(new Vector(0, 0, 0));
forceWorkPlane();
}
}
function writeToolMeasureBlock(tool, preMeasure) {
var comment = measureTool ? formatComment("MEASURE TOOL") : "";
if (!preMeasure) {
prepareForToolCheck();
}
if (true) { // use Macro P9023 to measure tools
var probingType = getHaasProbingType(tool.type, true);
writeBlock(
gFormat.format(65),
"P9023",
"A" + probingType + ".",
"T" + toolFormat.format(tool.number),
conditional((probingType != 12), "H" + xyzFormat.format(getBodyLength(tool))),
conditional((probingType != 12), "D" + xyzFormat.format(tool.diameter)),
comment
);
} else { // use Macro P9995 to measure tools
writeBlock("T" + toolFormat.format(tool.number), mFormat.format(6)); // get tool
writeBlock(
gFormat.format(65),
"P9995",
"A0.",
"B" + getHaasToolType(tool.type) + ".",
"C" + getHaasProbingType(tool.type, false) + ".",
"T" + toolFormat.format(tool.number),
"E" + xyzFormat.format(getBodyLength(tool)),
"D" + xyzFormat.format(tool.diameter),
"K" + xyzFormat.format(0.1),
"I0.",
comment
); // probe tool
}
measureTool = false;
}
function defineMachine() {
var useTCP = false;
if (false) { // note: setup your machine here
// using 0 instead of -35 to avoid rewind issues
var bAxis = createAxis({coordinate:1, table:true, axis:[0, 1, 0], range:[0 - 0.0001, 110 + 0.0001], preference:1, reset:1, tcp:true});
var cAxis = createAxis({coordinate:2, table:true, axis:[0, 0, 1], cyclic:false, range:[-13320, 13320], preference:0, reset:1, tcp:true});
machineConfiguration = new MachineConfiguration(bAxis, cAxis);
setMachineConfiguration(machineConfiguration);
if (receivedMachineConfiguration) {
warning(localize("The provided CAM machine configuration is overwritten by the postprocessor."));
receivedMachineConfiguration = false; // CAM provided machine configuration is overwritten
}
}
if (!receivedMachineConfiguration) {
// multiaxis settings
if (machineConfiguration.isHeadConfiguration()) {
machineConfiguration.setVirtualTooltip(false); // translate the pivot point to the virtual tool tip for nonTCP rotary heads
}
// retract / reconfigure
var performRewinds = false; // set to true to enable the rewind/reconfigure logic
if (performRewinds) {
machineConfiguration.enableMachineRewinds(); // enables the retract/reconfigure logic
safeRetractDistance = (unit == IN) ? 1 : 25; // additional distance to retract out of stock, can be overridden with a property
safeRetractFeed = (unit == IN) ? 20 : 500; // retract feed rate
safePlungeFeed = (unit == IN) ? 10 : 250; // plunge feed rate
machineConfiguration.setSafeRetractDistance(safeRetractDistance);
machineConfiguration.setSafeRetractFeedrate(safeRetractFeed);
machineConfiguration.setSafePlungeFeedrate(safePlungeFeed);
var stockExpansion = new Vector(toPreciseUnit(0.1, IN), toPreciseUnit(0.1, IN), toPreciseUnit(0.1, IN)); // expand stock XYZ values
machineConfiguration.setRewindStockExpansion(stockExpansion);
}
// multi-axis feedrates
if (machineConfiguration.isMultiAxisConfiguration()) {
var useDPMFeeds = false;
machineConfiguration.setMultiAxisFeedrate(
useTCP ? FEED_FPM : useDPMFeeds ? FEED_FPM : FEED_INVERSE_TIME,
9999.99, // maximum output value for inverse time feed rates
useDPMFeeds ? DPM_COMBINATION : INVERSE_MINUTES, // INVERSE_MINUTES/INVERSE_SECONDS or DPM_COMBINATION/DPM_STANDARD
0.5, // tolerance to determine when the DPM feed has changed
1.0 // ratio of rotary accuracy to linear accuracy for DPM calculations
);
setMachineConfiguration(machineConfiguration);
}
/* home positions */
// machineConfiguration.setHomePositionX(toPreciseUnit(-29.0, IN));
// machineConfiguration.setHomePositionY(toPreciseUnit(-8, IN));
// machineConfiguration.setRetractPlane(toPreciseUnit(2.5, IN));
}
}
function onOpen() {
receivedMachineConfiguration = machineConfiguration.isReceived();
if (typeof defineMachine == "function") {
defineMachine(); // hardcoded machine configuration
}
activateMachine(); // enable the machine optimizations and settings
if (getProperty("useRadius")) {
maximumCircularSweep = toRad(90); // avoid potential center calculation errors for CNC
}
if (getProperty("forceHomeOnIndexing")) {
settings.retract.homeXY.onIndexing = {axes:[X, Y], singleLine:true};
}
if (settings.workPlaneMethod.useTiltedWorkplane) {
validate(getSetting("workPlaneMethod.useABCPrepositioning", true), localize("Setting 'useABCPrepositioning' must be enabled when 'useTiltedWorkplane' is enabled."));
validate(settings.workPlaneMethod.eulerConvention == undefined, localize("This post processor does not support EULER angles."));
}
if (getProperty("useLiveConnection")) {
if (getProperty("showSequenceNumbers")) {
warning(localize("'Use sequence numbers' is switched off due to live connection."));
}
setProperty("showSequenceNumbers", "false");
}
gWorkplaneModal.format(255); // Default to G255 DWO off
gRotationModal.format(69); // Default to G69 Rotation Off
fourthAxisClamp.format(10); // Default 4th axis modal code to be clamped
fifthAxisClamp.format(12); // Default 5th axis modal code to be clamped
if (highFeedrate <= 0) {
error(localize("You must set 'highFeedrate' because axes are not synchronized for rapid traversal."));
return;
}
if (!getProperty("separateWordsWithSpace")) {
setWordSeparator("");
}
writeln("%");
writeln("O" + oFormat.format(getProgramNumber()) + conditional(programComment, " " + formatComment(programComment)));
if (getProperty("useG0")) {
writeComment(localize("Using G0 which travels along dogleg path."));
} else {
writeComment(subst(localize("Using high feed G1 F%1 instead of G0."), feedFormat.format(highFeedrate)));
}
if (getProperty("writeVersion")) {
if ((typeof getHeaderVersion == "function") && getHeaderVersion()) {
writeComment(localize("post version") + ": " + getHeaderVersion());
}
if ((typeof getHeaderDate == "function") && getHeaderDate()) {
writeComment(localize("post modified") + ": " + getHeaderDate());
}
}
writeProgramHeader();
if (getProperty("optionallyCycleToolsAtStart") || getProperty("measureTools")) {
cycleToolsAtStart(); // optionally cycle through all tools
}
// absolute coordinates and feed per min
writeBlock(gAbsIncModal.format(90), gPlaneModal.format(17));
gFeedModeModal.format(94); // G94 is an option on pre-NGC controls and can generate an error
writeBlock(gUnitModal.format(unit == MM ? 21 : 20));
if (getProperty("gotChipConveyor")) {
onCommand(COMMAND_START_CHIP_TRANSPORT);
}
if (typeof inspectionWriteVariables == "function") {
inspectionWriteVariables();
}
if (getProperty("useLiveConnection") && (typeof liveConnectionHeader == "function")) {
liveConnectionHeader();
}
validateCommonParameters();
}
function cycleToolsAtStart() {
var tools = getToolTable();
optionalSection = true;
if (tools.getNumberOfTools() > 0) {
writeln("");
writeBlock(mFormat.format(0), formatComment(localize("Read note"))); // wait for operator
writeComment(localize("With BLOCK DELETE turned off each tool will cycle through"));
writeComment(localize("the spindle to verify that the correct tool is in the tool magazine"));
if (getProperty("measureTools")) {
writeComment(localize("and to automatically measure it"));
}
writeComment(localize("Once the tools are verified turn BLOCK DELETE on to skip verification"));
if (getProperty("toolArmDrive") && getProperty("measureTools")) {
writeBlock(mProbeArmModal.format(104), formatComment("Extend tool setting probe arm"));
}
for (var i = 0; i < tools.getNumberOfTools(); ++i) {
var tool = tools.getTool(i);
if (getProperty("measureTools") && (tool.type == TOOL_PROBE)) {
continue;
}
var comment = "T" + toolFormat.format(tool.number) + " " +
"D=" + xyzFormat.format(tool.diameter) + " " +
localize("CR") + "=" + xyzFormat.format(tool.cornerRadius);
if ((tool.taperAngle > 0) && (tool.taperAngle < Math.PI)) {
comment += " " + localize("TAPER") + "=" + taperFormat.format(tool.taperAngle) + localize("deg");
}
comment += " - " + getToolTypeName(tool.type);
writeComment(comment);
if (getProperty("measureTools")) {
writeToolMeasureBlock(tool, true);
} else {
writeToolCycleBlock(tool);
}
}
}
if (getProperty("toolArmDrive") && getProperty("measureTools")) {
writeBlock(mProbeArmModal.format(105), formatComment("Retract tool setting probe arm"));
}
optionalSection = false;
writeln("");
}
/** Disables length compensation if currently active or if forced. */
function disableLengthCompensation(force, message) {
if (state.tcpIsActive || force) {
if (state.lengthCompensationActive || force) {
writeBlock(toolLengthCompOutput.format(49), conditional(message, formatComment(message)));
}
}
}
function setSmoothing(mode) {
smoothingSettings = settings.smoothing;
if (mode == smoothing.isActive && (!mode || !smoothing.isDifferent) && !smoothing.force) {
return; // return if smoothing is already active or is not different
}
if (validateLengthCompensation && smoothingSettings.cancelCompensation) {
validate(!state.lengthCompensationActive, "Length compensation is active while trying to update smoothing.");
}
if (mode) { // enable smoothing
writeBlock(
gFormat.format(187),
"P" + smoothing.level,
conditional((smoothingSettings.differenceCriteria != "level"), "E" + xyzFormat.format(smoothing.tolerance))
);
} else { // disable smoothing
writeBlock(gFormat.format(187));
}
smoothing.isActive = mode;
smoothing.force = false;
smoothing.isDifferent = false;
}
function onSection() {
var forceSectionRestart = optionalSection && !currentSection.isOptional();
optionalSection = currentSection.isOptional();
var insertToolCall = isToolChangeNeeded() || forceSectionRestart;
var newWorkOffset = isNewWorkOffset() || forceSectionRestart;
var newWorkPlane = isNewWorkPlane() || forceSectionRestart;
operationNeedsSafeStart = getProperty("safeStartAllOperations") && !isFirstSection();
initializeSmoothing(); // initialize smoothing mode
if (insertToolCall || operationNeedsSafeStart) {
if (getProperty("fastToolChange") && !isProbeOperation()) {
currentCoolantMode = COOLANT_OFF;
} else if (insertToolCall) { // no coolant off command if safe start operation
onCommand(COMMAND_COOLANT_OFF);
}
}
// toolpath starting information for live connection
if (getProperty("useLiveConnection") && (typeof liveConnectionWriteData == "function")) {
liveConnectionWriteData("toolpathStart");
}
if ((insertToolCall && !getProperty("fastToolChange")) || newWorkOffset || newWorkPlane || toolChecked || state.tcpIsActive) {
// stop spindle before retract during tool change
if (insertToolCall && !isFirstSection() && !toolChecked && !getProperty("fastToolChange")) {
onCommand(COMMAND_STOP_SPINDLE);
}
if (state.tcpIsActive) {
disableLengthCompensation(false, "TCPC OFF");
}
writeRetract(Z); // retract to safe plane
if (forceResetWorkPlane && newWorkPlane) {
forceWorkPlane();
setWorkPlane(new Vector(0, 0, 0)); // reset working plane
}
}
writeln("");
writeComment(getParameter("operation-comment", ""));
if (getProperty("showNotes")) {
writeSectionNotes();
}
// tool change
writeToolCall(tool, insertToolCall);
if (gFeedModeModal.getCurrent() == 94) {
gFeedModeModal.format(94); // re-apply G94 to avoid undesired output for pre-NGC controls
}
// activate those two coolant modes before the spindle is turned on
if ((tool.coolant == COOLANT_THROUGH_TOOL) || (tool.coolant == COOLANT_AIR_THROUGH_TOOL) || (tool.coolant == COOLANT_FLOOD_THROUGH_TOOL)) {
if (!isFirstSection() && !insertToolCall && (currentCoolantMode != tool.coolant)) {
onCommand(COMMAND_STOP_SPINDLE);
forceSpindleSpeed = true;
}
setCoolant(tool.coolant);
} else if ((currentCoolantMode == COOLANT_THROUGH_TOOL) || (currentCoolantMode == COOLANT_AIR_THROUGH_TOOL) || (currentCoolantMode == COOLANT_FLOOD_THROUGH_TOOL)) {
onCommand(COMMAND_STOP_SPINDLE);
setCoolant(COOLANT_OFF);
forceSpindleSpeed = true;
}
if (toolChecked) {
forceSpindleSpeed = true; // spindle must be restarted if tool is checked without a tool change
toolChecked = false; // state of tool is not known at the beginning of a section since it could be broken for the previous section
}
startSpindle(tool, insertToolCall);
// write parametric feedrate table
if (typeof initializeParametricFeeds == "function") {
initializeParametricFeeds(insertToolCall);
}
// Output modal commands here
writeBlock(gPlaneModal.format(17), gAbsIncModal.format(90), gFeedModeModal.format(94));
// set wcs
var wcsIsRequired = true;
if (insertToolCall || operationNeedsSafeStart) {
currentWorkOffset = undefined; // force work offset when changing tool
wcsIsRequired = newWorkOffset || insertToolCall || !operationNeedsSafeStart;
}
writeWCS(currentSection, wcsIsRequired);
var abc = defineWorkPlane(currentSection, true);
setProbeAngle(); // output probe angle rotations if required
setCoolant(tool.coolant); // writes the required coolant codes
smoothing.force = operationNeedsSafeStart && (getProperty("useSmoothing") != "-1");
setSmoothing(smoothing.isAllowed);
// prepositioning
var initialPosition = isPolarModeActive() ? getCurrentPosition() : getFramePosition(currentSection.getInitialPosition());
var isRequired = insertToolCall || state.retractedZ || !state.lengthCompensationActive || (!isFirstSection() && getPreviousSection().isMultiAxis());
writeInitialPositioning(initialPosition, isRequired);
writeStartBlocks(insertToolCall, function () {
var preloadTool = getNextTool(tool.number != getFirstTool().number);
if (getProperty("preloadTool") && preloadTool) {
writeBlock("T" + toolFormat.format(preloadTool.number)); // preload next/first tool
}
});
if (isProbeOperation()) {
validate(probeVariables.probeAngleMethod != "G68", "You cannot probe while G68 Rotation is in effect.");
validate(probeVariables.probeAngleMethod != "G54.4", "You cannot probe while workpiece setting error compensation G54.4 is enabled.");
writeBlock(gFormat.format(65), "P" + 9832); // spin the probe on
inspectionCreateResultsFileHeader();
} else {
if (isInspectionOperation() && (typeof inspectionProcessSectionStart == "function")) {
inspectionProcessSectionStart();
}
}
if (subprogramsAreSupported()) {
subprogramDefine(initialPosition, abc); // define subprogram
}
}
var toolLengthCompOutput = createOutputVariable({control : CONTROL_FORCE,
onchange: function() {
state.tcpIsActive = toolLengthCompOutput.getCurrent() == 234;
state.lengthCompensationActive = toolLengthCompOutput.getCurrent() != 49;
}
}, gFormat);
function getOffsetCode() {
if (!getSetting("outputToolLengthCompensation", true) && toolLengthCompOutput.isEnabled()) {
state.lengthCompensationActive = true; // always assume that length compensation is active
toolLengthCompOutput.disable();
}
var offsetCode = 43;
if (tcp.isSupportedByOperation) {
offsetCode = 234;
}
return toolLengthCompOutput.format(offsetCode);
}
function onDwell(seconds) {
if (seconds > 99999.999) {
warning(localize("Dwelling time is out of range."));
}
seconds = clamp(0.001, seconds, 99999.999);
writeBlock(gFeedModeModal.format(94), gFormat.format(4), "P" + milliFormat.format(seconds * 1000));
}
function onSpindleSpeed(spindleSpeed) {
writeBlock(sOutput.format(spindleSpeed));
}
function onCycle() {
writeBlock(gPlaneModal.format(17));
}
function onCyclePoint(x, y, z) {
if (isInspectionOperation()) {
if (typeof inspectionCycleInspect == "function") {
inspectionCycleInspect(cycle, x, y, z);
return;
} else {
cycleNotSupported();
}
} else if (isProbeOperation()) {
writeProbeCycle(cycle, x, y, z);
} else {
writeDrillCycle(cycle, x, y, z);
}
}
function onCycleEnd() {
if (isProbeOperation()) {
zOutput.reset();
gMotionModal.reset();
writeBlock(gFormat.format(65), "P" + 9810, zOutput.format(cycle.retract)); // protected retract move
} else {
if (subprogramsAreSupported() && subprogramState.cycleSubprogramIsActive) {
subprogramEnd();
}
if (!cycleExpanded) {
writeBlock(gCycleModal.format(80));
gMotionModal.reset();
}
writeBlock(gFeedModeModal.format(94));
if (currentSection.feedMode == FEED_PER_REVOLUTION) {
feedOutput.setFormat(feedFormat); // re-apply feedFormat to feedOutput
}
}
if (getProperty("useLiveConnection") && isProbeOperation() && typeof liveConnectionWriteData == "function") {
liveConnectionWriteData("macroEnd");
}
}
// Start of onRewindMachine logic
/** Allow user to override the onRewind logic. */
function onRewindMachineEntry(_a, _b, _c) {
return false;
}
/** Retract to safe position before indexing rotaries. */
function onMoveToSafeRetractPosition() {
// cancel TCP so that tool doesn't follow rotaries
disableLengthCompensation(false, "TCPC OFF");
writeRetract(Z);
if (getSetting("retract.homeXY.onIndexing", false)) {
writeRetract(settings.retract.homeXY.onIndexing);
}
}
/** Rotate axes to new position above reentry position */
function onRotateAxes(_x, _y, _z, _a, _b, _c) {
// position rotary axes
xOutput.disable();
yOutput.disable();
zOutput.disable();
unwindABC(new Vector(_a, _b, _c));
onRapid5D(_x, _y, _z, _a, _b, _c);
setCurrentABC(new Vector(_a, _b, _c));
machineSimulation({a:_a, b:_b, c:_c, coordinates:MACHINE});
xOutput.enable();
yOutput.enable();
zOutput.enable();
}
/** Return from safe position after indexing rotaries. */
function onReturnFromSafeRetractPosition(_x, _y, _z) {
// reinstate TCP
if (tcp.isSupportedByOperation) {
if (getSetting("workPlaneMethod.prepositionWithTWP", true)) {
writeInitialPositioning(new Vector(_x, _y, _z), true);
} else {
writeBlock(gMotionModal.format(0), getOffsetCode(), hFormat.format(tool.lengthOffset), formatComment("TCPC ON"));
forceFeed();
}
} else {
// position in XY
forceXYZ();
xOutput.reset();
yOutput.reset();
zOutput.disable();
if (highFeedMapping != HIGH_FEED_NO_MAPPING) {
onLinear(_x, _y, _z, highFeedrate);
} else {
onRapid(_x, _y, _z);
}
machineSimulation({x:_x, y:_y});
// position in Z
zOutput.enable();
invokeOnRapid(_x, _y, _z);
}
}
// End of onRewindMachine logic
var currentCoolantMode = COOLANT_OFF;
var coolantOff = undefined;
var forceCoolant = false;
var isOptionalCoolant = false;
function setCoolant(coolant) {
var coolantCodes = getCoolantCodes(coolant);
if (Array.isArray(coolantCodes)) {
writeStartBlocks(!isOptionalCoolant, function () {
if (settings.coolant.singleLineCoolant) {
writeBlock(coolantCodes.join(getWordSeparator()));
} else {
for (var c in coolantCodes) {
writeBlock(coolantCodes[c]);
}
}
});
return undefined;
}
return coolantCodes;
}
var isSpecialCoolantActive = false;
function getCoolantCodes(coolant) {
var coolants = settings.coolant.coolants;
isOptionalCoolant = false;
var multipleCoolantBlocks = new Array(); // create a formatted array to be passed into the outputted line
if (!coolants) {
error(localize("Coolants have not been defined."));
}
if (tool.type == TOOL_PROBE) { // avoid coolant output for probing
coolant = COOLANT_OFF;
}
if (coolant == currentCoolantMode) {
if (operationNeedsSafeStart && coolant != COOLANT_OFF && !isSpecialCoolantActive) {
isOptionalCoolant = true;
} else if (!forceCoolant || coolant == COOLANT_OFF) {
return undefined; // coolant is already active
}
}
if ((coolant != COOLANT_OFF) && (currentCoolantMode != COOLANT_OFF) && (coolantOff != undefined) && !isOptionalCoolant && !forceCoolant) {
if (Array.isArray(coolantOff)) {
for (var i in coolantOff) {
multipleCoolantBlocks.push(coolantOff[i]);
}
} else {
multipleCoolantBlocks.push(coolantOff);
}
}
forceCoolant = false;
if (isSpecialCoolantActive) {
forceSpindleSpeed = true;
}
var m;
var coolantCodes = {};
for (var c in coolants) { // find required coolant codes into the coolants array
if (coolants[c].id == coolant) {
isSpecialCoolantActive = (coolants[c].id == COOLANT_THROUGH_TOOL) || (coolants[c].id == COOLANT_FLOOD_THROUGH_TOOL) || (coolants[c].id == COOLANT_AIR_THROUGH_TOOL);
coolantCodes.on = coolants[c].on;
if (coolants[c].off != undefined) {
coolantCodes.off = coolants[c].off;
break;
} else {
for (var i in coolants) {
if (coolants[i].id == COOLANT_OFF) {
coolantCodes.off = coolants[i].off;
break;
}
}
}
}
}
if (coolant == COOLANT_OFF) {
m = !coolantOff ? coolantCodes.off : coolantOff; // use the default coolant off command when an 'off' value is not specified
} else {
coolantOff = coolantCodes.off;
m = coolantCodes.on;
}
if (!m) {
onUnsupportedCoolant(coolant);
m = 9;
} else {
if (Array.isArray(m)) {
for (var i in m) {
multipleCoolantBlocks.push(m[i]);
}
} else {
multipleCoolantBlocks.push(m);
}
currentCoolantMode = coolant;
for (var i in multipleCoolantBlocks) {
if (typeof multipleCoolantBlocks[i] == "number") {
multipleCoolantBlocks[i] = mFormat.format(multipleCoolantBlocks[i]);
}
}
return multipleCoolantBlocks; // return the single formatted coolant value
}
return undefined;
}
var mapCommand = {
COMMAND_END : 2,
COMMAND_SPINDLE_CLOCKWISE : 3,
COMMAND_SPINDLE_COUNTERCLOCKWISE: 4,
COMMAND_STOP_SPINDLE : 5,
COMMAND_ORIENTATE_SPINDLE : 19,
COMMAND_LOAD_TOOL : 6
};
function onCommand(command) {
switch (command) {
case COMMAND_STOP:
writeBlock(mFormat.format(0));
forceSpindleSpeed = true;
forceCoolant = true;
return;
case COMMAND_OPTIONAL_STOP:
writeBlock(mFormat.format(1));
forceSpindleSpeed = true;
forceCoolant = true;
return;
case COMMAND_COOLANT_ON:
setCoolant(tool.coolant);
return;
case COMMAND_COOLANT_OFF:
setCoolant(COOLANT_OFF);
return;
case COMMAND_START_SPINDLE:
forceSpindleSpeed = false;
writeBlock(sOutput.format(spindleSpeed), mFormat.format(tool.clockwise ? 3 : 4));
return;
case COMMAND_LOAD_TOOL:
writeToolBlock("T" + toolFormat.format(tool.number), mFormat.format(6));
writeComment(tool.comment);
if (measureTool) {
writeToolMeasureBlock(tool, false);
}
// preload tool is handled within onSection
return;
case COMMAND_LOCK_MULTI_AXIS:
if (machineConfiguration.isMultiAxisConfiguration()) {
writeBlock(fourthAxisClamp.format(10)); // lock 4th axis
if (machineConfiguration.getNumberOfAxes() > 4) {
writeBlock(fifthAxisClamp.format(12)); // lock 5th axis
}
}
return;
case COMMAND_UNLOCK_MULTI_AXIS:
var outputClampCodes = getProperty("useClampCodes") || currentSection.isMultiAxis() || isPolarModeActive();
if (outputClampCodes && machineConfiguration.isMultiAxisConfiguration()) {
writeBlock(fourthAxisClamp.format(11)); // unlock 4th axis
if (machineConfiguration.getNumberOfAxes() > 4) {
writeBlock(fifthAxisClamp.format(13)); // unlock 5th axis
}
}
return;
case COMMAND_BREAK_CONTROL:
if (!toolChecked) { // avoid duplicate COMMAND_BREAK_CONTROL
prepareForToolCheck();
writeBlock(
gFormat.format(65),
"P" + 9853,
"T" + toolFormat.format(tool.number),
"B" + xyzFormat.format(0),
"H" + xyzFormat.format(getProperty("toolBreakageTolerance"))
);
toolChecked = true;
toolLengthCompOutput.setCurrent(49); // macro 9853 cancels tool length compensation
}
return;
case COMMAND_TOOL_MEASURE:
measureTool = true;
return;
case COMMAND_START_CHIP_TRANSPORT:
writeBlock(mFormat.format(31));
return;
case COMMAND_STOP_CHIP_TRANSPORT:
writeBlock(mFormat.format(33));
return;
case COMMAND_PROBE_ON:
return;
case COMMAND_PROBE_OFF:
return;
}
var stringId = getCommandStringId(command);
var mcode = mapCommand[stringId];
if (mcode != undefined) {
writeBlock(mFormat.format(mcode));
} else {
onUnsupportedCommand(command);
}
}
function onSectionEnd() {
if (isInspectionOperation() && !isLastSection()) {
writeBlock(gFormat.format(103), "P0", formatComment("LOOKAHEAD ON"));
}
if (!isLastSection()) {
if (getNextSection().getTool().coolant != tool.coolant) {
setCoolant(COOLANT_OFF);
}
if (tool.breakControl && isToolChangeNeeded(getNextSection(), getProperty("toolAsName") ? "description" : "number")) {
onCommand(COMMAND_BREAK_CONTROL);
} else {
toolChecked = false;
}
}
if (subprogramsAreSupported()) {
subprogramEnd();
}
forceAny();
writeBlock(gFeedModeModal.format(94)); // feed per minute
if (isProbeOperation()) {
writeBlock(gFormat.format(65), "P" + 9833); // spin the probe off
if (probeVariables.probeAngleMethod != "G68") {
setProbeAngle(); // output probe angle rotations if required
}
}
if (getProperty("useLiveConnection") && (typeof liveConnectionWriteData == "function")) {
liveConnectionWriteData("toolpathEnd");
if (isInspectionOperation()) {
liveConnectionWriteData("inspectSurfaceAlarm");
}
}
operationNeedsSafeStart = false; // reset for next section
}
function onClose() {
if (!(getProperty("useLiveConnection") && controlType != "NGC")) {
if (isDPRNTopen) {
writeln("DPRNT[END]");
writeBlock("PCLOS");
isDPRNTopen = false;
}
}
if (!getProperty("useLiveConnection") && typeof inspectionProcessSectionEnd == "function") {
inspectionProcessSectionEnd();
}
cancelWCSRotation();
writeln("");
optionalSection = false;
onCommand(COMMAND_STOP_SPINDLE);
onCommand(COMMAND_COOLANT_OFF);
disableLengthCompensation();
// retract
writeRetract(Z);
if (getSetting("retract.homeXY.onProgramEnd", false)) {
if (!getProperty("homePositionCenter") || (machineConfiguration.isMultiAxisConfiguration() && getCurrentDirection().length != 0)) {
writeRetract(settings.retract.homeXY.onProgramEnd);
}
}
cancelWorkPlane();
// Unwind Rotary table at end
if (machineConfiguration.isMultiAxisConfiguration()) {
unwindABC(new Vector(0, 0, 0));
positionABC(new Vector(0, 0, 0), true);
}
if (getProperty("homePositionCenter")) {
if (hasParameter("part-upper-x") && hasParameter("part-lower-x")) {
var xHome = (getParameter("part-upper-x") + getParameter("part-lower-x")) / 2;
} else {
var xHome = machineConfiguration.hasHomePositionX() ? machineConfiguration.getHomePositionX() : toPreciseUnit(0, MM);
}
writeBlock(gMotionModal.format(0), "X" + xyzFormat.format(xHome)); // only desired when X is in the table
writeRetract(Y);
}
if (getProperty("useLiveConnection")) {
writeComment("Live Connection Footer"); // Live connection write footer
writeBlock(inspectionVariables.liveConnectionStatus, "= 2"); // If using live connection set results active to a 2 to signify program end
}
onImpliedCommand(COMMAND_END);
onImpliedCommand(COMMAND_STOP_SPINDLE);
writeBlock(mFormat.format(30)); // stop program, spindle stop, coolant off
if (subprogramsAreSupported()) {
writeSubprograms();
}
writeln("");
writeln("%");
}
/*
keywords += (keywords ? " MODEL_IMAGE" : "MODEL_IMAGE");
function onTerminate() {
var outputPath = getOutputPath();
var programFilename = FileSystem.getFilename(outputPath);
var programSize = FileSystem.getFileSize(outputPath);
var postPath = findFile("setup-sheet-excel-2007.cps");
var intermediatePath = getIntermediatePath();
var a = "--property unit " + ((unit == IN) ? "0" : "1"); // use 0 for inch and 1 for mm
if (programName) {
a += " --property programName \"'" + programName + "'\"";
}
if (programComment) {
a += " --property programComment \"'" + programComment + "'\"";
}
a += " --property programFilename \"'" + programFilename + "'\"";
a += " --property programSize \"" + programSize + "\"";
a += " --noeditor --log temp.log \"" + postPath + "\" \"" + intermediatePath + "\" \"" + FileSystem.replaceExtension(outputPath, "xlsx") + "\"";
execute(getPostProcessorPath(), a, false, "");
executeNoWait("excel", "\"" + FileSystem.replaceExtension(outputPath, "xlsx") + "\"", false, "");
}
*/
// >>>>> INCLUDED FROM include_files/commonFunctions.cpi
// internal variables, do not change
var receivedMachineConfiguration;
var tcp = {isSupportedByControl:getSetting("supportsTCP", true), isSupportedByMachine:false, isSupportedByOperation:false};
var state = {
retractedX : false, // specifies that the machine has been retracted in X
retractedY : false, // specifies that the machine has been retracted in Y
retractedZ : false, // specifies that the machine has been retracted in Z
tcpIsActive : false, // specifies that TCP is currently active
twpIsActive : false, // specifies that TWP is currently active
lengthCompensationActive: !getSetting("outputToolLengthCompensation", true), // specifies that tool length compensation is active
mainState : true // specifies the current context of the state (true = main, false = optional)
};
var validateLengthCompensation = getSetting("outputToolLengthCompensation", true); // disable validation when outputToolLengthCompensation is disabled
var multiAxisFeedrate;
var sequenceNumber;
var optionalSection = false;
var currentWorkOffset;
var forceSpindleSpeed = false;
var operationNeedsSafeStart = false; // used to convert blocks to optional for safeStartAllOperations
function activateMachine() {
// disable unsupported rotary axes output
if (!machineConfiguration.isMachineCoordinate(0) && (typeof aOutput != "undefined")) {
aOutput.disable();
}
if (!machineConfiguration.isMachineCoordinate(1) && (typeof bOutput != "undefined")) {
bOutput.disable();
}
if (!machineConfiguration.isMachineCoordinate(2) && (typeof cOutput != "undefined")) {
cOutput.disable();
}
// setup usage of useTiltedWorkplane
settings.workPlaneMethod.useTiltedWorkplane = getProperty("useTiltedWorkplane") != undefined ? getProperty("useTiltedWorkplane") :
getSetting("workPlaneMethod.useTiltedWorkplane", false);
settings.workPlaneMethod.useABCPrepositioning = getSetting("workPlaneMethod.useABCPrepositioning", true);
if (!machineConfiguration.isMultiAxisConfiguration()) {
return; // don't need to modify any settings for 3-axis machines
}
// identify if any of the rotary axes has TCP enabled
var axes = [machineConfiguration.getAxisU(), machineConfiguration.getAxisV(), machineConfiguration.getAxisW()];
tcp.isSupportedByMachine = axes.some(function(axis) {return axis.isEnabled() && axis.isTCPEnabled();}); // true if TCP is enabled on any rotary axis
// save multi-axis feedrate settings from machine configuration
var mode = machineConfiguration.getMultiAxisFeedrateMode();
var type = mode == FEED_INVERSE_TIME ? machineConfiguration.getMultiAxisFeedrateInverseTimeUnits() :
(mode == FEED_DPM ? machineConfiguration.getMultiAxisFeedrateDPMType() : DPM_STANDARD);
multiAxisFeedrate = {
mode : mode,
maximum : machineConfiguration.getMultiAxisFeedrateMaximum(),
type : type,
tolerance: mode == FEED_DPM ? machineConfiguration.getMultiAxisFeedrateOutputTolerance() : 0,
bpwRatio : mode == FEED_DPM ? machineConfiguration.getMultiAxisFeedrateBpwRatio() : 1
};
// setup of retract/reconfigure TAG: Only needed until post kernel supports these machine config settings
if (receivedMachineConfiguration && machineConfiguration.performRewinds()) {
safeRetractDistance = machineConfiguration.getSafeRetractDistance();
safePlungeFeed = machineConfiguration.getSafePlungeFeedrate();
safeRetractFeed = machineConfiguration.getSafeRetractFeedrate();
}
if (typeof safeRetractDistance == "number" && getProperty("safeRetractDistance") != undefined && getProperty("safeRetractDistance") != 0) {
safeRetractDistance = getProperty("safeRetractDistance");
}
if (machineConfiguration.isHeadConfiguration() && getSetting("workPlaneMethod.compensateToolLength", false)) {
for (var i = 0; i < getNumberOfSections(); ++i) {
var section = getSection(i);
if (section.isMultiAxis()) {
machineConfiguration.setToolLength(getBodyLength(section.getTool())); // define the tool length for head adjustments
section.optimizeMachineAnglesByMachine(machineConfiguration, OPTIMIZE_AXIS);
}
}
} else {
optimizeMachineAngles2(OPTIMIZE_AXIS);
}
}
function getBodyLength(tool) {
for (var i = 0; i < getNumberOfSections(); ++i) {
var section = getSection(i);
if (tool.number == section.getTool().number) {
if (section.hasParameter("operation:tool_assemblyGaugeLength")) { // For Fusion
return tool.bodyLength + tool.holderLength;
} else { // Legacy products
return section.getParameter("operation:tool_overallLength", tool.bodyLength + tool.holderLength);
}
}
}
return tool.bodyLength + tool.holderLength;
}
function getFeed(f) {
if (getProperty("useG95")) {
return feedOutput.format(f / spindleSpeed); // use feed value
}
if (typeof activeMovements != "undefined" && activeMovements) {
var feedContext = activeMovements[movement];
if (feedContext != undefined) {
if (!feedFormat.areDifferent(feedContext.feed, f)) {
if (feedContext.id == currentFeedId) {
return ""; // nothing has changed
}
forceFeed();
currentFeedId = feedContext.id;
return settings.parametricFeeds.feedOutputVariable + (settings.parametricFeeds.firstFeedParameter + feedContext.id);
}
}
currentFeedId = undefined; // force parametric feed next time
}
return feedOutput.format(f); // use feed value
}
function validateCommonParameters() {
validateToolData();
for (var i = 0; i < getNumberOfSections(); ++i) {
var section = getSection(i);
if (getSection(0).workOffset == 0 && section.workOffset > 0) {
if (!(typeof wcsDefinitions != "undefined" && wcsDefinitions.useZeroOffset)) {
error(localize("Using multiple work offsets is not possible if the initial work offset is 0."));
}
}
if (section.isMultiAxis()) {
if (!section.isOptimizedForMachine() &&
(!getSetting("workPlaneMethod.useTiltedWorkplane", false) || !getSetting("supportsToolVectorOutput", false))) {
error(localize("This postprocessor requires a machine configuration for 5-axis simultaneous toolpath."));
}
if (machineConfiguration.getMultiAxisFeedrateMode() == FEED_INVERSE_TIME && !getSetting("supportsInverseTimeFeed", true)) {
error(localize("This postprocessor does not support inverse time feedrates."));
}
if (getSetting("supportsToolVectorOutput", false) && !tcp.isSupportedByControl) {
error(localize("Incompatible postprocessor settings detected." + EOL +
"Setting 'supportsToolVectorOutput' requires setting 'supportsTCP' to be enabled as well."));
}
}
}
if (!tcp.isSupportedByControl && tcp.isSupportedByMachine) {
error(localize("The machine configuration has TCP enabled which is not supported by this postprocessor."));
}
if (getProperty("safePositionMethod") == "clearanceHeight") {
var msg = "-Attention- Property 'Safe Retracts' is set to 'Clearance Height'." + EOL +
"Ensure the clearance height will clear the part and or fixtures." + EOL +
"Raise the Z-axis to a safe height before starting the program.";
warning(msg);
writeComment(msg);
}
}
function validateToolData() {
var _default = 99999;
var _maximumSpindleRPM = machineConfiguration.getMaximumSpindleSpeed() > 0 ? machineConfiguration.getMaximumSpindleSpeed() :
settings.maximumSpindleRPM == undefined ? _default : settings.maximumSpindleRPM;
var _maximumToolNumber = machineConfiguration.isReceived() && machineConfiguration.getNumberOfTools() > 0 ? machineConfiguration.getNumberOfTools() :
settings.maximumToolNumber == undefined ? _default : settings.maximumToolNumber;
var _maximumToolLengthOffset = settings.maximumToolLengthOffset == undefined ? _default : settings.maximumToolLengthOffset;
var _maximumToolDiameterOffset = settings.maximumToolDiameterOffset == undefined ? _default : settings.maximumToolDiameterOffset;
var header = ["Detected maximum values are out of range.", "Maximum values:"];
var warnings = {
toolNumber : {msg:"Tool number value exceeds the maximum value for tool: " + EOL, max:" Tool number: " + _maximumToolNumber, values:[]},
lengthOffset : {msg:"Tool length offset value exceeds the maximum value for tool: " + EOL, max:" Tool length offset: " + _maximumToolLengthOffset, values:[]},
diameterOffset: {msg:"Tool diameter offset value exceeds the maximum value for tool: " + EOL, max:" Tool diameter offset: " + _maximumToolDiameterOffset, values:[]},
spindleSpeed : {msg:"Spindle speed exceeds the maximum value for operation: " + EOL, max:" Spindle speed: " + _maximumSpindleRPM, values:[]}
};
var toolIds = [];
for (var i = 0; i < getNumberOfSections(); ++i) {
var section = getSection(i);
if (toolIds.indexOf(section.getTool().getToolId()) === -1) { // loops only through sections which have a different tool ID
var toolNumber = section.getTool().number;
var lengthOffset = section.getTool().lengthOffset;
var diameterOffset = section.getTool().diameterOffset;
var comment = section.getParameter("operation-comment", "");
if (toolNumber > _maximumToolNumber && !getProperty("toolAsName")) {
warnings.toolNumber.values.push(SP + toolNumber + EOL);
}
if (lengthOffset > _maximumToolLengthOffset) {
warnings.lengthOffset.values.push(SP + "Tool " + toolNumber + " (" + comment + "," + " Length offset: " + lengthOffset + ")" + EOL);
}
if (diameterOffset > _maximumToolDiameterOffset) {
warnings.diameterOffset.values.push(SP + "Tool " + toolNumber + " (" + comment + "," + " Diameter offset: " + diameterOffset + ")" + EOL);
}
toolIds.push(section.getTool().getToolId());
}
// loop through all sections regardless of tool id for idenitfying spindle speeds
// identify if movement ramp is used in current toolpath, use ramp spindle speed for comparisons
var ramp = section.getMovements() & ((1 << MOVEMENT_RAMP) | (1 << MOVEMENT_RAMP_ZIG_ZAG) | (1 << MOVEMENT_RAMP_PROFILE) | (1 << MOVEMENT_RAMP_HELIX));
var _sectionSpindleSpeed = Math.max(section.getTool().spindleRPM, ramp ? section.getTool().rampingSpindleRPM : 0, 0);
if (_sectionSpindleSpeed > _maximumSpindleRPM) {
warnings.spindleSpeed.values.push(SP + section.getParameter("operation-comment", "") + " (" + _sectionSpindleSpeed + " RPM" + ")" + EOL);
}
}
// sort lists by tool number
warnings.toolNumber.values.sort(function(a, b) {return a - b;});
warnings.lengthOffset.values.sort(function(a, b) {return a.localeCompare(b);});
warnings.diameterOffset.values.sort(function(a, b) {return a.localeCompare(b);});
var warningMessages = [];
for (var key in warnings) {
if (warnings[key].values != "") {
header.push(warnings[key].max); // add affected max values to the header
warningMessages.push(warnings[key].msg + warnings[key].values.join(""));
}
}
if (warningMessages.length != 0) {
warningMessages.unshift(header.join(EOL) + EOL);
warning(warningMessages.join(EOL));
}
}
function forceFeed() {
currentFeedId = undefined;
feedOutput.reset();
}
/** Force output of X, Y, and Z. */
function forceXYZ() {
xOutput.reset();
yOutput.reset();
zOutput.reset();
}
/** Force output of A, B, and C. */
function forceABC() {
aOutput.reset();
bOutput.reset();
cOutput.reset();
}
/** Force output of X, Y, Z, A, B, C, and F on next output. */
function forceAny() {
forceXYZ();
forceABC();
forceFeed();
}
/**
Writes the specified block.
*/
function writeBlock() {
var text = formatWords(arguments);
if (!text) {
return;
}
var prefix = getSetting("sequenceNumberPrefix", "N");
var suffix = getSetting("writeBlockSuffix", "");
if ((optionalSection || skipBlocks) && !getSetting("supportsOptionalBlocks", true)) {
error(localize("Optional blocks are not supported by this post."));
}
if (getProperty("showSequenceNumbers") == "true") {
if (sequenceNumber == undefined || sequenceNumber >= settings.maximumSequenceNumber) {
sequenceNumber = getProperty("sequenceNumberStart");
}
if (optionalSection || skipBlocks) {
writeWords2("/", prefix + sequenceNumber, text + suffix);
} else {
writeWords2(prefix + sequenceNumber, text + suffix);
}
sequenceNumber += getProperty("sequenceNumberIncrement");
} else {
if (optionalSection || skipBlocks) {
writeWords2("/", text + suffix);
} else {
writeWords(text + suffix);
}
}
}
validate(settings.comments, "Setting 'comments' is required but not defined.");
function formatComment(text) {
var prefix = settings.comments.prefix;
var suffix = settings.comments.suffix;
var _permittedCommentChars = settings.comments.permittedCommentChars == undefined ? "" : settings.comments.permittedCommentChars;
switch (settings.comments.outputFormat) {
case "upperCase":
text = text.toUpperCase();
_permittedCommentChars = _permittedCommentChars.toUpperCase();
break;
case "lowerCase":
text = text.toLowerCase();
_permittedCommentChars = _permittedCommentChars.toLowerCase();
break;
case "ignoreCase":
_permittedCommentChars = _permittedCommentChars.toUpperCase() + _permittedCommentChars.toLowerCase();
break;
default:
error(localize("Unsupported option specified for setting 'comments.outputFormat'."));
}
if (_permittedCommentChars != "") {
text = filterText(String(text), _permittedCommentChars);
}
text = String(text).substring(0, settings.comments.maximumLineLength - prefix.length - suffix.length);
return text != "" ? prefix + text + suffix : "";
}
/**
Output a comment.
*/
function writeComment(text) {
if (!text) {
return;
}
var comments = String(text).split(EOL);
for (comment in comments) {
var _comment = formatComment(comments[comment]);
if (_comment) {
if (getSetting("comments.showSequenceNumbers", false)) {
writeBlock(_comment);
} else {
writeln(_comment);
}
}
}
}
function onComment(text) {
writeComment(text);
}
/**
Writes the specified block - used for tool changes only.
*/
function writeToolBlock() {
var show = getProperty("showSequenceNumbers");
setProperty("showSequenceNumbers", (show == "true" || show == "toolChange") ? "true" : "false");
writeBlock(arguments);
setProperty("showSequenceNumbers", show);
machineSimulation({/*x:toPreciseUnit(200, MM), y:toPreciseUnit(200, MM), coordinates:MACHINE,*/ mode:TOOLCHANGE}); // move machineSimulation to a tool change position
}
var skipBlocks = false;
var initialState = JSON.parse(JSON.stringify(state)); // save initial state
var optionalState = JSON.parse(JSON.stringify(state));
var saveCurrentSectionId = undefined;
function writeStartBlocks(isRequired, code) {
var saveSkipBlocks = skipBlocks;
var saveMainState = state; // save main state
if (!isRequired) {
if (!getProperty("safeStartAllOperations", false)) {
return; // when safeStartAllOperations is disabled, dont output code and return
}
if (saveCurrentSectionId != getCurrentSectionId()) {
saveCurrentSectionId = getCurrentSectionId();
forceModals(); // force all modal variables when entering a new section
optionalState = Object.create(initialState); // reset optionalState to initialState when entering a new section
}
skipBlocks = true; // if values are not required, but safeStartAllOperations is enabled - write following blocks as optional
state = optionalState; // set state to optionalState if skipBlocks is true
state.mainState = false;
}
code(); // writes out the code which is passed to this function as an argument
state = saveMainState; // restore main state
skipBlocks = saveSkipBlocks; // restore skipBlocks value
}
var pendingRadiusCompensation = -1;
function onRadiusCompensation() {
pendingRadiusCompensation = radiusCompensation;
if (pendingRadiusCompensation >= 0 && !getSetting("supportsRadiusCompensation", true)) {
error(localize("Radius compensation mode is not supported."));
return;
}
}
function onPassThrough(text) {
var commands = String(text).split(",");
for (text in commands) {
writeBlock(commands[text]);
}
}
function forceModals() {
if (arguments.length == 0) { // reset all modal variables listed below
if (typeof gMotionModal != "undefined") {
gMotionModal.reset();
}
if (typeof gPlaneModal != "undefined") {
gPlaneModal.reset();
}
if (typeof gAbsIncModal != "undefined") {
gAbsIncModal.reset();
}
if (typeof gFeedModeModal != "undefined") {
gFeedModeModal.reset();
}
} else {
for (var i in arguments) {
arguments[i].reset(); // only reset the modal variable passed to this function
}
}
}
/** Helper function to be able to use a default value for settings which do not exist. */
function getSetting(setting, defaultValue) {
var result = defaultValue;
var keys = setting.split(".");
var obj = settings;
for (var i in keys) {
if (obj[keys[i]] != undefined) { // setting does exist
result = obj[keys[i]];
if (typeof [keys[i]] === "object") {
obj = obj[keys[i]];
continue;
}
} else { // setting does not exist, use default value
if (defaultValue != undefined) {
result = defaultValue;
} else {
error("Setting '" + keys[i] + "' has no default value and/or does not exist.");
return undefined;
}
}
}
return result;
}
function getForwardDirection(_section) {
var forward = undefined;
var _optimizeType = settings.workPlaneMethod && settings.workPlaneMethod.optimizeType;
if (_section.isMultiAxis()) {
forward = _section.workPlane.forward;
} else if (!getSetting("workPlaneMethod.useTiltedWorkplane", false) && machineConfiguration.isMultiAxisConfiguration()) {
if (_optimizeType == undefined) {
var saveRotation = getRotation();
getWorkPlaneMachineABC(_section, true);
forward = getRotation().forward;
setRotation(saveRotation); // reset rotation
} else {
var abc = getWorkPlaneMachineABC(_section, false);
var forceAdjustment = settings.workPlaneMethod.optimizeType == OPTIMIZE_TABLES || settings.workPlaneMethod.optimizeType == OPTIMIZE_BOTH;
forward = machineConfiguration.getOptimizedDirection(_section.workPlane.forward, abc, false, forceAdjustment);
}
} else {
forward = getRotation().forward;
}
return forward;
}
function getRetractParameters() {
var _arguments = typeof arguments[0] === "object" ? arguments[0].axes : arguments;
var singleLine = arguments[0].singleLine == undefined ? true : arguments[0].singleLine;
var words = []; // store all retracted axes in an array
var retractAxes = new Array(false, false, false);
var method = getProperty("safePositionMethod", "undefined");
if (method == "clearanceHeight") {
if (!is3D()) {
error(localize("Safe retract option 'Clearance Height' is only supported when all operations are along the setup Z-axis."));
}
return undefined;
}
validate(settings.retract, "Setting 'retract' is required but not defined.");
validate(_arguments.length != 0, "No axis specified for getRetractParameters().");
for (i in _arguments) {
retractAxes[_arguments[i]] = true;
}
if ((retractAxes[0] || retractAxes[1]) && !state.retractedZ) { // retract Z first before moving to X/Y home
error(localize("Retracting in X/Y is not possible without being retracted in Z."));
return undefined;
}
// special conditions
if (retractAxes[0] || retractAxes[1]) {
method = getSetting("retract.methodXY", method);
}
if (retractAxes[2]) {
method = getSetting("retract.methodZ", method);
}
// define home positions
var useZeroValues = (settings.retract.useZeroValues && settings.retract.useZeroValues.indexOf(method) != -1);
var _xHome = machineConfiguration.hasHomePositionX() && !useZeroValues ? machineConfiguration.getHomePositionX() : toPreciseUnit(0, MM);
var _yHome = machineConfiguration.hasHomePositionY() && !useZeroValues ? machineConfiguration.getHomePositionY() : toPreciseUnit(0, MM);
var _zHome = machineConfiguration.getRetractPlane() != 0 && !useZeroValues ? machineConfiguration.getRetractPlane() : toPreciseUnit(0, MM);
for (var i = 0; i < _arguments.length; ++i) {
switch (_arguments[i]) {
case X:
if (!state.retractedX) {
words.push("X" + xyzFormat.format(_xHome));
xOutput.reset();
state.retractedX = true;
}
break;
case Y:
if (!state.retractedY) {
words.push("Y" + xyzFormat.format(_yHome));
yOutput.reset();
state.retractedY = true;
}
break;
case Z:
if (!state.retractedZ) {
words.push("Z" + xyzFormat.format(_zHome));
zOutput.reset();
state.retractedZ = true;
}
break;
default:
error(localize("Unsupported axis specified for getRetractParameters()."));
return undefined;
}
}
return {
method : method,
retractAxes: retractAxes,
words : words,
positions : {
x: retractAxes[0] ? _xHome : undefined,
y: retractAxes[1] ? _yHome : undefined,
z: retractAxes[2] ? _zHome : undefined},
singleLine: singleLine};
}
/** Returns true when subprogram logic does exist into the post. */
function subprogramsAreSupported() {
return typeof subprogramState != "undefined";
}
// Start of machine simulation connection move support
var debugSimulation = false; // enable to output debug information for connection move support in the NC program
var TCPON = "TCP ON";
var TCPOFF = "TCP OFF";
var TWPON = "TWP ON";
var TWPOFF = "TWP OFF";
var TOOLCHANGE = "TOOL CHANGE";
var RETRACTTOOLAXIS = "RETRACT TOOLAXIS";
var WORK = "WORK CS";
var MACHINE = "MACHINE CS";
var MIN = "MIN";
var MAX = "MAX";
var WARNING_NON_RANGE = [0, 1, 2];
var isTwpOn; // only used for debugging
var isTcpOn; // only used for debugging
/**
* Helper function for connection moves in machine simulation.
* @param {Object} parameters An object containing the desired options for machine simulation.
* @note Available properties are:
* @param {Number} x X axis position, alternatively use MIN or MAX to move to the axis limit
* @param {Number} y Y axis position, alternatively use MIN or MAX to move to the axis limit
* @param {Number} z Z axis position, alternatively use MIN or MAX to move to the axis limit
* @param {Number} a A axis position (in radians)
* @param {Number} b B axis position (in radians)
* @param {Number} c C axis position (in radians)
* @param {Number} feed desired feedrate, automatically set to high/current feedrate if not specified
* @param {String} mode mode TCPON | TCPOFF | TWPON | TWPOFF | TOOLCHANGE | RETRACTTOOLAXIS
* @param {String} coordinates WORK | MACHINE - if undefined, work coordinates will be used by default
* @param {Number} eulerAngles the calculated Euler angles for the workplane
* @example
machineSimulation({a:abc.x, b:abc.y, c:abc.z, coordinates:MACHINE});
machineSimulation({x:toPreciseUnit(200, MM), y:toPreciseUnit(200, MM), coordinates:MACHINE, mode:TOOLCHANGE});
*/
function machineSimulation(parameters) {
if (revision < 50075 || skipBlocks) {
return; // return when post kernel revision is lower than 50075 or when skipBlocks is enabled
}
getAxisLimit = function(axis, limit) {
validate(limit == MIN || limit == MAX, subst(localize("Invalid argument \"%1\" passed to the machineSimulation function."), limit));
var range = axis.getRange();
if (range.isNonRange()) {
var axisLetters = ["X", "Y", "Z"];
var warningMessage = subst(localize("An attempt was made to move the \"%1\" axis to its MIN/MAX limits during machine simulation, but its range is set to \"unlimited\"." + EOL +
"A limited range must be set for the \"%1\" axis in the machine definition, or these motions will not be shown in machine simulation."), axisLetters[axis.getCoordinate()]);
warningOnce(warningMessage, WARNING_NON_RANGE[axis.getCoordinate()]);
return undefined;
}
return limit == MIN ? range.minimum : range.maximum;
};
var x = (isNaN(parameters.x) && parameters.x) ? getAxisLimit(machineConfiguration.getAxisX(), parameters.x) : parameters.x;
var y = (isNaN(parameters.y) && parameters.y) ? getAxisLimit(machineConfiguration.getAxisY(), parameters.y) : parameters.y;
var z = (isNaN(parameters.z) && parameters.z) ? getAxisLimit(machineConfiguration.getAxisZ(), parameters.z) : parameters.z;
var rotaryAxesErrorMessage = localize("Invalid argument for rotary axes passed to the machineSimulation function. Only numerical values are supported.");
var a = (isNaN(parameters.a) && parameters.a) ? error(rotaryAxesErrorMessage) : parameters.a;
var b = (isNaN(parameters.b) && parameters.b) ? error(rotaryAxesErrorMessage) : parameters.b;
var c = (isNaN(parameters.c) && parameters.c) ? error(rotaryAxesErrorMessage) : parameters.c;
var coordinates = parameters.coordinates;
var eulerAngles = parameters.eulerAngles;
var feed = parameters.feed;
if (feed === undefined && typeof gMotionModal !== "undefined") {
feed = gMotionModal.getCurrent() !== 0;
}
var mode = parameters.mode;
var performToolChange = mode == TOOLCHANGE;
if (mode !== undefined && ![TCPON, TCPOFF, TWPON, TWPOFF, TOOLCHANGE, RETRACTTOOLAXIS].includes(mode)) {
error(subst("Mode '%1' is not supported.", mode));
}
// mode takes precedence over TCP/TWP states
var enableTCP = false;
var enableTWP = false;
if (mode === TCPON) {
enableTCP = true;
} else if (mode === TCPOFF) {
enableTWP = typeof state !== "undefined" && state.twpIsActive;
} else if (mode === TWPON) {
enableTWP = true;
} else if (mode === TWPOFF) {
enableTCP = typeof state !== "undefined" && state.tcpIsActive;
} else {
enableTCP = typeof state !== "undefined" && state.tcpIsActive;
enableTWP = typeof state !== "undefined" && state.twpIsActive;
}
var disableTCP = !enableTCP;
var disableTWP = !enableTWP;
// update TCP mode
if (enableTCP) {
simulation.setTWPModeOff();
simulation.setTCPModeOn();
isTwpOn = false;
isTcpOn = true;
}
if (disableTCP) {
simulation.setTCPModeOff();
isTcpOn = false;
}
// update TWP mode
if (enableTWP) {
simulation.setTCPModeOff();
if (settings.workPlaneMethod.eulerConvention == undefined) {
simulation.setTWPModeAlignToCurrentPose();
} else if (eulerAngles) {
simulation.setTWPModeByEulerAngles(settings.workPlaneMethod.eulerConvention, eulerAngles.x, eulerAngles.y, eulerAngles.z);
}
isTwpOn = true;
isTcpOn = false;
}
if (disableTWP) {
simulation.setTWPModeOff();
isTwpOn = false;
}
if (mode == RETRACTTOOLAXIS) {
simulation.retractAlongToolAxisToLimit();
}
if (debugSimulation) {
writeln(" DEBUG" + JSON.stringify(parameters));
writeln(" DEBUG" + JSON.stringify({isTwpOn:isTwpOn, isTcpOn:isTcpOn, feed:feed}));
}
if (x !== undefined || y !== undefined || z !== undefined || a !== undefined || b !== undefined || c !== undefined) {
if (x !== undefined) {simulation.setTargetX(x);}
if (y !== undefined) {simulation.setTargetY(y);}
if (z !== undefined) {simulation.setTargetZ(z);}
if (a !== undefined) {simulation.setTargetA(a);}
if (b !== undefined) {simulation.setTargetB(b);}
if (c !== undefined) {simulation.setTargetC(c);}
if (feed != undefined && feed) {
simulation.setMotionToLinear();
simulation.setFeedrate(typeof feed == "number" ? feed : feedOutput.getCurrent() == 0 ? highFeedrate : feedOutput.getCurrent());
} else {
simulation.setMotionToRapid();
}
if (coordinates != undefined && coordinates == MACHINE) {
simulation.moveToTargetInMachineCoords();
} else {
simulation.moveToTargetInWorkCoords();
}
}
if (performToolChange) {
simulation.performToolChangeCycle();
simulation.moveToTargetInMachineCoords();
}
}
// <<<<< INCLUDED FROM include_files/commonFunctions.cpi
// >>>>> INCLUDED FROM include_files/defineWorkPlane.cpi
validate(settings.workPlaneMethod, "Setting 'workPlaneMethod' is required but not defined.");
function defineWorkPlane(_section, _setWorkPlane) {
var abc = new Vector(0, 0, 0);
if (settings.workPlaneMethod.forceMultiAxisIndexing || !is3D() || machineConfiguration.isMultiAxisConfiguration()) {
if (isPolarModeActive()) {
abc = getCurrentDirection();
} else if (_section.isMultiAxis()) {
forceWorkPlane();
cancelTransformation();
abc = _section.isOptimizedForMachine() ? _section.getInitialToolAxisABC() : _section.getGlobalInitialToolAxis();
} else if (settings.workPlaneMethod.useTiltedWorkplane && settings.workPlaneMethod.eulerConvention != undefined) {
if (settings.workPlaneMethod.eulerCalculationMethod == "machine" && machineConfiguration.isMultiAxisConfiguration()) {
abc = machineConfiguration.getOrientation(getWorkPlaneMachineABC(_section, true)).getEuler2(settings.workPlaneMethod.eulerConvention);
} else {
abc = _section.workPlane.getEuler2(settings.workPlaneMethod.eulerConvention);
}
} else {
abc = getWorkPlaneMachineABC(_section, true);
}
if (_setWorkPlane) {
if (_section.isMultiAxis() || isPolarModeActive()) { // 4-5x simultaneous operations
cancelWorkPlane();
if (_section.isOptimizedForMachine()) {
positionABC(abc, true);
} else {
setCurrentDirection(abc);
}
} else { // 3x and/or 3+2x operations
setWorkPlane(abc);
}
}
} else {
var remaining = _section.workPlane;
if (!isSameDirection(remaining.forward, new Vector(0, 0, 1))) {
error(localize("Tool orientation is not supported."));
return abc;
}
setRotation(remaining);
}
tcp.isSupportedByOperation = isTCPSupportedByOperation(_section);
return abc;
}
function isTCPSupportedByOperation(_section) {
var _tcp = _section.getOptimizedTCPMode() == OPTIMIZE_NONE;
if (!_section.isMultiAxis() && (settings.workPlaneMethod.useTiltedWorkplane ||
isSameDirection(machineConfiguration.getSpindleAxis(), getForwardDirection(_section)) ||
settings.workPlaneMethod.optimizeType == OPTIMIZE_HEADS ||
settings.workPlaneMethod.optimizeType == OPTIMIZE_TABLES ||
settings.workPlaneMethod.optimizeType == OPTIMIZE_BOTH)) {
_tcp = false;
}
return _tcp;
}
// <<<<< INCLUDED FROM include_files/defineWorkPlane.cpi
// >>>>> INCLUDED FROM include_files/getWorkPlaneMachineABC.cpi
validate(settings.machineAngles, "Setting 'machineAngles' is required but not defined.");
function getWorkPlaneMachineABC(_section, rotate) {
var currentABC = isFirstSection() ? new Vector(0, 0, 0) : getCurrentABC();
var abc = _section.getABCByPreference(machineConfiguration, _section.workPlane, currentABC, settings.machineAngles.controllingAxis, settings.machineAngles.type, settings.machineAngles.options);
if (!isSameDirection(machineConfiguration.getDirection(abc), _section.workPlane.forward)) {
error(localize("Orientation not supported."));
}
if (rotate) {
if (settings.workPlaneMethod.optimizeType == undefined || settings.workPlaneMethod.useTiltedWorkplane) { // legacy
var useTCP = false;
var R = machineConfiguration.getRemainingOrientation(abc, _section.workPlane);
setRotation(useTCP ? _section.workPlane : R);
} else {
if (!_section.isOptimizedForMachine()) {
machineConfiguration.setToolLength(getSetting("workPlaneMethod.compensateToolLength", false) ? getBodyLength(_section.getTool()) : 0); // define the tool length for head adjustments
_section.optimize3DPositionsByMachine(machineConfiguration, abc, settings.workPlaneMethod.optimizeType);
}
}
}
return abc;
}
// <<<<< INCLUDED FROM include_files/getWorkPlaneMachineABC.cpi
// >>>>> INCLUDED FROM include_files/positionABC.cpi
function positionABC(abc, force) {
if (!machineConfiguration.isMultiAxisConfiguration()) {
error("Function 'positionABC' can only be used with multi-axis machine configurations.");
}
if (typeof unwindABC == "function") {
unwindABC(abc);
}
if (force) {
forceABC();
}
var a = aOutput.format(abc.x);
var b = bOutput.format(abc.y);
var c = cOutput.format(abc.z);
if (a || b || c) {
writeRetract(Z);
if (getSetting("retract.homeXY.onIndexing", false)) {
writeRetract(settings.retract.homeXY.onIndexing);
}
onCommand(COMMAND_UNLOCK_MULTI_AXIS);
gMotionModal.reset();
writeBlock(gMotionModal.format(0), a, b, c);
setCurrentABC(abc); // required for machine simulation
machineSimulation({a:abc.x, b:abc.y, c:abc.z, coordinates:MACHINE});
}
}
// <<<<< INCLUDED FROM include_files/positionABC.cpi
// >>>>> INCLUDED FROM include_files/unwindABC.cpi
function unwindABC(abc) {
if (settings.unwind == undefined) {
return;
}
if (settings.unwind.method != 1 && settings.unwind.method != 2) {
error(localize("Unsupported unwindABC method."));
return;
}
var axes = new Array(machineConfiguration.getAxisU(), machineConfiguration.getAxisV(), machineConfiguration.getAxisW());
var currentDirection = getCurrentDirection();
for (var i in axes) {
if (axes[i].isEnabled() && (settings.unwind.useAngle != "prefix" || settings.unwind.anglePrefix[axes[i].getCoordinate] != "")) {
var j = axes[i].getCoordinate();
// only use the active axis in calculations
var tempABC = new Vector(0, 0, 0);
tempABC.setCoordinate(j, abc.getCoordinate(j));
var tempCurrent = new Vector(0, 0, 0); // only use the active axis in calculations
tempCurrent.setCoordinate(j, currentDirection.getCoordinate(j));
var orientation = machineConfiguration.getOrientation(tempCurrent);
// get closest angle without respecting 'reset' flag
// and distance from previous angle to closest abc
var nearestABC = machineConfiguration.getABCByPreference(orientation, tempABC, ABC, PREFER_PREFERENCE, ENABLE_WCS);
var distanceABC = abcFormat.getResultingValue(Math.abs(Vector.diff(getCurrentDirection(), abc).getCoordinate(j)));
// calculate distance from calculated abc to closest abc
// include move to origin for G28 moves
var distanceOrigin = 0;
if (settings.unwind.method == 2) {
distanceOrigin = abcFormat.getResultingValue(Math.abs(Vector.diff(nearestABC, abc).getCoordinate(j)));
} else { // closest angle
distanceOrigin = abcFormat.getResultingValue(Math.abs(getCurrentDirection().getCoordinate(j))) % 360; // calculate distance for unwinding axis
distanceOrigin = (distanceOrigin > 180) ? 360 - distanceOrigin : distanceOrigin; // take shortest route to 0
distanceOrigin += abcFormat.getResultingValue(Math.abs(abc.getCoordinate(j))); // add distance from 0 to new position
}
// determine if the axis needs to be rewound and rewind it if required
var revolutions = distanceABC / 360;
var angle = settings.unwind.method == 2 ? nearestABC.getCoordinate(j) : 0;
if (distanceABC > distanceOrigin && (settings.unwind.method == 2 || (revolutions > 1))) { // G28 method will move rotary, so make sure move is greater than 360 degrees
writeRetract(Z);
if (getSetting("retract.homeXY.onIndexing", false)) {
writeRetract(settings.retract.homeXY.onIndexing);
}
onCommand(COMMAND_UNLOCK_MULTI_AXIS);
var outputs = [aOutput, bOutput, cOutput];
outputs[j].reset();
writeBlock(
settings.unwind.codes,
settings.unwind.workOffsetCode ? settings.unwind.workOffsetCode + currentWorkOffset : "",
settings.unwind.useAngle == "true" ? outputs[j].format(angle) :
(settings.unwind.useAngle == "prefix" ? settings.unwind.anglePrefix[j] + abcFormat.format(angle) : "")
);
if (settings.unwind.resetG90) {
gAbsIncModal.reset();
writeBlock(gAbsIncModal.format(90));
}
outputs[j].reset();
// set the current rotary axis angle from the unwind block
currentDirection.setCoordinate(j, angle);
setCurrentDirection(currentDirection);
}
}
}
}
// <<<<< INCLUDED FROM include_files/unwindABC.cpi
// >>>>> INCLUDED FROM include_files/writeWCS.cpi
function writeWCS(section, wcsIsRequired) {
if (section.workOffset != currentWorkOffset) {
if (getSetting("workPlaneMethod.cancelTiltFirst", false) && wcsIsRequired) {
cancelWorkPlane();
}
if (typeof forceWorkPlane == "function" && wcsIsRequired) {
forceWorkPlane();
}
writeStartBlocks(wcsIsRequired, function () {
writeBlock(section.wcs);
});
currentWorkOffset = section.workOffset;
}
}
// <<<<< INCLUDED FROM include_files/writeWCS.cpi
// >>>>> INCLUDED FROM include_files/writeToolCall.cpi
function writeToolCall(tool, insertToolCall) {
if (!isFirstSection()) {
writeStartBlocks(!getProperty("safeStartAllOperations") && insertToolCall, function () {
writeRetract(Z); // write optional Z retract before tool change if safeStartAllOperations is enabled
});
}
writeStartBlocks(insertToolCall, function () {
writeRetract(Z);
if (getSetting("retract.homeXY.onToolChange", false)) {
writeRetract(settings.retract.homeXY.onToolChange);
}
if (!isFirstSection() && insertToolCall) {
if (typeof forceWorkPlane == "function") {
forceWorkPlane();
}
onCommand(COMMAND_COOLANT_OFF); // turn off coolant on tool change
if (typeof disableLengthCompensation == "function") {
disableLengthCompensation(false);
}
}
if (tool.manualToolChange) {
onCommand(COMMAND_STOP);
writeComment("MANUAL TOOL CHANGE TO T" + toolFormat.format(tool.number));
} else {
if (!isFirstSection() && getProperty("optionalStop") && insertToolCall) {
onCommand(COMMAND_OPTIONAL_STOP);
}
onCommand(COMMAND_LOAD_TOOL);
}
});
if (typeof forceModals == "function" && (insertToolCall || getProperty("safeStartAllOperations"))) {
forceModals();
}
}
// <<<<< INCLUDED FROM include_files/writeToolCall.cpi
// >>>>> INCLUDED FROM include_files/startSpindle.cpi
function startSpindle(tool, insertToolCall) {
if (tool.type != TOOL_PROBE) {
var spindleSpeedIsRequired = insertToolCall || forceSpindleSpeed || isFirstSection() ||
rpmFormat.areDifferent(spindleSpeed, sOutput.getCurrent()) ||
(tool.clockwise != getPreviousSection().getTool().clockwise);
writeStartBlocks(spindleSpeedIsRequired, function () {
if (spindleSpeedIsRequired || operationNeedsSafeStart) {
onCommand(COMMAND_START_SPINDLE);
}
});
}
}
// <<<<< INCLUDED FROM include_files/startSpindle.cpi
// >>>>> INCLUDED FROM include_files/parametricFeeds.cpi
properties.useParametricFeed = {
title : "Parametric feed",
description: "Specifies that the feedrates should be output using parameters.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
};
var activeMovements;
var currentFeedId;
validate(settings.parametricFeeds, "Setting 'parametricFeeds' is required but not defined.");
function initializeParametricFeeds(insertToolCall) {
if (getProperty("useParametricFeed") && getParameter("operation-strategy") != "drill" && !currentSection.hasAnyCycle()) {
if (!insertToolCall && activeMovements && (getCurrentSectionId() > 0) &&
((getPreviousSection().getPatternId() == currentSection.getPatternId()) && (currentSection.getPatternId() != 0))) {
return; // use the current feeds
}
} else {
activeMovements = undefined;
return;
}
activeMovements = new Array();
var movements = currentSection.getMovements();
var id = 0;
var activeFeeds = new Array();
if (hasParameter("operation:tool_feedCutting")) {
if (movements & ((1 << MOVEMENT_CUTTING) | (1 << MOVEMENT_LINK_TRANSITION) | (1 << MOVEMENT_EXTENDED))) {
var feedContext = new FeedContext(id, localize("Cutting"), getParameter("operation:tool_feedCutting"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_CUTTING] = feedContext;
if (!hasParameter("operation:tool_feedTransition")) {
activeMovements[MOVEMENT_LINK_TRANSITION] = feedContext;
}
activeMovements[MOVEMENT_EXTENDED] = feedContext;
}
++id;
if (movements & (1 << MOVEMENT_PREDRILL)) {
feedContext = new FeedContext(id, localize("Predrilling"), getParameter("operation:tool_feedCutting"));
activeMovements[MOVEMENT_PREDRILL] = feedContext;
activeFeeds.push(feedContext);
}
++id;
}
if (hasParameter("operation:finishFeedrate")) {
if (movements & (1 << MOVEMENT_FINISH_CUTTING)) {
var feedContext = new FeedContext(id, localize("Finish"), getParameter("operation:finishFeedrate"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_FINISH_CUTTING] = feedContext;
}
++id;
} else if (hasParameter("operation:tool_feedCutting")) {
if (movements & (1 << MOVEMENT_FINISH_CUTTING)) {
var feedContext = new FeedContext(id, localize("Finish"), getParameter("operation:tool_feedCutting"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_FINISH_CUTTING] = feedContext;
}
++id;
}
if (hasParameter("operation:tool_feedEntry")) {
if (movements & (1 << MOVEMENT_LEAD_IN)) {
var feedContext = new FeedContext(id, localize("Entry"), getParameter("operation:tool_feedEntry"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_LEAD_IN] = feedContext;
}
++id;
}
if (hasParameter("operation:tool_feedExit")) {
if (movements & (1 << MOVEMENT_LEAD_OUT)) {
var feedContext = new FeedContext(id, localize("Exit"), getParameter("operation:tool_feedExit"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_LEAD_OUT] = feedContext;
}
++id;
}
if (hasParameter("operation:noEngagementFeedrate")) {
if (movements & (1 << MOVEMENT_LINK_DIRECT)) {
var feedContext = new FeedContext(id, localize("Direct"), getParameter("operation:noEngagementFeedrate"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_LINK_DIRECT] = feedContext;
}
++id;
} else if (hasParameter("operation:tool_feedCutting") &&
hasParameter("operation:tool_feedEntry") &&
hasParameter("operation:tool_feedExit")) {
if (movements & (1 << MOVEMENT_LINK_DIRECT)) {
var feedContext = new FeedContext(id, localize("Direct"), Math.max(getParameter("operation:tool_feedCutting"), getParameter("operation:tool_feedEntry"), getParameter("operation:tool_feedExit")));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_LINK_DIRECT] = feedContext;
}
++id;
}
if (hasParameter("operation:reducedFeedrate")) {
if (movements & (1 << MOVEMENT_REDUCED)) {
var feedContext = new FeedContext(id, localize("Reduced"), getParameter("operation:reducedFeedrate"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_REDUCED] = feedContext;
}
++id;
}
if (hasParameter("operation:tool_feedRamp")) {
if (movements & ((1 << MOVEMENT_RAMP) | (1 << MOVEMENT_RAMP_HELIX) | (1 << MOVEMENT_RAMP_PROFILE) | (1 << MOVEMENT_RAMP_ZIG_ZAG))) {
var feedContext = new FeedContext(id, localize("Ramping"), getParameter("operation:tool_feedRamp"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_RAMP] = feedContext;
activeMovements[MOVEMENT_RAMP_HELIX] = feedContext;
activeMovements[MOVEMENT_RAMP_PROFILE] = feedContext;
activeMovements[MOVEMENT_RAMP_ZIG_ZAG] = feedContext;
}
++id;
}
if (hasParameter("operation:tool_feedPlunge")) {
if (movements & (1 << MOVEMENT_PLUNGE)) {
var feedContext = new FeedContext(id, localize("Plunge"), getParameter("operation:tool_feedPlunge"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_PLUNGE] = feedContext;
}
++id;
}
if (true) { // high feed
if ((movements & (1 << MOVEMENT_HIGH_FEED)) || (highFeedMapping != HIGH_FEED_NO_MAPPING)) {
var feed;
if (hasParameter("operation:highFeedrateMode") && getParameter("operation:highFeedrateMode") != "disabled") {
feed = getParameter("operation:highFeedrate");
} else {
feed = this.highFeedrate;
}
var feedContext = new FeedContext(id, localize("High Feed"), feed);
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_HIGH_FEED] = feedContext;
activeMovements[MOVEMENT_RAPID] = feedContext;
}
++id;
}
if (hasParameter("operation:tool_feedTransition")) {
if (movements & (1 << MOVEMENT_LINK_TRANSITION)) {
var feedContext = new FeedContext(id, localize("Transition"), getParameter("operation:tool_feedTransition"));
activeFeeds.push(feedContext);
activeMovements[MOVEMENT_LINK_TRANSITION] = feedContext;
}
++id;
}
for (var i = 0; i < activeFeeds.length; ++i) {
var feedContext = activeFeeds[i];
var feedDescription = typeof formatComment == "function" ? formatComment(feedContext.description) : feedContext.description;
writeBlock(settings.parametricFeeds.feedAssignmentVariable + (settings.parametricFeeds.firstFeedParameter + feedContext.id) + "=" + feedFormat.format(feedContext.feed) + SP + feedDescription);
}
}
function FeedContext(id, description, feed) {
this.id = id;
this.description = description;
this.feed = feed;
}
// <<<<< INCLUDED FROM include_files/parametricFeeds.cpi
// >>>>> INCLUDED FROM include_files/smoothing.cpi
// collected state below, do not edit
validate(settings.smoothing, "Setting 'smoothing' is required but not defined.");
var smoothing = {
cancel : false, // cancel tool length prior to update smoothing for this operation
isActive : false, // the current state of smoothing
isAllowed : false, // smoothing is allowed for this operation
isDifferent: false, // tells if smoothing levels/tolerances/both are different between operations
level : -1, // the active level of smoothing
tolerance : -1, // the current operation tolerance
force : false // smoothing needs to be forced out in this operation
};
function initializeSmoothing() {
var smoothingSettings = settings.smoothing;
var previousLevel = smoothing.level;
var previousTolerance = xyzFormat.getResultingValue(smoothing.tolerance);
// format threshold parameters
var thresholdRoughing = xyzFormat.getResultingValue(smoothingSettings.thresholdRoughing);
var thresholdSemiFinishing = xyzFormat.getResultingValue(smoothingSettings.thresholdSemiFinishing);
var thresholdFinishing = xyzFormat.getResultingValue(smoothingSettings.thresholdFinishing);
// determine new smoothing levels and tolerances
smoothing.level = parseInt(getProperty("useSmoothing"), 10);
smoothing.level = isNaN(smoothing.level) ? -1 : smoothing.level;
smoothing.tolerance = xyzFormat.getResultingValue(Math.max(getParameter("operation:tolerance", thresholdFinishing), 0));
if (smoothing.level == 9999) {
if (smoothingSettings.autoLevelCriteria == "stock") { // determine auto smoothing level based on stockToLeave
var stockToLeave = xyzFormat.getResultingValue(getParameter("operation:stockToLeave", 0));
var verticalStockToLeave = xyzFormat.getResultingValue(getParameter("operation:verticalStockToLeave", 0));
if (((stockToLeave >= thresholdRoughing) && (verticalStockToLeave >= thresholdRoughing)) || getParameter("operation:strategy", "") == "face") {
smoothing.level = smoothingSettings.roughing; // set roughing level
} else {
if (((stockToLeave >= thresholdSemiFinishing) && (stockToLeave < thresholdRoughing)) &&
((verticalStockToLeave >= thresholdSemiFinishing) && (verticalStockToLeave < thresholdRoughing))) {
smoothing.level = smoothingSettings.semi; // set semi level
} else if (((stockToLeave >= thresholdFinishing) && (stockToLeave < thresholdSemiFinishing)) &&
((verticalStockToLeave >= thresholdFinishing) && (verticalStockToLeave < thresholdSemiFinishing))) {
smoothing.level = smoothingSettings.semifinishing; // set semi-finishing level
} else {
smoothing.level = smoothingSettings.finishing; // set finishing level
}
}
} else { // detemine auto smoothing level based on operation tolerance instead of stockToLeave
if (smoothing.tolerance >= thresholdRoughing || getParameter("operation:strategy", "") == "face") {
smoothing.level = smoothingSettings.roughing; // set roughing level
} else {
if (((smoothing.tolerance >= thresholdSemiFinishing) && (smoothing.tolerance < thresholdRoughing))) {
smoothing.level = smoothingSettings.semi; // set semi level
} else if (((smoothing.tolerance >= thresholdFinishing) && (smoothing.tolerance < thresholdSemiFinishing))) {
smoothing.level = smoothingSettings.semifinishing; // set semi-finishing level
} else {
smoothing.level = smoothingSettings.finishing; // set finishing level
}
}
}
}
if (smoothing.level == -1) { // useSmoothing is disabled
smoothing.isAllowed = false;
} else { // do not output smoothing for the following operations
smoothing.isAllowed = !(currentSection.getTool().type == TOOL_PROBE || isDrillingCycle());
}
if (!smoothing.isAllowed) {
smoothing.level = -1;
smoothing.tolerance = -1;
}
switch (smoothingSettings.differenceCriteria) {
case "level":
smoothing.isDifferent = smoothing.level != previousLevel;
break;
case "tolerance":
smoothing.isDifferent = smoothing.tolerance != previousTolerance;
break;
case "both":
smoothing.isDifferent = smoothing.level != previousLevel || smoothing.tolerance != previousTolerance;
break;
default:
error(localize("Unsupported smoothing criteria."));
return;
}
// tool length compensation needs to be canceled when smoothing state/level changes
if (smoothingSettings.cancelCompensation) {
smoothing.cancel = !isFirstSection() && smoothing.isDifferent;
}
}
// <<<<< INCLUDED FROM include_files/smoothing.cpi
// >>>>> INCLUDED FROM include_files/writeProgramHeader.cpi
properties.writeMachine = {
title : "Write machine",
description: "Output the machine settings in the header of the program.",
group : "formats",
type : "boolean",
value : true,
scope : "post"
};
properties.writeTools = {
title : "Write tool list",
description: "Output a tool list in the header of the program.",
group : "formats",
type : "boolean",
value : true,
scope : "post"
};
function writeProgramHeader() {
// dump machine configuration
var vendor = machineConfiguration.getVendor();
var model = machineConfiguration.getModel();
var mDescription = machineConfiguration.getDescription();
if (getProperty("writeMachine") && (vendor || model || mDescription)) {
writeComment(localize("Machine"));
if (vendor) {
writeComment(" " + localize("vendor") + ": " + vendor);
}
if (model) {
writeComment(" " + localize("model") + ": " + model);
}
if (mDescription) {
writeComment(" " + localize("description") + ": " + mDescription);
}
}
// dump tool information
if (getProperty("writeTools")) {
if (false) { // set to true to use the post kernel version of the tool list
writeToolTable(TOOL_NUMBER_COL);
} else {
var zRanges = {};
if (is3D()) {
var numberOfSections = getNumberOfSections();
for (var i = 0; i < numberOfSections; ++i) {
var section = getSection(i);
var zRange = section.getGlobalZRange();
var tool = section.getTool();
if (zRanges[tool.number]) {
zRanges[tool.number].expandToRange(zRange);
} else {
zRanges[tool.number] = zRange;
}
}
}
var tools = getToolTable();
if (tools.getNumberOfTools() > 0) {
for (var i = 0; i < tools.getNumberOfTools(); ++i) {
var tool = tools.getTool(i);
var comment = (getProperty("toolAsName") ? "\"" + tool.description.toUpperCase() + "\"" : "T" + toolFormat.format(tool.number)) + " " +
"D=" + xyzFormat.format(tool.diameter) + " " +
localize("CR") + "=" + xyzFormat.format(tool.cornerRadius);
if ((tool.taperAngle > 0) && (tool.taperAngle < Math.PI)) {
comment += " " + localize("TAPER") + "=" + taperFormat.format(tool.taperAngle) + localize("deg");
}
if (zRanges[tool.number]) {
comment += " - " + localize("ZMIN") + "=" + xyzFormat.format(zRanges[tool.number].getMinimum());
}
comment += " - " + getToolTypeName(tool.type);
writeComment(comment);
}
}
}
}
}
// <<<<< INCLUDED FROM include_files/writeProgramHeader.cpi
// >>>>> INCLUDED FROM include_files/subprograms.cpi
properties.useSubroutines = {
title : "Use subroutines",
description: "Select your desired subroutine option. 'All Operations' creates subroutines per each operation, 'Cycles' creates subroutines for cycle operations on same holes, and 'Patterns' creates subroutines for patterned operations.",
group : "preferences",
type : "enum",
values : [
{title:"No", id:"none"},
{title:"All Operations", id:"allOperations"},
{title:"All Operations & Patterns", id:"allPatterns"},
{title:"Cycles", id:"cycles"},
{title:"Operations, Patterns, Cycles", id:"all"},
{title:"Patterns", id:"patterns"}
],
value: "none",
scope: "post"
};
properties.useFilesForSubprograms = {
title : "Use files for subroutines",
description: "If enabled, subroutines will be saved as individual files.",
group : "preferences",
type : "boolean",
value : false,
scope : "post"
};
var NONE = 0x0000;
var PATTERNS = 0x0001;
var CYCLES = 0x0010;
var ALLOPERATIONS = 0x0100;
var subroutineBitmasks = {
none : NONE,
patterns : PATTERNS,
cycles : CYCLES,
allOperations: ALLOPERATIONS,
allPatterns : PATTERNS + ALLOPERATIONS,
all : PATTERNS + CYCLES + ALLOPERATIONS
};
var SUB_UNKNOWN = 0;
var SUB_PATTERN = 1;
var SUB_CYCLE = 2;
// collected state below, do not edit
validate(settings.subprograms, "Setting 'subprograms' is required but not defined.");
var subprogramState = {
subprograms : [], // Redirection buffer
newSubprogram : false, // Indicate if the current subprogram is new to definedSubprograms
currentSubprogram : 0, // The current subprogram number
lastSubprogram : undefined, // The last subprogram number
definedSubprograms : new Array(), // A collection of pattern and cycle subprograms
saveShowSequenceNumbers: "", // Used to store pre-condition of "showSequenceNumbers"
cycleSubprogramIsActive: false, // Indicate if it's handling a cycle subprogram
patternIsActive : false, // Indicate if it's handling a pattern subprogram
incrementalSubprogram : false, // Indicate if the current subprogram needs to go incremental mode
incrementalMode : false, // Indicate if incremental mode is on
mainProgramNumber : undefined // The main program number
};
function subprogramResolveSetting(_setting, _val, _comment) {
if (typeof _setting == "string") {
return formatWords(_setting.toString().replace("%currentSubprogram", subprogramState.currentSubprogram), (_comment ? formatComment(_comment) : ""));
} else {
return formatWords(_setting + (_val ? settings.subprograms.format.format(_val) : ""), (_comment ? formatComment(_comment) : ""));
}
}
/**
* Start to redirect buffer to subprogram.
* @param {Vector} initialPosition Initial position
* @param {Vector} abc Machine axis angles
* @param {boolean} incremental If the subprogram needs to go incremental mode
*/
function subprogramStart(initialPosition, abc, incremental) {
var comment = getParameter("operation-comment", "");
var startBlock;
if (getProperty("useFilesForSubprograms")) {
var _fileName = subprogramState.currentSubprogram;
var subprogramExtension = extension;
if (settings.subprograms.files) {
if (settings.subprograms.files.prefix != undefined) {
_fileName = subprogramResolveSetting(settings.subprograms.files.prefix, subprogramState.currentSubprogram);
}
if (settings.subprograms.files.extension) {
subprogramExtension = settings.subprograms.files.extension;
}
}
var path = FileSystem.getCombinedPath(FileSystem.getFolderPath(getOutputPath()), _fileName + "." + subprogramExtension);
redirectToFile(path);
startBlock = subprogramResolveSetting(settings.subprograms.startBlock.files, subprogramState.currentSubprogram, comment);
} else {
redirectToBuffer();
startBlock = subprogramResolveSetting(settings.subprograms.startBlock.embedded, subprogramState.currentSubprogram, comment);
}
writeln(startBlock);
subprogramState.saveShowSequenceNumbers = getProperty("showSequenceNumbers", undefined);
if (subprogramState.saveShowSequenceNumbers != undefined) {
setProperty("showSequenceNumbers", "false");
}
if (incremental) {
setAbsIncMode(true, initialPosition, abc);
}
if (typeof gPlaneModal != "undefined" && typeof gMotionModal != "undefined") {
forceModals(gPlaneModal, gMotionModal);
}
}
/** Output the command for calling a subprogram by its subprogram number. */
function subprogramCall() {
var callBlock;
if (getProperty("useFilesForSubprograms")) {
callBlock = subprogramResolveSetting(settings.subprograms.callBlock.files, subprogramState.currentSubprogram);
} else {
callBlock = subprogramResolveSetting(settings.subprograms.callBlock.embedded, subprogramState.currentSubprogram);
}
writeBlock(callBlock); // call subprogram
}
/** End of subprogram and close redirection. */
function subprogramEnd() {
if (isRedirecting()) {
if (subprogramState.newSubprogram) {
var finalPosition = getFramePosition(currentSection.getFinalPosition());
var abc;
if (currentSection.isMultiAxis() && machineConfiguration.isMultiAxisConfiguration()) {
abc = currentSection.getFinalToolAxisABC();
} else {
abc = getCurrentDirection();
}
setAbsIncMode(false, finalPosition, abc);
if (getProperty("useFilesForSubprograms")) {
var endBlockFiles = subprogramResolveSetting(settings.subprograms.endBlock.files);
writeln(endBlockFiles);
} else {
var endBlockEmbedded = subprogramResolveSetting(settings.subprograms.endBlock.embedded);
writeln(endBlockEmbedded);
writeln("");
subprogramState.subprograms += getRedirectionBuffer();
}
}
forceAny();
subprogramState.newSubprogram = false;
subprogramState.cycleSubprogramIsActive = false;
if (subprogramState.saveShowSequenceNumbers != undefined) {
setProperty("showSequenceNumbers", subprogramState.saveShowSequenceNumbers);
}
closeRedirection();
}
}
/** Returns true if the spatial vectors are significantly different. */
function areSpatialVectorsDifferent(_vector1, _vector2) {
return (xyzFormat.getResultingValue(_vector1.x) != xyzFormat.getResultingValue(_vector2.x)) ||
(xyzFormat.getResultingValue(_vector1.y) != xyzFormat.getResultingValue(_vector2.y)) ||
(xyzFormat.getResultingValue(_vector1.z) != xyzFormat.getResultingValue(_vector2.z));
}
/** Returns true if the spatial boxes are a pure translation. */
function areSpatialBoxesTranslated(_box1, _box2) {
return !areSpatialVectorsDifferent(Vector.diff(_box1[1], _box1[0]), Vector.diff(_box2[1], _box2[0])) &&
!areSpatialVectorsDifferent(Vector.diff(_box2[0], _box1[0]), Vector.diff(_box2[1], _box1[1]));
}
/** Returns true if the spatial boxes are same. */
function areSpatialBoxesSame(_box1, _box2) {
return !areSpatialVectorsDifferent(_box1[0], _box2[0]) && !areSpatialVectorsDifferent(_box1[1], _box2[1]);
}
/**
* Search defined pattern subprogram by the given id.
* @param {number} subprogramId Subprogram Id
* @returns {Object} Returns defined subprogram if found, otherwise returns undefined
*/
function getDefinedPatternSubprogram(subprogramId) {
for (var i = 0; i < subprogramState.definedSubprograms.length; ++i) {
if ((SUB_PATTERN == subprogramState.definedSubprograms[i].type) && (subprogramId == subprogramState.definedSubprograms[i].id)) {
return subprogramState.definedSubprograms[i];
}
}
return undefined;
}
/**
* Search defined cycle subprogram pattern by the given id, initialPosition, finalPosition.
* @param {number} subprogramId Subprogram Id
* @param {Vector} initialPosition Initial position of the cycle
* @param {Vector} finalPosition Final position of the cycle
* @returns {Object} Returns defined subprogram if found, otherwise returns undefined
*/
function getDefinedCycleSubprogram(subprogramId, initialPosition, finalPosition) {
for (var i = 0; i < subprogramState.definedSubprograms.length; ++i) {
if ((SUB_CYCLE == subprogramState.definedSubprograms[i].type) && (subprogramId == subprogramState.definedSubprograms[i].id) &&
!areSpatialVectorsDifferent(initialPosition, subprogramState.definedSubprograms[i].initialPosition) &&
!areSpatialVectorsDifferent(finalPosition, subprogramState.definedSubprograms[i].finalPosition)) {
return subprogramState.definedSubprograms[i];
}
}
return undefined;
}
/**
* Creates and returns new defined subprogram
* @param {Section} section The section to create subprogram
* @param {number} subprogramId Subprogram Id
* @param {number} subprogramType Subprogram type, can be SUB_UNKNOWN, SUB_PATTERN or SUB_CYCLE
* @param {Vector} initialPosition Initial position
* @param {Vector} finalPosition Final position
* @returns {Object} Returns new defined subprogram
*/
function defineNewSubprogram(section, subprogramId, subprogramType, initialPosition, finalPosition) {
// determine if this is valid for creating a subprogram
isValid = subprogramIsValid(section, subprogramId, subprogramType);
var subprogram = isValid ? subprogram = ++subprogramState.lastSubprogram : undefined;
subprogramState.definedSubprograms.push({
type : subprogramType,
id : subprogramId,
subProgram : subprogram,
isValid : isValid,
initialPosition: initialPosition,
finalPosition : finalPosition
});
return subprogramState.definedSubprograms[subprogramState.definedSubprograms.length - 1];
}
/** Returns true if the given section is a pattern **/
function isPatternOperation(section) {
return section.isPatterned && section.isPatterned();
}
/** Returns true if the given section is a cycle operation **/
function isCycleOperation(section, minimumCyclePoints) {
return section.doesStrictCycle &&
(section.getNumberOfCycles() == 1) && (section.getNumberOfCyclePoints() >= minimumCyclePoints);
}
/** Returns true if the subroutine bit flag is enabled **/
function isSubProgramEnabledFor(subroutine) {
return subroutineBitmasks[getProperty("useSubroutines")] & subroutine;
}
/**
* Define subprogram based on the property "useSubroutines"
* @param {Vector} _initialPosition Initial position
* @param {Vector} _abc Machine axis angles
*/
function subprogramDefine(_initialPosition, _abc) {
if (isSubProgramEnabledFor(NONE)) {
// Return early
return;
}
if (subprogramState.lastSubprogram == undefined) { // initialize first subprogram number
if (settings.subprograms.initialSubprogramNumber == undefined) {
try {
subprogramState.lastSubprogram = getAsInt(programName);
subprogramState.mainProgramNumber = subprogramState.lastSubprogram; // mainProgramNumber must be a number
} catch (e) {
error(localize("Program name must be a number when using subprograms."));
return;
}
} else {
subprogramState.lastSubprogram = settings.subprograms.initialSubprogramNumber - 1;
// if programName is a string set mainProgramNumber to undefined, if programName is a number set mainProgramNumber to programName
subprogramState.mainProgramNumber = (!isNaN(programName) && !isNaN(parseInt(programName, 10))) ? getAsInt(programName) : undefined;
}
}
// convert patterns into subprograms
subprogramState.patternIsActive = false;
if (isSubProgramEnabledFor(PATTERNS) && isPatternOperation(currentSection)) {
var subprogramId = currentSection.getPatternId();
var subprogramType = SUB_PATTERN;
var subprogramDefinition = getDefinedPatternSubprogram(subprogramId);
subprogramState.newSubprogram = !subprogramDefinition;
if (subprogramState.newSubprogram) {
subprogramDefinition = defineNewSubprogram(currentSection, subprogramId, subprogramType, _initialPosition, _initialPosition);
}
subprogramState.currentSubprogram = subprogramDefinition.subProgram;
if (subprogramDefinition.isValid) {
// make sure Z-position is output prior to subprogram call
var z = zOutput.format(_initialPosition.z);
if (!state.retractedZ && z) {
validate(!validateLengthCompensation || state.lengthCompensationActive, "Tool length compensation is not active."); // make sure that length compensation is enabled
var block = "";
if (typeof gAbsIncModal != "undefined") {
block += gAbsIncModal.format(90);
}
if (typeof gPlaneModal != "undefined") {
block += gPlaneModal.format(17);
}
writeBlock(block);
zOutput.reset();
invokeOnRapid(xOutput.getCurrent(), yOutput.getCurrent(), _initialPosition.z);
}
// call subprogram
subprogramCall();
subprogramState.patternIsActive = true;
if (subprogramState.newSubprogram) {
subprogramStart(_initialPosition, _abc, subprogramState.incrementalSubprogram);
} else {
skipRemainingSection();
setCurrentPosition(getFramePosition(currentSection.getFinalPosition()));
}
}
}
// Patterns are not used, check other cases
if (!subprogramState.patternIsActive) {
// Output cycle operation as subprogram
if (isSubProgramEnabledFor(CYCLES) && isCycleOperation(currentSection, settings.subprograms.minimumCyclePoints)) {
var finalPosition = getFramePosition(currentSection.getFinalPosition());
var subprogramId = currentSection.getNumberOfCyclePoints();
var subprogramType = SUB_CYCLE;
var subprogramDefinition = getDefinedCycleSubprogram(subprogramId, _initialPosition, finalPosition);
subprogramState.newSubprogram = !subprogramDefinition;
if (subprogramState.newSubprogram) {
subprogramDefinition = defineNewSubprogram(currentSection, subprogramId, subprogramType, _initialPosition, finalPosition);
}
subprogramState.currentSubprogram = subprogramDefinition.subProgram;
subprogramState.cycleSubprogramIsActive = subprogramDefinition.isValid;
}
// Neither patterns and cycles are used, check other operations
if (!subprogramState.cycleSubprogramIsActive && isSubProgramEnabledFor(ALLOPERATIONS)) {
// Output all operations as subprograms
subprogramState.currentSubprogram = ++subprogramState.lastSubprogram;
if (subprogramState.mainProgramNumber != undefined && (subprogramState.currentSubprogram == subprogramState.mainProgramNumber)) {
subprogramState.currentSubprogram = ++subprogramState.lastSubprogram; // avoid using main program number for current subprogram
}
subprogramCall();
subprogramState.newSubprogram = true;
subprogramStart(_initialPosition, _abc, false);
}
}
}
/**
* Determine if this is valid for creating a subprogram
* @param {Section} section The section to create subprogram
* @param {number} subprogramId Subprogram Id
* @param {number} subprogramType Subprogram type, can be SUB_UNKNOWN, SUB_PATTERN or SUB_CYCLE
* @returns {boolean} If this is valid for creating a subprogram
*/
function subprogramIsValid(_section, subprogramId, subprogramType) {
var sectionId = _section.getId();
var numberOfSections = getNumberOfSections();
var validSubprogram = subprogramType != SUB_CYCLE;
var masterPosition = new Array();
masterPosition[0] = getFramePosition(_section.getInitialPosition());
masterPosition[1] = getFramePosition(_section.getFinalPosition());
var tempBox = _section.getBoundingBox();
var masterBox = new Array();
masterBox[0] = getFramePosition(tempBox[0]);
masterBox[1] = getFramePosition(tempBox[1]);
var rotation = getRotation();
var translation = getTranslation();
subprogramState.incrementalSubprogram = undefined;
for (var i = 0; i < numberOfSections; ++i) {
var section = getSection(i);
if (section.getId() != sectionId) {
defineWorkPlane(section, false);
// check for valid pattern
if (subprogramType == SUB_PATTERN) {
if (section.getPatternId() == subprogramId) {
var patternPosition = new Array();
patternPosition[0] = getFramePosition(section.getInitialPosition());
patternPosition[1] = getFramePosition(section.getFinalPosition());
tempBox = section.getBoundingBox();
var patternBox = new Array();
patternBox[0] = getFramePosition(tempBox[0]);
patternBox[1] = getFramePosition(tempBox[1]);
if (areSpatialBoxesSame(masterPosition, patternPosition) && areSpatialBoxesSame(masterBox, patternBox) && !section.isMultiAxis()) {
subprogramState.incrementalSubprogram = subprogramState.incrementalSubprogram ? subprogramState.incrementalSubprogram : false;
} else if (!areSpatialBoxesTranslated(masterPosition, patternPosition) || !areSpatialBoxesTranslated(masterBox, patternBox)) {
validSubprogram = false;
break;
} else {
subprogramState.incrementalSubprogram = true;
}
}
// check for valid cycle operation
} else if (subprogramType == SUB_CYCLE) {
if ((section.getNumberOfCyclePoints() == subprogramId) && (section.getNumberOfCycles() == 1)) {
var patternInitial = getFramePosition(section.getInitialPosition());
var patternFinal = getFramePosition(section.getFinalPosition());
if (!areSpatialVectorsDifferent(patternInitial, masterPosition[0]) && !areSpatialVectorsDifferent(patternFinal, masterPosition[1])) {
validSubprogram = true;
break;
}
}
}
}
}
setRotation(rotation);
setTranslation(translation);
return (validSubprogram);
}
/**
* Sets xyz and abc output formats to incremental or absolute type
* @param {boolean} incremental true: Sets incremental mode, false: Sets absolute mode
* @param {Vector} xyz Linear axis values for formating
* @param {Vector} abc Rotary axis values for formating
*/
function setAbsIncMode(incremental, xyz, abc) {
var outputFormats = [xOutput, yOutput, zOutput, aOutput, bOutput, cOutput];
for (var i = 0; i < outputFormats.length; ++i) {
outputFormats[i].setType(incremental ? TYPE_INCREMENTAL : TYPE_ABSOLUTE);
if (typeof incPrefix != "undefined" && typeof absPrefix != "undefined") {
outputFormats[i].setPrefix(incremental ? incPrefix[i] : absPrefix[i]);
}
if (i <= 2) { // xyz
outputFormats[i].setCurrent(xyz.getCoordinate(i));
} else { // abc
outputFormats[i].setCurrent(abc.getCoordinate(i - 3));
}
}
subprogramState.incrementalMode = incremental;
if (typeof gAbsIncModal != "undefined") {
if (incremental) {
forceModals(gAbsIncModal);
}
writeBlock(gAbsIncModal.format(incremental ? 91 : 90));
}
}
function setCyclePosition(_position) {
var _spindleAxis;
if (typeof gPlaneModal != "undefined") {
_spindleAxis = gPlaneModal.getCurrent() == 17 ? Z : (gPlaneModal.getCurrent() == 18 ? Y : X);
} else {
var _spindleDirection = machineConfiguration.getSpindleAxis().getAbsolute();
_spindleAxis = isSameDirection(_spindleDirection, new Vector(0, 0, 1)) ? Z : isSameDirection(_spindleDirection, new Vector(0, 1, 0)) ? Y : X;
}
switch (_spindleAxis) {
case Z:
zOutput.format(_position);
break;
case Y:
yOutput.format(_position);
break;
case X:
xOutput.format(_position);
break;
}
}
/**
* Place cycle operation in subprogram
* @param {Vector} initialPosition Initial position
* @param {Vector} abc Machine axis angles
* @param {boolean} incremental If the subprogram needs to go incremental mode
*/
function handleCycleSubprogram(initialPosition, abc, incremental) {
subprogramState.cycleSubprogramIsActive &= !(cycleExpanded || isProbeOperation());
if (subprogramState.cycleSubprogramIsActive) {
// call subprogram
subprogramCall();
subprogramStart(initialPosition, abc, incremental);
}
}
function writeSubprograms() {
if (subprogramState.subprograms.length > 0) {
writeln("");
write(subprogramState.subprograms);
}
}
// <<<<< INCLUDED FROM include_files/subprograms.cpi
// >>>>> INCLUDED FROM include_files/onRapid_haas.cpi
function onRapid(_x, _y, _z) {
var x = xOutput.format(_x);
var y = yOutput.format(_y);
var z = zOutput.format(_z);
if (x || y || z) {
if (pendingRadiusCompensation >= 0) {
error(localize("Radius compensation mode cannot be changed at rapid traversal."));
return;
}
if (!getProperty("useG0") && (((x ? 1 : 0) + (y ? 1 : 0) + (z ? 1 : 0)) > 1)) {
// axes are not synchronized
writeBlock(gFeedModeModal.format(94), gMotionModal.format(1), x, y, z, getFeed(highFeedrate));
} else {
writeBlock(gMotionModal.format(0), x, y, z);
forceFeed();
}
}
}
// <<<<< INCLUDED FROM include_files/onRapid_haas.cpi
// >>>>> INCLUDED FROM include_files/onLinear_fanuc.cpi
function onLinear(_x, _y, _z, feed) {
if (pendingRadiusCompensation >= 0) {
xOutput.reset();
yOutput.reset();
}
var x = xOutput.format(_x);
var y = yOutput.format(_y);
var z = zOutput.format(_z);
var f = getFeed(feed);
if (x || y || z) {
if (pendingRadiusCompensation >= 0) {
pendingRadiusCompensation = -1;
var d = getSetting("outputToolDiameterOffset", true) ? diameterOffsetFormat.format(tool.diameterOffset) : "";
writeBlock(gPlaneModal.format(17));
switch (radiusCompensation) {
case RADIUS_COMPENSATION_LEFT:
writeBlock(gMotionModal.format(1), gFormat.format(41), x, y, z, d, f);
break;
case RADIUS_COMPENSATION_RIGHT:
writeBlock(gMotionModal.format(1), gFormat.format(42), x, y, z, d, f);
break;
default:
writeBlock(gMotionModal.format(1), gFormat.format(40), x, y, z, f);
}
} else {
writeBlock(gMotionModal.format(1), x, y, z, f);
}
} else if (f) {
if (getNextRecord().isMotion()) { // try not to output feed without motion
forceFeed(); // force feed on next line
} else {
writeBlock(gMotionModal.format(1), f);
}
}
}
// <<<<< INCLUDED FROM include_files/onLinear_fanuc.cpi
// >>>>> INCLUDED FROM include_files/onRapid5D_haas.cpi
function onRapid5D(_x, _y, _z, _a, _b, _c) {
if (!currentSection.isOptimizedForMachine()) {
error(localize("This post configuration has not been customized for 5-axis simultaneous toolpath."));
return;
}
if (pendingRadiusCompensation >= 0) {
error(localize("Radius compensation mode cannot be changed at rapid traversal."));
return;
}
var num =
(xyzFormat.areDifferent(_x, xOutput.getCurrent()) ? 1 : 0) +
(xyzFormat.areDifferent(_y, yOutput.getCurrent()) ? 1 : 0) +
(xyzFormat.areDifferent(_z, zOutput.getCurrent()) ? 1 : 0) +
((aOutput.isEnabled() && abcFormat.areDifferent(_a, aOutput.getCurrent())) ? 1 : 0) +
((bOutput.isEnabled() && abcFormat.areDifferent(_b, bOutput.getCurrent())) ? 1 : 0) +
((cOutput.isEnabled() && abcFormat.areDifferent(_c, cOutput.getCurrent())) ? 1 : 0);
var x = xOutput.format(_x);
var y = yOutput.format(_y);
var z = zOutput.format(_z);
var a = aOutput.format(_a);
var b = bOutput.format(_b);
var c = cOutput.format(_c);
if (x || y || z || a || b || c) {
if (!getProperty("useG0") && (tcp.isSupportedByOperation || (num > 1))) {
// axes are not synchronized
writeBlock(gFeedModeModal.format(94), gMotionModal.format(1), x, y, z, a, b, c, getFeed(highFeedrate));
} else {
writeBlock(gMotionModal.format(0), x, y, z, a, b, c);
forceFeed();
}
}
}
// <<<<< INCLUDED FROM include_files/onRapid5D_haas.cpi
// >>>>> INCLUDED FROM include_files/onLinear5D_fanuc.cpi
function onLinear5D(_x, _y, _z, _a, _b, _c, feed, feedMode) {
if (pendingRadiusCompensation >= 0) {
error(localize("Radius compensation cannot be activated/deactivated for 5-axis move."));
return;
}
if (!currentSection.isOptimizedForMachine()) {
forceXYZ();
}
var x = xOutput.format(_x);
var y = yOutput.format(_y);
var z = zOutput.format(_z);
var a = currentSection.isOptimizedForMachine() ? aOutput.format(_a) : toolVectorOutputI.format(_a);
var b = currentSection.isOptimizedForMachine() ? bOutput.format(_b) : toolVectorOutputJ.format(_b);
var c = currentSection.isOptimizedForMachine() ? cOutput.format(_c) : toolVectorOutputK.format(_c);
if (feedMode == FEED_INVERSE_TIME) {
forceFeed();
}
var f = feedMode == FEED_INVERSE_TIME ? inverseTimeOutput.format(feed) : getFeed(feed);
var fMode = feedMode == FEED_INVERSE_TIME ? 93 : getProperty("useG95") ? 95 : 94;
if (x || y || z || a || b || c) {
writeBlock(gFeedModeModal.format(fMode), gMotionModal.format(1), x, y, z, a, b, c, f);
} else if (f) {
if (getNextRecord().isMotion()) { // try not to output feed without motion
forceFeed(); // force feed on next line
} else {
writeBlock(gFeedModeModal.format(fMode), gMotionModal.format(1), f);
}
}
}
// <<<<< INCLUDED FROM include_files/onLinear5D_fanuc.cpi
// >>>>> INCLUDED FROM include_files/onCircular_haas.cpi
function onCircular(clockwise, cx, cy, cz, x, y, z, feed) {
if (isSpiral()) {
var startRadius = getCircularStartRadius();
var endRadius = getCircularRadius();
var dr = Math.abs(endRadius - startRadius);
if (dr > maximumCircularRadiiDifference) { // maximum limit
linearize(tolerance); // or alternatively use other G-codes for spiral motion
return;
}
}
if (gRotationModal.getCurrent() == 68 && getCircularPlane() != PLANE_XY) {
linearize(tolerance);
return;
}
if (pendingRadiusCompensation >= 0) {
error(localize("Radius compensation cannot be activated/deactivated for a circular move."));
return;
}
var start = getCurrentPosition();
if (isFullCircle()) {
if (getProperty("useRadius") || isHelical()) { // radius mode does not support full arcs
linearize(tolerance);
return;
}
switch (getCircularPlane()) {
case PLANE_XY:
writeBlock(gPlaneModal.format(17), gFeedModeModal.format(94), gMotionModal.format(clockwise ? 2 : 3), iOutput.format(cx - start.x), jOutput.format(cy - start.y), getFeed(feed));
break;
case PLANE_ZX:
writeBlock(gPlaneModal.format(18), gFeedModeModal.format(94), gMotionModal.format(clockwise ? 2 : 3), iOutput.format(cx - start.x), kOutput.format(cz - start.z), getFeed(feed));
break;
case PLANE_YZ:
writeBlock(gPlaneModal.format(19), gFeedModeModal.format(94), gMotionModal.format(clockwise ? 2 : 3), jOutput.format(cy - start.y), kOutput.format(cz - start.z), getFeed(feed));
break;
default:
linearize(tolerance);
}
} else if (!getProperty("useRadius")) {
switch (getCircularPlane()) {
case PLANE_XY:
writeBlock(gPlaneModal.format(17), gFeedModeModal.format(94), gMotionModal.format(clockwise ? 2 : 3), xOutput.format(x), yOutput.format(y), zOutput.format(z), iOutput.format(cx - start.x), jOutput.format(cy - start.y), getFeed(feed));
break;
case PLANE_ZX:
writeBlock(gPlaneModal.format(18), gFeedModeModal.format(94), gMotionModal.format(clockwise ? 2 : 3), xOutput.format(x), yOutput.format(y), zOutput.format(z), iOutput.format(cx - start.x), kOutput.format(cz - start.z), getFeed(feed));
break;
case PLANE_YZ:
writeBlock(gPlaneModal.format(19), gFeedModeModal.format(94), gMotionModal.format(clockwise ? 2 : 3), xOutput.format(x), yOutput.format(y), zOutput.format(z), jOutput.format(cy - start.y), kOutput.format(cz - start.z), getFeed(feed));
break;
default:
linearize(tolerance);
}
} else { // use radius mode
var r = getCircularRadius();
if (toDeg(getCircularSweep()) > (180 + 1e-9)) {
r = -r; // allow up to <360 deg arcs
}
switch (getCircularPlane()) {
case PLANE_XY:
writeBlock(gPlaneModal.format(17), gFeedModeModal.format(94), gMotionModal.format(clockwise ? 2 : 3), xOutput.format(x), yOutput.format(y), zOutput.format(z), "R" + rFormat.format(r), getFeed(feed));
break;
case PLANE_ZX:
writeBlock(gPlaneModal.format(18), gFeedModeModal.format(94), gMotionModal.format(clockwise ? 2 : 3), xOutput.format(x), yOutput.format(y), zOutput.format(z), "R" + rFormat.format(r), getFeed(feed));
break;
case PLANE_YZ:
writeBlock(gPlaneModal.format(19), gFeedModeModal.format(94), gMotionModal.format(clockwise ? 2 : 3), xOutput.format(x), yOutput.format(y), zOutput.format(z), "R" + rFormat.format(r), getFeed(feed));
break;
default:
linearize(tolerance);
}
}
}
// <<<<< INCLUDED FROM include_files/onCircular_haas.cpi
// >>>>> INCLUDED FROM include_files/workPlaneFunctions_haas.cpi
var currentWorkPlaneABC = undefined;
function forceWorkPlane() {
currentWorkPlaneABC = undefined;
}
function cancelWCSRotation() {
if (typeof gRotationModal != "undefined" && gRotationModal.getCurrent() == 68) {
writeBlock(gRotationModal.format(69));
}
}
function cancelWorkPlane(force) {
if (typeof gWorkplaneModal != "undefined") {
if (force) {
gWorkplaneModal.reset();
}
var command = gWorkplaneModal.format(255);
if (command) {
writeBlock(command); // cancel frame
forceWorkPlane();
}
}
}
function setWorkPlane(abc) {
if (!settings.workPlaneMethod.forceMultiAxisIndexing && is3D() && !machineConfiguration.isMultiAxisConfiguration()) {
return; // ignore
}
var workplaneIsRequired = (currentWorkPlaneABC == undefined) ||
abcFormat.areDifferent(abc.x, currentWorkPlaneABC.x) ||
abcFormat.areDifferent(abc.y, currentWorkPlaneABC.y) ||
abcFormat.areDifferent(abc.z, currentWorkPlaneABC.z);
writeStartBlocks(workplaneIsRequired, function () {
writeRetract(Z);
if (getSetting("retract.homeXY.onIndexing", false)) {
writeRetract(settings.retract.homeXY.onIndexing);
}
if (settings.workPlaneMethod.useTiltedWorkplane) {
onCommand(COMMAND_UNLOCK_MULTI_AXIS);
cancelWorkPlane();
if (machineConfiguration.isMultiAxisConfiguration()) {
var machineABC = abc.isNonZero() ? (currentSection.isMultiAxis() ? getCurrentDirection() : getWorkPlaneMachineABC(currentSection, false)) : abc;
if (settings.workPlaneMethod.useABCPrepositioning || machineABC.isZero()) {
positionABC(machineABC, false);
} else {
setCurrentABC(machineABC);
machineSimulation({a:machineABC.x, b:machineABC.y, c:machineABC.z, coordinates:MACHINE});
}
if (abcFormat.isSignificant(abc.x % (Math.PI * 2)) || abcFormat.isSignificant(abc.y % (Math.PI * 2)) || abcFormat.isSignificant(abc.z % (Math.PI * 2))) {
writeBlock(gWorkplaneModal.format(254)); // enable DWO
}
}
} else {
positionABC(abc, true);
}
if (!currentSection.isMultiAxis() && !isPolarModeActive()) {
onCommand(COMMAND_LOCK_MULTI_AXIS);
}
currentWorkPlaneABC = abc;
});
}
// <<<<< INCLUDED FROM include_files/workPlaneFunctions_haas.cpi
// >>>>> INCLUDED FROM include_files/writeRetract_fanuc.cpi
function writeRetract() {
var retract = getRetractParameters.apply(this, arguments);
if (retract && retract.words.length > 0) {
if (typeof cancelWCSRotation == "function" && getSetting("retract.cancelRotationOnRetracting", false)) { // cancel rotation before retracting
cancelWCSRotation();
}
if (typeof disableLengthCompensation == "function" && getSetting("allowCancelTCPBeforeRetracting", false) && state.tcpIsActive) {
disableLengthCompensation(); // cancel TCP before retracting
}
for (var i in retract.words) {
var words = retract.singleLine ? retract.words : retract.words[i];
switch (retract.method) {
case "G28":
forceModals(gMotionModal, gAbsIncModal);
writeBlock(gFormat.format(28), gAbsIncModal.format(91), words);
writeBlock(gAbsIncModal.format(90));
break;
case "G30":
forceModals(gMotionModal, gAbsIncModal);
writeBlock(gFormat.format(30), gAbsIncModal.format(91), words);
writeBlock(gAbsIncModal.format(90));
break;
case "G53":
forceModals(gMotionModal);
writeBlock(gAbsIncModal.format(90), gFormat.format(53), gMotionModal.format(0), words);
break;
default:
if (typeof writeRetractCustom == "function") {
writeRetractCustom(retract);
return;
} else {
error(subst(localize("Unsupported safe position method '%1'"), retract.method));
}
}
machineSimulation({
x : retract.singleLine || words.indexOf("X") != -1 ? retract.positions.x : undefined,
y : retract.singleLine || words.indexOf("Y") != -1 ? retract.positions.y : undefined,
z : retract.singleLine || words.indexOf("Z") != -1 ? retract.positions.z : undefined,
coordinates: MACHINE
});
if (retract.singleLine) {
break;
}
}
}
}
// <<<<< INCLUDED FROM include_files/writeRetract_fanuc.cpi
// >>>>> INCLUDED FROM include_files/initialPositioning_haas.cpi
/**
* Writes the initial positioning procedure for a section to get to the start position of the toolpath.
* @param {Vector} position The initial position to move to
* @param {boolean} isRequired true: Output full positioning, false: Output full positioning in optional state or output simple positioning only
* @param {String} codes1 Allows to add additional code to the first positioning line
* @param {String} codes2 Allows to add additional code to the second positioning line (if applicable)
* @example
var myVar1 = formatWords("T" + tool.number, currentSection.wcs);
var myVar2 = getCoolantCodes(tool.coolant);
writeInitialPositioning(initialPosition, isRequired, myVar1, myVar2);
*/
function writeInitialPositioning(position, isRequired, codes1, codes2) {
var motionCode = {single:0, multi:0};
if (false) {
switch (highFeedMapping) {
case HIGH_FEED_MAP_ANY:
motionCode = {single:1, multi:1}; // map all rapid traversals to high feed
break;
case HIGH_FEED_MAP_MULTI:
motionCode = {single:0, multi:1}; // map rapid traversal along more than one axis to high feed
break;
}
} else {
motionCode = (highFeedMapping != HIGH_FEED_NO_MAPPING || !getProperty("useG0") ? {single:0, multi:1} : {single:0, multi:0});
}
var feed = (highFeedMapping != HIGH_FEED_NO_MAPPING || !getProperty("useG0")) ? getFeed(highFeedrate) : "";
var hOffset = getSetting("outputToolLengthOffset", true) ? hFormat.format(tool.lengthOffset) : "";
var additionalCodes = [formatWords(codes1), formatWords(codes2)];
writeBlock(gPlaneModal.format(17));
forceModals(gMotionModal);
writeStartBlocks(isRequired, function() {
var modalCodes = formatWords(gAbsIncModal.format(90));
// multi axis prepositioning with TWP
if (currentSection.isMultiAxis() && getSetting("workPlaneMethod.prepositionWithTWP", true) && getSetting("workPlaneMethod.useTiltedWorkplane", false) &&
tcp.isSupportedByOperation && getCurrentDirection().isNonZero()) {
var W = machineConfiguration.getOrientation(getCurrentDirection());
var prePosition = W.getTransposed().multiply(position);
var angles = settings.workPlaneMethod.eulerConvention != undefined ? W.getEuler2(settings.workPlaneMethod.eulerConvention) : getCurrentDirection();
setWorkPlane(angles);
writeBlock(modalCodes, gMotionModal.format(motionCode.multi), xOutput.format(prePosition.x), yOutput.format(prePosition.y), feed, additionalCodes[0]);
machineSimulation({x:prePosition.x, y:prePosition.y});
cancelWorkPlane();
writeBlock(gMotionModal.format(0), getOffsetCode(), hOffset, additionalCodes[1]); // G0 motion mode is required for the G234 command
forceXYZ();
writeBlock(gMotionModal.format(motionCode.single), xOutput.format(position.x), yOutput.format(position.y), zOutput.format(position.z)); // motionCode.single is desired, we only expect Z movement
machineSimulation({x:position.x, y:position.y, z:position.z});
} else {
if (machineConfiguration.isHeadConfiguration()) {
writeBlock(modalCodes, gMotionModal.format(motionCode.multi), getOffsetCode(),
xOutput.format(position.x), yOutput.format(position.y), zOutput.format(position.z),
hOffset, feed, additionalCodes
);
machineSimulation({x:position.x, y:position.y, z:position.z});
} else {
writeBlock(modalCodes, gMotionModal.format(motionCode.multi), xOutput.format(position.x), yOutput.format(position.y), feed, additionalCodes[0]);
machineSimulation({x:position.x, y:position.y});
writeBlock(gMotionModal.format(motionCode.single), getOffsetCode(), zOutput.format(position.z), hOffset, additionalCodes[1]);
if (tcp.isSupportedByOperation) {
machineSimulation({x:position.x, y:position.y, z:position.z});
} else {
machineSimulation({z:position.z});
}
}
}
forceModals(gMotionModal);
if (isRequired) {
additionalCodes = []; // clear additionalCodes buffer
}
});
validate(!validateLengthCompensation || state.lengthCompensationActive, "Tool length compensation is not active."); // make sure that lenght compensation is enabled
if (!isRequired) { // simple positioning
var modalCodes = formatWords(gAbsIncModal.format(90), gPlaneModal.format(17));
forceXYZ();
if (!state.retractedZ && xyzFormat.getResultingValue(getCurrentPosition().z) < xyzFormat.getResultingValue(position.z)) {
writeBlock(modalCodes, gMotionModal.format(motionCode.single), zOutput.format(position.z), feed);
machineSimulation({z:position.z});
}
writeBlock(modalCodes, gMotionModal.format(motionCode.multi), xOutput.format(position.x), yOutput.format(position.y), feed, additionalCodes);
machineSimulation({x:position.x, y:position.y});
}
forceFeed();
}
// <<<<< INCLUDED FROM include_files/initialPositioning_haas.cpi
// >>>>> INCLUDED FROM include_files/getProgramNumber_fanuc.cpi
function getProgramNumber() {
if (typeof oFormat != "undefined" && getProperty("o8")) {
oFormat.setMinDigitsLeft(8);
}
var minimumProgramNumber = getSetting("programNumber.min", 1);
var maximumProgramNumber = getSetting("programNumber.max", getProperty("o8") ? 99999999 : 9999);
var reservedProgramNumbers = getSetting("programNumber.reserved", [8000, 9999]);
if (programName) {
var _programNumber;
try {
_programNumber = getAsInt(programName);
} catch (e) {
error(localize("Program name must be a number."));
}
if (!((_programNumber >= minimumProgramNumber) && (_programNumber <= maximumProgramNumber))) {
error(subst(localize("Program number '%1' is out of range. Please enter a program number between '%2' and '%3'."), _programNumber, minimumProgramNumber, maximumProgramNumber));
}
if ((_programNumber >= reservedProgramNumbers[0]) && (_programNumber <= reservedProgramNumbers[1])) {
warning(subst(localize("Program number '%1' is potentially reserved by the machine tool builder. Reserved range is '%2' to '%3'."), _programNumber, reservedProgramNumbers[0], reservedProgramNumbers[1]));
}
} else {
error(localize("Program name has not been specified."));
}
return _programNumber;
}
// <<<<< INCLUDED FROM include_files/getProgramNumber_fanuc.cpi
// >>>>> INCLUDED FROM include_files/drillCycles_haas.cpi
function writeDrillCycle(cycle, x, y, z) {
if (isInspectionOperation() && (typeof inspectionCycleInspect == "function")) {
inspectionCycleInspect(cycle, x, y, z);
return;
}
if (!isSameDirection(machineConfiguration.getSpindleAxis(), getForwardDirection(currentSection))) {
expandCyclePoint(x, y, z);
return;
}
var forceCycle = false;
switch (cycleType) {
case "tapping-with-chip-breaking":
case "left-tapping-with-chip-breaking":
case "right-tapping-with-chip-breaking":
forceCycle = true;
if (!isFirstCyclePoint()) {
writeBlock(gCycleModal.format(80));
gMotionModal.reset();
}
}
if (forceCycle || isFirstCyclePoint()) {
// return to initial Z which is clearance plane and set absolute mode
repositionToCycleClearance(cycle, x, y, z);
if (currentSection.feedMode == FEED_PER_REVOLUTION) {
feedOutput.setFormat(feedPerRevFormat); // apply feedPerRevFormat to feedOutput
writeBlock(gFeedModeModal.format(95));
}
var F = cycle.feedrate;
var P = !cycle.dwell ? 0 : clamp(1, cycle.dwell * 1000, 99999999); // in milliseconds
var E = typeof cycleReverse != "undefined" && cycleReverse ? "E" + rpmFormat.format(2000) : "";
switch (cycleType) {
case "drilling":
writeBlock(
gRetractModal.format(98), gCycleModal.format(81),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
E, feedOutput.format(F)
);
break;
case "counter-boring":
if (P > 0) {
writeBlock(
gRetractModal.format(98), gCycleModal.format(82),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
"P" + milliFormat.format(P), // not optional
E, feedOutput.format(F)
);
} else {
writeBlock(
gRetractModal.format(98), gCycleModal.format(81),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
E, feedOutput.format(F)
);
}
break;
case "chip-breaking":
var useG73Retract = getProperty("useG73Retract", false);
if ((!useG73Retract && (cycle.accumulatedDepth < cycle.depth)) ||
(useG73Retract && (cycle.accumulatedDepth < cycle.depth) && (cycle.incrementalDepthReduction > 0))) {
expandCyclePoint(x, y, z);
} else if (cycle.accumulatedDepth < cycle.depth) {
writeBlock(
gRetractModal.format(98), gCycleModal.format(73),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
("Q" + xyzFormat.format(cycle.incrementalDepth)),
("K" + xyzFormat.format(cycle.accumulatedDepth)),
conditional(P > 0, "P" + milliFormat.format(P)), // optional
E, feedOutput.format(F)
);
} else {
writeBlock(
gRetractModal.format(98), gCycleModal.format(73),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
(((cycle.incrementalDepthReduction > 0) ? "I" : "Q") + xyzFormat.format(cycle.incrementalDepth)),
conditional(cycle.incrementalDepthReduction > 0, "J" + xyzFormat.format(cycle.incrementalDepthReduction)),
conditional(cycle.incrementalDepthReduction > 0, "K" + xyzFormat.format(cycle.minimumIncrementalDepth)),
conditional(P > 0, "P" + milliFormat.format(P)), // optional
E, feedOutput.format(F)
);
}
break;
case "deep-drilling":
writeBlock(
gRetractModal.format(98), gCycleModal.format(83),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
(((cycle.incrementalDepthReduction > 0) ? "I" : "Q") + xyzFormat.format(cycle.incrementalDepth)),
conditional(cycle.incrementalDepthReduction > 0, "J" + xyzFormat.format(cycle.incrementalDepthReduction)),
conditional(cycle.incrementalDepthReduction > 0, "K" + xyzFormat.format(cycle.minimumIncrementalDepth)),
conditional(P > 0, "P" + milliFormat.format(P)), // optional
E, feedOutput.format(F)
);
break;
case "tapping":
var tappingFPM = tool.getThreadPitch() * rpmFormat.getResultingValue(spindleSpeed);
F = (getProperty("useG95forTapping") ? tool.getThreadPitch() : tappingFPM);
if (getProperty("useG95forTapping")) {
writeBlock(gFeedModeModal.format(95));
}
writeBlock(
gRetractModal.format(98), gCycleModal.format((tool.type == TOOL_TAP_LEFT_HAND) ? 74 : 84),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
E, pitchOutput.format(F)
);
forceFeed();
break;
case "left-tapping":
var tappingFPM = tool.getThreadPitch() * rpmFormat.getResultingValue(spindleSpeed);
F = (getProperty("useG95forTapping") ? tool.getThreadPitch() : tappingFPM);
if (getProperty("useG95forTapping")) {
writeBlock(gFeedModeModal.format(95));
}
writeBlock(
gRetractModal.format(98), gCycleModal.format(74),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
E, pitchOutput.format(F)
);
forceFeed();
break;
case "right-tapping":
var tappingFPM = tool.getThreadPitch() * rpmFormat.getResultingValue(spindleSpeed);
F = (getProperty("useG95forTapping") ? tool.getThreadPitch() : tappingFPM);
if (getProperty("useG95forTapping")) {
writeBlock(gFeedModeModal.format(95));
}
writeBlock(
gRetractModal.format(98), gCycleModal.format(84),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
E, pitchOutput.format(F)
);
forceFeed();
break;
case "tapping-with-chip-breaking":
case "left-tapping-with-chip-breaking":
case "right-tapping-with-chip-breaking":
var tappingFPM = tool.getThreadPitch() * rpmFormat.getResultingValue(spindleSpeed);
F = (getProperty("useG95forTapping") ? tool.getThreadPitch() : tappingFPM);
if (getProperty("useG95forTapping")) {
writeBlock(gFeedModeModal.format(95));
}
if (getProperty("usePeckTapping")) {
writeBlock(
gRetractModal.format(98), gCycleModal.format((tool.type == TOOL_TAP_LEFT_HAND ? 74 : 84)),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
E, peckOutput.format(cycle.incrementalDepth),
pitchOutput.format(F)
);
forceFeed();
} else {
// Parameter 57 bit 6, REPT RIG TAP, is set to 1 (On)
// On Mill software versions12.09 and above, REPT RIG TAP has been moved from the Parameters to Setting 133
var u = cycle.stock;
var step = cycle.incrementalDepth;
var first = true;
while (u > cycle.bottom) {
if (step < cycle.minimumIncrementalDepth) {
step = cycle.minimumIncrementalDepth;
}
u -= step;
step -= cycle.incrementalDepthReduction;
gCycleModal.reset(); // required
if ((u - 0.001) <= cycle.bottom) {
u = cycle.bottom;
}
if (first) {
first = false;
writeBlock(
gRetractModal.format(99), gCycleModal.format((tool.type == TOOL_TAP_LEFT_HAND ? 74 : 84)),
getCommonCycle((gPlaneModal.getCurrent() == 19) ? u : x, (gPlaneModal.getCurrent() == 18) ? u : y, (gPlaneModal.getCurrent() == 17) ? u : z, cycle.retract, cycle.clearance),
E, pitchOutput.format(F)
);
} else {
var position;
var depth;
switch (gPlaneModal.getCurrent()) {
case 17:
xOutput.reset();
position = xOutput.format(x);
depth = zOutput.format(u);
break;
case 18:
zOutput.reset();
position = zOutput.format(z);
depth = yOutput.format(u);
break;
case 19:
yOutput.reset();
position = yOutput.format(y);
depth = xOutput.format(u);
break;
}
writeBlock(conditional(u <= cycle.bottom, gRetractModal.format(98)), position, depth);
}
if (subprogramState.incrementalMode) {
setCyclePosition(cycle.retract);
}
}
}
forceFeed();
break;
case "fine-boring":
writeBlock(
gRetractModal.format(98), gCycleModal.format(76),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
"P" + milliFormat.format(P), // not optional
"Q" + xyzFormat.format(cycle.shift),
E, feedOutput.format(F)
);
forceSpindleSpeed = true;
break;
case "back-boring":
if (P > 0) {
expandCyclePoint(x, y, z);
} else {
var dx = (gPlaneModal.getCurrent() == 19) ? cycle.backBoreDistance : 0;
var dy = (gPlaneModal.getCurrent() == 18) ? cycle.backBoreDistance : 0;
var dz = (gPlaneModal.getCurrent() == 17) ? cycle.backBoreDistance : 0;
writeBlock(
gRetractModal.format(98), gCycleModal.format(77),
getCommonCycle(x - dx, y - dy, z - dz, cycle.bottom, cycle.clearance),
"Q" + xyzFormat.format(cycle.shift),
E, feedOutput.format(F)
);
forceSpindleSpeed = true;
}
break;
case "reaming":
if (feedFormat.getResultingValue(cycle.feedrate) != feedFormat.getResultingValue(cycle.retractFeedrate)) {
expandCyclePoint(x, y, z);
break;
}
writeBlock(
gRetractModal.format(98), gCycleModal.format(85),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
E, feedOutput.format(F)
);
break;
case "stop-boring":
if (P > 0) {
expandCyclePoint(x, y, z);
} else {
writeBlock(
gRetractModal.format(98), gCycleModal.format(86),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
E, feedOutput.format(F)
);
forceSpindleSpeed = true;
}
break;
case "manual-boring":
writeBlock(
gRetractModal.format(98), gCycleModal.format(88),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
"P" + milliFormat.format(P), // not optional
E, feedOutput.format(F)
);
break;
case "boring":
if (feedFormat.getResultingValue(cycle.feedrate) != feedFormat.getResultingValue(cycle.retractFeedrate)) {
expandCyclePoint(x, y, z);
break;
}
writeBlock(
gRetractModal.format(98), gCycleModal.format(89),
getCommonCycle(x, y, z, cycle.retract, cycle.clearance),
"P" + milliFormat.format(P), // not optional
E, feedOutput.format(F)
);
break;
default:
expandCyclePoint(x, y, z);
}
if (subprogramsAreSupported()) {
// place cycle operation in subprogram
handleCycleSubprogram(new Vector(x, y, z), new Vector(0, 0, 0), false);
if (subprogramState.incrementalMode) { // set current position to clearance height
setCyclePosition(cycle.clearance);
}
}
} else {
if (cycleExpanded) {
expandCyclePoint(x, y, z);
} else {
if (isPolarModeActive()) {
var polarPosition = getPolarPosition(x, y, z);
writeBlock(xOutput.format(polarPosition.first.x), yOutput.format(polarPosition.first.y), zOutput.format(polarPosition.first.z),
aOutput.format(polarPosition.second.x), bOutput.format(polarPosition.second.y), cOutput.format(polarPosition.second.z));
return;
}
if (!xyzFormat.areDifferent(x, xOutput.getCurrent()) &&
!xyzFormat.areDifferent(y, yOutput.getCurrent()) &&
!xyzFormat.areDifferent(z, zOutput.getCurrent())) {
switch (gPlaneModal.getCurrent()) {
case 17: // XY
xOutput.reset(); // at least one axis is required
break;
case 18: // ZX
zOutput.reset(); // at least one axis is required
break;
case 19: // YZ
yOutput.reset(); // at least one axis is required
break;
}
}
if (subprogramsAreSupported() && subprogramState.incrementalMode) { // set current position to retract height
setCyclePosition(cycle.retract);
}
writeBlock(xOutput.format(x), yOutput.format(y), zOutput.format(z));
if (subprogramsAreSupported() && subprogramState.incrementalMode) { // set current position to clearance height
setCyclePosition(cycle.clearance);
}
}
}
}
function getCommonCycle(x, y, z, r, c) {
forceXYZ();
if (isPolarModeActive()) {
var polarPosition = getPolarPosition(x, y, z);
return [xOutput.format(polarPosition.first.x), yOutput.format(polarPosition.first.y),
zOutput.format(polarPosition.first.z),
aOutput.format(polarPosition.second.x),
bOutput.format(polarPosition.second.y),
cOutput.format(polarPosition.second.z),
"R" + xyzFormat.format(r)];
} else {
if (subprogramsAreSupported() && subprogramState.incrementalMode) {
zOutput.format(c);
return [xOutput.format(x), yOutput.format(y),
"Z" + xyzFormat.format(z - r),
"R" + xyzFormat.format(r - c)];
} else {
return [xOutput.format(x), yOutput.format(y),
zOutput.format(z),
"R" + xyzFormat.format(r)];
}
}
}
// <<<<< INCLUDED FROM include_files/drillCycles_haas.cpi
// >>>>> INCLUDED FROM include_files/commonInspectionFunctions_haas.cpi
var isDPRNTopen = false;
var WARNING_OUTDATED = 0;
var toolpathIdFormat = createFormat({decimals:5, forceDecimal:true});
var patternInstances = new Array();
var initializePatternInstances = true; // initialize patternInstances array the first time inspectionGetToolpathId is called
function inspectionGetToolpathId(section) {
if (initializePatternInstances) {
for (var i = 0; i < getNumberOfSections(); ++i) {
var _section = getSection(i);
if (_section.getInternalPatternId) {
var sectionId = _section.getId();
var patternId = _section.getInternalPatternId();
var isPatterned = _section.isPatterned && _section.isPatterned();
var isMirrored = patternId != _section.getPatternId();
if (isPatterned || isMirrored) {
var isKnownPatternId = false;
for (var j = 0; j < patternInstances.length; j++) {
if (patternId == patternInstances[j].patternId) {
patternInstances[j].patternIndex++;
patternInstances[j].sections.push(sectionId);
isKnownPatternId = true;
break;
}
}
if (!isKnownPatternId) {
patternInstances.push({patternId:patternId, patternIndex:1, sections:[sectionId]});
}
}
}
}
initializePatternInstances = false;
}
var _operationId = section.getParameter("autodeskcam:operation-id", "");
var key = -1;
for (k in patternInstances) {
if (patternInstances[k].patternId == _operationId) {
key = k;
break;
}
}
var _patternId = (key > -1) ? patternInstances[key].sections.indexOf(section.getId()) + 1 : 0;
var _cycleId = cycle && ("cycleID" in cycle) ? cycle.cycleID : section.getParameter("cycleID", 0);
if (isProbeOperation(section) && _cycleId == 0 && getGlobalParameter("product-id").toLowerCase().indexOf("fusion") > -1) {
// we expect the cycleID to be non zero always for macro probing toolpaths, Fusion only
warningOnce(localize("Outdated macro probing operations detected. Please regenerate all macro probing operations."), WARNING_OUTDATED);
}
if (_patternId > 99) {
error(subst(localize("The maximum number of pattern instances is limited to 99" + EOL +
"You need to split operation '%1' into separate pattern groups."
), section.getParameter("operation-comment", "")));
}
if (_cycleId > 99) {
error(subst(localize("The maximum number of probing cycles is limited to 99" + EOL +
"You need to split operation '%1' to multiple operations with less than 100 cycles in each operation."
), section.getParameter("operation-comment", "")));
}
return toolpathIdFormat.format(_operationId + (_cycleId * 0.01) + (_patternId * 0.0001) + 0.00001);
}
function inspectionCreateResultsFileHeader() {
if (getProperty("useLiveConnection") && controlType != "NGC") {
return; // do not DPRNT if Live connection is active on a classic control
}
if (isDPRNTopen) {
if (!getProperty("singleResultsFile")) {
writeln("DPRNT[END]");
writeBlock("PCLOS");
isDPRNTopen = false;
}
}
if (isProbeOperation() && !printProbeResults()) {
return; // if print results is not desired by probe/probeWCS
}
if (!isDPRNTopen) {
writeBlock("PCLOS");
writeBlock("POPEN");
// check for existence of none alphanumeric characters but not spaces
var resFile;
if (getProperty("singleResultsFile")) {
resFile = getParameter("job-description") + "-RESULTS";
} else {
resFile = getParameter("operation-comment") + "-RESULTS";
}
resFile = resFile.replace(/:/g, "-");
resFile = resFile.replace(/[^a-zA-Z0-9 -]/g, "");
resFile = resFile.replace(/\s/g, "-");
writeln("DPRNT[START]");
writeln("DPRNT[RESULTSFILE*" + resFile + "]");
if (hasGlobalParameter("document-id")) {
writeln("DPRNT[DOCUMENTID*" + getGlobalParameter("document-id") + "]");
}
if (hasGlobalParameter("model-version")) {
writeln("DPRNT[MODELVERSION*" + getGlobalParameter("model-version") + "]");
}
}
if (isProbeOperation() && printProbeResults()) {
isDPRNTopen = true;
}
}
function getPointNumber() {
if (typeof inspectionWriteVariables == "function") {
return (inspectionVariables.pointNumber);
} else {
return ("#172[60]");
}
}
function inspectionWriteCADTransform() {
if (getProperty("useLiveConnection") && controlType != "NGC") {
return; // do not DPRNT if Live connection is active on a classic control
}
var cadOrigin = currentSection.getModelOrigin();
var cadWorkPlane = currentSection.getModelPlane().getTransposed();
var cadEuler = cadWorkPlane.getEuler2(EULER_XYZ_S);
writeln(
"DPRNT[G331" +
"*N" + getPointNumber() +
"*A" + abcFormat.format(cadEuler.x) +
"*B" + abcFormat.format(cadEuler.y) +
"*C" + abcFormat.format(cadEuler.z) +
"*X" + xyzFormat.format(-cadOrigin.x) +
"*Y" + xyzFormat.format(-cadOrigin.y) +
"*Z" + xyzFormat.format(-cadOrigin.z) +
"]"
);
}
function inspectionWriteWorkplaneTransform() {
var orientation = (machineConfiguration.isMultiAxisConfiguration()) ? machineConfiguration.getOrientation(getCurrentDirection()) : currentSection.workPlane;
var abc = orientation.getEuler2(EULER_XYZ_S);
if ((getProperty("useLiveConnection"))) {
liveConnectorInterface("WORKPLANE");
writeBlock(inspectionVariables.liveConnectionWPA + " = " + abcFormat.format(abc.x));
writeBlock(inspectionVariables.liveConnectionWPB + " = " + abcFormat.format(abc.y));
writeBlock(inspectionVariables.liveConnectionWPC + " = " + abcFormat.format(abc.z));
writeBlock("IF [" + inspectionVariables.workplaneStartAddress, "EQ -1] THEN",
inspectionVariables.workplaneStartAddress, "=", inspectionGetToolpathId(currentSection)
);
}
if (getProperty("useLiveConnection") && controlType != "NGC") {
return; // do not DPRNT if Live connection is active on a classic control
}
writeln("DPRNT[G330" +
"*N" + getPointNumber() +
"*A" + abcFormat.format(abc.x) +
"*B" + abcFormat.format(abc.y) +
"*C" + abcFormat.format(abc.z) +
"*X0*Y0*Z0*I0*R0]"
);
}
function writeProbingToolpathInformation(cycleDepth) {
if (getProperty("useLiveConnection") && controlType != "NGC") {
return; // do not DPRNT if Live connection is active on a classic control
}
writeln("DPRNT[TOOLPATHID*" + inspectionGetToolpathId(currentSection) + "]");
if (isInspectionOperation()) {
writeln("DPRNT[TOOLPATH*" + getParameter("operation-comment") + "]");
} else {
writeln("DPRNT[CYCLEDEPTH*" + xyzFormat.format(cycleDepth) + "]");
}
}
// <<<<< INCLUDED FROM include_files/commonInspectionFunctions_haas.cpi
// >>>>> INCLUDED FROM include_files/probeCycles_renishaw.cpi
validate(settings.probing, "Setting 'probing' is required but not defined.");
var probeVariables = {
outputRotationCodes: false, // determines if it is required to output rotation codes
compensationXY : undefined,
probeAngleMethod : undefined,
rotaryTableAxis : -1
};
function writeProbeCycle(cycle, x, y, z, P, F) {
if (isProbeOperation()) {
if (!settings.workPlaneMethod.useTiltedWorkplane && !isSameDirection(currentSection.workPlane.forward, new Vector(0, 0, 1))) {
if (!settings.probing.allowIndexingWCSProbing && currentSection.strategy == "probe") {
error(localize("Updating WCS / work offset using probing is only supported by the CNC in the WCS frame."));
return;
}
}
if (printProbeResults()) {
writeProbingToolpathInformation(z - cycle.depth + tool.diameter / 2);
inspectionWriteCADTransform();
inspectionWriteWorkplaneTransform();
if (typeof inspectionWriteVariables == "function") {
inspectionVariables.pointNumber += 1;
}
}
protectedProbeMove(cycle, x, y, z);
}
var macroCall = settings.probing.macroCall;
switch (cycleType) {
case "probing-x":
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9811,
"X" + xyzFormat.format(x + approach(cycle.approach1) * (cycle.probeClearance + tool.diameter / 2)),
"Q" + xyzFormat.format(cycle.probeOvertravel),
getProbingArguments(cycle, true)
);
break;
case "probing-y":
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9811,
"Y" + xyzFormat.format(y + approach(cycle.approach1) * (cycle.probeClearance + tool.diameter / 2)),
"Q" + xyzFormat.format(cycle.probeOvertravel),
getProbingArguments(cycle, true)
);
break;
case "probing-z":
protectedProbeMove(cycle, x, y, Math.min(z - cycle.depth + cycle.probeClearance, cycle.retract));
writeBlock(
macroCall, "P" + 9811,
"Z" + xyzFormat.format(z - cycle.depth),
"Q" + xyzFormat.format(cycle.probeOvertravel),
getProbingArguments(cycle, true)
);
break;
case "probing-x-wall":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9812,
"X" + xyzFormat.format(cycle.width1),
zOutput.format(z - cycle.depth),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-y-wall":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9812,
"Y" + xyzFormat.format(cycle.width1),
zOutput.format(z - cycle.depth),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-x-channel":
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9812,
"X" + xyzFormat.format(cycle.width1),
"Q" + xyzFormat.format(cycle.probeOvertravel),
// not required "R" + xyzFormat.format(cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-x-channel-with-island":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9812,
"X" + xyzFormat.format(cycle.width1),
zOutput.format(z - cycle.depth),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(-cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-y-channel":
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9812,
"Y" + xyzFormat.format(cycle.width1),
"Q" + xyzFormat.format(cycle.probeOvertravel),
// not required "R" + xyzFormat.format(cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-y-channel-with-island":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9812,
"Y" + xyzFormat.format(cycle.width1),
zOutput.format(z - cycle.depth),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(-cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-circular-boss":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9814,
"D" + xyzFormat.format(cycle.width1),
"Z" + xyzFormat.format(z - cycle.depth),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-circular-partial-boss":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9823,
"A" + xyzFormat.format(cycle.partialCircleAngleA),
"B" + xyzFormat.format(cycle.partialCircleAngleB),
"C" + xyzFormat.format(cycle.partialCircleAngleC),
"D" + xyzFormat.format(cycle.width1),
"Z" + xyzFormat.format(z - cycle.depth),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-circular-hole":
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9814,
"D" + xyzFormat.format(cycle.width1),
"Q" + xyzFormat.format(cycle.probeOvertravel),
// not required "R" + xyzFormat.format(cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-circular-partial-hole":
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9823,
"A" + xyzFormat.format(cycle.partialCircleAngleA),
"B" + xyzFormat.format(cycle.partialCircleAngleB),
"C" + xyzFormat.format(cycle.partialCircleAngleC),
"D" + xyzFormat.format(cycle.width1),
"Q" + xyzFormat.format(cycle.probeOvertravel),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-circular-hole-with-island":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9814,
"Z" + xyzFormat.format(z - cycle.depth),
"D" + xyzFormat.format(cycle.width1),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(-cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-circular-partial-hole-with-island":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9823,
"Z" + xyzFormat.format(z - cycle.depth),
"A" + xyzFormat.format(cycle.partialCircleAngleA),
"B" + xyzFormat.format(cycle.partialCircleAngleB),
"C" + xyzFormat.format(cycle.partialCircleAngleC),
"D" + xyzFormat.format(cycle.width1),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(-cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-rectangular-hole":
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9812,
"X" + xyzFormat.format(cycle.width1),
"Q" + xyzFormat.format(cycle.probeOvertravel),
// not required "R" + xyzFormat.format(-cycle.probeClearance),
getProbingArguments(cycle, true)
);
if (getProperty("useLiveConnection") && (typeof liveConnectionStoreResults == "function")) {
liveConnectionStoreResults();
}
writeBlock(
macroCall, "P" + 9812,
"Y" + xyzFormat.format(cycle.width2),
"Q" + xyzFormat.format(cycle.probeOvertravel),
// not required "R" + xyzFormat.format(-cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-rectangular-boss":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9812,
"Z" + xyzFormat.format(z - cycle.depth),
"X" + xyzFormat.format(cycle.width1),
"R" + xyzFormat.format(cycle.probeClearance),
"Q" + xyzFormat.format(cycle.probeOvertravel),
getProbingArguments(cycle, true)
);
if (getProperty("useLiveConnection") && (typeof liveConnectionStoreResults == "function")) {
liveConnectionStoreResults();
}
writeBlock(
macroCall, "P" + 9812,
"Z" + xyzFormat.format(z - cycle.depth),
"Y" + xyzFormat.format(cycle.width2),
"R" + xyzFormat.format(cycle.probeClearance),
"Q" + xyzFormat.format(cycle.probeOvertravel),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-rectangular-hole-with-island":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9812,
"Z" + xyzFormat.format(z - cycle.depth),
"X" + xyzFormat.format(cycle.width1),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(-cycle.probeClearance),
getProbingArguments(cycle, true)
);
if (getProperty("useLiveConnection") && (typeof liveConnectionStoreResults == "function")) {
liveConnectionStoreResults();
}
writeBlock(
macroCall, "P" + 9812,
"Z" + xyzFormat.format(z - cycle.depth),
"Y" + xyzFormat.format(cycle.width2),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(-cycle.probeClearance),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-inner-corner":
var cornerX = x + approach(cycle.approach1) * (cycle.probeClearance + tool.diameter / 2);
var cornerY = y + approach(cycle.approach2) * (cycle.probeClearance + tool.diameter / 2);
var cornerI = 0;
var cornerJ = 0;
if (cycle.probeSpacing !== undefined) {
cornerI = cycle.probeSpacing;
cornerJ = cycle.probeSpacing;
}
if ((cornerI != 0) && (cornerJ != 0)) {
if (currentSection.strategy == "probe") {
setProbeAngleMethod();
}
}
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9815, xOutput.format(cornerX), yOutput.format(cornerY),
conditional(cornerI != 0, "I" + xyzFormat.format(cornerI)),
conditional(cornerJ != 0, "J" + xyzFormat.format(cornerJ)),
"Q" + xyzFormat.format(cycle.probeOvertravel),
getProbingArguments(cycle, true)
);
break;
case "probing-xy-outer-corner":
var cornerX = x + approach(cycle.approach1) * (cycle.probeClearance + tool.diameter / 2);
var cornerY = y + approach(cycle.approach2) * (cycle.probeClearance + tool.diameter / 2);
var cornerI = 0;
var cornerJ = 0;
if (cycle.probeSpacing !== undefined) {
cornerI = cycle.probeSpacing;
cornerJ = cycle.probeSpacing;
}
if ((cornerI != 0) && (cornerJ != 0)) {
if (currentSection.strategy == "probe") {
setProbeAngleMethod();
}
}
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9816, xOutput.format(cornerX), yOutput.format(cornerY),
conditional(cornerI != 0, "I" + xyzFormat.format(cornerI)),
conditional(cornerJ != 0, "J" + xyzFormat.format(cornerJ)),
"Q" + xyzFormat.format(cycle.probeOvertravel),
getProbingArguments(cycle, true)
);
break;
case "probing-x-plane-angle":
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9843,
"X" + xyzFormat.format(x + approach(cycle.approach1) * (cycle.probeClearance + tool.diameter / 2)),
"D" + xyzFormat.format(cycle.probeSpacing),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"A" + xyzFormat.format(cycle.nominalAngle != undefined ? cycle.nominalAngle : 90),
getProbingArguments(cycle, false)
);
if (currentSection.strategy == "probe") {
setProbeAngleMethod();
probeVariables.compensationXY = "X" + xyzFormat.format(0) + " Y" + xyzFormat.format(0);
}
break;
case "probing-y-plane-angle":
protectedProbeMove(cycle, x, y, z - cycle.depth);
writeBlock(
macroCall, "P" + 9843,
"Y" + xyzFormat.format(y + approach(cycle.approach1) * (cycle.probeClearance + tool.diameter / 2)),
"D" + xyzFormat.format(cycle.probeSpacing),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"A" + xyzFormat.format(cycle.nominalAngle != undefined ? cycle.nominalAngle : 0),
getProbingArguments(cycle, false)
);
if (currentSection.strategy == "probe") {
setProbeAngleMethod();
probeVariables.compensationXY = "X" + xyzFormat.format(0) + " Y" + xyzFormat.format(0);
}
break;
case "probing-xy-pcd-hole":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9819,
"A" + xyzFormat.format(cycle.pcdStartingAngle),
"B" + xyzFormat.format(cycle.numberOfSubfeatures),
"C" + xyzFormat.format(cycle.widthPCD),
"D" + xyzFormat.format(cycle.widthFeature),
"K" + xyzFormat.format(z - cycle.depth),
"Q" + xyzFormat.format(cycle.probeOvertravel),
getProbingArguments(cycle, false)
);
if (cycle.updateToolWear) {
error(localize("Action -Update Tool Wear- is not supported with this cycle."));
return;
}
break;
case "probing-xy-pcd-boss":
protectedProbeMove(cycle, x, y, z);
writeBlock(
macroCall, "P" + 9819,
"A" + xyzFormat.format(cycle.pcdStartingAngle),
"B" + xyzFormat.format(cycle.numberOfSubfeatures),
"C" + xyzFormat.format(cycle.widthPCD),
"D" + xyzFormat.format(cycle.widthFeature),
"Z" + xyzFormat.format(z - cycle.depth),
"Q" + xyzFormat.format(cycle.probeOvertravel),
"R" + xyzFormat.format(cycle.probeClearance),
getProbingArguments(cycle, false)
);
if (cycle.updateToolWear) {
error(localize("Action -Update Tool Wear- is not supported with this cycle."));
return;
}
break;
}
}
function printProbeResults() {
return currentSection.getParameter("printResults", 0) == 1;
}
/** Convert approach to sign. */
function approach(value) {
validate((value == "positive") || (value == "negative"), "Invalid approach.");
return (value == "positive") ? 1 : -1;
}
// <<<<< INCLUDED FROM include_files/probeCycles_renishaw.cpi
// >>>>> INCLUDED FROM include_files/getProbingArguments_renishaw.cpi
function getProbingArguments(cycle, updateWCS) {
var outputWCSCode = updateWCS && currentSection.strategy == "probe";
if (outputWCSCode) {
var maximumWcsNumber = 0;
for (var i in wcsDefinitions.wcs) {
maximumWcsNumber = Math.max(maximumWcsNumber, wcsDefinitions.wcs[i].range[1]);
}
maximumWcsNumber = probeExtWCSFormat.getResultingValue(maximumWcsNumber);
var resultingWcsNumber = probeExtWCSFormat.getResultingValue(currentSection.probeWorkOffset - 6);
validate(resultingWcsNumber <= maximumWcsNumber, subst("Probe work offset %1 is out of range, maximum value is %2.", resultingWcsNumber, maximumWcsNumber));
var probeOutputWorkOffset = currentSection.probeWorkOffset > 6 ? probeExtWCSFormat.format(currentSection.probeWorkOffset - 6) : probeWCSFormat.format(currentSection.probeWorkOffset);
var nextWorkOffset = hasNextSection() ? getNextSection().workOffset == 0 ? 1 : getNextSection().workOffset : -1;
if (currentSection.probeWorkOffset == nextWorkOffset) {
currentWorkOffset = undefined;
}
}
return [
(cycle.angleAskewAction == "stop-message" ? "B" + xyzFormat.format(cycle.toleranceAngle ? cycle.toleranceAngle : 0) : undefined),
((cycle.updateToolWear && cycle.toolWearErrorCorrection < 100) ? "F" + xyzFormat.format(cycle.toolWearErrorCorrection ? cycle.toolWearErrorCorrection / 100 : 100) : undefined),
(cycle.wrongSizeAction == "stop-message" ? "H" + xyzFormat.format(cycle.toleranceSize ? cycle.toleranceSize : 0) : undefined),
(cycle.outOfPositionAction == "stop-message" ? "M" + xyzFormat.format(cycle.tolerancePosition ? cycle.tolerancePosition : 0) : undefined),
((cycle.updateToolWear && cycleType == "probing-z") ? "T" + xyzFormat.format(cycle.toolLengthOffset) : undefined),
((cycle.updateToolWear && cycleType !== "probing-z") ? "T" + xyzFormat.format(cycle.toolDiameterOffset) : undefined),
(cycle.updateToolWear ? "V" + xyzFormat.format(cycle.toolWearUpdateThreshold ? cycle.toolWearUpdateThreshold : 0) : undefined),
(cycle.printResults ? "W" + xyzFormat.format(1 + cycle.incrementComponent) : undefined), // 1 for advance feature, 2 for reset feature count and advance component number. first reported result in a program should use W2.
conditional(outputWCSCode, probeOutputWorkOffset)
];
}
// <<<<< INCLUDED FROM include_files/getProbingArguments_renishaw.cpi
// >>>>> INCLUDED FROM include_files/protectedProbeMove_renishaw.cpi
function protectedProbeMove(_cycle, x, y, z) {
var _x = xOutput.format(x);
var _y = yOutput.format(y);
var _z = zOutput.format(z);
var macroCall = settings.probing.macroCall;
if (_z && z >= getCurrentPosition().z) {
writeBlock(macroCall, "P" + 9810, _z, getFeed(cycle.feedrate)); // protected positioning move
}
if (_x || _y) {
writeBlock(macroCall, "P" + 9810, _x, _y, getFeed(highFeedrate)); // protected positioning move
}
if (_z && z < getCurrentPosition().z) {
writeBlock(macroCall, "P" + 9810, _z, getFeed(cycle.feedrate)); // protected positioning move
}
}
// <<<<< INCLUDED FROM include_files/protectedProbeMove_renishaw.cpi
// >>>>> INCLUDED FROM include_files/setProbeAngle_fanuc.cpi
function setProbeAngle() {
if (probeVariables.outputRotationCodes) {
validate(settings.probing.probeAngleVariables, localize("Setting 'probing.probeAngleVariables' is required for angular probing."));
var probeAngleVariables = settings.probing.probeAngleVariables;
var px = probeAngleVariables.x;
var py = probeAngleVariables.y;
var pz = probeAngleVariables.z;
var pi = probeAngleVariables.i;
var pj = probeAngleVariables.j;
var pk = probeAngleVariables.k;
var pr = probeAngleVariables.r;
var baseParamG54x4 = probeAngleVariables.baseParamG54x4;
var baseParamAxisRot = probeAngleVariables.baseParamAxisRot;
var probeOutputWorkOffset = currentSection.probeWorkOffset;
validate(probeOutputWorkOffset <= 6, "Angular Probing only supports work offsets 1-6.");
if (probeVariables.probeAngleMethod == "G68" && (Vector.diff(currentSection.getGlobalInitialToolAxis(), new Vector(0, 0, 1)).length > 1e-4)) {
error(localize("You cannot use multi axis toolpaths while G68 Rotation is in effect."));
}
var validateWorkOffset = false;
switch (probeVariables.probeAngleMethod) {
case "G54.4":
var param = baseParamG54x4 + (probeOutputWorkOffset * 10);
writeBlock("#" + param + "=" + px);
writeBlock("#" + (param + 1) + "=" + py);
writeBlock("#" + (param + 5) + "=" + pr);
writeBlock(gFormat.format(54.4), "P" + probeOutputWorkOffset);
break;
case "G68":
gRotationModal.reset();
gAbsIncModal.reset();
var xy = probeVariables.compensationXY || formatWords(formatCompensationParameter("X", px), formatCompensationParameter("Y", py));
writeBlock(
gRotationModal.format(68), gAbsIncModal.format(90),
xy,
formatCompensationParameter("Z", pz),
formatCompensationParameter("I", pi),
formatCompensationParameter("J", pj),
formatCompensationParameter("K", pk),
formatCompensationParameter("R", pr)
);
validateWorkOffset = true;
break;
case "AXIS_ROT":
var param = baseParamAxisRot + probeOutputWorkOffset * 20 + probeVariables.rotaryTableAxis + 4;
writeBlock("#" + param + " = " + "[#" + param + " + " + pr + "]");
forceWorkPlane(); // force workplane to rotate ABC in order to apply rotation offsets
currentWorkOffset = undefined; // force WCS output to make use of updated parameters
validateWorkOffset = true;
break;
default:
error(localize("Angular Probing is not supported for this machine configuration."));
return;
}
if (validateWorkOffset) {
for (var i = currentSection.getId(); i < getNumberOfSections(); ++i) {
if (getSection(i).workOffset != currentSection.workOffset) {
error(localize("WCS offset cannot change while using angle rotation compensation."));
return;
}
}
}
probeVariables.outputRotationCodes = false;
}
}
function formatCompensationParameter(label, value) {
return typeof value == "string" ? label + "[" + value + "]" : typeof value == "number" ? label + xyzFormat.format(value) : "";
}
// <<<<< INCLUDED FROM include_files/setProbeAngle_fanuc.cpi
// >>>>> INCLUDED FROM include_files/setProbeAngleMethod.cpi
function setProbeAngleMethod() {
var axisRotIsSupported = false;
var axes = [machineConfiguration.getAxisU(), machineConfiguration.getAxisV(), machineConfiguration.getAxisW()];
for (var i = 0; i < axes.length; ++i) {
if (axes[i].isEnabled() && isSameDirection((axes[i].getAxis()).getAbsolute(), new Vector(0, 0, 1)) && axes[i].isTable()) {
axisRotIsSupported = true;
if (settings.probing.probeAngleVariables.method == 0) { // Fanuc
validate(i < 2, localize("Rotary table axis is invalid."));
probeVariables.rotaryTableAxis = i;
} else { // Haas
probeVariables.rotaryTableAxis = axes[i].getCoordinate();
}
break;
}
}
if (settings.probing.probeAngleMethod == undefined) {
probeVariables.probeAngleMethod = axisRotIsSupported ? "AXIS_ROT" : getProperty("useG54x4") ? "G54.4" : "G68"; // automatic selection
} else {
probeVariables.probeAngleMethod = settings.probing.probeAngleMethod; // use probeAngleMethod from settings
if (probeVariables.probeAngleMethod == "AXIS_ROT" && !axisRotIsSupported) {
error(localize("Setting probeAngleMethod 'AXIS_ROT' is not supported on this machine."));
}
}
probeVariables.outputRotationCodes = true;
}
// <<<<< INCLUDED FROM include_files/setProbeAngleMethod.cpi
// <<<<< INCLUDED FROM generic_posts/haas.cps
capabilities |= CAPABILITY_INSPECTION;
description += " Inspection";
longDescription += " This postprocessor has Inspection & Live connection capabilities.";
var controlType = "Classic"; // Choose the correct control model
// >>>>> INCLUDED FROM ../common/haas base inspection.cps
properties.toolOffsetType = {
title : "Tool offset type",
description: "Select the which offsets are available on the tool offset page.",
group : "probing",
type : "enum",
values : [
{id:"geomWear", title:"Geometry & Wear"},
{id:"geomOnly", title:"Geometry only"}
],
value: "geomWear",
scope: "post"
};
properties.commissioningMode = {
title : "Commissioning Mode",
description: "Enables commissioning mode where M0 and messages are output at key points in the program.",
group : "probing",
type : "boolean",
value : true,
scope : "post"
};
properties.probeOnCommand = {
title : "Probe On Command",
description: "The command used to turn the probe on, this can be a M code or sub program call.",
group : "probing",
type : "string",
value : "G65 P9832",
scope : "post"
};
properties.probeOffCommand = {
title : "Probe Off Command",
description: "The command used to turn the probe off, this can be a M code or sub program call.",
group : "probing",
type : "string",
value : "G65 P9833",
scope : "post"
};
properties.probeResultsBuffer = {
title : "Measurement results store start",
description: "Specify the starting value of macro # variables where measurement results are stored.",
group : "probing",
type : "integer",
value : (controlType == "NGC" ? 10100 : 150),
scope : "post",
visible : false
};
properties.probeCalibratedRadius = {
title : "Calibrated Radius",
description: "Macro Variable used for storing probe calibrated radi.",
group : "probing",
type : "integer",
value : (controlType == "NGC" ? 10556 : 556),
scope : "post"
};
properties.probeEccentricityX = {
title : "Eccentricity X",
description: "Macro Variable used for storing the X eccentricity.",
group : "probing",
type : "integer",
value : (controlType == "NGC" ? 10558 : 558),
scope : "post"
};
properties.probeEccentricityY = {
title : "Eccentricity Y",
description: "Macro Variable used for storing the Y eccentricity.",
group : "probing",
type : "integer",
value : (controlType == "NGC" ? 10559 : 559),
scope : "post"
};
properties.probeCalibrationMethod = {
title : "Probe calibration Method",
description: "Select the probe calibration method.",
group : "probing",
type : "enum",
values : [
{id:"Renishaw", title:"Renishaw"},
{id:"Autodesk", title:"Autodesk"},
{id:"Other", title:"Other"}
],
value: "Renishaw",
scope: "post"
};
properties.useLiveConnection = {
title : "Live device connection",
description: "Creates a live connection between the controller and Fusion, used for live importing of measurement results and toolpath tracking",
group : "probing",
type : "boolean",
value : false,
scope : "post"
};
var ijkFormat = createFormat({decimals:5, forceDecimal:true});
// Part Alignment Capability of this Post
// Set this to 0 to indicate translations only (3 axis), 1 to indicate translation and rotation (4 axis), 2 to indicate full translation and rotations (5 axis)
var alignmentCapability = 0; // Translations only
// inspection variables
var inspectionVariables = {
localVariablePrefix : "#",
probeRadius : 0,
systemVariableMeasuredX : 5061,
systemVariableMeasuredY : 5062,
systemVariableMeasuredZ : 5063,
pointNumber : 1,
probeResultsBufferFull : false,
probeResultsBufferIndex : 1,
hasInspectionSections : false,
inspectionSectionCount : 0,
systemVariableOffsetLengthTable: 2000,
systemVariableOffsetWearTable : 2200,
workpieceOffset : "",
systemVariablePreviousX : 5001,
systemVariablePreviousY : 5002,
systemVariablePreviousZ : 5003,
systemVariableMachineCoordX : 5021,
systemVariableMachineCoordY : 5022,
systemVariableMachineCoordZ : 5023,
systemVariableWCSOffset : 5200,
systemVariableWCSOffsetExt : 14000,
bufferVersion : 2,
bufferCapacity : 4
};
var macroFormat = createFormat({prefix:inspectionVariables.localVariablePrefix, decimals:0});
var LINEAR_MOVE = 1;
var SAFE_MOVE = 2;
var SAFE_MOVE_DWO = 3;
var MEASURE_MOVE = 4;
var ALARM_IF_DEFLECTED = "M78";
var ALARM_IF_NOT_DEFLECTED = "M79";
var NO_DEFLECTION_CHECK = "";
function inspectionWriteVariables() {
var count = 1;
var prefix = inspectionVariables.localVariablePrefix;
inspectionVariables.probeRadius = prefix + count; // #1
inspectionVariables.xTarget = prefix + ++count;
inspectionVariables.yTarget = prefix + ++count;
inspectionVariables.zTarget = prefix + ++count;
inspectionVariables.xMeasured = prefix + ++count;
inspectionVariables.yMeasured = prefix + ++count;
inspectionVariables.zMeasured = prefix + ++count;
inspectionVariables.activeToolLength = prefix + ++count;
inspectionVariables.macroVariable1 = prefix + ++count;
inspectionVariables.macroVariable2 = prefix + ++count;
inspectionVariables.macroVariable3 = prefix + ++count;
inspectionVariables.macroVariable4 = prefix + ++count;
inspectionVariables.macroVariable5 = prefix + ++count;
inspectionVariables.macroVariable6 = prefix + ++count;
inspectionVariables.macroVariable7 = prefix + ++count;
inspectionVariables.wcsVectorX = prefix + ++count;
inspectionVariables.wcsVectorY = prefix + ++count;
inspectionVariables.wcsVectorZ = prefix + ++count;
inspectionVariables.previousWCSX = prefix + ++count;
inspectionVariables.previousWCSY = prefix + ++count;
inspectionVariables.previousWCSZ = prefix + ++count; // #21
// set Buffer Variable
if (getProperty("useLiveConnection")) {
var bufferCount = getProperty("probeResultsBuffer");
inspectionVariables.liveConnectionVersion = prefix + bufferCount; // #10100
inspectionVariables.liveConnectionCapacity = prefix + ++bufferCount;
inspectionVariables.liveConnectionReadPointer = prefix + ++bufferCount;
inspectionVariables.liveConnectionWritePointer = prefix + ++bufferCount;
inspectionVariables.liveConnectionStatus = prefix + ++bufferCount;
inspectionVariables.workplaneStartAddress = prefix + ++bufferCount;
inspectionVariables.liveConnectionWPA = prefix + ++bufferCount;
inspectionVariables.liveConnectionWPB = prefix + ++bufferCount;
inspectionVariables.liveConnectionWPC = prefix + ++bufferCount;
inspectionVariables.probeRadius = prefix + ++bufferCount; // override
inspectionVariables.commandID = prefix + ++bufferCount; // #10110
inspectionVariables.commandArg1 = prefix + ++bufferCount;
inspectionVariables.commandArg2 = prefix + ++bufferCount;
inspectionVariables.commandArg3 = prefix + ++bufferCount;
inspectionVariables.commandArg4 = prefix + ++bufferCount;
inspectionVariables.commandArg5 = prefix + ++bufferCount;
inspectionVariables.commandArg6 = prefix + ++bufferCount;
inspectionVariables.commandArg7 = prefix + ++bufferCount;
inspectionVariables.commandArg8 = prefix + ++bufferCount;
inspectionVariables.commandArg9 = prefix + ++bufferCount;
inspectionVariables.probeResultsStartAddress = ++bufferCount; // #10120
if (getProperty("probeResultsBuffer") <= 0) {
error("Probe Results Buffer start address cannot be less than or equal to zero when using a direct connection.");
return;
}
if (getProperty("probeResultsBuffer") <= count) {
error("Macro variables (" +
prefix + 1 + "-" + prefix + count +
") and live probe results storage area (" +
prefix + getProperty("probeResultsBuffer") + "-" + prefix + (bufferCount) +
") overlap." + EOL +
"The minimal allowed value for property '" + properties.probeResultsBuffer.title + "' is " + (count + 1) + "."
);
return;
}
}
// loop through all NC stream sections to check for inspection operations
for (var i = 0; i < getNumberOfSections(); ++i) {
var section = getSection(i);
if (isInspectionOperation(section)) {
inspectionVariables.workpieceOffset = section.workOffset;
inspectionVariables.hasInspectionSections = true;
inspectionValidateInspectionSettings();
if (getProperty("commissioningMode")) {
writeBlock("#3006=1 " + formatComment("Property 'Inspection commissioning mode' is active."));
writeComment("When the machine is measuring correctly please disable this property.");
}
break;
}
}
}
function onProbe(status) {
if (status) { // probe ON
writeBlock(mFormat.format(19));
writeBlock(getProperty("probeOnCommand")); // Command for switching the probe on
onDwell(2);
if (getProperty("commissioningMode")) {
writeBlock("#3006=1" + formatComment("Ensure Probe Is Active"));
}
} else { // probe OFF
writeBlock(getProperty("probeOffCommand")); // Command for switching the probe off
onDwell(2);
if (getProperty("commissioningMode")) {
writeBlock("#3006=1" + formatComment("Ensure Probe Has Deactivated"));
}
}
}
function inspectionCycleInspect(cycle, x, y, z) {
if (getNumberOfCyclePoints() != 3) {
error(localize("Missing Endpoint in Inspection Cycle, check Approach and Retract heights"));
}
forceFeed(); // ensure feed is always output - just incase.
if (isFirstCyclePoint()) {
writeComment("Approach Move");
// safe move to approach point start
if (gWorkplaneModal.getCurrent() == 254) {
// Apply Eccentricity
gMotionModal.reset();
writeBlock(gFormat.format(61)); // exact stop mode on
writeBlock(gAbsIncModal.format(91), gFormat.format(1),
"X-" + macroFormat.format(getProperty("probeEccentricityX")),
"Y-" + macroFormat.format(getProperty("probeEccentricityY")),
feedOutput.format(cycle.safeFeed)
);
writeBlock(gFormat.format(103), "P1", formatComment("LOOKAHEAD OFF"));
inspectionGetCoordinates(true);
inspectionCalculateTargetEndpoint(x, y, z, SAFE_MOVE_DWO);
// move alond probing vector with DWO off
inspectionWriteCycleMove(gAbsIncModal.format(91), cycle.safeFeed, SAFE_MOVE_DWO, ALARM_IF_DEFLECTED);
// Apply radius delta correction
writeBlock(gAbsIncModal.format(91), gFormat.format(1),
"Z+[" + xyzFormat.format(tool.diameter / 2) + "-" + inspectionVariables.probeRadius + "]",
feedOutput.format(cycle.safeFeed)
);
writeBlock(gFormat.format(103), "P1", formatComment("LOOKAHEAD OFF"));
inspectionGetCoordinates(false);
} else {
// only do trigger check when DWO is not active
inspectionCalculateTargetEndpoint(x, y, z, SAFE_MOVE);
inspectionWriteCycleMove(gAbsIncModal.format(90), cycle.safeFeed, SAFE_MOVE, ALARM_IF_DEFLECTED);
}
return;
}
if (isLastCyclePoint()) {
// retract move
writeComment("Retract Move");
inspectionCalculateTargetEndpoint(x, y, z, LINEAR_MOVE);
inspectionWriteCycleMove(gAbsIncModal.format(90), cycle.linkFeed, LINEAR_MOVE, NO_DEFLECTION_CHECK);
forceXYZ();
writeBlock(gFormat.format(64)); // exact stop mode on
return;
}
// measure move
if (getProperty("commissioningMode") && (inspectionVariables.pointNumber == 1)) {
writeBlock("#3006=1" + formatComment("Probe is about to contact part. Axes should stop on contact"));
}
inspectionWriteNominalData(cycle);
inspectionCalculateTargetEndpoint(x, y, z, MEASURE_MOVE);
var f = cycle.measureFeed;
if (gWorkplaneModal.getCurrent() == 254) {
inspectionWriteCycleMove(gAbsIncModal.format(91), f, MEASURE_MOVE, ALARM_IF_NOT_DEFLECTED);
writeBlock(inspectionVariables.xTarget + "=" + macroFormat.format(inspectionVariables.systemVariableMeasuredX));
writeBlock(inspectionVariables.yTarget + "=" + macroFormat.format(inspectionVariables.systemVariableMeasuredY));
writeBlock(inspectionVariables.zTarget + "=" + macroFormat.format(inspectionVariables.systemVariableMeasuredZ) + " - " + inspectionVariables.activeToolLength);
inspectionWriteCycleMove(gAbsIncModal.format(90), f, LINEAR_MOVE, NO_DEFLECTION_CHECK);
inspectionReconfirmPositionDWO(f);
} else {
inspectionWriteCycleMove(gAbsIncModal.format(90), f, MEASURE_MOVE, ALARM_IF_NOT_DEFLECTED);
}
inspectionCorrectProbeMeasurement();
inspectionWriteMeasuredData(cycle);
}
function inspectionWriteNominalData(cycle) {
var m = getRotation();
var v = new Vector(cycle.nominalX, cycle.nominalY, cycle.nominalZ);
var vt = m.multiply(v);
var pathVector = new Vector(cycle.nominalI, cycle.nominalJ, cycle.nominalK);
var nv = m.multiply(pathVector).normalized;
cycle.nominalX = vt.x;
cycle.nominalY = vt.y;
cycle.nominalZ = vt.z;
cycle.nominalI = nv.x;
cycle.nominalJ = nv.y;
cycle.nominalK = nv.z;
if (getProperty("useLiveConnection") && controlType != "NGC") {
return;
}
writeln("DPRNT[G800" +
"*N" + inspectionVariables.pointNumber +
"*X" + xyzFormat.format(cycle.nominalX) +
"*Y" + xyzFormat.format(cycle.nominalY) +
"*Z" + xyzFormat.format(cycle.nominalZ) +
"*I" + ijkFormat.format(cycle.nominalI) +
"*J" + ijkFormat.format(cycle.nominalJ) +
"*K" + ijkFormat.format(cycle.nominalK) +
"*O" + xyzFormat.format(getParameter("operation:inspectSurfaceOffset")) +
"*U" + xyzFormat.format(getParameter("operation:inspectUpperTolerance")) +
"*L" + xyzFormat.format(getParameter("operation:inspectLowerTolerance")) +
"]"
);
}
function inspectionCalculateTargetEndpoint(x, y, z, moveType) {
writeComment("CALCULATE TARGET ENDPOINT");
if (gWorkplaneModal.getCurrent() == 254 && (moveType == MEASURE_MOVE || moveType == SAFE_MOVE_DWO)) {
// get measure move vector with TWP active
var searchIJK = new Vector(0, 0, 0);
var searchDistance;
var moveDistance;
switch (moveType) {
case MEASURE_MOVE:
// writeComment("CTE - MEASURE_MOVE");
searchDistance = getParameter("probeClearance") + getParameter("probeOvertravel");
moveDistance = searchDistance * 0.1;
searchDistance -= moveDistance;
searchIJK.i = cycle.nominalI * -1 * moveDistance;
searchIJK.j = cycle.nominalJ * -1 * moveDistance;
searchIJK.k = cycle.nominalK * -1 * moveDistance;
break;
case SAFE_MOVE_DWO:
// get safe move unit vector with DWO active
// writeComment("CTE - SAFE_MOVE_DWO");
var xyz = new Vector(0, 0, 0);
xyz = getCurrentPosition();
var vectorI = x - xyz.x;
var vectorJ = y - xyz.y;
var vectorK = z - xyz.z;
var magnitude = Math.sqrt((vectorI * vectorI) + (vectorJ * vectorJ) + (vectorK * vectorK));
moveDistance = magnitude * 0.1;
searchIJK.i = (vectorI / magnitude) * moveDistance;
searchIJK.j = (vectorJ / magnitude) * moveDistance;
searchIJK.k = (vectorK / magnitude) * moveDistance;
searchDistance = magnitude - moveDistance;
break;
default:
// writeComment("CTE - DEFAULT");
}
// xyzTarget is previous move endpoint - with eccentricity correction
writeBlock(inspectionVariables.xTarget + " =" + xyzFormat.format(searchIJK.i));
writeBlock(inspectionVariables.yTarget + " =" + xyzFormat.format(searchIJK.j));
writeBlock(inspectionVariables.zTarget + " =" + xyzFormat.format(searchIJK.k));
inspectionWriteCycleMove(gAbsIncModal.format(91), moveType == MEASURE_MOVE ? cycle.measureFeed : cycle.safeFeed, LINEAR_MOVE, ALARM_IF_DEFLECTED);
writeBlock(gFormat.format(255));
writeComment("Calculate vector in WPCS");
writeBlock(inspectionVariables.wcsVectorX + " =" + macroFormat.format(inspectionVariables.systemVariableMachineCoordX) + "-" + inspectionVariables.previousWCSX);
writeBlock(inspectionVariables.wcsVectorY + " =" + macroFormat.format(inspectionVariables.systemVariableMachineCoordY) + "-" + inspectionVariables.previousWCSY);
writeBlock(inspectionVariables.wcsVectorZ + " =[" + macroFormat.format(inspectionVariables.systemVariableMachineCoordZ) + "-" + inspectionVariables.activeToolLength + "]-" + inspectionVariables.previousWCSZ);
writeBlock(inspectionVariables.macroVariable4 + " =SQRT[" +
"[" + inspectionVariables.wcsVectorX + "*" + inspectionVariables.wcsVectorX + "]" + "+" +
"[" + inspectionVariables.wcsVectorY + "*" + inspectionVariables.wcsVectorY + "]" + "+" +
"[" + inspectionVariables.wcsVectorZ + "*" + inspectionVariables.wcsVectorZ + "]]"
);
writeComment("Convert to unit vector");
// safe or measure move endpointwith DWO active
writeBlock(inspectionVariables.xTarget + " =[" + xyzFormat.format(searchDistance) + " * [" + inspectionVariables.wcsVectorX + "/" + inspectionVariables.macroVariable4 + "]]");
writeBlock(inspectionVariables.yTarget + " =[" + xyzFormat.format(searchDistance) + " * [" + inspectionVariables.wcsVectorY + "/" + inspectionVariables.macroVariable4 + "]]");
writeBlock(inspectionVariables.zTarget + " =[" + xyzFormat.format(searchDistance) + " * [" + inspectionVariables.wcsVectorZ + "/" + inspectionVariables.macroVariable4 + "]]");
} else {
writeBlock(inspectionVariables.xTarget + " =" + xyzFormat.format(x) + "-" + macroFormat.format(getProperty("probeEccentricityX")));
writeBlock(inspectionVariables.yTarget + " =" + xyzFormat.format(y) + "-" + macroFormat.format(getProperty("probeEccentricityY")));
writeBlock(inspectionVariables.zTarget + " =" + xyzFormat.format(z) + "+[" + xyzFormat.format(tool.diameter / 2) + "-" + inspectionVariables.probeRadius + "]");
}
}
function inspectionWriteCycleMove(absInc, _feed, moveType, triggerCheck) {
// writeComment("moveType = " + moveType, triggerCheck);
var motionCommand = moveType == LINEAR_MOVE ? 1 : 31;
gMotionModal.reset();
writeBlock(absInc,
gFormat.format(motionCommand),
"X" + inspectionVariables.xTarget,
"Y" + inspectionVariables.yTarget,
"Z" + inspectionVariables.zTarget,
feedOutput.format(_feed),
triggerCheck
);
writeBlock(gFormat.format(103), "P1", formatComment("LOOKAHEAD OFF"));
}
function inspectionProbeTriggerCheck(triggered) {
var condition = triggered ? " GT " : " LT ";
var message = triggered ? "NO POINT TAKEN" : "PATH OBSTRUCTED";
var inPositionTolerance = (unit == MM) ? 0.01 : 0.0004;
writeBlock(inspectionVariables.macroVariable1 + " =" + inspectionVariables.xTarget + "-" + macroFormat.format(inspectionVariables.systemVariableMeasuredX));
writeBlock(inspectionVariables.macroVariable2 + " =" + inspectionVariables.yTarget + "-" + macroFormat.format(inspectionVariables.systemVariableMeasuredY));
writeBlock(inspectionVariables.macroVariable3 + " =" + inspectionVariables.zTarget + "-" + macroFormat.format(inspectionVariables.systemVariableMeasuredZ) + "+" + inspectionVariables.activeToolLength);
writeBlock(inspectionVariables.macroVariable4 + " =" +
"[" + inspectionVariables.macroVariable1 + "*" + inspectionVariables.macroVariable1 + "]" + "+" +
"[" + inspectionVariables.macroVariable2 + "*" + inspectionVariables.macroVariable2 + "]" + "+" +
"[" + inspectionVariables.macroVariable3 + "*" + inspectionVariables.macroVariable3 + "]"
);
forceSequenceNumbers(true);
writeBlock("IF [" + inspectionVariables.macroVariable4 + condition + inPositionTolerance + "] GOTO" + skipNLines(2));
writeBlock("#3000 = 1 " + formatComment(message));
writeBlock(" ");
forceSequenceNumbers(false);
}
function inspectionCorrectProbeMeasurement() {
writeComment("Correct Measurements");
var tiltedWorkplaneIsActive = gWorkplaneModal.getCurrent() == 254;
var adjustX = macroFormat.format(tiltedWorkplaneIsActive ? inspectionVariables.systemVariablePreviousX : inspectionVariables.systemVariableMeasuredX);
var adjustY = macroFormat.format(tiltedWorkplaneIsActive ? inspectionVariables.systemVariablePreviousY : inspectionVariables.systemVariableMeasuredY);
var adjustZ = macroFormat.format(tiltedWorkplaneIsActive ? inspectionVariables.systemVariablePreviousZ : inspectionVariables.systemVariableMeasuredZ);
writeBlock(inspectionVariables.xMeasured + " =" + adjustX + "+" + macroFormat.format(getProperty("probeEccentricityX")));
writeBlock(inspectionVariables.yMeasured + " =" + adjustY + "+" + macroFormat.format(getProperty("probeEccentricityY")));
// need to consider probe centre tool output point in future too
var correctToolLength = tiltedWorkplaneIsActive ? "" : ("-" + inspectionVariables.activeToolLength);
writeBlock(inspectionVariables.zMeasured + " =" + adjustZ + "+" + inspectionVariables.probeRadius + correctToolLength);
}
function inspectionCalculateDeviation(cycle) {
var outputFormat = (unit == MM) ? "[53]" : "[44]";
// calculate the deviation and produce a warning if out of tolerance.
// (Measured + ((vector *(-1))*calibrated radi))
writeComment("calculate deviation");
// compensate for tip rad in X
writeBlock(
inspectionVariables.macroVariable1 + "=[" +
inspectionVariables.xMeasured + "+[[" +
ijkFormat.format(cycle.nominalI) + "*[-1]]*" +
inspectionVariables.probeRadius + "]]"
);
// compensate for tip rad in Y
writeBlock(
inspectionVariables.macroVariable2 + "=[" +
inspectionVariables.yMeasured + "+[[" +
ijkFormat.format(cycle.nominalJ) + "*[-1]]*" +
inspectionVariables.probeRadius + "]]"
);
// compensate for tip rad in Z
writeBlock(
inspectionVariables.macroVariable3 + "=[" +
inspectionVariables.zMeasured + "+[[" +
ijkFormat.format(cycle.nominalK) + "*[-1]]*" +
inspectionVariables.probeRadius + "]]"
);
// calculate deviation vector (Measured x - nominal x)
writeBlock(
inspectionVariables.macroVariable4 + "=" +
inspectionVariables.macroVariable1 + "-" +
xyzFormat.format(cycle.nominalX)
);
// calculate deviation vector (Measured y - nominal y)
writeBlock(
inspectionVariables.macroVariable5 + "=" +
inspectionVariables.macroVariable2 + "-" +
xyzFormat.format(cycle.nominalY)
);
// calculate deviation vector (Measured Z - nominal Z)
writeBlock(
inspectionVariables.macroVariable6 + "=[" +
inspectionVariables.macroVariable3 + "-[" +
xyzFormat.format(cycle.nominalZ) + "]]"
);
// sqrt xyz.xyz this is the value of the deviation
writeBlock(
inspectionVariables.macroVariable7 + "=SQRT[[" +
inspectionVariables.macroVariable4 + "*" +
inspectionVariables.macroVariable4 + "]+[" +
inspectionVariables.macroVariable5 + "*" +
inspectionVariables.macroVariable5 + "]+[" +
inspectionVariables.macroVariable6 + "*" +
inspectionVariables.macroVariable6 + "]]"
);
// sign of the vector
writeBlock(
inspectionVariables.macroVariable1 + "=[[" +
ijkFormat.format(cycle.nominalI) + "*" +
inspectionVariables.macroVariable4 + "]+[" +
ijkFormat.format(cycle.nominalJ) + "*" +
inspectionVariables.macroVariable5 + "]+[" +
ijkFormat.format(cycle.nominalK) + "*" +
inspectionVariables.macroVariable6 + "]]"
);
// print out deviation value
forceSequenceNumbers(true);
writeBlock(
"IF [" + inspectionVariables.macroVariable1 + "GE0] GOTO" + skipNLines(3)
);
writeBlock(
inspectionVariables.macroVariable4 + "=" +
inspectionVariables.macroVariable7
);
writeBlock("GOTO" + skipNLines(2));
writeBlock(
inspectionVariables.macroVariable4 + "=[" +
inspectionVariables.macroVariable7 + "*[-1]]"
);
writeBlock(" ");
if (!getProperty("useLiveConnection") || controlType == "NGC") {
writeln(
"DPRNT[G802" + "*N" + inspectionVariables.pointNumber +
"*DEVIATION*" + inspectionVariables.macroVariable4 + outputFormat + "]"
);
}
// tolerance check
writeBlock(
"IF [" + inspectionVariables.macroVariable4 +
"LT" + (xyzFormat.format(getParameter("operation:inspectUpperTolerance"))) +
"] GOTO" + skipNLines(3)
);
writeBlock(
"#3006 = 1" + formatComment("Inspection point over tolerance")
);
writeBlock("GOTO" + skipNLines(3));
writeBlock(
"IF [" + inspectionVariables.macroVariable4 +
"GT" + (xyzFormat.format(getParameter("operation:inspectLowerTolerance"))) +
"] GOTO" + skipNLines(2)
);
writeBlock(
"#3006 = 1" + formatComment("Inspection point under tolerance")
);
writeBlock(" ");
forceSequenceNumbers(false);
}
function inspectionWriteMeasuredData(cycle) {
var outputFormat = (unit == MM) ? "[53]" : "[44]";
if (!getProperty("useLiveConnection") || controlType == "NGC") {
writeln("DPRNT[G801" +
"*N" + inspectionVariables.pointNumber +
"*X" + inspectionVariables.xMeasured + outputFormat +
"*Y" + inspectionVariables.yMeasured + outputFormat +
"*Z" + inspectionVariables.zMeasured + outputFormat +
"*R" + inspectionVariables.probeRadius + outputFormat +
"]"
);
} else {
writeComment("Live connection");
}
if (cycle.outOfPositionAction == "stop-message" && !getProperty("liveConnection")) {
inspectionCalculateDeviation(cycle);
}
if (getProperty("useLiveConnection")) {
liveConnectionWriteData("inspectSurfacePoint");
}
inspectionVariables.pointNumber += 1;
}
var saveShowSequenceNumbers;
function forceSequenceNumbers(force) {
if (force) {
saveShowSequenceNumbers = getProperty("showSequenceNumbers");
setProperty("showSequenceNumbers", "true");
} else {
setProperty("showSequenceNumbers", saveShowSequenceNumbers);
}
}
function skipNLines(n) {
if (sequenceNumber == undefined) {
sequenceNumber = getProperty("sequenceNumberStart");
}
return (n * getProperty("sequenceNumberIncrement") + sequenceNumber);
}
function inspectionProcessSectionStart() {
writeBlock(gFormat.format(103), "P1", formatComment("LOOKAHEAD OFF"));
// only write header once if user selects a single results file
if (!isDPRNTopen || !getProperty("singleResultsFile") || (currentSection.workOffset != inspectionVariables.workpieceOffset)) {
inspectionCreateResultsFileHeader();
inspectionVariables.workpieceOffset = currentSection.workOffset;
}
// write the toolpath name as a comment
if (!getProperty("useLiveConnection") || controlType == "NGC") {
writeProbingToolpathInformation();
}
inspectionWriteCADTransform();
inspectionWriteWorkplaneTransform();
inspectionVariables.inspectionSectionCount += 1;
if (getProperty("toolOffsetType") == "geomOnly") {
writeComment("Geometry Only");
writeBlock(
inspectionVariables.activeToolLength + "=" +
inspectionVariables.localVariablePrefix + "[" +
inspectionVariables.systemVariableOffsetLengthTable + " + " +
macroFormat.format(4111) +
"]"
);
} else {
writeComment("Geometry and Wear");
writeBlock(
inspectionVariables.activeToolLength + "=" +
inspectionVariables.localVariablePrefix + "[" +
inspectionVariables.systemVariableOffsetLengthTable + " + " +
macroFormat.format(4111) +
"] + " +
inspectionVariables.localVariablePrefix + "[" +
inspectionVariables.systemVariableOffsetWearTable + " + " +
macroFormat.format(4111) +
"]"
);
}
if (getProperty("probeCalibrationMethod") == "Renishaw") {
writeBlock(inspectionVariables.probeRadius + "=[[" +
macroFormat.format(getProperty("probeCalibratedRadius")) + " + " +
macroFormat.format(getProperty("probeCalibratedRadius") + 1) + "]" + "/2]"
);
} else {
writeBlock(inspectionVariables.probeRadius + "=" + macroFormat.format(getProperty("probeCalibratedRadius")));
}
if (getProperty("commissioningMode") && !isDPRNTopen) {
var outputFormat = (unit == MM) ? "[53]" : "[44]";
if (!getProperty("useLiveConnection") || controlType == "NGC") {
writeln("DPRNT[CALIBRATED*RADIUS*" + inspectionVariables.probeRadius + outputFormat + "]");
writeln("DPRNT[ECCENTRICITY*X****" + macroFormat.format(getProperty("probeEccentricityX")) + outputFormat + "]");
writeln("DPRNT[ECCENTRICITY*Y****" + macroFormat.format(getProperty("probeEccentricityY")) + outputFormat + "]");
}
forceSequenceNumbers(true);
writeBlock("IF [" + inspectionVariables.probeRadius + " NE #0] GOTO" + skipNLines(2));
writeBlock("#3000 = 1" + formatComment("PROBE NOT CALIBRATED OR PROPERTY CALIBRATED RADIUS INCORRECT"));
writeBlock("IF [" + inspectionVariables.probeRadius + " NE 0] GOTO" + skipNLines(2));
writeBlock("#3000 = 1" + formatComment("PROBE NOT CALIBRATED OR PROPERTY CALIBRATED RADIUS INCORRECT"));
writeBlock("IF [" + inspectionVariables.probeRadius + " LT " + xyzFormat.format(tool.diameter / 2) + "] GOTO" + skipNLines(2));
writeBlock("#3000 = 1" + formatComment("PROBE NOT CALIBRATED OR PROPERTY CALIBRATED RADIUS INCORRECT"));
var maxEccentricity = (unit == MM) ? 0.2 : 0.0079;
writeBlock("IF [ABS[" + macroFormat.format(getProperty("probeEccentricityX")) + "] LT " + maxEccentricity + "] GOTO" + skipNLines(2));
writeBlock("#3000 = 1" + formatComment("PROBE NOT CALIBRATED OR PROPERTY ECCENTRICITY X INCORRECT"));
writeBlock("IF [ABS[" + macroFormat.format(getProperty("probeEccentricityY")) + "] LT " + maxEccentricity + "] GOTO" + skipNLines(2));
writeBlock("#3000 = 1" + formatComment("PROBE NOT CALIBRATED OR PROPERTY ECCENTRICITY Y INCORRECT"));
writeBlock("IF [" + macroFormat.format(getProperty("probeEccentricityX")) + " NE #0] GOTO" + skipNLines(2));
writeBlock("#3000 = 1" + formatComment("PROBE NOT CALIBRATED OR PROPERTY ECCENTRICITY X INCORRECT"));
writeBlock("IF [" + macroFormat.format(getProperty("probeEccentricityY")) + " NE #0] GOTO" + skipNLines(2));
writeBlock("#3000 = 1" + formatComment("PROBE NOT CALIBRATED OR PROPERTY ECCENTRICITY Y INCORRECT"));
writeBlock(" ");
forceSequenceNumbers(false);
}
isDPRNTopen = true;
}
function inspectionProcessSectionEnd() {
// close inspection results file if the NC has inspection toolpaths
if (inspectionVariables.hasInspectionSections) {
if (getProperty("commissioningMode")) {
if (controlType == "NGC") {
forceSequenceNumbers(true);
writeBlock(inspectionVariables.macroVariable1 + " = [#20261 * " + 4 * getProperty("sequenceNumberIncrement") + " + " + skipNLines(2) + "]");
writeBlock("GOTO " + inspectionVariables.macroVariable1);
writeBlock(" ");
writeBlock("#3006=1" + formatComment("DPRNT LOCATION NOT SET"));
onCommand(COMMAND_STOP);
writeBlock("GOTO " + skipNLines(8));
writeBlock(" ");
writeBlock("#3006=1" + formatComment("CHECK SETTING 262 FOR RESULTS FILE LOCATION"));
onCommand(COMMAND_STOP);
writeBlock("GOTO " + skipNLines(4));
writeBlock(" ");
writeBlock("#3006=1" + formatComment("RESULTS FILE WRITTEN TO TCP PORT"));
onCommand(COMMAND_STOP);
writeBlock(" ");
forceSequenceNumbers(false);
} else {
writeBlock("#3006=1" + formatComment("RESULTS FILE WRITTEN TO SERIAL PORT"));
}
}
writeBlock(gFormat.format(103), "P0", formatComment("LOOKAHEAD ON"));
}
}
function inspectionGetCoordinates(isApproachMove) {
if (isApproachMove) {
writeComment("Get Current Point DWO ON");
writeBlock(inspectionVariables.xTarget + " =" + macroFormat.format(inspectionVariables.systemVariablePreviousX));
writeBlock(inspectionVariables.yTarget + " =" + macroFormat.format(inspectionVariables.systemVariablePreviousY));
writeBlock(inspectionVariables.zTarget + " =" + macroFormat.format(inspectionVariables.systemVariablePreviousZ));
}
writeComment("Current Point in WCS");
writeBlock(gFormat.format(255));
writeBlock(inspectionVariables.previousWCSX + " =" + macroFormat.format(inspectionVariables.systemVariableMachineCoordX));
writeBlock(inspectionVariables.previousWCSY + " =" + macroFormat.format(inspectionVariables.systemVariableMachineCoordY));
writeBlock(inspectionVariables.previousWCSZ + " =" + macroFormat.format(inspectionVariables.systemVariableMachineCoordZ) + "-" + inspectionVariables.activeToolLength);
inspectionReconfirmPositionDWO(cycle.safeFeed);
}
function inspectionReconfirmPositionDWO(f) {
// zero length move to re-confirm current position
writeComment("Re-confirm position DWO Active");
writeBlock(gFormat.format(254));
writeBlock(gAbsIncModal.format(91), gMotionModal.format(1), "X0.0 Y0.0", feedOutput.format(f));
writeBlock("Z0.0");
writeBlock(gFormat.format(103), "P1", formatComment("LOOKAHEAD OFF"));
}
function liveConnectionHeader() {
writeComment("Live Connection Header");
writeBlock(gFormat.format(103), "P1", formatComment("LOOKAHEAD OFF"));
writeBlock((inspectionVariables.liveConnectionVersion) + " = " + inspectionVariables.bufferVersion);
writeBlock((inspectionVariables.liveConnectionCapacity) + " = " + inspectionVariables.bufferCapacity);
writeBlock(inspectionVariables.liveConnectionReadPointer + " = 0");
writeBlock(inspectionVariables.liveConnectionWritePointer + " = 1");
writeBlock("IF [" + inspectionVariables.liveConnectionStatus, "NE -1] THEN", inspectionVariables.liveConnectionStatus + " = 1");
writeBlock("IF [" + inspectionVariables.liveConnectionStatus, "EQ -1] THEN", inspectionVariables.liveConnectionStatus + " = 3");
writeBlock(inspectionVariables.workplaneStartAddress + " = 0");
writeBlock(inspectionVariables.liveConnectionWPA + " = 0");
writeBlock(inspectionVariables.liveConnectionWPB + " = 0");
writeBlock(inspectionVariables.liveConnectionWPC + " = 0");
if (getProperty("probeCalibrationMethod") == "Renishaw") {
writeBlock(inspectionVariables.probeRadius + "=[[" +
macroFormat.format(getProperty("probeCalibratedRadius")) + " + " +
macroFormat.format(getProperty("probeCalibratedRadius") + 1) + "]" + "/2]"
);
} else {
writeBlock(inspectionVariables.probeRadius + "=" + macroFormat.format(getProperty("probeCalibratedRadius")));
}
writeBlock(inspectionVariables.commandID + " = 0");
for (var i = 1; i <= 9; i++) {
writeBlock(inspectionVariables["commandArg" + i] + " = 0");
}
if (getProperty("probeResultsBuffer") == 0) {
error("Probe Results Buffer start address cannot be zero when using a live connection.");
return;
}
writeBlock("WHILE [" + inspectionVariables.liveConnectionStatus + " NE -1] DO1");
writeComment("WAITING FOR FUSION CONNECTION");
writeBlock(gFormat.format(53));
writeBlock("END1");
// LOOP THOUGH ALL THE TOOLPATHS TO GIVE THE DATA TO LIVE CONNECTION.
writeComment("loop though all toolpaths for live connection");
for (var i = 0; i < getNumberOfSections(); ++i) {
var value = inspectionVariables.probeResultsStartAddress + 6 * inspectionVariables.probeResultsBufferIndex;
var pathTypeID = macroFormat.format(value);
var toolpathID = macroFormat.format(value + 1);
var toolpathInfo1 = macroFormat.format(value + 2);
var toolpathInfo2 = macroFormat.format(value + 3);
var toolpathInfo3 = macroFormat.format(value + 4);
var toolpathInfo4 = macroFormat.format(value + 5);
var section = getSection(i);
if (section.hasParameter("autodeskcam:operation-id")) {
writeln("");
writeBlock("WHILE [[" + inspectionVariables.liveConnectionStatus + " EQ -1" +
"] AND [" + inspectionVariables.liveConnectionReadPointer + " EQ " + inspectionVariables.liveConnectionWritePointer + "]] DO1"
);
writeComment("WAITING FOR FUSION CONNECTION-OVERWRITE PROTECTION");
writeBlock(gFormat.format(53));
writeBlock("END1");
writeBlock(pathTypeID + " = 0"); // Path type set to 0 as this is an Information data block
writeBlock(toolpathID + " = " + inspectionGetToolpathId(section));
writeBlock(toolpathInfo1 + " = 0"); // notice type record
writeBlock(toolpathInfo2 + " = 0", formatComment("tool length")); // length
writeBlock(toolpathInfo3 + " = 0", formatComment("tool radius")); // radius
writeBlock(toolpathInfo4 + " = 0");
inspectionVariables.probeResultsBufferIndex += 1;
if (inspectionVariables.probeResultsBufferIndex > inspectionVariables.bufferCapacity) {
inspectionVariables.probeResultsBufferIndex = 0;
}
writeBlock(inspectionVariables.liveConnectionWritePointer + " = " + inspectionVariables.probeResultsBufferIndex);
}
}
writeBlock(gFormat.format(103), "P0", formatComment("LOOKAHEAD ON"));
}
// Store X value for size and position
function liveConnectionStoreResults() {
writeBlock(gFormat.format(103), "P1", formatComment("LOOKAHEAD OFF"));
writeBlock(inspectionVariables.commandArg8, "=", macroFormat.format(185)); // Store X position
writeBlock(inspectionVariables.commandArg9, "=", macroFormat.format(188)); // Store X size
writeBlock(gFormat.format(103), "P0", formatComment("LOOKAHEAD ON"));
}
function liveConnectionWriteData(type) {
var pathTypeValue; // path types 0=Information / 1=inspection / 2=macro probing / 3=milling / 4=additive
if (isInspectionOperation()) {
pathTypeValue = 1;
} else if (isProbeOperation()) {
pathTypeValue = 2;
} else {
pathTypeValue = 3; // if its anything else than inspection, path type=3 i.e milling
}
var value = inspectionVariables.probeResultsStartAddress + 6 * inspectionVariables.probeResultsBufferIndex;
var pathTypeID = macroFormat.format(value);
var toolpathID = macroFormat.format(value + 1);
var toolpathInfo1 = macroFormat.format(value + 2);
var toolpathInfo2 = macroFormat.format(value + 3);
var toolpathInfo3 = macroFormat.format(value + 4);
var toolpathInfo4 = macroFormat.format(value + 5);
writeln("");
liveConnectorInterface("overwriteProtection");
writeBlock(gFormat.format(103), "P1", formatComment("LOOKAHEAD OFF"));
switch (type) {
case "toolpathStart":
writeComment("Toolpath Start Live Import");
writeBlock(pathTypeID + " = 0"); // record type
writeBlock(toolpathID + " = " + inspectionGetToolpathId(currentSection));
writeBlock(toolpathInfo1 + " = 1"); // information type, 1 = "start" record, 2 = end record, 3 = part alignment
writeBlock(toolpathInfo2 + " = #3012"); // HH-MM-SS 235,959 (max value)
writeBlock(toolpathInfo3 + " = 0");
writeBlock(toolpathInfo4 + " = 0");
inspectionVariables.probeResultsBufferIndex += 1;
break;
case "toolpathEnd":
writeComment("Toolpath End Live Import");
writeBlock(pathTypeID + " = 0");
writeBlock(toolpathID + " = " + inspectionGetToolpathId(currentSection));
writeBlock(inspectionVariables.commandArg1 + " = " + inspectionGetToolpathId(currentSection)); // store toolpath ID in cmd arg 1 for part alignment
writeBlock(toolpathInfo1 + " = 2");
writeBlock(toolpathInfo2 + " = #3012");
writeBlock(toolpathInfo3 + " = 0");
writeBlock(toolpathInfo4 + " = 0");
inspectionVariables.probeResultsBufferIndex += 1;
break;
case "toolpathAlignment":
writeComment("Toolpath Alignment Live Import");
writeBlock(pathTypeID + " = 0");
writeBlock(toolpathID + " = " + inspectionVariables.commandArg1);
writeBlock(toolpathInfo1 + " = 3");
writeBlock(toolpathInfo2 + " = " + alignmentCapability);
writeBlock(toolpathInfo3 + " = 0");
writeBlock(toolpathInfo4 + " = 0");
inspectionVariables.probeResultsBufferIndex += 1;
break;
case "milling":
writeComment("Milling Toolpath Live Import");
writeBlock(pathTypeID + " = " + pathTypeValue);
writeBlock(toolpathID + " = " + inspectionGetToolpathId(currentSection));
writeBlock(toolpathInfo1 + " = 0");
writeBlock(toolpathInfo2 + " = 0");
writeBlock(toolpathInfo3 + " = 0");
writeBlock(toolpathInfo4 + " = 0");
inspectionVariables.probeResultsBufferIndex += 1;
break;
case "inspectSurfacePoint":
writeComment("Inspection Live Import");
writeBlock(pathTypeID + " = " + pathTypeValue);
writeBlock(toolpathID + " = " + inspectionGetToolpathId(currentSection));
writeBlock(toolpathInfo1 + " = " + cycle.pointID);
writeBlock(toolpathInfo2 + " = " + inspectionVariables.xMeasured);
writeBlock(toolpathInfo3 + " = " + inspectionVariables.yMeasured);
writeBlock(toolpathInfo4 + " = " + inspectionVariables.zMeasured);
inspectionVariables.probeResultsBufferIndex += 1;
break;
case "inspectSurfaceAlarm":
onDwell(1);
writeBlock("IF [" + inspectionVariables.commandID + " EQ 2] THEN " + inspectionVariables.commandID + "= -2");
writeBlock("IF [[" + inspectionVariables.commandID + " EQ -2] AND [" + inspectionVariables.commandArg1 + " EQ 1]] THEN #3006 = 1 (OUT_OF_TOLERANCE)");
writeBlock("IF [[" + inspectionVariables.commandID + " EQ -2] AND [" + inspectionVariables.commandArg1 + " EQ 2]] THEN #3006 = 1 (-OUT_OF_TOLERANCE-)"); // Point unprojected alarm
writeBlock("IF [[" + inspectionVariables.commandID + " EQ -2] AND [" + inspectionVariables.commandArg1 + " EQ 3]] THEN #3006 = 1 (PART_ALIGNMENT_ALARM)");
writeBlock("IF [[" + inspectionVariables.commandID + " EQ -2] AND [" + inspectionVariables.commandArg1 + " EQ 4]] THEN #3006 = 1 (UNSPECIFIED)");
writeBlock("IF [" + inspectionVariables.commandID + " EQ -2] THEN " + inspectionVariables.commandID + " = 0");
break;
case "macroEnd":
var macroType = 0.099;
var data1 = 0;
var data2 = 0;
var data3 = 0;
var data4 = 0;
switch (cycleType) {
case "probing-x":
macroType = 0.000;
data2 = (macroFormat.format(185));
break;
case "probing-y":
macroType = 0.000;
data3 = (macroFormat.format(186));
break;
case "probing-z":
macroType = 0.000;
data4 = (macroFormat.format(187));
break;
case "probing-x-wall":
case "probing-x-channel":
case "probing-x-channel-with-island":
macroType = 0.001;
data1 = (macroFormat.format(185)); // X position
data2 = (macroFormat.format(188)); // X size
break;
case "probing-y-wall":
case "probing-y-channel":
case "probing-y-channel-with-island":
macroType = 0.001;
data3 = (macroFormat.format(186)); // Y position
data4 = (macroFormat.format(188)); // Y size
break;
case "probing-xy-circular-boss":
case "probing-xy-circular-hole":
case "probing-xy-circular-partial-boss":
case "probing-xy-circular-partial-hole":
case "probing-xy-circular-hole-with-island":
case "probing-xy-circular-partial-hole-with-island":
macroType = 0.002;
data1 = (macroFormat.format(188)); // Diameter
data2 = (macroFormat.format(185)); // X position
data3 = (macroFormat.format(186)); // Y Position
break;
case "probing-xy-inner-corner":
case "probing-xy-outer-corner":
macroType = 0.003;
data3 = (macroFormat.format(185)); // x position
data4 = (macroFormat.format(186)); // Y position
break;
case "probing-x-plane-angle":
case "probing-y-plane-angle":
macroType = 0.005;
data4 = (macroFormat.format(194)); // angle error
break;
case "probing-xy-rectangular-boss":
case "probing-xy-rectangular-hole":
case "probing-xy-rectangular-hole-with-island":
macroType = 0.009;
data1 = (inspectionVariables.commandArg9); // X size
data2 = (inspectionVariables.commandArg8); // X position
data3 = (macroFormat.format(186)); // Y position
data4 = (macroFormat.format(188)); // Y size
break;
default:
warning("This probing macro is not yet operated by Live connection");
return;
}
writeComment("Macro Probing Live Import");
writeBlock(pathTypeID + " =" + (pathTypeValue + macroType + 0.00001));
writeBlock(toolpathID + " = " + inspectionGetToolpathId(currentSection));
writeBlock(toolpathInfo1 + " = " + data1);
writeBlock(toolpathInfo2 + " = " + data2);
writeBlock(toolpathInfo3 + " = " + data3);
writeBlock(toolpathInfo4 + " = " + data4);
inspectionVariables.probeResultsBufferIndex += 1;
break;
}
if (inspectionVariables.probeResultsBufferIndex > inspectionVariables.bufferCapacity) {
inspectionVariables.probeResultsBufferIndex = 0;
}
writeBlock(inspectionVariables.liveConnectionWritePointer + " = " + inspectionVariables.probeResultsBufferIndex);
writeBlock(gFormat.format(103), "P0", formatComment("LOOKAHEAD ON"));
}
function liveConnectorInterface(type) {
switch (type) {
case "overwriteProtection":
writeBlock(
"WHILE [[" + inspectionVariables.liveConnectionStatus + " EQ -1" +
"] AND [" + inspectionVariables.liveConnectionReadPointer + " EQ " + inspectionVariables.liveConnectionWritePointer + "]] DO1"
);
writeComment("WAITING FOR FUSION CONNECTION");
writeBlock(gFormat.format(53));
writeBlock("END1");
break;
case "WORKPLANE":
var orientation = machineConfiguration.isMultiAxisConfiguration() ? machineConfiguration.getOrientation(getCurrentDirection()) : currentSection.workPlane;
var abc = orientation.getEuler2(EULER_XYZ_S);
writeBlock(
"WHILE [[" + inspectionVariables.workplaneStartAddress + " NE 0] AND [[" +
inspectionVariables.liveConnectionWPA, "NE", abcFormat.format(abc.x) + "] OR [" +
inspectionVariables.liveConnectionWPB, "NE", abcFormat.format(abc.y) + "] OR [" +
inspectionVariables.liveConnectionWPC, "NE", abcFormat.format(abc.z) + "]]] DO1"
);
writeComment("WAITING FOR FUSION CONNECTION WORKPLANE READ");
writeBlock(gFormat.format(53));
writeBlock("END1");
writeBlock(
"IF [[" +
inspectionVariables.liveConnectionWPA, "NE", abcFormat.format(abc.x) + "] OR [" +
inspectionVariables.liveConnectionWPB, "NE", abcFormat.format(abc.y) + "] OR [" +
inspectionVariables.liveConnectionWPC, "NE", abcFormat.format(abc.z) + "]] THEN " +
inspectionVariables.workplaneStartAddress, "= -1"
);
break;
}
}
function onLiveAlignment() {
if (!getProperty("useLiveConnection")) {
writeBlock("#3006=1" + formatComment("Import the result file for part alignment first, and"));
writeBlock("#3006=1" + formatComment("then regenerate the NC program of the following milling operations."));
onCommand(COMMAND_STOP);
return;
}
var workOffset = (currentWorkOffset == 0 ? 1 : currentWorkOffset);
var nextWorkOffset = hasNextSection() ? getNextSection().workOffset == 0 ? 1 : getNextSection().workOffset : -1;
if (workOffset == nextWorkOffset) {
currentWorkOffset = undefined;
}
var standardRange = 6;
var systemWCS = (workOffset > standardRange ? inspectionVariables.systemVariableWCSOffsetExt : inspectionVariables.systemVariableWCSOffset);
systemWCS += (workOffset > standardRange ? (workOffset - (standardRange + 1)) : workOffset) * 20;
var liveAlignmentOffset = {
x: macroFormat.format(systemWCS + 1),
y: macroFormat.format(systemWCS + 2),
z: macroFormat.format(systemWCS + 3),
a: macroFormat.format(systemWCS + 4),
b: macroFormat.format(systemWCS + 5),
c: macroFormat.format(systemWCS + 6),
};
writeln("");
writeBlock(gFormat.format(103), "P1", formatComment("LOOKAHEAD OFF"));
liveConnectionWriteData("toolpathAlignment");
writeBlock("WHILE [" + inspectionVariables.commandID + " NE 3] DO1");
writeComment("WAITING FOR WCS UPDATE");
writeBlock(gFormat.format(53));
writeBlock("IF [" + inspectionVariables.commandID + " EQ 2] THEN " + inspectionVariables.commandID + "= -2");
writeBlock("IF [[" + inspectionVariables.commandID + " EQ -2] AND [" + inspectionVariables.commandArg1 + " EQ 3]] THEN #3006 = 1 (PART_ALIGNMENT_ALARM)");
writeBlock("IF [[" + inspectionVariables.commandID + " EQ -2] AND [" + inspectionVariables.commandArg1 + " EQ 3]] THEN " + inspectionVariables.liveConnectionStatus, "= 2"); //If using live connection set Results active to a 2 to signify program end
writeBlock("IF [" + inspectionVariables.commandID + " EQ -2] THEN " + inspectionVariables.commandID + " = 0"); // Clear Alarm
writeBlock("IF [[" + inspectionVariables.liveConnectionStatus + " EQ 2] AND [" + inspectionVariables.commandArg1 + " EQ 3]] THEN M30");
writeBlock("END1");
writeBlock(liveAlignmentOffset.x + " = " + liveAlignmentOffset.x + "-" + inspectionVariables.commandArg1);
writeBlock(liveAlignmentOffset.y + " = " + liveAlignmentOffset.y + "-" + inspectionVariables.commandArg2);
writeBlock(liveAlignmentOffset.z + " = " + liveAlignmentOffset.z + "-" + inspectionVariables.commandArg3);
writeBlock(liveAlignmentOffset.a + " = " + liveAlignmentOffset.a + "-" + inspectionVariables.commandArg4);
writeBlock(liveAlignmentOffset.b + " = " + liveAlignmentOffset.b + "-" + inspectionVariables.commandArg5);
writeBlock(liveAlignmentOffset.c + " = " + liveAlignmentOffset.c + "-" + inspectionVariables.commandArg6);
writeBlock("IF [" + inspectionVariables.commandID + " EQ 3] THEN " + inspectionVariables.commandID + " = 0");
writeBlock(gFormat.format(103), "P0", formatComment("LOOKAHEAD ON"));
}
// <<<<< INCLUDED FROM ../common/haas base inspection.cps
function inspectionValidateInspectionSettings() {
var errorText = "";
if (getProperty("probeOnCommand") == "") {
errorText += "\n-Probe On Command-";
}
if (getProperty("probeOffCommand") == "") {
errorText += "\n-Probe Off Command-";
}
if (getProperty("probeCalibratedRadius") == 0) {
errorText += "\n-Calibrated Radius-";
}
if (getProperty("probeEccentricityX") == 0) {
errorText += "\n-Eccentricity X-";
}
if (getProperty("probeEccentricityY") == 0) {
errorText += "\n-Eccentricity Y-";
}
if (errorText != "") {
error(localize("The following properties need to be configured:" + errorText + "\n-Please consult the guide PDF found at https://cam.autodesk.com/hsmposts?p=haas_inspection for more information-"));
}
}