From 562f971c3d039fb3a8a1d7f8362e34a15d851b62 Mon Sep 17 00:00:00 2001 From: Eric Callahan Date: Sun, 10 Oct 2021 18:08:25 -0400 Subject: [PATCH] docs: update the mqtt documentation Signed-off-by: Eric Callahan --- docs/configuration.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index abe7f74..72ecc88 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -563,19 +563,26 @@ status_objects: # A newline separated list of Klipper objects whose state will be # published in the payload of the following topic: # {instance_name}/klipper/status -# For example, to track the "webhooks" and "toolhead" objects this -# option would be set as follows: +# For example, this option could be set as follows: +# # status_objects: # webhooks -# toolhead -# See the "Printer Objects" section of the documentation for an -# overview of the most common objects available. Note that Klipper -# will only push an update to an object/field if the field has changed. -# An object with no fields that have changed will not be part of the -# payload. Object state is checked and published roughly every -# 250 ms. +# toolhead=position,print_time,homed_axes +# extruder=temperature +# +# In the example above, all fields of the "webhooks" object will be tracked +# and changes will be published. Only the "position", "print_time", and +# "homed_axes" fields of the "toolhead" will be tracked. Likewise, only the +# "temperature" field of the extruder will be tracked. See the +# "Printer Objects" section of the documentation for an overview of the most +# common objects available. +# +# Note that Klipper will only push an update to an object/field if the field +# has changed. An object with no fields that have changed will not be part +# of the payload. Object state is checked and published roughly every 250 ms. +# # If not configured then no objects will be tracked and published to -# the status topic. +# the klipper/status topic. default_qos: 0 # The default QOS level used when publishing or subscribing to topics. # Must be an integer value from 0 to 2. The default is 0.