Features

Here you can see details of all the available features in the plugin, what they do, how to use them, and their configuration options.

For many of these items below, they reference 'effects' - you can see all of the options for effects on the [effects page](

Printing event tracking

At the core of the plugin is it's event reacting effects. The first feature to be created, and the most used!

The events that the plugin reacts to are:

• Printer connected - note that this may not be caught if you have 'auto connect on startup' enabled, as the connect can come before the plugin has initialised.
• Printer disconnected
• Print success
• Print paused
• Print failed
• Printing - note that this overrides the print progress effect if it is enabled.

Progress tracking

The plugin can track the progress of different events too, and render this on the LEDs.

Each type can be turned on and off, as well as the progress bar colour and base colour can be configured.

Printing Progress

Shows the same percentage progress that is shown on the progress bar of OctoPrint's web interface.

TODO visualisation

Heating Progress

Shows the progress of heating, from current temperature to target temperature. For this type there are a couple more options:

• Enable tracking tool heating - and which tool to track
• Enable tracking bed heating

TODO visualisation

M150 intercept

Plugin will intercept M150 commands, and display them on the LED strip. Commands should be formatted as below: -

M150 [P<intensity>] [R<intensity>] [G<intensity>] [B<intensity>] [W<intensity>]

Parameters

• P: Brightness, max 255. If not included, defaults to set brightness within plugin settings.
• R: Red intensity, max 255.
• G: Green intensity, max 255 (Can also be U for Marlin compatibility)
• B: Blue intensity, max 255
• W: White intensity, max 255. Overrides any previous R, G or B value, to set white.

All of the parameters are optional, and can be included in any order. If an option is not included, its value is 0 - as a result ending an empty M150 command turns the LEDs off. (This is not recommended as it means they come back on for the next effect. Please see @ Commands below)

Examples:

M150 R255 G255  # Sets LEDs to yellow
M150 G238 B255  # Sets to light-ish blue
M150 W100       # Sets to white, at 100 intensity
M150 R255 P200  # Sets LEDs to red, at 200 brightness

LED On/Off from navbar

A button in the navbar will turn the LEDs on and off, until it is switched back on.

TODO: image of button

Host @ commands

(From OctoPrint's documentation)

@ commands (also known as host commands elsewhere) are special commands you may include in GCODE files streamed through OctoPrint to your printer or send as part of GCODE scripts, through the Terminal Tab, the API or plugins. Contrary to other commands they will never be sent to the printer but instead trigger functions inside OctoPrint.

The plugin reacts to two @ commands, named:-

• @WS_LIGHTSON: Turns lights on, same as pressing switch in navbar.
• @WS_LIGHTSOFF: Turns lights off.

These commands can be used in g-code scripts, or in custom controls in apps - see here for instructions for OctoRemote

Torch mode

You can select an effect that you can manually trigger from the navbar too. This effect runs for the time configured, then it goes back to the previous one.

TODO: Add image of button