diff options
author | Barnaby Gray <barnaby@pickle.me.uk> | 2019-10-16T08·58+0100 |
---|---|---|
committer | Barnaby Gray <barnaby@pickle.me.uk> | 2019-10-16T08·58+0100 |
commit | a05efe1c00a8ca7cec3f430196e7f76b01ac7180 (patch) | |
tree | bb61214dd0c100cb862d691a24e1241299a7985e /broadlink | |
parent | 660c2269e4e9f999ad1f383b7aa128511f7ec431 (diff) |
Add detail on return value for get_state()
Diffstat (limited to 'broadlink')
-rw-r--r-- | broadlink/__init__.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/broadlink/__init__.py b/broadlink/__init__.py index be0ca7edec55..3190a7b7446c 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) |