Skip to content
This repository has been archived by the owner on Dec 19, 2024. It is now read-only.

Commit

Permalink
Small bugfix, extended Readme.md and increased version
Browse files Browse the repository at this point in the history
  • Loading branch information
maocypher committed Dec 25, 2020
1 parent a6fb4c9 commit 3d27668
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ After installation a restart of Octoprint is recommended.
### GPIO Pin
* Choose any free GPIO pin you for data usage, but I would recommend to use GPIO pins without special functionalities like e.g. I2C
* Run the sensor only on 3.3V, because GPIO pins don't like 5V for a long time
* In [BigTreeTech SmartFilamentSensor Manual](https://github.com/bigtreetech/smart-filament-detection-module/tree/master/manual) on page 12 you can find the functionality of the pins. Please ensure that there is no undocumented twist in your cable
* My recommended GPIO pins: 11, 13, 15, 17 (such without any special usage). Please check the [documentation](https://www.raspberrypi.org/documentation/usage/gpio/) of your Raspberry Pi version/model. Also other pins could work, if you know how to configure it on the Raspberry, but it might be tricky and not work out of the box.

### Detection time
Currently it is necessary to configure a maximum time period no filament movement was detected. This time could be depended on the print speed and maximum print line length. For the beginning - until I figured out how to estimate the best detection time - you can run a test print and messearue your maximum time and configure this value.
Expand All @@ -48,6 +50,9 @@ Since v1.1.3 there are also alternative pausing commands [M0, M1, M25, M226, M60
### Octoprint - GCode Scripts
If you do not want that the print is paused right on your print, I recommend to add a GCode Script for "After print job is paused". Also adding GCode script "Before print job is resumed" might be useful, in the case you hit the heatbed or print head during the change of the filament or removing the blockage.

### Test script
Advice: don't run the test script in this repository durin a print. This leads to failures in the detection of movements of the print and therefore to missbehaviour of the plugin.

## GCode
### Start GCode
Since the sensor is activated with the first G0 or G1 command it is adviced to perform these commands after complete heatup of the printer.
Expand Down
2 changes: 1 addition & 1 deletion octoprint_smart_filament_sensor/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ def distance_detection(self, comm_instance, phase, cmd, cmd_type, gcode, *args,


__plugin_name__ = "Smart Filament Sensor"
__plugin_version__ = "1.1.3"
__plugin_version__ = "1.1.4"
__plugin_pythoncompat__ = ">=2.7,<4"

def __plugin_load__():
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
plugin_name = "Octoprint-Smart-Filament-Sensor"

# The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module
plugin_version = "1.1.3"
plugin_version = "1.1.4"

# The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
# module
Expand Down

0 comments on commit 3d27668

Please sign in to comment.