Merge pull request #48 from smartin015/printer_profiles

Add printer profiles / settings

Author: smartin015

continuousprint/__init__.py

@@ -5,6 +5,8 @@
 import octoprint.util
 import flask
 import json
+import yaml
+import os
 import time
 from io import BytesIO
 from octoprint.server.util.flask import restricted_access
@@ -53,27 +55,24 @@ def _update_driver_settings(self):
 
     # part of SettingsPlugin
     def get_settings_defaults(self):
+        base = os.path.dirname(__file__)
+        with open(os.path.join(base, "data/printer_profiles.yaml"), "r") as f:
+          self._printer_profiles = yaml.safe_load(f.read())['PrinterProfile']
+        with open(os.path.join(base, "data/gcode_scripts.yaml"), "r") as f:
+          self._gcode_scripts = yaml.safe_load(f.read())['GScript']
+
         d = {}
         d[QUEUE_KEY] = "[]"
-        d[CLEARING_SCRIPT_KEY] = (
-            "M17 ;enable steppers\n"
-            "G91 ; Set relative for lift\n"
-            "G0 Z10 ; lift z by 10\n"
-            "G90 ;back to absolute positioning\n"
-            "M190 R25 ; set bed to 25 and wait for cooldown\n"
-            "G0 X200 Y235 ;move to back corner\n"
-            "G0 X110 Y235 ;move to mid bed aft\n"
-            "G0 Z1 ;come down to 1MM from bed\n"
-            "G0 Y0 ;wipe forward\n"
-            "G0 Y235 ;wipe aft\n"
-            "G28 ; home"
-        )
-        d[FINISHED_SCRIPT_KEY] = (
-            "M18 ; disable steppers\n"
-            "M104 T0 S0 ; extruder heater off\n"
-            "M140 S0 ; heated bed heater off\n"
-            "M300 S880 P300 ; beep to show its finished"
-        )
+        d[CLEARING_SCRIPT_KEY] = ""
+        d[FINISHED_SCRIPT_KEY] = ""
+
+        for s in self._gcode_scripts:
+          name = s['name']
+          gcode = s['gcode']
+          if name == "Pause":
+            d[CLEARING_SCRIPT_KEY] = gcode
+          elif name == "Generic Off":
+            d[FINISHED_SCRIPT_KEY] = gcode
         d[RESTART_MAX_RETRIES_KEY] = 3
         d[RESTART_ON_PAUSE_KEY] = False
         d[RESTART_MAX_TIME_KEY] = 60 * 60
@@ -441,25 +440,15 @@ def reset(self):
     # part of TemplatePlugin
     def get_template_vars(self):
         return dict(
-            cp_enabled=(self.d.active if hasattr(self, "d") else False),
-            cp_bed_clearing_script=self._settings.get([CLEARING_SCRIPT_KEY]),
-            cp_queue_finished=self._settings.get([FINISHED_SCRIPT_KEY]),
-            cp_restart_on_pause_enabled=self._settings.get_boolean(
-                [RESTART_ON_PAUSE_KEY]
-            ),
-            cp_restart_on_pause_max_seconds=self._settings.get_int(
-                [RESTART_MAX_TIME_KEY]
-            ),
-            cp_restart_on_pause_max_restarts=self._settings.get_int(
-                [RESTART_MAX_RETRIES_KEY]
-            ),
+            printer_profiles=self._printer_profiles,
+            gcode_scripts=self._gcode_scripts
         )
 
     def get_template_configs(self):
         return [
             dict(
                 type="settings",
-                custom_bindings=False,
+                custom_bindings=True,
                 template="continuousprint_settings.jinja2",
             ),
             dict(
@@ -480,6 +469,7 @@ def get_assets(self):
                 "js/continuousprint_queueset.js",
                 "js/continuousprint_job.js",
                 "js/continuousprint_viewmodel.js",
+                "js/continuousprint_settings.js",
                 "js/continuousprint.js",
             ],
             css=["css/continuousprint.css"],

continuousprint/data/gcode_scripts.yaml

@@ -0,0 +1,64 @@
+GScript:
+  - name: "Sweep Gantry"
+    description: > 
+      This script example assumes a box style printer with a vertical Z axis and a 200mm x 235mm XY build area.
+      It uses the printer's extruder to push the part off the build plate."
+    version: 0.0.1
+    gcode: |
+      M17 ;enable steppers
+      G91 ; Set relative for lift
+      G0 Z10 ; lift z by 10
+      G90 ;back to absolute positioning
+      M190 R25 ; set bed to 25 and wait for cooldown
+      G0 X200 Y235 ;move to back corner
+      G0 X110 Y235 ;move to mid bed aft
+      G0 Z1 ;come down to 1MM from bed
+      G0 Y0 ;wipe forward
+      G0 Y235 ;wipe aft
+      G28 ; home
+  - name: "Advance Belt Short"
+    description: >
+      This script works with a belt printer (specifically, a Creality CR-30). The belt is advanced to move 
+      the print out of the way before starting another print.
+    version: 0.0.1
+    gcode: |
+      M17 ; enable steppers
+      G91 ; Set relative for lift
+      G21 ; Set units to mm
+      G0 Z10 ; advance bed (Z) by 10mm
+      G90 ; back to absolute positioning
+      M104 S0; Set Hot-end to 0C (off)
+      M140 S0; Set bed to 0C (off)
+  - name: "Pause"
+    description: >
+      Use this script if you want to remove the print yourself but use the queue to keep track of your 
+      prints. It uses an @ Command to tell OctoPrint to pause the print. The printer will stay paused 
+      until you press "Resume" on the OctoPrint UI.
+    version: 0.0.1
+    gcode: |
+      M18 ; disable steppers
+      M104 T0 S0 ; extruder heater off
+      M140 S0 ; heated bed heater off
+      @pause ; wait for user input
+  - name: "Generic Off"
+    description: >
+      This is a generic "heaters and motors off" script which should be compatible with most printers.
+    version: 0.0.1
+    gcode: |
+      M18 ; disable steppers
+      M104 T0 S0 ; extruder heater off
+      M140 S0 ; heated bed heater off
+      M300 S880 P300 ; beep to show its finished
+  - name: "Advance Belt Long"
+    description: >
+      The same idea as "Advance Belt Short", but with a longer advancement to roll off all completed prints.
+    version: 0.0.1
+    gcode: |
+      M17 ; enable steppers
+      G91 ; Set relative for lift
+      G21 ; Set units to mm
+      G0 Z300 ; advance bed (Z) to roll off all parts
+      M18 ; Disable steppers
+      G90 ; back to absolute positioning
+      M104 S0; Set Hot-end to 0C (off)
+      M140 S0; Set bed to 0C (off)

continuousprint/data/printer_profiles.yaml

@@ -0,0 +1,34 @@
+PrinterProfile:
+  - name: "Generic"
+    make: "Generic"
+    model: "Generic"
+    width: 150
+    depth: 150
+    height: 150
+    formFactor: "rectangular"
+    selfClearing: false
+    defaults:
+      clearBed: "Pause"
+      finished: "Generic Off"
+  - name: "Creality CR30"
+    make: "Creality"
+    model: "CR30"
+    width: 200
+    depth: 1000
+    height: 200
+    formFactor: "rectangular"
+    selfClearing: true
+    defaults:
+      clearBed: "Advance Belt Short"
+      finished: "Advance Belt Long"
+  - name: "Monoprice Mini Delta V2"
+    make: "Monoprice"
+    model: "Mini Delta V2"
+    width: 110
+    depth: 110
+    height: 120
+    formFactor: "circular"
+    selfClearing: false
+    defaults:
+      clearBed: "Pause"
+      finished: "Generic Off"

continuousprint/static/js/continuousprint.js

@@ -32,4 +32,11 @@ $(function() {
         ],
         elements: ["#tab_plugin_continuousprint"]
     });
+    OCTOPRINT_VIEWMODELS.push({
+        construct: CPSettingsViewModel,
+        dependencies: [
+          "settingsViewModel",
+        ],
+        elements: ["#settings_plugin_continuousprint"]
+    });
 });

continuousprint/static/js/continuousprint_settings.js

@@ -0,0 +1,63 @@
+if (typeof log === "undefined" || log === null) {
+  // In the testing environment, dependencies must be manually imported
+  ko = require('knockout');
+  log = {
+    "getLogger": () => {return console;}
+  };
+  CP_PRINTER_PROFILES = [];
+  CP_GCODE_SCRIPTS = [];
+}
+
+function CPSettingsViewModel(parameters, profiles=CP_PRINTER_PROFILES, scripts=CP_GCODE_SCRIPTS) {
+    var self = this;
+    self.PLUGIN_ID = "octoprint.plugins.continuousprint";
+    self.log = log.getLogger(self.PLUGIN_ID);
+    self.settings = parameters[0];
+
+    // Constants defined in continuousprint_settings.jinja2, passed from the plugin (see `get_template_vars()` in __init__.py)
+    self.profiles = {};
+    for (let prof of profiles) {
+      if (self.profiles[prof.make] === undefined) {
+        self.profiles[prof.make] = {};
+      }
+      self.profiles[prof.make][prof.model] = prof;
+    }
+    self.scripts = {};
+    for (let s of scripts) {
+      self.scripts[s.name] = s.gcode;
+    }
+
+    self.selected_make = ko.observable();
+    let makes = Object.keys(self.profiles);
+    makes.unshift("Select one");
+    self.printer_makes = ko.observable(makes);
+    self.selected_model = ko.observable();
+    self.printer_models = ko.computed(function() {
+      let models = self.profiles[self.selected_make()];
+      if (models === undefined) {
+        return ["-"];
+      }
+      let result = Object.keys(models);
+      result.unshift("-");
+      return result;
+    });
+
+    self.modelChanged = function() {
+      let profile = (self.profiles[self.selected_make()] || {})[self.selected_model()];
+      if (profile === undefined) {
+        return;
+      }
+      let cpset = self.settings.settings.plugins.continuousprint;
+      cpset.cp_bed_clearing_script(self.scripts[profile.defaults.clearBed]);
+      cpset.cp_queue_finished_script(self.scripts[profile.defaults.finished]);
+    }
+}
+
+
+try {
+module.exports = {
+  CPSettingsViewModel,
+  CP_PRINTER_PROFILES,
+  CP_GCODE_SCRIPTS,
+};
+} catch {}

continuousprint/static/js/continuousprint_settings.test.js

@@ -0,0 +1,77 @@
+// Import must happen after declaring constants
+const VM = require('./continuousprint_settings');
+
+const PROFILES = [
+  {
+    name: 'Generic',
+    make: 'Generic',
+    model: 'Generic',
+    defaults: {
+      clearBed: 'script1',
+      finished: 'script2',
+    },
+  },
+  {
+    name: 'TestPrinter',
+    make: 'Test',
+    model: 'Printer',
+    defaults: {
+      clearBed: 'script1',
+      finished: 'script2',
+    },
+  },
+]
+
+const SCRIPTS = [
+  {
+    name: 'script1',
+    gcode: 'test1',
+  },
+  {
+    name: 'script2',
+    gcode: 'test2',
+  },
+];
+
+
+function mocks() {
+  return [
+    {
+      settings: {
+        plugins: {
+          continuousprint: {
+            cp_bed_clearing_script: jest.fn(),
+            cp_queue_finished_script: jest.fn(),
+          },
+        },
+      },
+    },
+  ];
+}
+
+test('makes are populated', () => {
+  let v = new VM.CPSettingsViewModel(mocks(), PROFILES, SCRIPTS);
+  expect(v.printer_makes().length).toBeGreaterThan(1); // Not just "Select one"
+});
+
+test('models are populated based on selected_make', () => {
+  let v = new VM.CPSettingsViewModel(mocks(), PROFILES, SCRIPTS);
+  v.selected_make("Test");
+  expect(v.printer_models()).toEqual(["-", "Printer"]);
+});
+
+test('valid model change updates settings scripts', () => {
+  let v = new VM.CPSettingsViewModel(mocks(), PROFILES, SCRIPTS);
+  v.selected_make("Test");
+  v.selected_model("Printer");
+  v.modelChanged();
+  expect(v.settings.settings.plugins.continuousprint.cp_bed_clearing_script).toHaveBeenCalledWith("test1");
+  expect(v.settings.settings.plugins.continuousprint.cp_queue_finished_script).toHaveBeenCalledWith("test2");
+});
+
+test('invalid model change is ignored', () => {
+  let v = new VM.CPSettingsViewModel(mocks(), PROFILES, SCRIPTS);
+  v.modelChanged();
+  expect(v.settings.settings.plugins.continuousprint.cp_bed_clearing_script).not.toHaveBeenCalled();
+  expect(v.settings.settings.plugins.continuousprint.cp_queue_finished_script).not.toHaveBeenCalled();
+});