Skip to content
OctoPrint plug-in that detects when printer is out of filament
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
octoprint_filamentencore Fixed wrong key for update hook May 31, 2019
.editorconfig Initial Commit Jan 6, 2017
.gitignore Added option to prevent printing if no filament detected May 20, 2019
LICENSE Add License Jun 23, 2017 Initial Commit Jan 6, 2017 Prevent print setting on/off now works May 31, 2019
babel.cfg Initial Commit Jan 6, 2017
requirements.txt Prevent resume now disables resume button May 30, 2019


OctoPrint 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.

Based on the Octoprint-Filament-Reloaded plugin by kontakt.

Required sensor

Using this plugin requires a filament sensor. The code is set to use the Raspberry Pi's internal Pull-Up resistors, so the switch should be between your detection pin and a ground pin.


  • Optionally prevent printer from starting with no filament

  • Configurable GPIO pin.
  • Debounce noisy sensors.
  • Support normally open and normally closed sensors.
  • Execution of custom GCODE when out of filament detected.
  • Optionally pause print when out of filament.

An API is available to check the filament sensor status via a GET method to /plugin/filamentreload/status which returns a JSON

  • {status: "-1"} if the sensor is not setup
  • {status: "0"} if the sensor is OFF (filament not present)
  • {status: "1"} if the sensor is ON (filament present)



After installation, configure the plugin via OctoPrint Settings interface.

You can’t perform that action at this time.