From 20e5c8543df9bc53242d2953d991e9f2e7be33d4 Mon Sep 17 00:00:00 2001
From: Teemu Rytilahti <tpr@iki.fi>
Date: Mon, 2 Oct 2017 10:06:53 +0200
Subject: [PATCH] Revise based on code review, add an example & some
 docstrings, plus fix invalid send() in status()

---
 mirobo/wifispeaker.py | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/mirobo/wifispeaker.py b/mirobo/wifispeaker.py
index 2cfaa398c..2b64268e5 100644
--- a/mirobo/wifispeaker.py
+++ b/mirobo/wifispeaker.py
@@ -7,18 +7,26 @@
 
 class WifiSpeakerStatus:
     def __init__(self, data):
+        # {"DeviceName": "Mi Internet Speaker", "channel_title\": "XXX",
+        #  "current_state": "PLAYING", "hardware_version": "S602",
+        # "play_mode": "REPEAT_ALL", "track_artist": "XXX",
+        # "track_duration": "00:04:58", "track_title": "XXX",
+        #  "transport_channel": "PLAYLIST"}
         self.data = data
 
     @property
     def device_name(self) -> str:
+        """Name of the device."""
         return self.data["DeviceName"]
 
     @property
     def channel(self) -> str:
+        """Name of the channel."""
         return self.data["channel_title"]
 
     @property
     def state(self) -> str:
+        """State of the device, e.g. PLAYING."""
         # note: this can be enumized when all values are known
         return self.data["current_state"]
 
@@ -28,23 +36,28 @@ def hardware_version(self) -> str:
 
     @property
     def play_mode(self):
+        """Play mode such as REPEAT_ALL."""
         # note: this can be enumized when all values are known
         return self.data["play_mode"]
 
     @property
     def track_artist(self) -> str:
+        """Artist of the current track."""
         return self.data["track_artist"]
 
     @property
     def track_title(self) -> str:
+        """Title of the current track."""
         return self.data["track_title"]
 
     @property
     def track_duration(self) -> str:
+        """Total duration of the current track."""
         return self.data["track_duration"]
 
     @property
     def transport_channel(self) -> str:
+        """Transport channel, e.g. PLAYLIST"""
         # note: this can be enumized when all values are known
         return self.data["transport_channel"]
 
@@ -57,23 +70,30 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
     def status(self):
-        return WifiSpeakerStatus(self.command("get_prop", ["umi"]))
+        """Return device status."""
+        return WifiSpeakerStatus(self.send("get_prop", ["umi"]))
 
     def power(self):
+        """Toggle power on and off."""
         # is this a toggle?
         return self.send("power")
 
     def volume_up(self, amount: int = 5):
+        """Set volume up."""
         return self.send("vol_up", [amount])
 
     def volume_down(self, amount: int = 5):
+        """Set volume down."""
         return self.send("vol_down", [amount])
 
     def track_previous(self):
+        """Move to previous track."""
         return self.send("previous_track")
 
     def track_next(self):
+        """Move to next track."""
         return self.send("next_track")
 
-    def track_location(self):
+    def track_position(self):
+        """Return current track position."""
         return self.send("get_prop", ["rel_time"])