From 77052e15b0763c3ac79ccd2ea494d57dfaa8115b Mon Sep 17 00:00:00 2001 From: Eric Callahan Date: Mon, 28 Jun 2021 19:56:15 -0400 Subject: [PATCH] docs: update MQTT documentation Reflect the new behavior of wait_connection() Signed-off-by: Eric Callahan --- docs/components.md | 8 +++++--- docs/configuration.md | 1 + 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/components.md b/docs/components.md index 97e0ccd..23fe205 100644 --- a/docs/components.md +++ b/docs/components.md @@ -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)* diff --git a/docs/configuration.md b/docs/configuration.md index 472ebed..4084847 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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.