{"id":29161890,"url":"https://github.com/simplyprint/octoprint-simplyfilamentsensor","last_synced_at":"2025-07-01T04:09:51.670Z","repository":{"id":54274098,"uuid":"295826311","full_name":"SimplyPrint/OctoPrint-SimplyFilamentSensor","owner":"SimplyPrint","description":null,"archived":false,"fork":false,"pushed_at":"2021-03-09T16:10:34.000Z","size":990,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-30T04:17:08.988Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SimplyPrint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-15T19:14:39.000Z","updated_at":"2023-10-03T21:58:26.000Z","dependencies_parsed_at":"2022-08-13T10:40:36.279Z","dependency_job_id":null,"html_url":"https://github.com/SimplyPrint/OctoPrint-SimplyFilamentSensor","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/SimplyPrint/OctoPrint-SimplyFilamentSensor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimplyPrint%2FOctoPrint-SimplyFilamentSensor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimplyPrint%2FOctoPrint-SimplyFilamentSensor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimplyPrint%2FOctoPrint-SimplyFilamentSensor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimplyPrint%2FOctoPrint-SimplyFilamentSensor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SimplyPrint","download_url":"https://codeload.github.com/SimplyPrint/OctoPrint-SimplyFilamentSensor/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimplyPrint%2FOctoPrint-SimplyFilamentSensor/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262893658,"owners_count":23380712,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T04:09:50.978Z","updated_at":"2025-07-01T04:09:51.643Z","avatar_url":"https://github.com/SimplyPrint.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SimplyFilamentSensor\n### The new filament sensor plugin that actually works, is up to date, and offers a setup fit for everyone.\n\nThis plugin reacts to short lever microswitch output like [this](https://chinadaier.en.made-in-china.com/product/ABVJkvyMAqcT/China-1A-125VAC-on-off-Kw10-Mini-Micro-Mouse-Switch.html).\n\n### Features:\n* Automatically pauses the print when filament runs out\n* Works with [SimplyPrint](http://simplyprint.dk/)\n* Alerts you before starting a print, if filament has run out\n* Pop-up notifications in OctoPrint when printer runs out of filament\n  * Push, SMS and email notifications for SimplyPrint users\n* Test-button so you can easily see if the setup is correct\n* Filament check _before_ starting your print after a pause\n* Custom GCODE upon pausing\n* Pin validation so you don't accidentally save wrong pin number\n* Runs on OctoPrint 1.3.0 and higher\n* Python 2 \u0026 3 compatible\n\n**NOTE: this plugin only works when printing through SimplyPrint or OctoPrint. When printing through SD card _(also when starting a print via. OctoPrint from your SD card)_, this plugin won't work**\n\n## Setup\n\nInstall via the ~~bundled [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)~~ _(COMING SOON!)_\nor manually using this URL:\n\n    https://github.com/SimplyPrint/OctoPrint-SimplyFilamentSensor/archive/master.zip\n\n## Configuration\n\nConfiguration couldn't be simpler, all you need is to configure listening board pin (board mode) and if the second switch terminal is connected to ground or 3.3V.\n\nDefault pin is -1 (not configured) and ground (as it is safer, read below).\n\n**WARNING! Never connect the switch input to 5V as it could fry the GPIO section of your Raspberry!**\n\n**WARNING! When using test button on input pin used by other application it will reset internal pull up/down resistor**\n\n#### Advice\n\nYou might experience the same problem as I experienced - the sensor was randomly triggered. Turns out that if running sensor wires along motor wires, it was enough to interfere with sensor reading.\n\nTo solve this connect a shielded wire to your sensor and ground the shielding, ideally on both ends.\n\nIf you are unsure about your sensor being triggered, check [OctoPrint logs](https://community.octoprint.org/t/where-can-i-find-octoprints-and-octopis-log-files/299)\n\n## Screenshots\n_coming soon!_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplyprint%2Foctoprint-simplyfilamentsensor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplyprint%2Foctoprint-simplyfilamentsensor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplyprint%2Foctoprint-simplyfilamentsensor/lists"}