aboutsummaryrefslogtreecommitdiffstats
path: root/docs/G-Codes.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2024-09-21 15:47:19 -0400
committerKevin O'Connor <kevin@koconnor.net>2024-09-30 12:23:24 -0400
commit8f361a15b2c13f532f6ea16db448f749dcc408d3 (patch)
treec505f135417fd06aba8073aed12b786414afe971 /docs/G-Codes.md
parentf4143af4fa26822db2e1c4321de7377b808ce16f (diff)
downloadkutter-8f361a15b2c13f532f6ea16db448f749dcc408d3.tar.gz
kutter-8f361a15b2c13f532f6ea16db448f749dcc408d3.tar.xz
kutter-8f361a15b2c13f532f6ea16db448f749dcc408d3.zip
fan_generic: Support setting a TEMPLATE on SET_FAN_SPEED commands
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/G-Codes.md')
-rw-r--r--docs/G-Codes.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/G-Codes.md b/docs/G-Codes.md
index f855f364..63c84f56 100644
--- a/docs/G-Codes.md
+++ b/docs/G-Codes.md
@@ -476,6 +476,20 @@ enabled.
`SET_FAN_SPEED FAN=config_name SPEED=<speed>` This command sets the
speed of a fan. "speed" must be between 0.0 and 1.0.
+`SET_FAN_SPEED PIN=config_name TEMPLATE=<template_name>
+[<param_x>=<literal>]`: If `TEMPLATE` is specified then it assigns a
+[display_template](Config_Reference.md#display_template) to the given
+fan. For example, if one defined a `[display_template
+my_fan_template]` config section then one could assign
+`TEMPLATE=my_fan_template` here. The display_template should produce a
+string containing a floating point number with the desired value. The
+template will be continuously evaluated and the fan will be
+automatically set to the resulting speed. One may set display_template
+parameters to use during template evaluation (parameters will be
+parsed as Python literals). If TEMPLATE is an empty string then this
+command will clear any previous template assigned to the pin (one can
+then use `SET_FAN_SPEED` commands to manage the values directly).
+
### [filament_switch_sensor]
The following command is available when a