mirror of
https://github.com/Klipper3d/klipper.git
synced 2025-11-03 20:05:49 +01:00
685 lines
30 KiB
Python
685 lines
30 KiB
Python
# Parse gcode commands
|
|
#
|
|
# Copyright (C) 2016-2020 Kevin O'Connor <kevin@koconnor.net>
|
|
#
|
|
# This file may be distributed under the terms of the GNU GPLv3 license.
|
|
import os, re, logging, collections, shlex
|
|
import homing
|
|
|
|
class GCodeCommand:
|
|
error = homing.CommandError
|
|
def __init__(self, gcode, command, commandline, params, need_ack):
|
|
self._command = command
|
|
self._commandline = commandline
|
|
self._params = params
|
|
self._need_ack = need_ack
|
|
# Method wrappers
|
|
self.respond_info = gcode.respond_info
|
|
self.respond_raw = gcode.respond_raw
|
|
def get_command(self):
|
|
return self._command
|
|
def get_commandline(self):
|
|
return self._commandline
|
|
def get_command_parameters(self):
|
|
return self._params
|
|
def ack(self, msg=None):
|
|
if not self._need_ack:
|
|
return False
|
|
ok_msg = "ok"
|
|
if msg:
|
|
ok_msg = "ok %s" % (msg,)
|
|
self.respond_raw(ok_msg)
|
|
self._need_ack = False
|
|
return True
|
|
# Parameter parsing helpers
|
|
class sentinel: pass
|
|
def get(self, name, default=sentinel, parser=str, minval=None, maxval=None,
|
|
above=None, below=None):
|
|
value = self._params.get(name)
|
|
if value is None:
|
|
if default is self.sentinel:
|
|
raise self.error("Error on '%s': missing %s"
|
|
% (self._commandline, name))
|
|
return default
|
|
try:
|
|
value = parser(value)
|
|
except:
|
|
raise self.error("Error on '%s': unable to parse %s"
|
|
% (self._commandline, value))
|
|
if minval is not None and value < minval:
|
|
raise self.error("Error on '%s': %s must have minimum of %s"
|
|
% (self._commandline, name, minval))
|
|
if maxval is not None and value > maxval:
|
|
raise self.error("Error on '%s': %s must have maximum of %s"
|
|
% (self._commandline, name, maxval))
|
|
if above is not None and value <= above:
|
|
raise self.error("Error on '%s': %s must be above %s"
|
|
% (self._commandline, name, above))
|
|
if below is not None and value >= below:
|
|
raise self.error("Error on '%s': %s must be below %s"
|
|
% (self._commandline, name, below))
|
|
return value
|
|
def get_int(self, name, default=sentinel, minval=None, maxval=None):
|
|
return self.get(name, default, parser=int, minval=minval, maxval=maxval)
|
|
def get_float(self, name, default=sentinel, minval=None, maxval=None,
|
|
above=None, below=None):
|
|
return self.get(name, default, parser=float, minval=minval,
|
|
maxval=maxval, above=above, below=below)
|
|
|
|
# Parse and handle G-Code commands
|
|
class GCodeParser:
|
|
error = homing.CommandError
|
|
RETRY_TIME = 0.100
|
|
def __init__(self, printer, fd):
|
|
self.printer = printer
|
|
self.fd = fd
|
|
printer.register_event_handler("klippy:ready", self._handle_ready)
|
|
printer.register_event_handler("klippy:shutdown", self._handle_shutdown)
|
|
printer.register_event_handler("klippy:disconnect",
|
|
self._handle_disconnect)
|
|
printer.register_event_handler("extruder:activate_extruder",
|
|
self._handle_activate_extruder)
|
|
# Input handling
|
|
self.reactor = printer.get_reactor()
|
|
self.is_processing_data = False
|
|
self.is_fileinput = not not printer.get_start_args().get("debuginput")
|
|
self.fd_handle = None
|
|
if not self.is_fileinput:
|
|
self.fd_handle = self.reactor.register_fd(self.fd,
|
|
self._process_data)
|
|
self.partial_input = ""
|
|
self.pending_commands = []
|
|
self.bytes_read = 0
|
|
self.input_log = collections.deque([], 50)
|
|
# Command handling
|
|
self.is_printer_ready = False
|
|
self.mutex = self.reactor.mutex()
|
|
self.base_gcode_handlers = self.gcode_handlers = {}
|
|
self.ready_gcode_handlers = {}
|
|
self.mux_commands = {}
|
|
self.gcode_help = {}
|
|
for cmd in self.all_handlers:
|
|
func = getattr(self, 'cmd_' + cmd)
|
|
wnr = getattr(self, 'cmd_' + cmd + '_when_not_ready', False)
|
|
desc = getattr(self, 'cmd_' + cmd + '_help', None)
|
|
self.register_command(cmd, func, wnr, desc)
|
|
for a in getattr(self, 'cmd_' + cmd + '_aliases', []):
|
|
self.register_command(a, func, wnr)
|
|
# G-Code coordinate manipulation
|
|
self.absolute_coord = self.absolute_extrude = True
|
|
self.base_position = [0.0, 0.0, 0.0, 0.0]
|
|
self.last_position = [0.0, 0.0, 0.0, 0.0]
|
|
self.homing_position = [0.0, 0.0, 0.0, 0.0]
|
|
self.speed = 25.
|
|
self.speed_factor = 1. / 60.
|
|
self.extrude_factor = 1.
|
|
# G-Code state
|
|
self.saved_states = {}
|
|
self.move_transform = self.move_with_transform = None
|
|
self.position_with_transform = (lambda: [0., 0., 0., 0.])
|
|
self.toolhead = None
|
|
def is_traditional_gcode(self, cmd):
|
|
# A "traditional" g-code command is a letter and followed by a number
|
|
try:
|
|
cmd = cmd.upper().split()[0]
|
|
val = float(cmd[1:])
|
|
return cmd[0].isupper() and cmd[1].isdigit()
|
|
except:
|
|
return False
|
|
def register_command(self, cmd, func, when_not_ready=False, desc=None):
|
|
if func is None:
|
|
old_cmd = self.ready_gcode_handlers.get(cmd)
|
|
if cmd in self.ready_gcode_handlers:
|
|
del self.ready_gcode_handlers[cmd]
|
|
if cmd in self.base_gcode_handlers:
|
|
del self.base_gcode_handlers[cmd]
|
|
return old_cmd
|
|
if cmd in self.ready_gcode_handlers:
|
|
raise self.printer.config_error(
|
|
"gcode command %s already registered" % (cmd,))
|
|
if not self.is_traditional_gcode(cmd):
|
|
origfunc = func
|
|
func = lambda params: origfunc(self._get_extended_params(params))
|
|
self.ready_gcode_handlers[cmd] = func
|
|
if when_not_ready:
|
|
self.base_gcode_handlers[cmd] = func
|
|
if desc is not None:
|
|
self.gcode_help[cmd] = desc
|
|
def register_mux_command(self, cmd, key, value, func, desc=None):
|
|
prev = self.mux_commands.get(cmd)
|
|
if prev is None:
|
|
self.register_command(cmd, self._cmd_mux, desc=desc)
|
|
self.mux_commands[cmd] = prev = (key, {})
|
|
prev_key, prev_values = prev
|
|
if prev_key != key:
|
|
raise self.printer.config_error(
|
|
"mux command %s %s %s may have only one key (%s)" % (
|
|
cmd, key, value, prev_key))
|
|
if value in prev_values:
|
|
raise self.printer.config_error(
|
|
"mux command %s %s %s already registered (%s)" % (
|
|
cmd, key, value, prev_values))
|
|
prev_values[value] = func
|
|
def set_move_transform(self, transform, force=False):
|
|
if self.move_transform is not None and not force:
|
|
raise self.printer.config_error(
|
|
"G-Code move transform already specified")
|
|
old_transform = self.move_transform
|
|
if old_transform is None:
|
|
old_transform = self.toolhead
|
|
self.move_transform = transform
|
|
self.move_with_transform = transform.move
|
|
self.position_with_transform = transform.get_position
|
|
return old_transform
|
|
def stats(self, eventtime):
|
|
return False, "gcodein=%d" % (self.bytes_read,)
|
|
def _action_emergency_stop(self, msg="action_emergency_stop"):
|
|
self.printer.invoke_shutdown("Shutdown due to %s" % (msg,))
|
|
return ""
|
|
def _action_respond_info(self, msg):
|
|
self.respond_info(msg)
|
|
return ""
|
|
def _action_respond_error(self, msg):
|
|
self._respond_error(msg)
|
|
return ""
|
|
def _get_gcode_position(self):
|
|
p = [lp - bp for lp, bp in zip(self.last_position, self.base_position)]
|
|
p[3] /= self.extrude_factor
|
|
return p
|
|
def _get_gcode_speed(self):
|
|
return self.speed / self.speed_factor
|
|
def _get_gcode_speed_override(self):
|
|
return self.speed_factor * 60.
|
|
def get_status(self, eventtime):
|
|
move_position = self._get_gcode_position()
|
|
busy = self.is_processing_data
|
|
return {
|
|
'speed_factor': self._get_gcode_speed_override(),
|
|
'speed': self._get_gcode_speed(),
|
|
'extrude_factor': self.extrude_factor,
|
|
'absolute_coordinates': self.absolute_coord,
|
|
'absolute_extrude': self.absolute_extrude,
|
|
'busy': busy,
|
|
'move_xpos': move_position[0],
|
|
'move_ypos': move_position[1],
|
|
'move_zpos': move_position[2],
|
|
'move_epos': move_position[3],
|
|
'last_xpos': self.last_position[0],
|
|
'last_ypos': self.last_position[1],
|
|
'last_zpos': self.last_position[2],
|
|
'last_epos': self.last_position[3],
|
|
'base_xpos': self.base_position[0],
|
|
'base_ypos': self.base_position[1],
|
|
'base_zpos': self.base_position[2],
|
|
'base_epos': self.base_position[3],
|
|
'homing_xpos': self.homing_position[0],
|
|
'homing_ypos': self.homing_position[1],
|
|
'homing_zpos': self.homing_position[2],
|
|
'gcode_position': homing.Coord(*move_position),
|
|
'action_respond_info': self._action_respond_info,
|
|
'action_respond_error': self._action_respond_error,
|
|
'action_emergency_stop': self._action_emergency_stop,
|
|
}
|
|
def _handle_shutdown(self):
|
|
if not self.is_printer_ready:
|
|
return
|
|
self.is_printer_ready = False
|
|
self.gcode_handlers = self.base_gcode_handlers
|
|
self._dump_debug()
|
|
if self.is_fileinput:
|
|
self.printer.request_exit('error_exit')
|
|
self._respond_state("Shutdown")
|
|
def _handle_disconnect(self):
|
|
self._respond_state("Disconnect")
|
|
def _handle_ready(self):
|
|
self.is_printer_ready = True
|
|
self.gcode_handlers = self.ready_gcode_handlers
|
|
self.toolhead = self.printer.lookup_object('toolhead')
|
|
if self.move_transform is None:
|
|
self.move_with_transform = self.toolhead.move
|
|
self.position_with_transform = self.toolhead.get_position
|
|
if self.is_fileinput and self.fd_handle is None:
|
|
self.fd_handle = self.reactor.register_fd(self.fd,
|
|
self._process_data)
|
|
self._respond_state("Ready")
|
|
def _handle_activate_extruder(self):
|
|
self.reset_last_position()
|
|
self.extrude_factor = 1.
|
|
self.base_position[3] = self.last_position[3]
|
|
def reset_last_position(self):
|
|
if self.is_printer_ready:
|
|
self.last_position = self.position_with_transform()
|
|
def _dump_debug(self):
|
|
out = []
|
|
out.append("Dumping gcode input %d blocks" % (
|
|
len(self.input_log),))
|
|
for eventtime, data in self.input_log:
|
|
out.append("Read %f: %s" % (eventtime, repr(data)))
|
|
out.append(
|
|
"gcode state: absolute_coord=%s absolute_extrude=%s"
|
|
" base_position=%s last_position=%s homing_position=%s"
|
|
" speed_factor=%s extrude_factor=%s speed=%s" % (
|
|
self.absolute_coord, self.absolute_extrude,
|
|
self.base_position, self.last_position, self.homing_position,
|
|
self.speed_factor, self.extrude_factor, self.speed))
|
|
logging.info("\n".join(out))
|
|
# Parse input into commands
|
|
args_r = re.compile('([A-Z_]+|[A-Z*/])')
|
|
def _process_commands(self, commands, need_ack=True):
|
|
for line in commands:
|
|
# Ignore comments and leading/trailing spaces
|
|
line = origline = line.strip()
|
|
cpos = line.find(';')
|
|
if cpos >= 0:
|
|
line = line[:cpos]
|
|
# Break line into parts and determine command
|
|
parts = self.args_r.split(line.upper())
|
|
numparts = len(parts)
|
|
cmd = ""
|
|
if numparts >= 3 and parts[1] != 'N':
|
|
cmd = parts[1] + parts[2].strip()
|
|
elif numparts >= 5 and parts[1] == 'N':
|
|
# Skip line number at start of command
|
|
cmd = parts[3] + parts[4].strip()
|
|
# Build gcode "params" dictionary
|
|
params = { parts[i]: parts[i+1].strip()
|
|
for i in range(1, numparts, 2) }
|
|
gcmd = GCodeCommand(self, cmd, origline, params, need_ack)
|
|
# Invoke handler for command
|
|
handler = self.gcode_handlers.get(cmd, self.cmd_default)
|
|
try:
|
|
handler(gcmd)
|
|
except self.error as e:
|
|
self._respond_error(str(e))
|
|
self.reset_last_position()
|
|
self.printer.send_event("gcode:command_error")
|
|
if not need_ack:
|
|
raise
|
|
except:
|
|
msg = 'Internal error on command:"%s"' % (cmd,)
|
|
logging.exception(msg)
|
|
self.printer.invoke_shutdown(msg)
|
|
self._respond_error(msg)
|
|
if not need_ack:
|
|
raise
|
|
gcmd.ack()
|
|
m112_r = re.compile('^(?:[nN][0-9]+)?\s*[mM]112(?:\s|$)')
|
|
def _process_data(self, eventtime):
|
|
# Read input, separate by newline, and add to pending_commands
|
|
try:
|
|
data = os.read(self.fd, 4096)
|
|
except os.error:
|
|
logging.exception("Read g-code")
|
|
return
|
|
self.input_log.append((eventtime, data))
|
|
self.bytes_read += len(data)
|
|
lines = data.split('\n')
|
|
lines[0] = self.partial_input + lines[0]
|
|
self.partial_input = lines.pop()
|
|
pending_commands = self.pending_commands
|
|
pending_commands.extend(lines)
|
|
# Special handling for debug file input EOF
|
|
if not data and self.is_fileinput:
|
|
if not self.is_processing_data:
|
|
self.reactor.unregister_fd(self.fd_handle)
|
|
self.fd_handle = None
|
|
self.request_restart('exit')
|
|
pending_commands.append("")
|
|
# Handle case where multiple commands pending
|
|
if self.is_processing_data or len(pending_commands) > 1:
|
|
if len(pending_commands) < 20:
|
|
# Check for M112 out-of-order
|
|
for line in lines:
|
|
if self.m112_r.match(line) is not None:
|
|
self.cmd_M112(None)
|
|
if self.is_processing_data:
|
|
if len(pending_commands) >= 20:
|
|
# Stop reading input
|
|
self.reactor.unregister_fd(self.fd_handle)
|
|
self.fd_handle = None
|
|
return
|
|
# Process commands
|
|
self.is_processing_data = True
|
|
while pending_commands:
|
|
self.pending_commands = []
|
|
with self.mutex:
|
|
self._process_commands(pending_commands)
|
|
pending_commands = self.pending_commands
|
|
self.is_processing_data = False
|
|
if self.fd_handle is None:
|
|
self.fd_handle = self.reactor.register_fd(self.fd,
|
|
self._process_data)
|
|
def run_script_from_command(self, script):
|
|
self._process_commands(script.split('\n'), need_ack=False)
|
|
def run_script(self, script):
|
|
with self.mutex:
|
|
self._process_commands(script.split('\n'), need_ack=False)
|
|
def get_mutex(self):
|
|
return self.mutex
|
|
def create_gcode_command(self, command, commandline, params):
|
|
return GCodeCommand(self, command, commandline, params, False)
|
|
# Response handling
|
|
def respond_raw(self, msg):
|
|
if self.is_fileinput:
|
|
return
|
|
try:
|
|
os.write(self.fd, msg+"\n")
|
|
except os.error:
|
|
logging.exception("Write g-code response")
|
|
def respond_info(self, msg, log=True):
|
|
if log:
|
|
logging.info(msg)
|
|
lines = [l.strip() for l in msg.strip().split('\n')]
|
|
self.respond_raw("// " + "\n// ".join(lines))
|
|
def _respond_error(self, msg):
|
|
logging.warning(msg)
|
|
lines = msg.strip().split('\n')
|
|
if len(lines) > 1:
|
|
self.respond_info("\n".join(lines), log=False)
|
|
self.respond_raw('!! %s' % (lines[0].strip(),))
|
|
if self.is_fileinput:
|
|
self.printer.request_exit('error_exit')
|
|
def _respond_state(self, state):
|
|
self.respond_info("Klipper state: %s" % (state,), log=False)
|
|
# Parameter parsing helpers
|
|
extended_r = re.compile(
|
|
r'^\s*(?:N[0-9]+\s*)?'
|
|
r'(?P<cmd>[a-zA-Z_][a-zA-Z0-9_]+)(?:\s+|$)'
|
|
r'(?P<args>[^#*;]*?)'
|
|
r'\s*(?:[#*;].*)?$')
|
|
def _get_extended_params(self, gcmd):
|
|
m = self.extended_r.match(gcmd.get_commandline())
|
|
if m is None:
|
|
raise self.error("Malformed command '%s'"
|
|
% (gcmd.get_commandline(),))
|
|
eargs = m.group('args')
|
|
try:
|
|
eparams = [earg.split('=', 1) for earg in shlex.split(eargs)]
|
|
eparams = { k.upper(): v for k, v in eparams }
|
|
gcmd._params.clear()
|
|
gcmd._params.update(eparams)
|
|
return gcmd
|
|
except ValueError as e:
|
|
raise self.error("Malformed command '%s'"
|
|
% (gcmd.get_commandline(),))
|
|
# G-Code special command handlers
|
|
def cmd_default(self, gcmd):
|
|
cmd = gcmd.get_command()
|
|
if cmd == 'M105':
|
|
# Don't warn about temperature requests when not ready
|
|
gcmd.ack("T:0")
|
|
return
|
|
if not self.is_printer_ready:
|
|
raise gcmd.error(self.printer.get_state_message())
|
|
return
|
|
if not cmd:
|
|
logging.debug(gcmd.get_commandline())
|
|
return
|
|
if cmd.startswith("M117 "):
|
|
# Handle M117 gcode with numeric and special characters
|
|
handler = self.gcode_handlers.get("M117", None)
|
|
if handler is not None:
|
|
handler(gcmd)
|
|
return
|
|
elif cmd in ['M140', 'M104'] and not gcmd.get_float('S', 0.):
|
|
# Don't warn about requests to turn off heaters when not present
|
|
return
|
|
elif cmd == 'M107' or (cmd == 'M106' and (
|
|
not gcmd.get_float('S', 1.) or self.is_fileinput)):
|
|
# Don't warn about requests to turn off fan when fan not present
|
|
return
|
|
gcmd.respond_info('Unknown command:"%s"' % (cmd,))
|
|
def _cmd_mux(self, gcmd):
|
|
key, values = self.mux_commands[gcmd.get_command()]
|
|
if None in values:
|
|
key_param = gcmd.get(key, None)
|
|
else:
|
|
key_param = gcmd.get(key)
|
|
if key_param not in values:
|
|
raise gcmd.error("The value '%s' is not valid for %s"
|
|
% (key_param, key))
|
|
values[key_param](gcmd)
|
|
all_handlers = [
|
|
'G1', 'G4', 'G28', 'M400',
|
|
'G20', 'M82', 'M83', 'G90', 'G91', 'G92', 'M114', 'M220', 'M221',
|
|
'SET_GCODE_OFFSET', 'SAVE_GCODE_STATE', 'RESTORE_GCODE_STATE',
|
|
'M112', 'M115', 'IGNORE', 'GET_POSITION',
|
|
'RESTART', 'FIRMWARE_RESTART', 'ECHO', 'STATUS', 'HELP']
|
|
# G-Code movement commands
|
|
cmd_G1_aliases = ['G0']
|
|
def cmd_G1(self, gcmd):
|
|
# Move
|
|
params = gcmd._params
|
|
try:
|
|
for pos, axis in enumerate('XYZ'):
|
|
if axis in params:
|
|
v = float(params[axis])
|
|
if not self.absolute_coord:
|
|
# value relative to position of last move
|
|
self.last_position[pos] += v
|
|
else:
|
|
# value relative to base coordinate position
|
|
self.last_position[pos] = v + self.base_position[pos]
|
|
if 'E' in params:
|
|
v = float(params['E']) * self.extrude_factor
|
|
if not self.absolute_coord or not self.absolute_extrude:
|
|
# value relative to position of last move
|
|
self.last_position[3] += v
|
|
else:
|
|
# value relative to base coordinate position
|
|
self.last_position[3] = v + self.base_position[3]
|
|
if 'F' in params:
|
|
gcode_speed = float(params['F'])
|
|
if gcode_speed <= 0.:
|
|
raise gcmd.error("Invalid speed in '%s'"
|
|
% (gcmd.get_commandline(),))
|
|
self.speed = gcode_speed * self.speed_factor
|
|
except ValueError as e:
|
|
raise gcmd.error("Unable to parse move '%s'"
|
|
% (gcmd.get_commandline(),))
|
|
self.move_with_transform(self.last_position, self.speed)
|
|
def cmd_G4(self, gcmd):
|
|
# Dwell
|
|
delay = gcmd.get_float('P', 0., minval=0.) / 1000.
|
|
self.toolhead.dwell(delay)
|
|
def cmd_G28(self, gcmd):
|
|
# Move to origin
|
|
axes = []
|
|
for pos, axis in enumerate('XYZ'):
|
|
if gcmd.get(axis, None) is not None:
|
|
axes.append(pos)
|
|
if not axes:
|
|
axes = [0, 1, 2]
|
|
homing_state = homing.Homing(self.printer)
|
|
if self.is_fileinput:
|
|
homing_state.set_no_verify_retract()
|
|
homing_state.home_axes(axes)
|
|
for axis in homing_state.get_axes():
|
|
self.base_position[axis] = self.homing_position[axis]
|
|
self.reset_last_position()
|
|
def cmd_M400(self, gcmd):
|
|
# Wait for current moves to finish
|
|
self.toolhead.wait_moves()
|
|
# G-Code coordinate manipulation
|
|
def cmd_G20(self, gcmd):
|
|
# Set units to inches
|
|
raise gcmd.error('Machine does not support G20 (inches) command')
|
|
def cmd_M82(self, gcmd):
|
|
# Use absolute distances for extrusion
|
|
self.absolute_extrude = True
|
|
def cmd_M83(self, gcmd):
|
|
# Use relative distances for extrusion
|
|
self.absolute_extrude = False
|
|
def cmd_G90(self, gcmd):
|
|
# Use absolute coordinates
|
|
self.absolute_coord = True
|
|
def cmd_G91(self, gcmd):
|
|
# Use relative coordinates
|
|
self.absolute_coord = False
|
|
def cmd_G92(self, gcmd):
|
|
# Set position
|
|
offsets = [ gcmd.get_float(a, None) for a in 'XYZE' ]
|
|
for i, offset in enumerate(offsets):
|
|
if offset is not None:
|
|
if i == 3:
|
|
offset *= self.extrude_factor
|
|
self.base_position[i] = self.last_position[i] - offset
|
|
if offsets == [None, None, None, None]:
|
|
self.base_position = list(self.last_position)
|
|
cmd_M114_when_not_ready = True
|
|
def cmd_M114(self, gcmd):
|
|
# Get Current Position
|
|
p = self._get_gcode_position()
|
|
gcmd.respond_raw("X:%.3f Y:%.3f Z:%.3f E:%.3f" % tuple(p))
|
|
def cmd_M220(self, gcmd):
|
|
# Set speed factor override percentage
|
|
value = gcmd.get_float('S', 100., above=0.) / (60. * 100.)
|
|
self.speed = self._get_gcode_speed() * value
|
|
self.speed_factor = value
|
|
def cmd_M221(self, gcmd):
|
|
# Set extrude factor override percentage
|
|
new_extrude_factor = gcmd.get_float('S', 100., above=0.) / 100.
|
|
last_e_pos = self.last_position[3]
|
|
e_value = (last_e_pos - self.base_position[3]) / self.extrude_factor
|
|
self.base_position[3] = last_e_pos - e_value * new_extrude_factor
|
|
self.extrude_factor = new_extrude_factor
|
|
cmd_SET_GCODE_OFFSET_help = "Set a virtual offset to g-code positions"
|
|
def cmd_SET_GCODE_OFFSET(self, gcmd):
|
|
move_delta = [0., 0., 0., 0.]
|
|
for pos, axis in enumerate('XYZE'):
|
|
offset = gcmd.get_float(axis, None)
|
|
if offset is None:
|
|
offset = gcmd.get_float(axis + '_ADJUST', None)
|
|
if offset is None:
|
|
continue
|
|
offset += self.homing_position[pos]
|
|
delta = offset - self.homing_position[pos]
|
|
move_delta[pos] = delta
|
|
self.base_position[pos] += delta
|
|
self.homing_position[pos] = offset
|
|
# Move the toolhead the given offset if requested
|
|
if gcmd.get_int('MOVE', 0):
|
|
speed = gcmd.get_float('MOVE_SPEED', self.speed, above=0.)
|
|
for pos, delta in enumerate(move_delta):
|
|
self.last_position[pos] += delta
|
|
self.move_with_transform(self.last_position, speed)
|
|
cmd_SAVE_GCODE_STATE_help = "Save G-Code coordinate state"
|
|
def cmd_SAVE_GCODE_STATE(self, gcmd):
|
|
state_name = gcmd.get('NAME', 'default')
|
|
self.saved_states[state_name] = {
|
|
'absolute_coord': self.absolute_coord,
|
|
'absolute_extrude': self.absolute_extrude,
|
|
'base_position': list(self.base_position),
|
|
'last_position': list(self.last_position),
|
|
'homing_position': list(self.homing_position),
|
|
'speed': self.speed, 'speed_factor': self.speed_factor,
|
|
'extrude_factor': self.extrude_factor,
|
|
}
|
|
cmd_RESTORE_GCODE_STATE_help = "Restore a previously saved G-Code state"
|
|
def cmd_RESTORE_GCODE_STATE(self, gcmd):
|
|
state_name = gcmd.get('NAME', 'default')
|
|
state = self.saved_states.get(state_name)
|
|
if state is None:
|
|
raise gcmd.error("Unknown g-code state: %s" % (state_name,))
|
|
# Restore state
|
|
self.absolute_coord = state['absolute_coord']
|
|
self.absolute_extrude = state['absolute_extrude']
|
|
self.base_position = list(state['base_position'])
|
|
self.homing_position = list(state['homing_position'])
|
|
self.speed = state['speed']
|
|
self.speed_factor = state['speed_factor']
|
|
self.extrude_factor = state['extrude_factor']
|
|
# Restore the relative E position
|
|
e_diff = self.last_position[3] - state['last_position'][3]
|
|
self.base_position[3] += e_diff
|
|
# Move the toolhead back if requested
|
|
if gcmd.get_int('MOVE', 0):
|
|
speed = gcmd.get_float('MOVE_SPEED', self.speed, above=0.)
|
|
self.last_position[:3] = state['last_position'][:3]
|
|
self.move_with_transform(self.last_position, speed)
|
|
# G-Code miscellaneous commands
|
|
cmd_M112_when_not_ready = True
|
|
def cmd_M112(self, gcmd):
|
|
# Emergency Stop
|
|
self.printer.invoke_shutdown("Shutdown due to M112 command")
|
|
cmd_M115_when_not_ready = True
|
|
def cmd_M115(self, gcmd):
|
|
# Get Firmware Version and Capabilities
|
|
software_version = self.printer.get_start_args().get('software_version')
|
|
kw = {"FIRMWARE_NAME": "Klipper", "FIRMWARE_VERSION": software_version}
|
|
gcmd.ack(" ".join(["%s:%s" % (k, v) for k, v in kw.items()]))
|
|
cmd_IGNORE_when_not_ready = True
|
|
cmd_IGNORE_aliases = ["G21", "M110", "M21"]
|
|
def cmd_IGNORE(self, gcmd):
|
|
# Commands that are just silently accepted
|
|
pass
|
|
cmd_GET_POSITION_when_not_ready = True
|
|
def cmd_GET_POSITION(self, gcmd):
|
|
if self.toolhead is None:
|
|
self.cmd_default(gcmd)
|
|
return
|
|
kin = self.toolhead.get_kinematics()
|
|
steppers = kin.get_steppers()
|
|
mcu_pos = " ".join(["%s:%d" % (s.get_name(), s.get_mcu_position())
|
|
for s in steppers])
|
|
for s in steppers:
|
|
s.set_tag_position(s.get_commanded_position())
|
|
stepper_pos = " ".join(["%s:%.6f" % (s.get_name(), s.get_tag_position())
|
|
for s in steppers])
|
|
kin_pos = " ".join(["%s:%.6f" % (a, v)
|
|
for a, v in zip("XYZ", kin.calc_tag_position())])
|
|
toolhead_pos = " ".join(["%s:%.6f" % (a, v) for a, v in zip(
|
|
"XYZE", self.toolhead.get_position())])
|
|
gcode_pos = " ".join(["%s:%.6f" % (a, v)
|
|
for a, v in zip("XYZE", self.last_position)])
|
|
base_pos = " ".join(["%s:%.6f" % (a, v)
|
|
for a, v in zip("XYZE", self.base_position)])
|
|
homing_pos = " ".join(["%s:%.6f" % (a, v)
|
|
for a, v in zip("XYZ", self.homing_position)])
|
|
gcmd.respond_info("mcu: %s\n"
|
|
"stepper: %s\n"
|
|
"kinematic: %s\n"
|
|
"toolhead: %s\n"
|
|
"gcode: %s\n"
|
|
"gcode base: %s\n"
|
|
"gcode homing: %s"
|
|
% (mcu_pos, stepper_pos, kin_pos, toolhead_pos,
|
|
gcode_pos, base_pos, homing_pos))
|
|
def request_restart(self, result):
|
|
if self.is_printer_ready:
|
|
print_time = self.toolhead.get_last_move_time()
|
|
self.printer.send_event("gcode:request_restart", print_time)
|
|
self.toolhead.dwell(0.500)
|
|
self.toolhead.wait_moves()
|
|
self.printer.request_exit(result)
|
|
cmd_RESTART_when_not_ready = True
|
|
cmd_RESTART_help = "Reload config file and restart host software"
|
|
def cmd_RESTART(self, gcmd):
|
|
self.request_restart('restart')
|
|
cmd_FIRMWARE_RESTART_when_not_ready = True
|
|
cmd_FIRMWARE_RESTART_help = "Restart firmware, host, and reload config"
|
|
def cmd_FIRMWARE_RESTART(self, gcmd):
|
|
self.request_restart('firmware_restart')
|
|
cmd_ECHO_when_not_ready = True
|
|
def cmd_ECHO(self, gcmd):
|
|
gcmd.respond_info(gcmd.get_commandline(), log=False)
|
|
cmd_STATUS_when_not_ready = True
|
|
cmd_STATUS_help = "Report the printer status"
|
|
def cmd_STATUS(self, gcmd):
|
|
if self.is_printer_ready:
|
|
self._respond_state("Ready")
|
|
return
|
|
msg = self.printer.get_state_message()
|
|
msg = msg.rstrip() + "\nKlipper state: Not ready"
|
|
raise gcmd.error(msg)
|
|
cmd_HELP_when_not_ready = True
|
|
def cmd_HELP(self, gcmd):
|
|
cmdhelp = []
|
|
if not self.is_printer_ready:
|
|
cmdhelp.append("Printer is not ready - not all commands available.")
|
|
cmdhelp.append("Available extended commands:")
|
|
for cmd in sorted(self.gcode_handlers):
|
|
if cmd in self.gcode_help:
|
|
cmdhelp.append("%-10s: %s" % (cmd, self.gcode_help[cmd]))
|
|
gcmd.respond_info("\n".join(cmdhelp), log=False)
|