3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add missing headers to config examples 

Signed-off-by: Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2021-12-22 19:50:25 -05:00
parent 01245ea8a1
commit 51ca383591
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/configuration.md
View File

@ -486,6 +486,8 @@ address: 192.168.1.123
The following options are available for `tasmota` device types: The following options are available for `tasmota` device types:
```ini ```ini
# moonraker.conf
#
# Note: # Note:
# If your single-relay Tasmota device switches on/off successfully, # If your single-relay Tasmota device switches on/off successfully,
# but fails to report its state, ensure that 'SetOption26' is set in # but fails to report its state, ensure that 'SetOption26' is set in
@ -521,6 +523,8 @@ password: mypassword
The following options are available for `shelly` device types: The following options are available for `shelly` device types:
```ini ```ini
# moonraker.conf
address: address:
# A valid ip address or hostname for the shelly device. This parameter # A valid ip address or hostname for the shelly device. This parameter
# must be provided. # must be provided.
@ -622,6 +626,8 @@ domain: switch
The following options are available for `loxone` device types: The following options are available for `loxone` device types:
```ini ```ini
# moonraker.conf
address: address:
# A valid ip address or hostname for the Loxone server. This # A valid ip address or hostname for the Loxone server. This
# parameter must be provided. # parameter must be provided.
@ -640,6 +646,8 @@ output_id:
The following options are available for `mqtt` device types: The following options are available for `mqtt` device types:
```ini ```ini
# moonraker.conf
qos: qos:
# The MQTT QOS level to use when publishing and subscribing to topics. # The MQTT QOS level to use when publishing and subscribing to topics.
# The default is to use the setting supplied in the [mqtt] section. # The default is to use the setting supplied in the [mqtt] section.
@ -964,6 +972,8 @@ It is also possible for other components within Moonraker to use MQTT to
publish and subscribe to topics. publish and subscribe to topics.
```ini ```ini
# moonraker.conf
[mqtt] [mqtt]
address: address:
# Address of the Broker. This may be a hostname or IP Address. This # Address of the Broker. This may be a hostname or IP Address. This
@ -1040,6 +1050,8 @@ It is possible to publish a topic from a Klipper gcode macro with the
`publish_mqtt_topic` remote method. For example: `publish_mqtt_topic` remote method. For example:
```ini ```ini
# printer.cfg
[gcode_macro PUBLISH_ALERT] [gcode_macro PUBLISH_ALERT]
gcode: gcode:
{% set data = params.PAYLOAD|default(None) %} {% set data = params.PAYLOAD|default(None) %}