Skip to content

Commit a595411

Browse files
committed
docs: clarify is_mqtt_connected docstring with motivation
1 parent 4f2d298 commit a595411

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

roborock/devices/rpc/v1_channel.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,13 @@ def is_local_connected(self) -> bool:
204204

205205
@property
206206
def is_mqtt_connected(self) -> bool:
207-
"""Return whether MQTT connection is available."""
207+
"""Return whether MQTT connection is available for the device.
208+
209+
This requires the MQTT session to be connected to the broker and
210+
the subscription to the device's topic to have successfully
211+
been established (to handle cases where the device is offline
212+
or deleted).
213+
"""
208214
return self._mqtt_channel.is_connected and self._mqtt_unsub is not None
209215

210216
@property

0 commit comments

Comments
 (0)