From a05efe1c00a8ca7cec3f430196e7f76b01ac7180 Mon Sep 17 00:00:00 2001 From: Barnaby Gray Date: Wed, 16 Oct 2019 09:58:02 +0100 Subject: [PATCH] Add detail on return value for get_state() --- broadlink/__init__.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/broadlink/__init__.py b/broadlink/__init__.py index be0ca7ede..3190a7b74 100644 --- a/broadlink/__init__.py +++ b/broadlink/__init__.py @@ -358,7 +358,11 @@ class bg1(device): self.type = "BG1" def get_state(self): - """Get state of device""" + """Get state of device. + + Returns: + dict: Dictionary of current state + eg. `{"pwr":1,"pwr1":1,"pwr2":0,"maxworktime":60,"maxworktime1":60,"maxworktime2":0,"idcbrightness":50}`""" packet = self._encode(1, b'{}') response = self.send_packet(0x6a, packet) return self._decode(response)