Host @ Commands

The plugin reacts to a number of @ commands, this will tell you the details.

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 some different @ commands, listed below:

CommandExplanation

@WS_LIGHTSON

Turns lights on, same as pressing switch in navbar.

@WS_LIGHTSOFF

Turns lights off.

@WS_TORCH

Activates the torch mode, for timer mode

@WS_TORCH_ON

Turn torch on, for toggle mode

@WS_TORCH_OFF

Turn torch off, for toggle mode

These commands can be used in g-code scripts, or in custom controls in apps - see here for instructions for OctoRemote, or the guide on how to create a timelapse flash in OctoLapse which also uses @ commands.

Last updated