docs: update the mqtt documentation

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2021-10-10 18:08:25 -04:00
parent 25f9800f77
commit 562f971c3d
1 changed files with 17 additions and 10 deletions

View File

@ -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.