klipper-dgus/klippy/extras/respond.py

# Add 'RESPOND' and 'M118' commands for sending messages to the host
#
# Copyright (C) 2018  Alec Plumb <alec@etherwalker.com>
#
# This file may be distributed under the terms of the GNU GPLv3 license.

respond_types = {
    'echo': 'echo:',
    'command': '//',
    'error' : '!!',
}

class HostResponder:
    def __init__(self, config):
        self.printer = config.get_printer()
        self.reactor = self.printer.get_reactor()
        self.default_prefix = config.getchoice('default_type', respond_types,
                                               'echo')
        self.default_prefix = config.get('default_prefix', self.default_prefix)
        self.gcode = self.printer.lookup_object('gcode')
        self.cmd_M118_help = "Send a message to the host prefixed with '%s'" % (
            self.default_prefix,)
        self.gcode.register_command(
            'M118', self.cmd_M118, True, desc=self.cmd_M118_help)
        self.gcode.register_command('RESPOND', self.cmd_RESPOND, True)
    def cmd_M118(self, params):
        if '#original' in params:
            msg = params['#original']
            if not msg.startswith('M118'):
                # Parse out additional info if M118 recd during a print
                start = msg.find('M118')
                end = msg.rfind('*')
                msg = msg[start:end]
            if len(msg) > 5:
                msg = msg[5:]
            else:
                msg = ''
            self.gcode.respond("%s %s" %(self.default_prefix, msg))
    def cmd_RESPOND(self, params):
        respond_type = self.gcode.get_str('TYPE', params, None)
        prefix = self.default_prefix
        if(respond_type != None):
            respond_type = respond_type.lower()
            if(respond_type in respond_types):
                prefix = respond_types[respond_type]
            else:
                raise self.gcode.error(
                    "RESPOND TYPE '%s' is invalid. Must be one"
                    " of 'echo', 'command', or 'error'" % (respond_type,))
        prefix = self.gcode.get_str('PREFIX', params, prefix)
        msg = self.gcode.get_str('MSG', params, '')
        self.gcode.respond("%s %s" %(prefix, msg))

def load_config(config):
    return HostResponder(config)