Add confirmations to ensure that we've actually run out of filament due to cheap switches.

Add first of many segfault attempted fixes.

Author: Red-M

CODE_OF_CONDUCT.md

@@ -1,9 +1,12 @@
-# OctoPrint-FilamentReloaded
+# OctoPrint-FilamentSensor-ng
+
+I made this because [Octoprint-Filament-Reloaded](https://github.com/kontakt/Octoprint-Filament-Reloaded) would segfault and I wanted more options.
 
 [OctoPrint](http://octoprint.org/) plugin that integrates with a filament sensor hooked up to a Raspberry Pi GPIO pin and allows the filament spool to be changed during a print if the filament runs out.
 
 Future developments are planned to include multiple filament sensors and pop-ups.
 
+Initial work based on the [Octoprint-Filament-Reloaded](https://github.com/kontakt/Octoprint-Filament-Reloaded) plugin by kontakt.
 Initial work based on the [Octoprint-Filament](https://github.com/MoonshineSG/Octoprint-Filament) plugin by MoonshineSG.
 
 ## Required sensor
@@ -22,8 +25,7 @@ This plugin is using the GPIO.BOARD numbering scheme, the pin being used needs t
 
 ## Installation
 
-* Install via the bundled [Plugin Manager](https://github.com/foosel/OctoPrint/wiki/Plugin:-Plugin-Manager).
-* Manually using this URL: https://github.com/kontakt/Octoprint-Filament-Reloaded/archive/master.zip
+* Manually using this URL: https://github.com/Red-M/Octoprint-Filament-Sensor-ng/archive/master.zip
 
 ## Configuration
 

README.md

@@ -7,7 +7,7 @@
 from time import sleep
 
 
-class FilamentReloadedPlugin(octoprint.plugin.StartupPlugin,
+class filamentsensorngPlugin(octoprint.plugin.StartupPlugin,
                              octoprint.plugin.EventHandlerPlugin,
                              octoprint.plugin.TemplatePlugin,
                              octoprint.plugin.SettingsPlugin):
@@ -34,6 +34,10 @@ def switch(self):
     def mode(self):
         return int(self._settings.get(["mode"]))
 
+    @property
+    def confirmations(self):
+        return int(self._settings.get(["confirmations"]))
+
     @property
     def no_filament_gcode(self):
         return str(self._settings.get(["no_filament_gcode"])).splitlines()
@@ -57,7 +61,7 @@ def _setup_sensor(self):
             self._logger.info("Pin not configured, won't work unless configured!")
 
     def on_after_startup(self):
-        self._logger.info("Filament Sensor Reloaded started")
+        self._logger.info("FilamentSensor-ng started")
         self._setup_sensor()
 
     def get_settings_defaults(self):
@@ -66,6 +70,7 @@ def get_settings_defaults(self):
             bounce  = 250,  # Debounce 250ms
             switch  = 0,    # Normally Open
             mode    = 0,    # Board Mode
+            confirmations=0,# Confirm that we're actually out of filament
             no_filament_gcode = '',
             pause_print = True,
         )
@@ -95,13 +100,13 @@ def on_event(self, event, payload):
             Events.PRINT_RESUMED
         ):
             self._logger.info("%s: Enabling filament sensor." % (event))
-            if self.sensor_enabled():
-                GPIO.remove_event_detect(self.pin)
-                GPIO.add_event_detect(
-                    self.pin, GPIO.BOTH,
-                    callback=self.sensor_callback,
-                    bouncetime=self.bounce
-                )
+            # if self.sensor_enabled():
+                # GPIO.remove_event_detect(self.pin)
+                # GPIO.add_event_detect(
+                    # self.pin, GPIO.BOTH,
+                    # callback=self.sensor_callback,
+                    # bouncetime=self.bounce
+                # )
         # Disable sensor
         elif event in (
             Events.PRINT_DONE,

octoprint_filamentreload/__init__.py renamed to octoprint_filamentsensorng/__init__.py

@@ -3,20 +3,27 @@
     <div class="control-group">
         <label class="control-label">{{ _('Pin:') }}</label>
         <div class="controls" data-toggle="tooltip" title="{{ _('Which Raspberry Pi GPIO pin your switch is attached to (-1 disables the plugin)') }}">
-            <input type="number" step="any" min="0" class="input-mini text-right" data-bind="value: settings.plugins.filamentreload.pin">
+            <input type="number" step="any" min="0" class="input-mini text-right" data-bind="value: settings.plugins.filamentsensorng.pin">
         </div>
     </div>
     <div class="control-group">
         <label class="control-label">{{ _('Debounce Time:') }}</label>
         <div class="controls" data-toggle="tooltip" title="{{ _('When a sensor state change happens, wait for this amount of time to wait for the signal to stabilize.') }}">
-            <input type="number" step="any" min="0" class="input-mini text-right" data-bind="value: settings.plugins.filamentreload.bounce">
+            <input type="number" step="any" min="0" class="input-mini text-right" data-bind="value: settings.plugins.filamentsensorng.bounce">
+            <span class="add-on">ms</span>
+        </div>
+    </div>
+    <div class="control-group">
+        <label class="control-label">{{ _('Debounce Time:') }}</label>
+        <div class="controls" data-toggle="tooltip" title="{{ _('When a sensor state change happens, wait for this amount of continous reads of the sensor not having filament to trigger.') }}">
+            <input type="number" step="any" min="0" class="input-mini text-right" data-bind="value: settings.plugins.filamentsensorng.confirmations">
             <span class="add-on">ms</span>
         </div>
     </div>
     <div class="control-group">
         <label class="control-label">{{ _('Switch Type:') }}</label>
         <div class="controls" data-toggle="tooltip" title="{{ _('Whether the sensor should trip when the switch goes HIGH or LOW, Normally Open is LOW when filament is present, and Normally Closed is HIGH when filament is present.') }}">
-            <select class="select-mini" data-bind="value: settings.plugins.filamentreload.switch">
+            <select class="select-mini" data-bind="value: settings.plugins.filamentsensorng.switch">
                 <option value=0>{{ _('Normally Open') }}</option>
                 <option value=1>{{ _('Normally Closed') }}</option>
             </select>
@@ -25,7 +32,7 @@
     <div class="control-group">
         <label class="control-label">{{ _('Board Pin Mode:') }}</label>
         <div class="controls" data-toggle="tooltip" title="{{ _('RPi pins numbered in Board mode or BCM mode?') }}">
-           <select class="select-mini" data-bind="value: settings.plugins.filamentreload.mode">
+           <select class="select-mini" data-bind="value: settings.plugins.filamentsensorng.mode">
                 <option value=0>{{ _('Board Mode') }}</option>
                 <option value=1>{{ _('BCM Mode') }}</option>
         </select>
@@ -34,13 +41,13 @@
     <div class="control-group">
         <label class="control-label">{{ _('Out of filament GCODE:') }}</label>
         <div class="controls">
-            <textarea rows="4" class="block" data-bind="value: settings.plugins.filamentreload.no_filament_gcode"></textarea>
+            <textarea rows="4" class="block" data-bind="value: settings.plugins.filamentsensorng.no_filament_gcode"></textarea>
         </div>
     </div>
     <div class="control-group">
         <div class="controls" data-toggle="tooltip" title="{{ _('Beware that for some printers, pausing is incompatible with M600 (Filament change pause) as both will move the print head and it can resume at a different position as it paused.') }}">
             <label class="checkbox">
-                <input type="checkbox" data-bind="checked: settings.plugins.filamentreload.pause_print"> {{ _('Pause print when out of filament') }}
+                <input type="checkbox" data-bind="checked: settings.plugins.filamentsensorng.pause_print"> {{ _('Pause print when out of filament') }}
             </label>
         </div>
     </div>

octoprint_filamentreload/templates/filamentreload_settings.jinja2 renamed to octoprint_filamentsensorng/templates/filamentsensorng_settings.jinja2

@@ -4,33 +4,33 @@
 ### Do not forget to adjust the following variables to your own plugin.
 
 # The plugin's identifier, has to be unique
-plugin_identifier = "filamentreload"
+plugin_identifier = "filamentsensorng"
 
 # The plugin's python package, should be "octoprint_<plugin identifier>", has to be unique
-plugin_package = "octoprint_filamentreload"
+plugin_package = "octoprint_filamentsensorng"
 
 # The plugin's human readable name. Can be overwritten within OctoPrint's internal data via __plugin_name__ in the
 # plugin module
-plugin_name = "Octoprint-FilamentReload"
+plugin_name = "Octoprint-FilamentSensor-ng"
 
 # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module
-plugin_version = "1.0.1"
+plugin_version = "1.0.0"
 
 # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
 # module
-plugin_description = """A revamped and rewritten filament monitor that pauses the print when your filament runs out"""
+plugin_description = """A filament monitor that pauses the print when your filament runs out and lets you restart it."""
 
 # The plugin's author. Can be overwritten within OctoPrint's internal data via __plugin_author__ in the plugin module
-plugin_author = "Connor Huffine"
+plugin_author = "Connor Huffine, Red_M"
 
 # The plugin's author's mail address.
-plugin_author_email = "[email protected]"
+plugin_author_email = "[email protected], [email protected]"
 
 # The plugin's homepage URL. Can be overwritten within OctoPrint's internal data via __plugin_url__ in the plugin module
-plugin_url = "https://github.com/kontakt/Octoprint-Filament-Reloaded"
+plugin_url = "https://github.com/Red-M/Octoprint-Filament-Reloaded"
 
 # The plugin's license. Can be overwritten within OctoPrint's internal data via __plugin_license__ in the plugin module
-plugin_license = "AGPLv3"
+plugin_license = "GPLv3"
 
 # Any additional requirements besides OctoPrint should be listed here
 plugin_requires = ['RPi.GPIO']