├── Macro UI.png ├── codeOverrides.cfg ├── workspaceMacro.cfg ├── README.md ├── customOperations.cfg ├── kcncCustomOperations.cfg └── LICENSE /Macro UI.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/noobydp/CNC-Macros/HEAD/Macro UI.png -------------------------------------------------------------------------------- /codeOverrides.cfg: -------------------------------------------------------------------------------- 1 | # Built-In Macro Override 2 | [gcode_macro FW_RESTART] 3 | gcode: 4 | FIRMWARE_RESTART 5 | 6 | # Built-In Macro Override 7 | [gcode_macro EStop] 8 | gcode: 9 | M112 10 | 11 | [gcode_macro PAUSE] 12 | variable_paused_z: 0 13 | rename_existing: PAUSE_BASE 14 | gcode: 15 | # Save the current G-code state 16 | SAVE_GCODE_STATE NAME=PAUSE_state 17 | 18 | # Move to the maximum Z height adjusted for the defined Z offset 19 | {% set max_z = printer.configfile.config["stepper_z"].position_max|float - printer.gcode_move.homing_origin.z|float %} 20 | G90 ; Switch to absolute positioning 21 | G0 Z{max_z} ; Move Z to its maximum position 22 | 23 | M5 # Stop the spindle 24 | 25 | PAUSE_BASE 26 | 27 | [gcode_macro RESUME] 28 | rename_existing: RESUME_BASE 29 | gcode: 30 | {% set svv = printer.save_variables.variables %} 31 | M3 S{svv.spindle_speed} 32 | 33 | # Restore the previously saved G-code state 34 | RESTORE_GCODE_STATE NAME=PAUSE_state MOVE=0 35 | 36 | RESUME_BASE 37 | 38 | [gcode_macro CANCEL_PRINT] 39 | rename_existing: CANCEL_PRINT_BASE 40 | gcode: 41 | {% set max_z = printer.configfile.config["stepper_z"].position_max|float - printer.gcode_move.homing_origin.z|float %} 42 | G90 ; Switch to absolute positioning 43 | G0 Z{max_z} ; Move Z to its maximum position 44 | 45 | M5 # Stop the spindle 46 | M84 X Y Z # Turn off the motors 47 | CANCEL_PRINT_BASE 48 | 49 | # G28: Custom homing sequence 50 | [gcode_macro G28] 51 | rename_existing: G28.0 52 | gcode: 53 | # Define default behavior when no specific axis is requested 54 | {% set home_all = 'X' not in params and 'Y' not in params and 'Z' not in params %} 55 | 56 | # Home Z first if requested or if no axes are specified to avoid collisions 57 | {% if 'Z' in params or home_all %} 58 | G28.0 Z 59 | {% endif %} 60 | 61 | # Home X and Y; home both if no specific axis is mentioned 62 | {% if 'X' in params or 'Y' in params or home_all %} 63 | G28.0 {% if 'X' in params or home_all %}X{% endif %} {% if 'Y' in params or home_all %}Y{% endif %} 64 | {% endif %} 65 | 66 | # Force Absolute positioning mode 67 | G90 68 | 69 | # Reset kinematic positions for axes that were homed 70 | {% if 'X' in params or home_all %} 71 | SET_KINEMATIC_POSITION X=0 # Reset X position to zero 72 | {% endif %} 73 | {% if 'Y' in params or home_all %} 74 | SET_KINEMATIC_POSITION Y=0 # Reset Y position to zero 75 | {% endif %} 76 | -------------------------------------------------------------------------------- /workspaceMacro.cfg: -------------------------------------------------------------------------------- 1 | [gcode_macro SAVE_OFFSETS] 2 | gcode: 3 | SAVE_VARIABLE VARIABLE=x_offset VALUE='{printer.gcode_move.homing_origin.x}' 4 | SAVE_VARIABLE VARIABLE=y_offset VALUE='{printer.gcode_move.homing_origin.y}' 5 | SAVE_VARIABLE VARIABLE=z_offset VALUE='{printer.gcode_move.homing_origin.z}' 6 | 7 | [gcode_macro LOAD_OFFSETS] 8 | gcode: 9 | {% set svv = printer.save_variables.variables %} 10 | SET_GCODE_OFFSET X={svv.x_offset} Y={svv.y_offset} Z={svv.z_offset} 11 | RESPOND PREFIX="info" MSG="Loaded offsets: X={svv.x_offset} Y={svv.y_offset} Z={svv.z_offset}" 12 | 13 | [gcode_macro CHECK_OFFSET_XYZ] 14 | gcode: 15 | # Print out the offsets 16 | RESPOND PREFIX="info" MSG="Current Workspace Offsets - X: {printer.gcode_move.homing_origin.x}, Y: {printer.gcode_move.homing_origin.y}, Z: {printer.gcode_move.homing_origin.z}" 17 | 18 | [gcode_macro SET_OFFSETS_FROM_TOOL] 19 | gcode: 20 | # Get the current position of the toolhead 21 | {% set current_x = printer.toolhead.position.x %} 22 | {% set current_y = printer.toolhead.position.y %} 23 | {% set current_z = printer.toolhead.position.z %} 24 | 25 | # Set the current position as offsets 26 | SET_GCODE_OFFSET X={current_x} Y={current_y} Z={current_z} 27 | 28 | # Optional: Respond with the new offsets 29 | RESPOND PREFIX="info" MSG="New offsets set: X={current_x} Y={current_y} Z={current_z}" 30 | 31 | [gcode_macro UPDATE_OFFSETS_XYZ] 32 | gcode: 33 | # Calculate current offsets from homing positions and effective G-code positions 34 | {% set current_x_offset = printer.gcode_move.homing_origin.x %} 35 | {% set current_y_offset = printer.gcode_move.homing_origin.y %} 36 | {% set current_z_offset = printer.gcode_move.homing_origin.z %} 37 | 38 | # Check if the user has provided new offset values and update accordingly 39 | # Offsets must be >= 0 or they will be reset to 0 40 | {% if params.X is defined %} 41 | {% set new_x_offset = params.X|float %} 42 | {% if new_x_offset >= 0 %} 43 | {% set current_x_offset = new_x_offset%} 44 | {% else %} 45 | RESPOND PREFIX="error" MSG="X Offset is negative and will be set to 0" 46 | {% set current_x_offset = 0%} 47 | {%endif%} 48 | {% endif %} 49 | 50 | {% if params.Y is defined %} 51 | {% set new_y_offset = params.Y|float %} 52 | {% if new_y_offset >= 0 %} 53 | {% set current_y_offset = new_y_offset %} 54 | {% else %} 55 | RESPOND PREFIX="error" MSG="Y Offset is negative and will be set to 0" 56 | {% set current_y_offset = 0 %} 57 | {%endif%} 58 | {% endif %} 59 | 60 | {% if params.Z is defined %} 61 | {% set new_z_offset = params.Z|float %} 62 | {% if new_z_offset >= 0 %} 63 | {% set current_z_offset = new_z_offset %} 64 | {% else %} 65 | RESPOND PREFIX="error" MSG="Z Offset is negative and will be set to 0" 66 | {% set current_z_offset = 0 %} 67 | {%endif%} 68 | {% endif %} 69 | 70 | # Update the G-code offsets 71 | SET_GCODE_OFFSET X={current_x_offset} Y={current_y_offset} Z={current_z_offset} 72 | 73 | # Optional: Respond with the new offset values 74 | RESPOND PREFIX="info" MSG="Updated Workspace Offsets - X: {current_x_offset}, Y: {current_y_offset}, Z: {current_z_offset}" 75 | 76 | 77 | [gcode_macro ZERO_OFFSETS_XYZ] 78 | gcode: 79 | # Reset the G-code offsets to zero 80 | SET_GCODE_OFFSET X=0 Y=0 Z=0 81 | 82 | # Optional: Respond to confirm the offsets have been cleared 83 | RESPOND PREFIX="info" MSG="Workspace offsets cleared. X, Y, Z offsets set to 0." 84 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CNC-Macros 2 | Enhanced CNC Macros for Klipper Firmware 3 | 4 | Drawing inspiration from Klippy-cnc ([https://github.com/vladbabii/klippy-cnc/tree/master](https://github.com/vladbabii/klippy-cnc/tree/master)), this collection of CNC macros is specifically designed for 3-axis CNC machines like the 3018 / 3040 / 6040, but should work on any. It brings advanced capabilities in workspace management, custom movement commands, and specialized operations for CNC machining, elevating precision and functionality. 5 | 6 | The macros make use of the built-in SET_GCODE_OFFSET command to set the workpiece offset. 7 | 8 | ![Workspace Macros](Macro%20UI.png) 9 | 10 | ## Features 11 | - **Workspace Management**: Comprehensive set of macros for defining, adjusting, and recalling workspace coordinates. 12 | - **Custom Command Overrides**: Customizes standard G-code commands to incorporate workspace offset. 13 | - **Specialized Operations**: A range of specific macros tailored for tasks like slab flattening and probing. 14 | - **Enhanced Machine Control**: Macros for controlling the spindle, emergency stops, and firmware restarts, augmenting safety and ease of use. 15 | 16 | ### File Structure 17 | - **workspaceMacro.cfg**: Dedicated to workspace coordinate management. 18 | - **codeOverrides.cfg**: Contains overrides for default macros and custom G-code/M-code commands. 19 | - **customOperations.cfg**: Features macros for specific CNC tasks and operations. 20 | - **kcncCustomOperations.cfg**: Features macros for specific CNC tasks and operations when running klipper-for-cnc fork 21 | 22 | Combined, these files significantly improve control, accuracy, and safety in CNC machining using Klipper firmware. 23 | 24 | ## Usage 25 | 1. Download the `.cfg` files or clone the repo into `~/printer_data/config` or your chosen directory. 26 | 2. add the [save_variables] section to your `printer.cfg`: 27 | ``` 28 | [save_variables] 29 | filename:/home/pi/printer_data/config/savedVariables.cfg 30 | ``` 31 | 3. Include the `.cfg` files in your `printer.cfg`: 32 | ``` 33 | [include CNC-Macros/codeOverrides.cfg] 34 | [include CNC-Macros/workspaceMacro.cfg] 35 | [include CNC-Macros/customOperations.cfg] 36 | 37 | If you are using the klipper-for-cnc fork, also include this file 38 | 39 | [include CNC-Macros/kcncCustomOperations.cfg] 40 | - Note the kcncCustomOperations.cfg file overrides some macros in customOperations.cfg, this is by design. 41 | ``` 42 | 4. If using a tool setter switch add a `[gcode_macro USER_VARIABLES]` macro to printer.cfg 43 | ```[gcode_macro USER_VARIABLES] 44 | variable_tool_setter_xy: 1, 344.2 45 | variable_tool_setter_z_offset: 2.359 46 | variable_workpiece_probe_diameter: 4 47 | variable_multi_diameter: 2.00 48 | gcode: 49 | ``` 50 | 51 | 5. Read through the macros and comments in each of the cfg files so you know what's going on. 52 | 53 | ## Processes 54 | ### Simple Job Setup 55 | 1. Home the machine. 56 | 2. Jog to the start position (e.g., stock Top, Front, Left as 0,0,0 in Fusion 360 CAM). 57 | 3. Use `SET_OFFSET_FROM_TOOL` to set X, Y, Z offsets. 58 | 4. Optionally, use `SAVE_OFFSETS` to save offsets to a file. 59 | 5. Start the job. 60 | 6. Profit. 61 | 62 | ### Probing 63 | Two methods for probing metal workpieces: 64 | 1. **Alligator Clips**: Attach to the endmill and the metal piece. 65 | 2. **Z Puck Probe**: Like [this one from AliExpress](https://www.aliexpress.com/item/1005001344723565.html). 66 | 67 | With alligator clips, you can probe X, Y, and Z positions. 68 | 69 | For X and Y Probing: 70 | 1. Install a 4mm endmill or rod. 71 | 2. Attach clips to endmill and workpiece. 72 | 3. Position the tool close to the workpiece. 73 | 4. Use `PROBE_AXIS` with variables. 74 | 5. The toolhead moves in 0.1mm increments until contact. 75 | 76 | For Z Probing: 77 | - Use the actual endmill for correct height offset. 78 | 79 | -------------------------------------------------------------------------------- /customOperations.cfg: -------------------------------------------------------------------------------- 1 | [gcode_macro GOTO_WORKSPACE_X_Y] 2 | gcode: 3 | {% set feed_rate = printer.configfile.config["printer"].max_velocity|default(100)|float * 60 %} 4 | g1 X0 Y0 F{feed_rate} 5 | 6 | [gcode_macro FLATTEN_SLAB] 7 | gcode: 8 | {% set max_x = printer.configfile.config["stepper_x"].position_max|float %} 9 | {% set max_y = printer.configfile.config["stepper_y"].position_max|float %} 10 | {% set cut_depth = params.CUT_DEPTH|default(-0.5)|float %} 11 | 12 | {% set feed_rate = (params.FEED_RATE|default(10)|float) * 60 %} # Convert mm/s to mm/min 13 | {% set step_over = params.STEP_OVER|default(15)|float %} 14 | {% set spindle_speed = params.SPINDLE_SPEED|default(10000)|float %} 15 | 16 | # Use the new flatten_area macro 17 | 18 | FLATTEN_AREA START_X=0 START_Y=0 END_X={max_x} END_Y={max_y} CUT_DEPTH={cut_depth} FEED_RATE={feed_rate} STEP_OVER={step_over} SPINDLE_SPEED={spindle_speed} 19 | 20 | 21 | [gcode_macro FLATTEN_AREA] 22 | gcode: 23 | 24 | {% set start_x = params.START_X|default(0)|float %} 25 | {% set start_y = params.START_Y|default(0)|float %} 26 | 27 | {% set end_x = params.END_X|default(printer.configfile.config["stepper_x"].position_max|float)|float %} 28 | {% set end_y = params.END_Y|default(printer.configfile.config["stepper_y"].position_max|float)|float %} 29 | 30 | {% set cut_depth = params.CUT_DEPTH|default(-0.5)|float %} 31 | 32 | {% set feed_rate = (params.FEED_RATE|default(10)|float) * 60 %} # Convert mm/s to mm/min 33 | {% set step_over = params.STEP_OVER|default(15)|float %} 34 | {% set spindle_speed = params.SPINDLE_SPEED|default(10000)|float %} 35 | 36 | {% set max_z_with_offset = printer.configfile.config["stepper_z"].position_max|float - printer.gcode_move.homing_origin.z|float %} 37 | 38 | # Calculate the number of steps needed, ensuring it's an integer 39 | {% set num_steps = (((end_y - start_y - step_over) / step_over)|round(0, 'ceil'))|int %} 40 | 41 | RESPOND PREFIX="warning" MSG="Offsets are obeyed by this macro" 42 | RESPOND PREFIX="info" MSG="Flattening Area: ({start_x}, {start_y}) to ({end_x}, {end_y}), cut depth: {cut_depth}" 43 | 44 | G90 ; Absolute positioning 45 | G21 ; Set units to millimeters 46 | 47 | M3 S{spindle_speed} 48 | G0 Z{max_z_with_offset} F{feed_rate / 2} ; Move to safe height 49 | 50 | # Perimeter cut 51 | G0 X{start_x} Y{start_y} F{feed_rate} 52 | G1 Z{cut_depth} F{feed_rate / 2} 53 | G1 X{end_x} F{feed_rate} ; Cut along the X axis 54 | G1 Y{end_y} F{feed_rate} ; Cut along the Y axis 55 | G1 X{start_x} F{feed_rate} ; Cut back along the X axis 56 | G1 Y{start_y} F{feed_rate} ; Cut back along the Y axis 57 | 58 | #End position X=0 Y=0 59 | G0 X{step_over} F{feed_rate} ; Move to start position at current row 60 | 61 | # Sequential pattern cut 62 | {% for i in range(num_steps) %} 63 | {% set ypos = i * step_over + step_over %} 64 | G0 Y{ypos} F{feed_rate} ; Move to next row 65 | 66 | {% if i % 2 == 1 %} 67 | # The code here will execute if 'i' is odd. 68 | G0 X{step_over} F{feed_rate} ; Move to the step_over (near x_min) to perform a cut on moves 1, 3, 5 etc 69 | {% else %} 70 | G0 X{end_x - step_over} F{feed_rate} ; Move to the x_max minus step_over to perform a cut on moves 0, 2, 4 etc 71 | {% endif %} 72 | 73 | {% endfor %} 74 | 75 | G0 Z{max_z_with_offset} ; Raise to safety height 76 | M5 ; stop spindle 77 | G28 ; Home machine 78 | 79 | [gcode_macro PROBE_Z] 80 | gcode: 81 | PROBE_AXIS AXIS=Z DIRECTION=-1 82 | 83 | 84 | [gcode_macro PROBE_AXIS] 85 | variable_axis: None 86 | variable_total_steps: 0 87 | variable_current_step: 0 88 | variable_step: 0.05 89 | variable_feedrate: 500 90 | variable_distance: 10 91 | variable_direction: 1 92 | variable_probe_diameter: 4 93 | gcode: 94 | {% set axis = params.AXIS|lower %} 95 | {% if axis == 'z' %} 96 | {% set direction = params.DIRECTION|default(-1)|float %} 97 | {% else %} 98 | {% set direction = params.DIRECTION|default(1)|float %} 99 | {% endif %} 100 | {% set distance = params.DISTANCE|default(printer["gcode_macro PROBE_AXIS"].distance)|float %} 101 | {% set feedrate = params.FEEDRATE|default(printer["gcode_macro PROBE_AXIS"].feedrate)|float %} 102 | {% set step = printer["gcode_macro PROBE_AXIS"].step %} 103 | {% set probe_diameter = params.PROBE_DIAMETER|default(printer["gcode_macro PROBE_AXIS"].probe_diameter)|float %} 104 | 105 | {% set total_steps = (distance / step)|round(0, 'ceil')|int %} 106 | {% set current_step = 0 %} 107 | 108 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=axis VALUE="'{axis}'" 109 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=total_steps VALUE={total_steps} 110 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=current_step VALUE={current_step} 111 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=direction VALUE={direction} 112 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=probe_diameter VALUE={probe_diameter} 113 | 114 | G91 # Relative positioning 115 | G1 { axis|upper }{step * direction} F{ feedrate } 116 | G90 # Absolute positioning 117 | QUERY_PROBE 118 | UPDATE_DELAYED_GCODE ID=_PROBE_AXIS_DELAYED DURATION=0.05 MACRO=_PROBE_AXIS_DELAYED 119 | 120 | [delayed_gcode _PROBE_AXIS_DELAYED] 121 | gcode: 122 | {% set axis = printer["gcode_macro PROBE_AXIS"].axis|upper %} 123 | {% set step = printer["gcode_macro PROBE_AXIS"].step|float %} 124 | {% set direction = printer["gcode_macro PROBE_AXIS"].direction|float %} 125 | {% set feedrate = printer["gcode_macro PROBE_AXIS"].feedrate|float %} 126 | 127 | {% set probe_diameter = printer["gcode_macro PROBE_AXIS"].probe_diameter|default(0)|float %} 128 | {% if axis == 'Z' %} 129 | {% set probe_offset = 0 %} 130 | {% else %} 131 | {% set probe_offset = probe_diameter / 2 * direction|float %} 132 | {% endif %} 133 | 134 | {% if printer.probe.last_query %} 135 | {% set position = (printer.toolhead.position[{'x': 0, 'y': 1, 'z': 2}[axis|lower]] + probe_offset)|float %} 136 | RESPOND PREFIX="info" MSG="Probing Successful, Updating Offset, {axis|upper}:{position}" 137 | UPDATE_OFFSETS_XYZ {axis|upper}={position} 138 | {% else %} 139 | {% set current_step = printer["gcode_macro PROBE_AXIS"].current_step + 1 %} 140 | {% if current_step < printer["gcode_macro PROBE_AXIS"].total_steps %} 141 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=current_step VALUE={current_step} 142 | G91 # Relative positioning 143 | G1 { axis|upper }{ step * direction } F{ feedrate } 144 | G90 # Absolute positioning 145 | QUERY_PROBE 146 | UPDATE_DELAYED_GCODE ID=CONTINUE_PROBE DURATION=0.05 MACRO=CONTINUE_PROBE 147 | {% else %} 148 | RESPOND PREFIX="error" MSG="Probing Completed: Probe Not Triggered" 149 | {% endif %} 150 | {% endif %} 151 | -------------------------------------------------------------------------------- /kcncCustomOperations.cfg: -------------------------------------------------------------------------------- 1 | ### This file contains macros that only work with the klipper for cnc firmware fork: https://github.com/naikymen/klipper-for-cnc 2 | 3 | # The following probes are required for these macros and should be defined in your printer.cfg file (or whever you want but not here) 4 | # See: https://www.klipper3d.org/Config_Reference.html#probe 5 | 6 | # [probe_G38_multi tool_setter] -> Measures the tool length 7 | # [probe_G38_multi workpiece_probe] -> Measures the workpiece X, Y, or Z positions 8 | # [probe_G38_multi multi_axis_probe] -> CNC Probe like this https://www.aliexpress.com/item/1005003466415556.html 9 | 10 | # You also need to define user variables in your printer.cfg (or anywhere, just not here, and it should be defined after this cfg file is loaded) 11 | # You can copy the user variables macro below and update the relevant values. 12 | 13 | [gcode_macro USER_VARIABLES] 14 | # It is not recommended to edit these variables, re-define them in printer.cfg along with your probes 15 | variable_tool_setter_xy: -1, -1 # the X,Y coordinates the tool setter probe is located at - this should be fixed to the bed, otherwise dont use this macro 16 | variable_tool_setter_z_offset: -1 # The Z height that the probe triggers at the lowest part of your collet (i.e. with no tool). 17 | # You can work this out by using the collet to trigger the probe without a tool (or a tool that is flush with the collet/shoulder) 18 | variable_workpiece_probe_diameter: -1 19 | gcode: 20 | 21 | [gcode_macro KCNC_VARIABLES] 22 | variable_current_tool_length: 0 23 | gcode: 24 | 25 | [delayed_gcode startup] # This macro runs automatically when the machine is turned on or firmware restart. Required to pre-load data. 26 | initial_duration: 1 27 | gcode: 28 | Respond msg='Validating KCNC Configuration' 29 | {% set ts_x, ts_y = (printer['gcode_macro USER_VARIABLES'].tool_setter_xy) | map('float') %} 30 | {% set ts_z_offset = (printer['gcode_macro USER_VARIABLES'].tool_setter_z_offset) |float %} 31 | {% set workpiece_probe_diameter = (printer['gcode_macro USER_VARIABLES'].variable_workpiece_probe_diameter)|float %} 32 | 33 | {% if ts_x < 0 or ts_y < 0 %} 34 | RESPOND PREFIX='Error' MSG='Tool Setter X, Y coordinates not set in USER_VARIABLES' 35 | {% endif %} 36 | 37 | {% if ts_z_offset < 0 %} 38 | RESPOND PREFIX='Error' MSG='Tool Setter Z offset is not set in USER_VARIABLES' 39 | {% endif %} 40 | 41 | {% if workpiece_probe_diameter < 0 %} 42 | RESPOND PREFIX='Error' MSG='Workpiece Probe diameter is not set in USER_VARIABLES' 43 | {% endif %} 44 | 45 | 46 | [gcode_macro TEST_PROBE_POSITION] 47 | gcode: 48 | MULTIPROBE2 PROBE_NAME='workpiece_probe' X=-20 F=5 49 | QUERY_ENDSTOPS 50 | RESPOND MSG='last query: {printer.query_endstops.last_query}' 51 | RESPOND MSG='gcode_move: {printer.gcode_move}' 52 | RESPOND MSG='toolhead: {printer.toolhead}' 53 | 54 | [gcode_macro QUERY_TOOL_LENGTH] 55 | gcode: 56 | {% set current_tool_length = printer['gcode_macro KCNC_VARIABLES'].current_tool_length|float %} 57 | RESPOND PREFIX='info' MSG='Current Tool Length: {current_tool_length}' 58 | 59 | [gcode_macro MEASURE_TOOL_LENGTH] 60 | gcode: 61 | # Requires [probe_G38_multi tool_setter] 62 | 63 | SAVE_GCODE_STATE NAME=MTL_STATE # Saves offets 64 | 65 | # zero offsets to test save state and zeroing actual offsets in the macro 66 | {% set current_x_offset = 0|float %} 67 | {% set current_y_offset = 0|float %} 68 | {% set current_z_offset = 0|float %} 69 | 70 | {% set feed_rate = printer.configfile.config['printer'].max_velocity|default(100)|float * 60 %} 71 | {% set max_z_with_offset = printer.configfile.config['stepper_z'].position_max|float - current_z_offset %} 72 | 73 | # Set X Y offsets to 0 74 | # ZERO_OFFSETS_XYZ # calling this macro doesnt work 75 | SET_GCODE_OFFSET X=0 Y=0 Z=0 76 | 77 | {% set ts_x, ts_y = (printer['gcode_macro USER_VARIABLES'].tool_setter_xy) | map('float') %} 78 | {% if ts_x >= 0 and ts_y >= 0 %} 79 | # {% set tool_setter_xy = printer['gcode_macro USER_VARIABLES'].tool_setter_XY %} 80 | 81 | G1 Z{max_z_with_offset} # Move to max height to avoid collisions 82 | G1 X{ts_x - current_x_offset} Y{ts_y - current_y_offset} F{feed_rate} # move to the tool setter XY coords, adjusted to ignore offsets 83 | 84 | MULTIPROBE2 PROBE_NAME=tool_setter Z=0 F=5 # Probe to Z=0 at F=5mm/s 85 | G91 # Relative move 86 | G1 Z2 # move up 2mm 87 | G90 # Absolute move 88 | MULTIPROBE2 PROBE_NAME=tool_setter Z=0 F=1 # Probe again to Z=0 at F=1mm/s 89 | 90 | RESTORE_GCODE_STATE NAME=MTL_STATE # reload offsets before doing math 91 | 92 | QUERY_ENDSTOPS 93 | # It seems you cant query_endstops and immediately access the variables, so moving to the delayed gcode should solve the problem if we query before the delayed code executes. 94 | UPDATE_DELAYED_GCODE ID=_MEASURE_TOOL_LENGTH_DELAYED DURATION=0.1 MACRO=_MEASURE_TOOL_LENGTH_DELAYED 95 | {% else %} 96 | RESPOND PREFIX='Error' MSG='Tool Setter X, Y coordinates not set in USER_VARIABLES' 97 | {% endif %} 98 | 99 | [delayed_gcode _MEASURE_TOOL_LENGTH_DELAYED] 100 | # It seems you cant query_endstops and immediately access the variables, so moving to the delayed gcode should solve the problem if we query before the delayed code executes. 101 | gcode: 102 | {% set current_z_offset = printer.gcode_move.homing_origin.z|float %} 103 | {% set max_z_with_offset = printer.configfile.config['stepper_z'].position_max|float - current_z_offset %} 104 | 105 | {% set tool_setter_triggered = printer.query_endstops.last_query['probe_tool_setter'] %} 106 | # RESPOND MSG='{pt}' 107 | 108 | {% if tool_setter_triggered == 1 %} 109 | # calcualte tool length, update varioabels 110 | {% set tool_setter_z_offset = printer['gcode_macro USER_VARIABLES'].tool_setter_z_offset|float %} 111 | {% set current_z_position = printer.toolhead.position.z|float %} 112 | 113 | {% set current_workspace_offset_z = printer.gcode_move.homing_origin.z %} 114 | {% set current_tool_length = printer['gcode_macro KCNC_VARIABLES'].current_tool_length|float %} 115 | 116 | {% set new_tool_length = current_z_position - tool_setter_z_offset %} 117 | 118 | {% if current_tool_length > 0 %} 119 | # calc the difference and stuff 120 | # old tool has been measured and stored as current_tool_length, so we assume the SET_GCODE_OFFSET values were set with relative to the old tool length. 121 | {% set tool_length_difference = new_tool_length - current_tool_length %} 122 | {% set new_workspace_offset_z = current_workspace_offset_z + tool_length_difference %} 123 | 124 | UPDATE_OFFSETS_XYZ Z={new_workspace_offset_z} 125 | SET_GCODE_VARIABLE MACRO=KCNC_VARIABLES VARIABLE=current_tool_length VALUE={new_tool_length} 126 | RESPOND PREFIX='info' MSG='New Tool length: {new_tool_length}, Tool length difference: {tool_length_difference}, New Workspace Z Offset: {new_workspace_offset_z}' 127 | 128 | {% else %} % # tool length was not set 129 | # the tool length is the tool position, minus the tool setter offset 130 | # {% set tool_length = current_z_position - tool_setter_z_offset %} 131 | SET_GCODE_VARIABLE MACRO=KCNC_VARIABLES VARIABLE=current_tool_length VALUE={new_tool_length} 132 | RESPOND PREFIX='info' MSG='Tool length calculated as {current_z_position} - {tool_setter_z_offset} = {new_tool_length}' 133 | {% endif %} 134 | G4 P1000 135 | G1 Z{max_z_with_offset - 1} # Home Z to be safe 136 | {% else %} 137 | RESPOND PREFIX='Error' MSG='Error calculating tool length' 138 | {% endif %} 139 | 140 | [gcode_macro PROBE_AXIS] 141 | variable_probe_name: "" 142 | variable_axis: "" 143 | variable_direction: "" 144 | variable_probe_diameter: 0 145 | gcode: 146 | # SAVE_GCODE_STATE NAME=PA_STATE # Saves offets 147 | # SET_GCODE_OFFSET X=0 Y=0 Z=0 # zero offsets 148 | 149 | {% set probeName = params.PROBENAME|default('workpiece_probe')|lower %} 150 | {% set axis = params.AXIS|lower %} 151 | {% set distance = params.DISTANCE|default(20)|float %} 152 | {% set feedrate = params.FEEDRATE|default(5)|float %} 153 | 154 | {% set probeDiameter = params.PROBE_DIAMETER|default(printer['gcode_macro USER_VARIABLES'].workpiece_probe_diameter)|float %} 155 | 156 | 157 | {% if axis in printer.toolhead.homed_axes %} # test if the axis is homed before doing anything 158 | {% if axis == 'z' %} 159 | {% set direction = -1 %} # invert direction for Z probing 160 | {% else %} 161 | {% set direction = 1 %} 162 | {% endif %} 163 | 164 | G91 # Set relative movement mode 165 | MULTIPROBE2 PROBE_NAME={probeName} {axis}={distance*direction} F={feedrate} # 'fast' probe 166 | 167 | QUERY_ENDSTOPS 168 | # It seems you cant query_endstops and immediately access the variables, so moving to the delayed gcode should solve the problem if we query before the delayed code executes. 169 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=probe_name VALUE="'{probeName}'" 170 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=axis VALUE="'{axis}'" 171 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=direction VALUE={direction} 172 | SET_GCODE_VARIABLE MACRO=PROBE_AXIS VARIABLE=probe_diameter VALUE={probeDiameter} 173 | UPDATE_DELAYED_GCODE ID=_PROBE_AXIS_DELAYED DURATION=0.1 MACRO=_PROBE_AXIS_DELAYED 174 | {% else %} 175 | RESPOND prefix="error" msg="Unable to probe, axis: {axis} is not homed" 176 | {% endif %} 177 | 178 | G90 #Absolute mode 179 | 180 | [delayed_gcode _PROBE_AXIS_DELAYED] 181 | # It seems you cant query_endstops and immediately access the variables, so moving to the delayed gcode should solve the problem if we query before the delayed code executes. 182 | gcode: 183 | {% set parameters = printer['gcode_macro PROBE_AXIS'] %} 184 | 185 | {% set probeName = parameters.probe_name|lower %} 186 | {% set axis = parameters.axis|lower %} 187 | {% set probeDiameter = parameters.probe_diameter|float %} 188 | {% set probe = 'probe_' + probeName %} 189 | 190 | {% set probe_triggered = printer.query_endstops.last_query[probe] %} 191 | 192 | {% if probe_triggered == 1 %} 193 | # calcualte tool length, update varioabels 194 | 195 | {% if axis == 'z' %} 196 | {% set position = (printer.toolhead.position[{'x': 0, 'y': 1, 'z': 2}[axis|lower]])|float %} 197 | {% else %} 198 | {% set position = (printer.toolhead.position[{'x': 0, 'y': 1, 'z': 2}[axis|lower]] + probeDiameter/2)|float %} 199 | {% endif %} 200 | 201 | UPDATE_OFFSETS_XYZ {axis}={position} 202 | # SET_GCODE_VARIABLE MACRO=KCNC_VARIABLES VARIABLE=current_tool_length VALUE={new_tool_length} 203 | RESPOND PREFIX='info' MSG='Workpiece offset updated: {axis|upper}:{position}' 204 | 205 | {% else %} % # probing failed 206 | RESPOND PREFIX='error' MSG='Probing Failed' 207 | {% endif %} 208 | 209 | G90 #Absolute mode 210 | 211 | [gcode_macro _HOLE_CENTER_VARS] 212 | variable_probe_name: "" 213 | variable_probe_distance: 0 214 | variable_feedrate: 0 215 | 216 | variable_hole_x_min: -1 217 | variable_hole_y_min: -1 218 | variable_hole_center_x: -1 219 | variable_hole_center_y: -1 220 | variable_current_movement: "" 221 | variable_update_offset: "" # Update the current offset when macro is complete? 222 | gcode: 223 | 224 | [gcode_macro FIND_HOLE_CENTER] 225 | gcode: 226 | {% set probeName = params.PROBENAME|default('workpiece_probe')|string %} 227 | {% set probeDistance = params.PROBEDISTANCE|default(20)|float %} 228 | {% set feedrate = params.FEEDRATE|default(5)|float %} 229 | {% set updateOffset = params.UPDATEOFFSET|default('Y')|string %} # move up this amolunt to avoid the workpiece and clamps 230 | 231 | #set some vars for delayed macros 232 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=probe_name VALUE="'{probeName}'" 233 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=probe_distance VALUE={probeDistance} 234 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=feedrate VALUE={feedrate} 235 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=update_offset VALUE="'{updateOffset}'" 236 | 237 | # Reset all saved vars for validating later 238 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=hole_x_min VALUE=-1 239 | 240 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=hole_y_min VALUE=-1 241 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=hole_center_x VALUE=-1 242 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=hole_center_y VALUE=-1 243 | 244 | SET_GCODE_OFFSET X=0 Y=0 Z=0 245 | 246 | G91 # relative mode 247 | 248 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=current_movement VALUE="'hole_x_min'" # set next move in sequence 249 | UPDATE_DELAYED_GCODE ID=_FIND_HOLE_CENTER_PROBING_DELAYED DURATION=0.1 MACRO=_FIND_HOLE_CENTER_PROBING_DELAYED # trigger next probing sequence 250 | 251 | # G90 # Absolute mode 252 | 253 | [delayed_gcode _FIND_HOLE_CENTER_PROBING_DELAYED] 254 | gcode: 255 | {% set parameters = printer['gcode_macro _HOLE_CENTER_VARS'] %} 256 | {% set probeName = parameters.probe_name|string %} 257 | {% set probeDistance = parameters.probe_distance|float %} 258 | {% set feedrate = parameters.feedrate|float %} 259 | 260 | ########### X MIN PROBING 261 | {% if parameters.current_movement == 'hole_x_min' %} 262 | G91 # ensure relative mode 263 | MULTIPROBE2 PROBE_NAME={probeName} X=-{probeDistance} F={feedrate} 264 | UPDATE_DELAYED_GCODE ID=_FIND_HOLE_CENTER_CALCULATIONS_DELAYED DURATION=0.1 MACRO=_FIND_HOLE_CENTER_CALCULATIONS_DELAYED 265 | 266 | ########### X MAX PROBING 267 | {% elif parameters.current_movement == 'hole_x_max'%} 268 | G91 # ensure relative mode 269 | MULTIPROBE2 PROBE_NAME={probeName} X={probeDistance*2} F={feedrate} 270 | UPDATE_DELAYED_GCODE ID=_FIND_HOLE_CENTER_CALCULATIONS_DELAYED DURATION=0.1 MACRO=_FIND_HOLE_CENTER_CALCULATIONS_DELAYED 271 | 272 | ########### Y MIN PROBING 273 | {% elif parameters.current_movement == 'hole_y_min'%} 274 | G91 # ensure relative mode 275 | MULTIPROBE2 PROBE_NAME={probeName} Y=-{probeDistance} F={feedrate} 276 | UPDATE_DELAYED_GCODE ID=_FIND_HOLE_CENTER_CALCULATIONS_DELAYED DURATION=0.1 MACRO=_FIND_HOLE_CENTER_CALCULATIONS_DELAYED 277 | 278 | ########### Y MAX PROBING 279 | {% elif parameters.current_movement == 'hole_y_max'%} 280 | G91 # ensure relative mode 281 | MULTIPROBE2 PROBE_NAME={probeName} Y={probeDistance*2} F={feedrate} 282 | UPDATE_DELAYED_GCODE ID=_FIND_HOLE_CENTER_CALCULATIONS_DELAYED DURATION=0.1 MACRO=_FIND_HOLE_CENTER_CALCULATIONS_DELAYED 283 | 284 | {% else %} 285 | RESPOND PREFIX="error" MSG="Error in probing delayed macro" 286 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=current_movement VALUE="''" 287 | G90 # Absolute mode 288 | {% endif %} 289 | 290 | [delayed_gcode _FIND_HOLE_CENTER_CALCULATIONS_DELAYED] 291 | gcode: 292 | # RESPOND MSG='Inside CALCS' 293 | {% set parameters = printer['gcode_macro _HOLE_CENTER_VARS'] %} 294 | # RESPOND MSG='parameters {parameters}' 295 | 296 | ########### X MIN CALCS 297 | {% if parameters.current_movement == 'hole_x_min' %} 298 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=hole_x_min VALUE={printer.toolhead.position.x|float} 299 | # RESPOND MSG='parameters hole x min: {printer.toolhead.position.x|float}' 300 | 301 | G91 # ensure relative move 302 | G1 X1 # move away to stop trigger 303 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=current_movement VALUE="'hole_x_max'" # set next move in sequence 304 | UPDATE_DELAYED_GCODE ID=_FIND_HOLE_CENTER_PROBING_DELAYED DURATION=0.1 MACRO=_FIND_HOLE_CENTER_PROBING_DELAYED # trigger next probing sequence 305 | 306 | ########### X MAX CALCS 307 | {% elif parameters.current_movement == 'hole_x_max'%} 308 | {% set holeXMin = parameters.hole_x_min %} 309 | {% set holeXMax = printer.toolhead.position.x|float %} 310 | 311 | # RESPOND MSG='hole x min,max: {holeXMin},{holeXMax}' 312 | {% if (holeXMin >= 0) and (holeXMax >=0 ) %} 313 | # Calculate X center 314 | {% set holeCenterX = (holeXMin + holeXMax) / 2 %} 315 | {% set holeXRad = (holeXMax - holeXMin) / 2 %} 316 | RESPOND MSG='Hole X, min:{holeXMin}, max:{holeXMax}, center:{holeCenterX}' 317 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=hole_center_x VALUE={holeCenterX|float} 318 | 319 | G91 # ensure relative mode 320 | G1 X-{holeXRad} # move to X center 321 | 322 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=current_movement VALUE="'hole_y_min'" # set next move in sequence 323 | UPDATE_DELAYED_GCODE ID=_FIND_HOLE_CENTER_PROBING_DELAYED DURATION=0.1 MACRO=_FIND_HOLE_CENTER_PROBING_DELAYED # trigger next probing sequence 324 | {% else %} 325 | RESPOND prefix='error' MSG='Error calculating X center' 326 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=current_movement VALUE="''" 327 | G90 # Absolute mode 328 | {% endif %} 329 | 330 | ########### Y MIN CALCS 331 | {% elif parameters.current_movement == 'hole_y_min'%} 332 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=hole_y_min VALUE={printer.toolhead.position.y|float} 333 | # RESPOND MSG='parameters hole y min: {printer.toolhead.position.y|float}' 334 | 335 | G91 # ensure relative move 336 | G1 Y1 # move away to stop trigger 337 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=current_movement VALUE="'hole_y_max'" # set next move in sequence 338 | UPDATE_DELAYED_GCODE ID=_FIND_HOLE_CENTER_PROBING_DELAYED DURATION=0.1 MACRO=_FIND_HOLE_CENTER_PROBING_DELAYED # trigger next probing sequence 339 | 340 | ########### Y MAX CALCS 341 | {% elif parameters.current_movement == 'hole_y_max'%} 342 | # SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=hole_y_max VALUE={printer.toolhead.position.y|float} 343 | 344 | {% set holeCenterX = parameters.hole_center_x %} 345 | # SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=current_movement VALUE="''" 346 | 347 | {% set holeYMin = parameters.hole_y_min %} 348 | {% set HoleYMax = printer.toolhead.position.y|float %} 349 | 350 | # RESPOND MSG='hole y min,max: {holeYMin},{HoleYMax}' 351 | {% if (holeYMin >= 0) and (HoleYMax >=0 ) %} 352 | # Calculate Y center 353 | {% set holeCenterY = (holeYMin + HoleYMax) / 2 %} 354 | {% set holeYRad = (HoleYMax - holeYMin) /2 %} 355 | 356 | G91 # ensure relative mode 357 | G1 Y-{holeYRad} # move to Y center 358 | 359 | RESPOND MSG='Hole Y, min:{holeYMin}, max:{holeYMax}, center:{holeCenterY}' 360 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=hole_center_y VALUE={holeCenterY|float} 361 | 362 | {% if parameters.update_offset|lower == 'y' %} 363 | RESPOND PREFIX='Info' MSG='SETTING OFFSETS to hole center at: {holeCenterX}, {holeCenterY}' 364 | SET_GCODE_OFFSET X={holeCenterX} Y={holeCenterY} 365 | {% endif %} 366 | 367 | RESPOND PREFIX='Info' MSG='Ensure you reset Z Offset if required' 368 | 369 | {% else %} 370 | RESPOND prefix='error' msg='Error calculating Y center' 371 | SET_GCODE_VARIABLE MACRO=_HOLE_CENTER_VARS VARIABLE=current_movement VALUE="''" 372 | G90 # Absolute mode 373 | {% endif %} 374 | {% endif %} 375 | 376 | 377 | [gcode_macro _PART_CENTER_VARS] 378 | variable_probe_name: "" 379 | variable_probe_axis: "" 380 | variable_probe_distance: 0 381 | variable_feedrate: 0 382 | variable_part_distance: 0 383 | variable_z_hop: 0 384 | variable_update_offset: "" # Update the current offset when macro is complete? 385 | 386 | variable_part_min: -1 387 | variable_part_center: -1 388 | variable_current_movement: "" 389 | gcode: 390 | 391 | [gcode_macro FIND_PART_CENTER] 392 | gcode: 393 | {% set probeName = params.PROBENAME|default('workpiece_probe')|string %} 394 | {% set probeAxis = params.PROBEAXIS|default('x')|string %} 395 | {% set probeDistance = params.PROBEDISTANCE|default(20)|float %} # Move towards the workpiece by this amount on either side of the part (partDistance) 396 | {% set feedrate = params.FEEDRATE|default(5)|float %} 397 | {% set partDistance = params.PARTDISTANCE|default(100)|float %} 398 | {% set zHop = params.ZHOP|default(50)|float %} # move up this amolunt to avoid the workpiece and clamps 399 | {% set updateOffset = params.UPDATEOFFSET|default('Y')|string %} # move up this amolunt to avoid the workpiece and clamps 400 | 401 | {% if probeDistance > 0 %} 402 | #set some vars for delayed macros 403 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=probe_name VALUE="'{probeName}'" 404 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=probe_axis VALUE="'{probeAxis}'" 405 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=probe_distance VALUE={probeDistance} 406 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=feedrate VALUE={feedrate} 407 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=part_distance VALUE={partDistance} 408 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=z_hop VALUE={zHop} 409 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=update_offset VALUE="'{updateOffset}'" 410 | 411 | # Reset all saved vars for validating later 412 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=part_min VALUE=-1 413 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=part_center VALUE=-1 414 | 415 | # SET_GCODE_OFFSET X=0 Y=0 Z=0 416 | 417 | G91 # relative mode 418 | 419 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=current_movement VALUE="'part_min'" # set next move in sequence 420 | UPDATE_DELAYED_GCODE ID=_FIND_PART_CENTER_PROBING_DELAYED DURATION=0.1 MACRO=_FIND_PART_CENTER_PROBING_DELAYED # trigger next probing sequence 421 | 422 | # G90 # Absolute mode 423 | 424 | {% else %} 425 | RESPOND PREFIX="error" MSG="Error probe distance must be > 0" 426 | {% endif %} 427 | 428 | [delayed_gcode _FIND_PART_CENTER_PROBING_DELAYED] 429 | gcode: 430 | {% set parameters = printer['gcode_macro _PART_CENTER_VARS'] %} 431 | {% set probeName = parameters.probe_name|string %} 432 | {% set probeDistance = parameters.probe_distance|float %} 433 | {% set feedrate = parameters.feedrate|float %} 434 | 435 | ########### MIN PROBING 436 | {% if parameters.current_movement == 'part_min' %} 437 | G91 # ensure relative mode 438 | MULTIPROBE2 PROBE_NAME={probeName} {parameters.probe_axis|lower}={probeDistance} F={feedrate} 439 | UPDATE_DELAYED_GCODE ID=_FIND_PART_CENTER_CALCULATIONS_DELAYED DURATION=0.1 MACRO=_FIND_PART_CENTER_CALCULATIONS_DELAYED 440 | 441 | ########### MAX PROBING 442 | {% elif parameters.current_movement == 'part_max'%} 443 | G91 # ensure relative mode 444 | MULTIPROBE2 PROBE_NAME={probeName} {parameters.probe_axis|lower}=-{probeDistance*2} F={feedrate} # probe distance x2 for clearance after max move 445 | UPDATE_DELAYED_GCODE ID=_FIND_PART_CENTER_CALCULATIONS_DELAYED DURATION=0.1 MACRO=_FIND_PART_CENTER_CALCULATIONS_DELAYED 446 | 447 | {% else %} 448 | RESPOND PREFIX="error" MSG="Error in probing delayed macro" 449 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=current_movement VALUE="''" 450 | G90 # Absolute mode 451 | {% endif %} 452 | 453 | 454 | [delayed_gcode _FIND_PART_CENTER_CALCULATIONS_DELAYED] 455 | gcode: 456 | {% set parameters = printer['gcode_macro _PART_CENTER_VARS'] %} 457 | 458 | ########### MIN CALCS 459 | {% if parameters.current_movement == 'part_min' %} 460 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=part_min VALUE={printer.toolhead.position[parameters.probe_axis]} 461 | 462 | G91 # ensure relative move 463 | G1 {parameters.probe_axis|lower}-1 # move away to stop trigger 464 | G1 Z{parameters.z_hop|float} # move up to clear the part and clamps 465 | G1 {parameters.probe_axis|lower}{parameters.part_distance + parameters.probe_distance} # move over the part by part_distance plus probe distance for clearance 466 | G1 Z-{parameters.z_hop|float} # move back down 467 | 468 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=current_movement VALUE="'part_max'" # set next move in sequence 469 | UPDATE_DELAYED_GCODE ID=_FIND_PART_CENTER_PROBING_DELAYED DURATION=0.1 MACRO=_FIND_PART_CENTER_PROBING_DELAYED # trigger next probing sequence 470 | 471 | # ########### MAX CALCS 472 | {% elif parameters.current_movement == 'part_max'%} 473 | {% set partMin = parameters.part_min %} 474 | {% set partMax = printer.toolhead.position[parameters.probe_axis] %} 475 | 476 | # RESPOND MSG='hole x min,max: {partMin},{partMax}' 477 | {% if (partMin >= 0) and (partMax >=0 ) %} 478 | # Calculate X center 479 | {% set partCenter = (partMin + partMax) / 2 %} 480 | # {% set holeXRad = (partMax - partMin) / 2 %} 481 | RESPOND MSG='Part min:{partMin}, max:{partMax}, center:{partCenter}' 482 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=part_center VALUE={partCenter|float} 483 | 484 | {% if parameters.update_offset|lower == 'y' %} 485 | RESPOND MSG='{parameters.probe_axis|upper} Axis Offset updated to:{partCenter}' 486 | UPDATE_OFFSETS_XYZ {parameters.probe_axis}={partCenter} 487 | {% endif %} 488 | 489 | G91 # ensure relative move 490 | G1 {parameters.probe_axis|lower}1 # move away to stop trigger 491 | G1 Z{parameters.z_hop|float} # move up to clear the part and clamps 492 | 493 | {% else %} 494 | RESPOND prefix='error' MSG='Error calculating center' 495 | SET_GCODE_VARIABLE MACRO=_PART_CENTER_VARS VARIABLE=current_movement VALUE="''" 496 | G90 # Absolute mode 497 | {% endif %} 498 | {% endif %} 499 | 500 | [gcode_macro _TWO_POINTS_VARS] 501 | variable_probe_name: "" 502 | variable_probe_axis: "" 503 | variable_probe_distance: 0 504 | variable_feedrate: 0 505 | variable_point_distance: 0 506 | variable_z_hop: 0 507 | variable_update_offset: "" # Update the current offset when macro is complete? 508 | 509 | variable_first_point: -1 510 | # variable_part_center: -1 511 | variable_current_movement: "" 512 | gcode: 513 | 514 | [gcode_macro PROBE_TWO_POINTS] 515 | gcode: 516 | {% set probeName = params.PROBENAME|default('workpiece_probe')|string %} 517 | {% set probeAxis = params.PROBEAXIS|string %} 518 | {% set probeDistance = params.PROBEDISTANCE|default(20)|float %} # Move towards the workpiece by this amount on either side of the part (pointDistance) 519 | {% set feedrate = params.FEEDRATE|default(5)|float %} 520 | {% set pointDistance = params.POINTDISTANCE|default(100)|float %} 521 | {% set zHop = params.ZHOP|default(0)|float %} # move up this amolunt to avoid the workpiece and clamps 522 | # {% set updateOffset = params.UPDATEOFFSET|default('Y')|string %} # move up this amolunt to avoid the workpiece and clamps 523 | 524 | {% if pointDistance > 0 %} 525 | #set some vars for delayed macros 526 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=probe_name VALUE="'{probeName}'" 527 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=probe_axis VALUE="'{probeAxis}'" 528 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=probe_distance VALUE={probeDistance} 529 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=feedrate VALUE={feedrate} 530 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=point_distance VALUE={pointDistance} 531 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=z_hop VALUE={zHop} 532 | # SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=update_offset VALUE="'{updateOffset}'" 533 | 534 | # Reset all saved vars for validating later 535 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=first_point VALUE=-1 536 | 537 | SET_GCODE_OFFSET X=0 Y=0 Z=0 538 | 539 | G91 # relative mode 540 | 541 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=current_movement VALUE="'first_point'" # set next move in sequence 542 | UPDATE_DELAYED_GCODE ID=_PROBE_TWO_POINTS_LOGIC_DELAYED DURATION=0.1 MACRO=_PROBE_TWO_POINTS_LOGIC # trigger next probing sequence 543 | 544 | G90 # Absolute mode 545 | 546 | {% else %} 547 | RESPOND PREFIX="error" MSG="Error point distance must be > 0" 548 | {% endif %} 549 | 550 | [delayed_gcode _PROBE_TWO_POINTS_LOGIC_DELAYED] 551 | gcode: 552 | {% set parameters = printer['gcode_macro _TWO_POINTS_VARS'] %} 553 | {% set probeName = parameters.probe_name|string %} 554 | {% set probeDistance = parameters.probe_distance|float %} 555 | {% set feedrate = parameters.feedrate|float %} 556 | # {% set POINTdISTANCE = parameters.point_distance|float %} 557 | 558 | ########### FIRST POINT PROBING 559 | {% if parameters.current_movement == 'first_point' %} 560 | G91 # ensure relative mode 561 | MULTIPROBE2 PROBE_NAME={probeName} {parameters.probe_axis|lower}={probeDistance} F={feedrate} 562 | _PROBE_TWO_POINTS_CALCULATIONS 563 | 564 | ########### SECOND POINT PROBING 565 | {% elif parameters.current_movement == 'second_point'%} 566 | G91 # ensure relative mode 567 | MULTIPROBE2 PROBE_NAME={probeName} {parameters.probe_axis|lower}={probeDistance*2} F={feedrate} # probe distance x2 for clearance after max move 568 | _PROBE_TWO_POINTS_CALCULATIONS 569 | 570 | {% else %} 571 | RESPOND PREFIX="error" MSG="Error in probing macro" 572 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=current_movement VALUE="''" 573 | G90 # Absolute mode 574 | {% endif %} 575 | 576 | 577 | [gcode_macro _PROBE_TWO_POINTS_CALCULATIONS] 578 | gcode: 579 | {% set parameters = printer['gcode_macro _TWO_POINTS_VARS'] %} 580 | {% set axis_map = {'X': 'Y', 'Y': 'X'} %} 581 | {% set move_axis = axis_map[parameters.probe_axis|upper] %} 582 | 583 | ########### FIRST POINT CALCS 584 | {% if parameters.current_movement == 'first_point' %} 585 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=first_point VALUE={printer.toolhead.position[parameters.probe_axis]} 586 | 587 | G91 # ensure relative move 588 | G1 {parameters.probe_axis|lower}-{parameters.probe_distance/2} # move away to stop trigger 589 | G1 Z{parameters.z_hop|float} # move up to clear the part and clamps 590 | G1 {move_axis|lower}{parameters.point_distance} # move by point_distance 591 | G1 Z-{parameters.z_hop|float} # move back down 592 | 593 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=current_movement VALUE="'second_point'" # set next move in sequence 594 | UPDATE_DELAYED_GCODE ID=_PROBE_TWO_POINTS_LOGIC_DELAYED DURATION=0.1 MACRO=_PROBE_TWO_POINTS_LOGIC # trigger next probing sequence 595 | 596 | # ########### SECOND POINT CALCS 597 | {% elif parameters.current_movement == 'second_point' %} 598 | {% set firstPoint = parameters.first_point %} 599 | {% set secondPoint = printer.toolhead.position[parameters.probe_axis] %} 600 | 601 | RESPOND MSG="Points one,two: {firstPoint},{secondPoint}" 602 | {% if (firstPoint >= 0) and (secondPoint >=0 ) %} 603 | # Calculate difference 604 | {% set difference = secondPoint - firstPoint %} 605 | RESPOND MSG="Difference (second-first): {difference}" 606 | 607 | {% else %} 608 | RESPOND prefix='error' MSG="Error calculating difference" 609 | SET_GCODE_VARIABLE MACRO=_TWO_POINTS_VARS VARIABLE=current_movement VALUE="''" 610 | G90 # Absolute mode 611 | {% endif %} 612 | {% endif %} -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------