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

docs: update MQTT documentation 

Reflect the new behavior of wait_connection()

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2021-06-28 19:56:15 -04:00
parent ecc0fbdae9
commit 77052e15b0
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/components.md
View File

@ -316,9 +316,11 @@ otherwise.
#### *MQTTClient.wait_connection(timeout=None)*
Blocks until a connection with the broker has been successfully established.
If the optional `timeout` argument is specified then `asyncio.TimeoutError`
will be raised if the timeout has exceeded.
Blocks until a connection with the broker has been successfully established
or until the specified timeout has exceeded. Returns true if the connection
was successful established, or False on timeout. If no timeout is specified
then this method will block indefinitely until a connection has been
established.
#### *MQTTClient.publish_topic(topic, payload=None, qos=None, retain=False)*

1
docs/configuration.md
View File

@ -482,6 +482,7 @@ It is also possible for other components within Moonraker to use MQTT to
publish and subscribe to topics.
```ini
[mqtt]
address:
# Address of the Broker. This may be a hostname or IP Address. This
# parameter must be provided.