aboutsummaryrefslogtreecommitdiffstats
path: root/klippy/extras/pause_resume.py
blob: ffd63e923a11f6ecec3812165279d4f595cd82da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# Pause/Resume functionality with position capture/restore
#
# Copyright (C) 2019  Eric Callahan <arksine.code@gmail.com>
#
# This file may be distributed under the terms of the GNU GPLv3 license.


class PauseResume:
    def __init__(self, config):
        self.printer = config.get_printer()
        self.gcode = self.printer.lookup_object("gcode")
        self.recover_velocity = config.getfloat("recover_velocity", 50.0)
        self.v_sd = None
        self.is_paused = False
        self.sd_paused = False
        self.pause_command_sent = False
        self.printer.register_event_handler("klippy:connect", self.handle_connect)
        self.gcode.register_command("PAUSE", self.cmd_PAUSE, desc=self.cmd_PAUSE_help)
        self.gcode.register_command(
            "RESUME", self.cmd_RESUME, desc=self.cmd_RESUME_help
        )
        self.gcode.register_command(
            "CLEAR_PAUSE", self.cmd_CLEAR_PAUSE, desc=self.cmd_CLEAR_PAUSE_help
        )
        self.gcode.register_command(
            "CANCEL_PRINT", self.cmd_CANCEL_PRINT, desc=self.cmd_CANCEL_PRINT_help
        )
        webhooks = self.printer.lookup_object("webhooks")
        webhooks.register_endpoint("pause_resume/cancel", self._handle_cancel_request)
        webhooks.register_endpoint("pause_resume/pause", self._handle_pause_request)
        webhooks.register_endpoint("pause_resume/resume", self._handle_resume_request)

    def handle_connect(self):
        self.v_sd = self.printer.lookup_object("virtual_sdcard", None)

    def _handle_cancel_request(self, web_request):
        self.gcode.run_script("CANCEL_PRINT")

    def _handle_pause_request(self, web_request):
        self.gcode.run_script("PAUSE")

    def _handle_resume_request(self, web_request):
        self.gcode.run_script("RESUME")

    def get_status(self, eventtime):
        return {"is_paused": self.is_paused}

    def is_sd_active(self):
        return self.v_sd is not None and self.v_sd.is_active()

    def send_pause_command(self):
        # This sends the appropriate pause command from an event.  Note
        # the difference between pause_command_sent and is_paused, the
        # module isn't officially paused until the PAUSE gcode executes.
        if not self.pause_command_sent:
            if self.is_sd_active():
                # Printing from virtual sd, run pause command
                self.sd_paused = True
                self.v_sd.do_pause()
            else:
                self.sd_paused = False
                self.gcode.respond_info("action:paused")
            self.pause_command_sent = True

    cmd_PAUSE_help = "Pauses the current print"

    def cmd_PAUSE(self, gcmd):
        if self.is_paused:
            gcmd.respond_info("Print already paused")
            return
        self.send_pause_command()
        self.gcode.run_script_from_command("SAVE_GCODE_STATE NAME=PAUSE_STATE")
        self.is_paused = True

    def send_resume_command(self):
        if self.sd_paused:
            # Printing from virtual sd, run pause command
            self.v_sd.do_resume()
            self.sd_paused = False
        else:
            self.gcode.respond_info("action:resumed")
        self.pause_command_sent = False

    cmd_RESUME_help = "Resumes the print from a pause"

    def cmd_RESUME(self, gcmd):
        if not self.is_paused:
            gcmd.respond_info("Print is not paused, resume aborted")
            return
        velocity = gcmd.get_float("VELOCITY", self.recover_velocity)
        self.gcode.run_script_from_command(
            "RESTORE_GCODE_STATE NAME=PAUSE_STATE MOVE=1 MOVE_SPEED=%.4f" % (velocity)
        )
        self.send_resume_command()
        self.is_paused = False

    cmd_CLEAR_PAUSE_help = "Clears the current paused state without resuming the print"

    def cmd_CLEAR_PAUSE(self, gcmd):
        self.is_paused = self.pause_command_sent = False

    cmd_CANCEL_PRINT_help = "Cancel the current print"

    def cmd_CANCEL_PRINT(self, gcmd):
        if self.is_sd_active() or self.sd_paused:
            self.v_sd.do_cancel()
        else:
            gcmd.respond_info("action:cancel")
        self.cmd_CLEAR_PAUSE(gcmd)


def load_config(config):
    return PauseResume(config)