aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-01-19 23:12:41 -0500
committerKevin O'Connor <kevin@koconnor.net>2021-01-19 23:12:41 -0500
commit8a6619d18ef9d8de4adfdfa43a5d7595af56fc2c (patch)
tree32078922c4ea211c49643af78fa3ee36dbcd875d /docs
parente74d5d57b2937288f6cc518b103627fa3e0bf4ac (diff)
downloadkutter-8a6619d18ef9d8de4adfdfa43a5d7595af56fc2c.tar.gz
kutter-8a6619d18ef9d8de4adfdfa43a5d7595af56fc2c.tar.xz
kutter-8a6619d18ef9d8de4adfdfa43a5d7595af56fc2c.zip
mcu: Add a get_status() callback with micro-controller info and stats
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Command_Templates.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/Command_Templates.md b/docs/Command_Templates.md
index 57a5fa91..f2c5699b 100644
--- a/docs/Command_Templates.md
+++ b/docs/Command_Templates.md
@@ -288,6 +288,16 @@ The following are common printer attributes:
- `printer.hall_filament_width_sensor.Diameter`,
`printer.hall_filament_width_sensor.Raw`: The last read values from
the sensor.
+- `printer.mcu.mcu_version`: The Klipper code version reported by the
+ micro-controller.
+- `printer.mcu.mcu_build_versions`: Information on the build tools
+ used to generate the micro-controller code (as reported by the
+ micro-controller).
+- `printer.mcu.mcu_constants.<constant_name>`: Compile time constants
+ reported by the micro-controller. The available constants may differ
+ between micro-controller architectures and with each code revision.
+- `printer.mcu.last_stats.<statistics_name>`: Statistics information
+ on the micro-controller connection.
The above list is subject to change - if using an attribute be sure to
review the [Config Changes document](Config_Changes.md) when upgrading