Action Command Prompt support¶
New in version 1.3.9.
The OctoPrint Action Command Prompt Support Plugin comes bundled with OctoPrint.
It allows firmware to trigger dialog prompts for logged in users using action commands, e.g. to wait for user acknowledgement or allow the user to choose between options, and also to close the dialog again in case its no longer needed, e.g. due to the user proceeding on the printer’s own controller.
The choice of the user can be communicated back to the firmware via a configurable GCODE command with a placeholder for the selected option’s index.
Configuring the plugin¶
The plugin supports the following configuration keys:
enable: Whether to always enable (
always), disable (
enable_emergency_sending: Will make the selection command be sent as an emergency command to jump the internal send queue and even be sent to the printer if it’s not signaling to be able to received. Only done if this is true and the printer signals support for emergency command processing. Defaults to
enable_signaling: If enabled, will send the configured command with the
P1parameter to the printer to signal prompt support of the host. Defaults to
command: The command to send to the firmware on choice, defaults to
You can modify them either through the plugin’s configuration dialog under Settings, or by directly editing
Supported action commands¶
- prompt_begin <message>
Starts the definition of a prompt dialog.
<message>is the message to display to the user. Will be ignored if a dialog is already defined.
- prompt_choice <text>
Defines a choice with the associated
<text>. Will be ignored if no dialog has been defined yet.
- prompt_button <text>
Tells OctoPrint that the dialog is now fully defined and to prompt the user. Will be ignored if no dialog is defined yet.
Tells OctoPrint that the dialog should now be closed (e.g. the user made the choice on the printer directly instead of through OctoPrint). Will be ignored if no dialog is defined yet.
Example communication with the firmware¶
To display the above dialog the firmware sent these action commands:
//action:prompt_begin Filament unloaded, swap then proceed //action:prompt_choice Filament swapped //action:prompt_show
If the user clicks the button, OctoPrint will send back
M876 S0 (0-based index).
A more complicated example with three options would be the following:
//action:prompt_begin Filament runout detected. Please choose how to proceed: //action:prompt_choice Swap filament //action:prompt_choice Home X/Y and pause print //action:prompt_choice Abort print //action:prompt_show
This would produce the following output:
If the user selects “Abort print”, OctoPrint will send
2 as selected choice.
The source of the Action Command Prompt Support plugin is bundled with OctoPrint and can be found in
its source repository under