Octoprint Plugin

Install using the plug in manager that is included with Octoprint.

The installation package can be found here. The easiest way I find is to download the zip file.  In Octoprint, navigate to settings (the wrench in the top bar).  On the left hand side select Plugin Manager.  Select Get More …   Use the “… from an uploaded archive” option.  Browse to the zip file you just downloaded and click on install.  It will install the plugin and then ask you to restart Octoprint

Once installed you will need to configure the plugin.  To set this up go to settings again.  On the left hand side under PLUGINS you should find JamSentry.  Click it to open the settings window.

The followings settings are available:

1. JamSentry address (Optional) The address of the JamSentry (typically http://192.168.1.xxx). If the printer has multiple JamSentry units (one per extruder), then only one can be displayed. However the JamSentry plugin will still receive alerts from all units.  This provides a new tab that contains the JamSentry status page.

2. Port (Mandatory if you changed the default port that JamSentry uses) The port to listen on. This defaults to 27100. You can change the default that JamSentry uses. The JamSentry plugin must be configured to listen on whatever port the JamSentry uses to send the alert.

3. Password (Mandatory if you changed the default password in JamSentry). Since a jam detection will likely pause the print, you want to make sure it isn’t a prankster.  If you changed the default password, then the same password must be set in the plugin. The default password is “JamSentryPSWD”.

4. Custom GCode to send when a jam or filament runout is detected.

5. Whether or not to pause when a jam or filament runout is detected. If used, then GCODE for pause and resume should be set up in the GCODE Scripts in the Octoprint settings. Note that pause should be avoided in Octoprint versions 1.3.7 and 1.3.8 as it does not work reliably. If you don’t supply any GCODE script for the pause and resume functions, then the printer will pause, but in place. So the hotend will gradually melt a little blob in place.

NOTE:
For the GCODE Script for Pause, I use the following:

; relative XYZE
G91
M83

; retract filament, move Z slightly upwards
G1 Z+5 E-5 F4500

; absolute XYZE
M82
G90

; move to a safe rest position, adjust as necessary
G1 X0 Y0

For the GCODE Script for Resume, I use the following:

; relative extruder
M83

; prime nozzle
G1 E-5 F4500
G1 E5 F4500
G1 E5 F4500

; absolute E
M82

; absolute XYZ
G90

; reset E
G92 E{{ pause_position.e }}

; move back to pause position XYZ
G1 X{{ pause_position.x }} Y{{ pause_position.y }} Z{{ pause_position.z }} F4500

; reset to feed rate before pause
G1 {{ pause_position.f }}

You can test that everything works by using the TEST function in JamSentry to send out a fake pause message.