diff options
author | Kevin O'Connor <kevin@koconnor.net> | 2022-03-23 18:06:09 -0400 |
---|---|---|
committer | Kevin O'Connor <kevin@koconnor.net> | 2022-03-31 13:08:12 -0400 |
commit | 1ab3ac39e410441190690d43f6d2ef339f23a155 (patch) | |
tree | f1be1eab0194a7f6539a7cb16926fbf687750997 /docs/Config_Reference.md | |
parent | a6ab56c0a6c7c532f1f1e2b5b5b4060cea7001a5 (diff) | |
download | kutter-1ab3ac39e410441190690d43f6d2ef339f23a155.tar.gz kutter-1ab3ac39e410441190690d43f6d2ef339f23a155.tar.xz kutter-1ab3ac39e410441190690d43f6d2ef339f23a155.zip |
led: Support automated LED updates based on display_template results
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r-- | docs/Config_Reference.md | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index 1b264801..c62d4274 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -3552,12 +3552,18 @@ text: ### [display_template] Display data text "macros" (one may define any number of sections with -a display_template prefix). This feature allows one to reduce -repetitive definitions in display_data sections. One may use the -builtin render() function in display_data sections to evaluate a -template. For example, if one were to define `[display_template -my_template]` then one could use `{ render('my_template') }` in a -display_data section. +a display_template prefix). See the +[command templates](Command_Templates.md) document for information on +template evaluation. + +This feature allows one to reduce repetitive definitions in +display_data sections. One may use the builtin `render()` function in +display_data sections to evaluate a template. For example, if one were +to define `[display_template my_template]` then one could use `{ +render('my_template') }` in a display_data section. + +This feature can also be used for continuous LED updates using the +[SET_LED_TEMPLATE](G-Codes.md#set_led_template) command. ``` [display_template my_template_name] @@ -3570,9 +3576,9 @@ display_data section. # "param_speed = 75" might have a caller with # "render('my_template_name', param_speed=80)". Parameter names may # not use upper case characters. -#text: -# The text to return when the render() function is called for this -# template. This field is evaluated using command templates (see +text: +# The text to return when the this template is rendered. This field +# is evaluated using command templates (see # docs/Command_Templates.md). This parameter must be provided. ``` |