docs: add SET_DISPLAY_TEXT documentation

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2022-06-21 12:39:00 -04:00 committed by KevinOConnor
parent a431900f7f
commit 6ad6e39ad2
2 changed files with 12 additions and 2 deletions

View File

@ -138,8 +138,13 @@ This is quite useful if you want to change the behavior of certain commands like
[gcode_macro M117] [gcode_macro M117]
rename_existing: M117.1 rename_existing: M117.1
gcode: gcode:
M117.1 { rawparams } {% if rawparams %}
M118 { rawparams } {% set escaped_msg = rawparams|replace('"', '\\"') %}
SET_DISPLAY_TEXT MSG="{escaped_msg}"
RESPOND TYPE=command MSG="{escaped_msg}"
{% else %}
SET_DISPLAY_TEXT
{% endif %}
``` ```
### The "printer" Variable ### The "printer" Variable

View File

@ -295,6 +295,11 @@ provides the following standard G-Code commands:
- Display Message: `M117 <message>` - Display Message: `M117 <message>`
- Set build percentage: `M73 P<percent>` - Set build percentage: `M73 P<percent>`
Also provided is the following extended G-Code command:
- `SET_DISPLAY_TEXT MSG=<message>`: Performs the equivalent of M117,
setting the supplied `MSG` as the current display message. If
`MSG` is omitted the display will be cleared.
### [dual_carriage] ### [dual_carriage]
The following command is available when the The following command is available when the