Merge pull request kontakt#11 from fornellas/fix_bounce

Various fixes, rework of main functions and additional interface work

Author: kontakt

octoprint_filamentreload/__init__.py

@@ -5,6 +5,7 @@
 from octoprint.events import eventManager, Events
 from flask import jsonify, make_response
 import RPi.GPIO as GPIO
+from time import sleep
 
 class FilamentReloadedPlugin(octoprint.plugin.StartupPlugin,
                              octoprint.plugin.EventHandlerPlugin,
@@ -18,45 +19,101 @@ def initialize(self):
         GPIO.setmode(GPIO.BOARD)       # Use the board numbering scheme
         GPIO.setwarnings(False)        # Disable GPIO warnings
 
+    @property
+    def pin(self):
+        return int(self._settings.get(["pin"]))
+
+    @property
+    def bounce(self):
+        return int(self._settings.get(["bounce"]))
+
+    @property
+    def switch(self):
+        return int(self._settings.get(["switch"]))
+
+    @property
+    def after_pause_gcode(self):
+        return str(self._settings.get(["after_pause_gcode"])).splitlines()
+
+    @property
+    def after_resume_gcode(self):
+        return str(self._settings.get(["after_resume_gcode"])).splitlines()
+
     def on_after_startup(self):
         self._logger.info("Filament Sensor Reloaded started")
-        self.pin = int(self._settings.get(["pin"]))
-        self.bounce = int(self._settings.get(["bounce"]))
-        self.switch = int(self._settings.get(["switch"]))
-
-        if self._settings.get(["pin"]) != "-1":   # If a pin is defined
+        if self.sensor_enabled():
             self._logger.info("Filament Sensor active on GPIO Pin [%s]"%self.pin)
             GPIO.setup(self.pin, GPIO.IN, pull_up_down=GPIO.PUD_UP)    # Initialize GPIO as INPUT
+        else:
+            self._logger.info("Pin not configured, won't work unless configured!")
 
     def get_settings_defaults(self):
         return dict(
             pin     = -1,   # Default is no pin
             bounce  = 250,  # Debounce 250ms
-            switch  = 0    # Normally Open
+            switch  = 0,    # Normally Open
+            after_pause_gcode = '',
+            after_resume_gcode = '',
         )
 
+    def sensor_enabled(self):
+        return self.pin != -1
+
+    def no_filament(self):
+        return GPIO.input(self.pin) != self.switch
+
     def get_template_configs(self):
         return [dict(type="settings", custom_bindings=False)]
 
+    @property
+    def _filament_change(self):
+        return self.__dict__.get('_filament_change', False)
+
     def on_event(self, event, payload):
-        if event == Events.PRINT_STARTED:  # If a new print is beginning
-            self._logger.info("Printing started: Filament sensor enabled")
-            if self.pin != -1:
-                GPIO.add_event_detect(self.pin, GPIO.BOTH, callback=self.check_gpio, bouncetime=self.bounce)
-        elif event in (Events.PRINT_DONE, Events.PRINT_FAILED, Events.PRINT_CANCELLED):
-            self._logger.info("Printing stopped: Filament sensor disabled")
-            try:
+        # Early abort in case of out ot filament when start printing, as we
+        # can't change with a cold nozzle
+        if event is Events.PRINT_STARTED and self.no_filament():
+            self._logger.info("Printing aborted: no filament detected!")
+            self._printer.cancel_print()
+        # Run after resume gcode
+        if event is Events.PRINT_RESUMED:
+            if self._filament_change:
+                self._logger.info("Sending after resume GCODE!")
+                self._printer.commands(self.after_resume_gcode)
+                self._filament_change = False
+        # Enable sensor
+        if event in (
+            Events.PRINT_STARTED,
+            Events.PRINT_RESUMED
+        ):
+            self._logger.info("%s: Enabling filament sensor." % (event))
+            if self.sensor_enabled():
                 GPIO.remove_event_detect(self.pin)
-            except Exception:
-                pass
-
-    def check_gpio(self, channel):
-        state = GPIO.input(self.pin)
-        self._logger.debug("Detected sensor [%s] state [%s]"%(channel, state))
-        if state != self.switch:    # If the sensor is tripped
-            self._logger.debug("Sensor [%s]"%state)
-            if self._printer.is_printing():
-                self._printer.toggle_pause_print()
+                GPIO.add_event_detect(self.pin, GPIO.BOTH, callback=self.sensor_callback, bouncetime=self.bounce)
+        # Disable sensor
+        elif event in (
+            Events.PRINT_DONE,
+            Events.PRINT_FAILED,
+            Events.PRINT_CANCELLED,
+            Events.ERROR
+        ):
+            self._logger.info("%s: Disabling filament sensor." % (event))
+            GPIO.remove_event_detect(self.pin)
+
+    def sensor_callback(self, _):
+        sleep(self.bounce/1000)
+        if self.no_filament():
+            if self._filament_change:
+                self._logger.info("Out of filament, waiting for replacement!")
+            else:
+                self._logger.info("Out of filament, pausing!")
+                self._printer.pause_print()
+                if self.after_pause_gcode:
+                    self._logger.info("Sending after pause GCODE")
+                    self._printer.commands(self.after_pause_gcode)
+                self._filament_change = True
+        else:
+            self._logger.info("Filament detected, resume to continue!")
 
     def get_update_information(self):
         return dict(

octoprint_filamentreload/templates/filamentreload_settings.jinja2

@@ -24,4 +24,16 @@ Define the pin used by your sensor and the debounce timing for false positive pr
             </select>
         </div>
     </div>
+    <div class="control-group">
+        <label class="control-label">{{ _('After pause GCODE:') }}</label>
+        <div class="controls">
+            <textarea rows="4" class="block" data-bind="value: settings.plugins.filamentreload.after_pause_gcode"></textarea>
+        </div>
+    </div>
+    <div class="control-group">
+        <label class="control-label">{{ _('After resume GCODE:') }}</label>
+        <div class="controls">
+            <textarea rows="4" class="block" data-bind="value: settings.plugins.filamentreload.after_resume_gcode"></textarea>
+        </div>
+    </div>
 </form>