Add detail on return value for get_state()

barnybug · barnybug · commit a05efe1c00a8 · 2019-10-16T09:58:02.000+01:00
diff --git a/broadlink/__init__.py b/broadlink/__init__.py
@@ -358,7 +358,11 @@ def __init__(self, host, mac, devtype):
         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)
