Merge pull request #40 from toolpath/maker_macro

Maker macro

Author: JustinSGray

README.md

@@ -623,7 +623,57 @@ After you have loaded the tool, if no M argument (default) or an M1 argument is
 
 Example MDI Command: G65 "UNLOAD" T10
 
-
+## Maker Macro Usage 
+
+These macros, in their base form with human readable file names, must be put in the top level of whatever program you want to run. 
+Typically this means leaving them in the root folder of the machine and running all programs from there. 
+Though you could keep copies of these macros in sub-folders to run from them if you want. 
+
+Some users may want to use the `maker_macro_m##` feature of the control. 
+This lets you put files with that naming convention into the `maker_macros` folder on the control, 
+and then call those macros via an Mcode from any folder. 
+
+If you do this, then instead of calling --- for example -- `G65 "PROBEBORE"` you instead call `M810`. 
+So its up to you to remember the mapping somehow. 
+
+We've provided a python script that converts all the named files into the maker macro format for you. 
+That file, `build_maker_macros.py` can be run to convert all macros into the maker_macro format. 
+The script places all the new files inside the `maker_macro` folder. 
+Note that the script first DELETES EVERYTHING inside that folder, so do not make any manual edits to those files. 
+They will be lost. 
+Any edits need to be made in the top level macro files, and then propagated to the `maker_macro_m##` files via the 
+build script. 
+
+The mapping of file name to maker_macro is: 
+
+    'CALIBRATEPROBEBLOCK':801, 
+    'CALIBRATEPROBERING':802, 
+    'CALIBRATEPROBEZ':803, 
+    'CALIBRATETOOLSET':804, 
+    'CHECKPOSITIONALTOLERANCE':805, 
+    'COMPZEROPOINT':806, 
+    'COPYWCS':807,
+    'FINDCOR':808,
+    'LOADTOOL':809,
+    'PROBEBORE':810,
+    'PROBECIRCULARBOSS':811, 
+    'PROBECONFIG':812,
+    'PROBEINSIDECORNER':813,
+    'PROBERECTANGULARBOSS':814,
+    'PROBEY':815,
+    'PROBEYWEB':816,
+    'PROBEXSLOT':817,
+    'PROBEPOCKET':818,
+    'UNLOADTOOL':819,
+    'PROBEXYANGLE':820,
+    'PROBEOUTSIDECORNER':821,
+    'PROBEXWEB':822,
+    'PROBEYSLOT':823,
+    'PROBEX':824,
+    'TOOLSET':825,
+    'PROTECTEDMOVE':826,
+    'SAFESPIN':827,
+    'PROBEZ':828
 
 ## TODO
 
@@ -633,7 +683,6 @@ Example MDI Command: G65 "UNLOAD" T10
 	- Add a macro to check min/max values against soft-limits (would also like to add this to my post processor) 
 	- Add probe runout compensation into the calibration: Rotate the spindle 180 degrees with M19P180. Then re-do calibration and compare results to compute runout. Need to figure out the math for how to compensate for it during probing. 
 	- Add probe Angle routines (i.e. probe a wall and compute its angle, so you can rotate the X/Y axes)
-	- Add 4th Axis probing routines
 	- Add wear comp macros or wear comp to existing macros 
 
 

build_maker_macros.py

@@ -0,0 +1,145 @@
+import os
+import sys
+import re
+
+
+MACRO_FILES_NAME_MAP = {
+    'CALIBRATEPROBEBLOCK':801, 
+    'CALIBRATEPROBERING':802, 
+    'CALIBRATEPROBEZ':803, 
+    'CALIBRATETOOLSET':804, 
+    'CHECKPOSITIONALTOLERANCE':805, 
+    'COMPZEROPOINT':806, 
+    'COPYWCS':807,
+    'FINDCOR':808,
+    'LOADTOOL':809,
+    'PROBEBORE':810,
+    'PROBECIRCULARBOSS':811, 
+    'PROBECONFIG':812,
+    'PROBEINSIDECORNER':813,
+    'PROBERECTANGULARBOSS':814,
+    'PROBEY':815,
+    'PROBEYWEB':816,
+    'PROBEXSLOT':817,
+    'PROBEPOCKET':818,
+    'UNLOADTOOL':819,
+    'PROBEXYANGLE':820,
+    'PROBEOUTSIDECORNER':821,
+    'PROBEXWEB':822,
+    'PROBEYSLOT':823,
+    'PROBEX':824,
+    'TOOLSET':825,
+    'PROTECTEDMOVE':826,
+    'SAFESPIN':827,
+    'PROBEZ':828
+}
+
+
+MAKER_MACRO_FOLDER = 'maker_macros'
+
+
+########################################################
+# Helper functions 
+########################################################
+
+# we'll use these regex's a lot, so we want to precompile them 
+# instead of building them on the fly each time
+def build_regexs(name_map): 
+    """
+    make a precompiled regex for each macro file 
+    and store it with the macro name and new number. 
+    """
+    regex_map = []
+    for name, number in name_map.items(): 
+        pattern = re.compile(r'(G65\s+")' + re.escape(name) + r'(")')
+        regex_map.append((name, number, pattern))
+
+    return regex_map
+
+
+def find_all_caps_no_ext(directory="."):
+    """
+    Return a list of filenames in the specified directory that:
+    - Have no file extension.
+    - Have a name that is entirely uppercase letters.
+    """
+    matching_files = []
+    # Loop through all entries in the directory
+    for filename in os.listdir(directory):
+        full_path = os.path.join(directory, filename)
+        # Ensure that we're checking only files, not directories.
+        if os.path.isfile(full_path):
+            # Split the filename into base and extension
+            base, ext = os.path.splitext(filename)
+            # Check for no extension and all uppercase letters in the base name.
+            if ext == "" and base and base == base.upper():
+                matching_files.append(filename)
+    return matching_files
+
+
+########################################################
+# Build the make_macro_m## files
+########################################################
+
+#empty out the maker_macro folder of any existing file
+
+# Loop through all entries in the folder
+for filename in os.listdir(MAKER_MACRO_FOLDER):
+    file_path = os.path.join(MAKER_MACRO_FOLDER, filename)
+    # Check if it is a file (ignoring directories)
+    if os.path.isfile(file_path):
+        os.remove(file_path)
+
+MACRO_TO_MAKER_MACRO_LIST = build_regexs(MACRO_FILES_NAME_MAP)
+
+for (file_name, file_m_number, _) in MACRO_TO_MAKER_MACRO_LIST: 
+    # Read the file contents
+    # print ("editing ", file_name)
+    with open(file_name, 'r') as file:
+        content = file.read()
+
+    # fond all instances of G65 calls and replace with M calls
+    for (name, m_number, pattern) in MACRO_TO_MAKER_MACRO_LIST:
+        # Replace occurrences of the old file name with the new one
+        content = pattern.sub(f'M{m_number}', content)
+
+    # write the new maker macro file
+    file_path = os.path.join(MAKER_MACRO_FOLDER, f'maker_macro_m{file_m_number}')
+    with open(file_path, "w") as file:
+        # print("writing ", file_path)
+        file.write(content)
+
+
+###################################################################
+# Testing to make sure we didn't miss any files, or add extra ones
+###################################################################
+
+# Compare computed file list to the dictionary keys by converting both to sets.
+computed_files_set = set(find_all_caps_no_ext())
+provided_files_set = set(MACRO_FILES_NAME_MAP.keys())
+
+macro_files_found = find_all_caps_no_ext()
+
+# MACROS in the folder, but missing from the MAP
+missing_files = computed_files_set - provided_files_set
+# MACROS in the map, but missing from the folder
+extra_files = provided_files_set - computed_files_set
+
+if missing_files: 
+    print('###############################################################')
+    print("ERROR: The MACRO_FILES_NAME_MAP is missing the following files: ")
+    for name in missing_files: 
+        print('    ', name)
+    print('###############################################################')
+    print()
+if extra_files: 
+    print('###############################################################')
+    print("ERROR: The MACRO_FILES_NAME_MAP has following non existent files: ")
+    for name in extra_files: 
+        print('    ', name)
+    print('###############################################################')
+    print()
+# give a return code of 1 so the test fail
+if (missing_files or extra_files):
+    print("Self Tests Failed")
+    sys.exit(1) 

maker_macros/maker_macro_m801

@@ -0,0 +1,42 @@
+// Copyright 2024 Toolpath Labs Inc., Justin Gray, and Josh Smith
+
+// CALIBRATE PROBE TIP DIAMETER
+
+// #1 is the expected X length of the artifact
+// #2 is the expected Y length of the artifact
+// #3 is the Z drop height
+
+
+G90 G94 G17 G49 G40 G80
+G20                               // inch
+
+// load probe config
+M812
+
+M19 // ORIENT SPINDLE
+
+// important local variables
+#100 = @100             // TOOL NUMBER PROVIDED BY PROBECONFIG MACRO
+
+// Make sure diameter is zero when calibrating
+W_TOOL_DATA[0,#100,3,0]    // store tool diameter
+
+
+// calling web probe macros macros to measure the rectangle
+M822 A0 B#1 C#3 Q0 
+M816 A0 B#2 C#3 Q0 
+
+#131 = @998 // stored value of the measured X distance
+#132 = @999 // stored valued of the measured Y distance
+
+#133 = #1-#131                // error in x
+#134 = #2-#132                // error in y
+#135 = ABS[#133 + #134]/2     // average error
+W_TOOL_DATA[0,#100,3,#135]    // store tool diameter
+
+MENU_ADD["Ruby Diameter Set To: #135",""];  
+MENU["CALIBRATION REPORT","RESULTS","",1];
+
+M20                             // UNLOCK SPINDLE ORIENTATION FOR SAFETY
+G90
+M99

maker_macros/maker_macro_m802

@@ -0,0 +1,44 @@
+// Copyright 2024 Toolpath Labs Inc., Justin Gray, and Josh Smith
+
+// CALIBRATEDIAMETER
+// Description: Calibrate the Diameter of the probe using a ring guage
+// Initial coding 1/14/2024: Joshua Smith
+// Your probe must be concentric and you must use a ring guage!!!!!!!!!!
+// #1 is the expected DIAMETER of the artifact
+
+// load probe config
+M812
+
+M19 // ORIENT SPINDLE
+
+// important local variables
+#100 = @100             // TOOL NUMBER PROVIDED BY PROBECONFIG MACRO
+
+// Make sure diameter is zero when calibrating
+W_TOOL_DATA[0,#100,3,0]    // store tool diameter
+
+// calling our slot macros the first time centers probe
+M817 A0 B#1 Q0 
+M823 A0 B#1 Q0 
+
+
+// calling our slot macros a second time gives an accurate inspection
+M817 A0 B#1 Q0 
+M823 A0 B#1 Q0
+
+// average Diameter calculation
+// @999 and @998 are set in the slot macros
+// this could be improved by keeping track of both X and Y diameters and controling probe orientation
+#131 = @998                   // measured ring guage diameter in x
+#132 = @999                   // measured ring guage diameter in y
+#133 = #1-#131                // error in x
+#134 = #1-#132                // error in y
+#135 = ABS[#133 + #134]/2     // average error
+W_TOOL_DATA[0,#100,3,#135]    // store tool diameter
+
+MENU_ADD["Ruby Diameter Set To: #135",""];  
+MENU["CALIBRATION REPORT","RESULTS","",1];
+
+M20                             // UNLOCK SPINDLE ORIENTATION FOR SAFETY
+G90
+M99

maker_macros/maker_macro_m803

@@ -0,0 +1,84 @@
+// Copyright 2024 Toolpath Labs Inc., Justin Gray and Josh Smith
+
+// CALIBRATEZ
+// THIS MACRO ASSUMES THAT YOU HAVE PUT YOUR GAUGE TOOL IN THE SPINDLE
+//   AND MANUALLY JOGGED UP TILL YOUR REFERENCE ARTIFACT CAN JUST BARELY SLIDE UNDER THE TOOL.
+//   THE MACRO WILL SAVE THE XY LOCATION FOR FUTURE USE AND STORE THE REFERENCE HEIGHT OFFSET
+
+// Argument A -> turns on/off full calibration: default is quick calibration
+
+// load probe config
+M812
+
+M19 // ORIENT SPINDLE
+
+// important local variables
+#100 = @100             // TOOL NUMBER PROVIDED BY PROBECONFIG MACRO
+
+#108 = @108             // PROBE BACKOFF DISTANCE PROVIDED BY PROBECONFIG MACRO
+
+#104 = @104             // FAST PROBE SPEED PROVIDED BY PROBECONFIG MACRO
+#105 = @105             // SLOW PROBE SPEED PROVIDED BY PROBECONFIG MACRO
+#106 = @106             // PROBE CLEARANCE DISTANCE
+#108 = @108             // PROBE BACKOFF DISTANCE
+#109 = @109             // MASTER TOOL GAUGE LENGTH
+                        // NOTE: @5109 will be used to save reference block height
+#111 = @111             // PROBE CALIBRATION EXTENDED WORKOFFSET NUMBER
+
+IF [#1!=#0]
+  MSG_OK["CALIBRATE PROBE", "ZERO MASTER GAUGE TOOL ON CALIBRATION ARTIFACT AND LEAVE IT THERE",""]
+
+  @5109 = R_MACH_COOR[0,3]  // GET MACHINE Z COORDINATE WHICH SHOULD BE THE TOP OF A 123 BLOCK
+  #120 = @5109
+
+  // STORE THE CURRENT POSITION TO G54P99 FOR FUTURE FAST CALIBRATION
+  W_G54EXP_COOR[0,#111,1,R_MACH_COOR[0,1]]
+  W_G54EXP_COOR[0,#111,2,R_MACH_COOR[0,2]]
+ELSE                     // FAST CALIBRATION
+  MSG_OK["CALIBRATE PROBE", "INSTALL CALIBRATION ARTIFACT IN REFERENCE LOCATION",""]
+END_IF
+
+#120 = @5109            // PREVIOUSLY STORED REFERENCE HEIGHT
+
+
+// COMMAND A TOOL CHANGE
+T#100 M6                // BRING THE MACHINE UP TO TOOL CHANGE HEIGHT
+G28 G91 Z0.
+#121 = R_MACH_COOR[0,3] // GET MACHINE Z COORDINATE AFTER TOOL CHANGE
+
+IF [#1!=#0]
+  // TELL THE PERSON TO PUT THE PROBE INTO THE SPINDLE
+  MSG_OK["INSTALL PROBE", "SWITCH TO MPG MODE AND INSTALL THE PROBE THEN SWITCH BACK AND HIT CYCLE START; T#100",""]
+END_IF
+
+G54P#111                               // LOCATION OF PROBE CALIBARTION IS X0 Y0 ON G54P#111
+
+G90 G0 X0. Y0.                         // MOVE TO TOOLSETTER
+
+#123 = #120 - #109                     // DELTA DISTANCE WE HAVE MOVED PLUS SOME INCASE PROBE IS SHORTER THAN GAUGE TOOL
+// Probe Z ALL THE WAY BACK TO 123 BLOCK
+G31 G91 P2 Z[#123] F#104
+
+// Check that the probe has triggered
+IF[R_SKIP[0,1] == 1]
+
+  
+
+  G91 G01 Z[#108]                      // BACK OFF
+  FIX_CUT_OR_ON
+  G31 G91 P2 Z-[1.5*108] F#105         // PROBE Z AT SLOW SPEED
+  FIX_CUT_OR_OFF
+  #125 = R_SKIP[0,203]                 // GET MACHINE Z COORDINATE
+  G91 G01 Z[#108]                      // BACK OFF
+  #126 = [#125-#120+#109]              // PROBE LENGTH CALCULATION, ACCOUNTING FOR GAUGE TOOL LENGTH
+  W_TOOL_DATA[0,#100,203,#126]         // STORE PROBE LENGTH
+
+ELSE
+  ALARM["FAILED TO PROBE PART WITHIN SPECIFIED DISTANCE"]
+END_IF
+
+G28 G91 Z0.
+
+M20                             // UNLOCK SPINDLE ORIENTATION FOR SAFETY
+G90
+M99