OctoPrint-Estop/README.md

34 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2017-03-22 22:17:16 +01:00
# Emergency Stop
Add a big ugly emergency stop to your sidebar. It's big, it's yellow, it's red, it's impossible to miss. That's the point.
2017-03-22 22:34:28 +01:00
2017-03-22 23:59:47 +01:00
### THIS BUTTON DOES NOT CONFIRM BEFORE SENDING!
2017-03-22 22:34:28 +01:00
That's the point of an EMERGENCY stop!
2017-03-23 00:14:30 +01:00
![](/extras/assets/img/plugins/estop/enabled.PNG) vs ![](/extras/assets/img/plugins/estop/disabled.PNG)
2017-03-24 15:46:44 +01:00
2017-03-22 22:17:16 +01:00
## Setup
Install via the bundled plugin manager, or manually using this URL:
2017-03-22 22:17:16 +01:00
https://github.com/ntoff/OctoPrint-Estop/archive/master.zip
## Position
Once installed, you may wish to move the button to the top of the sidebar, you can do so by modifying the [config.yaml](http://docs.octoprint.org/en/master/configuration/config_yaml.html) file as follows:
Find the "appearance" section, and add the plugin to the top of the sidebar order. If no other components have been previously rearranged, you may end up with only the plugin in the order list, this is fine, you don't need to add every item to the list (not adding them won't stop them from showing up).
appearance:
components:
order:
sidebar:
- plugin_estop
2017-03-22 22:17:16 +01:00
Please note: White spaces are critical inside the config.yaml file, special care must be taken when adding or removing entries that the correct layout is maintained. For more information on config.yaml and its appearance section, see here: http://docs.octoprint.org/en/master/configuration/config_yaml.html#appearance
2017-03-24 15:46:44 +01:00
#### Disclaimer
This is not a magical button, it can't perform miracles, all it does is send the standard `M112` emergency stop gcode to your printer, how it responds to that is largely up to the firmware. Depending on the control board and firmware, a reset may be required to regain control, or a simple disconnect and reconnect may also work. So called 'blocking' gcodes (such as the heat-and-wait commands) may render this button ineffective (again, largely up to how the firmware handles incoming commands) and so a software solution should never be relied upon to overcome a hardware issue such as a fire or other critical event. There is no substitute for physical human intervention in case of an emergency, and a _pysical_ emergency stop button capable of cutting the incoming power.