Skip to content
No description, website, or topics provided.
Python HTML
Branch: master
Clone or download
Pull request Compare This branch is 9 commits ahead of kontakt:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
octoprint_filamentrevolutions Add plugin_check and fix get_update_information Nov 25, 2019
.editorconfig Initial Commit Jan 6, 2017
.gitignore Initial Commit Jan 6, 2017 Create Code of Conduct Jun 23, 2017
LICENSE Add License Jun 23, 2017 Initial Commit Jan 6, 2017 Update documentation Nov 20, 2019
babel.cfg Initial Commit Jan 6, 2017
requirements.txt Initial Commit Jan 6, 2017 Update with Jam sensor Nov 17, 2019


OctoPrint plugin that integrates with 1 or 2 filament sensors hooked up to a Raspberry Pi GPIO pin and allows the filament spool to be changed during a print if the filament runs out or is jammed.

Initial work based on the Octoprint-Filament-Reloaded plugin by kontakt.

Required sensor

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

This plugin can use the GPIO.BOARD or GPIO.BCM numbering scheme.


  • Configurable GPIO pins.
  • 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 sensors status via a GET method:

  • to /plugin/filamentrevolutions/filament for the filament sensor
  • to /plugin/filamentrevolutions/jammed for the jam sensor
  • {status: "-1"} if the sensor is not setup
  • {status: "0"} if the sensor is OFF (filament not present/filament not jammed)
  • {status: "1"} if the sensor is ON (filament present/filament jammed)



After installation, configure the plugin via OctoPrint Settings interface.

You can’t perform that action at this time.