This repository collects the sources of examples for writing plugins for OctoPrint.
Currently the following example plugins and more can be found here:
- add_tornado_route: Single file plugin (place it in
~/.octoprint/plugins) that shows how to utilize the octoprint.server.http.routes hook to add additional routes with customRequestHandlersto the server configuration. - custom_action_command: Single file plugin (place it in
~/.octoprint/plugins) that shows how to utilize the octoprint.comm.protocol.action hook hook and how to register hook handlers that are part of a mixin implementation. The plugin will listen for firmware messages of the form// action:customand if received will log that it received the "custom" action from the firmware. - custom_template_consumer: Single directory plugin (place it in
~/.octoprint/plugins) that shows how to have a plugin inject itself into custom places provided through other plugins in the web interface through utilizing a custom template type if the presence of the provider of that template is detected. - custom_template_provider: Single directory plugin (place it in
~/.octoprint/plugins) that shows how to provide a custom template type through the octoprint.ui.web.templatetypes hook and how to display templates of that type. - helloworld: A simple plugin that injects itself into various places in OctoPrint's web interface to display "Hello World". Shows the basic structure of a plugin, how plugins can execute code at startup, inject themselves into the interface and how they can control when their content is shown based on internal state of the UI such as login information.
- increase_bodysize: Single file plugin (place it in
~/.octoprint/plugins) that shows how to increase the maximum allowed request body size for specific endpoints by utilizing the octoprint.server.http.bodysize hook. - message_on_connect: Single file plugin (place it in
~/.octoprint/plugins) that shows how to utilize the octoprint.comm.protocol.scripts hook by adding anM117 OctoPrint connectedto the GCODE script sent to the printer after OctoPrint connected to it. - rewrite_m107: Single file plugin (place it in
~/.octoprint/plugins) that shows how to utilize the octoprint.comm.protocol.gcode hook by swapping the (deprecated)M107command with the equivalentM106 S0. - strip_all_comments: Single file plugin (place it in
~/.octoprint/plugins) that shows how to utilize the octoprint.filemanager.preprocessor hook by removing the comments (and empty lines) from all uploaded/generated GCODE files ending on the name postfix "_strip".
These examples are licensed under the MIT license. See also LICENSE in the source folder.