Device support for the xiaomi air purifier added. (#31)

* Device support for the xiaomi air purifier added.

* Code reformatted.

* Status class moved.

* Missing import added.

* OperationMode class introduced.

* Position of the OperationMode class moved.

* LedBrightness class introduced.
Whitespaces removed.

* More meaningful names used.

* Example response of an air purifier pro added. Thanks to @af950833.

* Code reformatted.

* Example response updated. It looks like we can request 16 properties max at once.

* Don't interpret unavailable property.

* A few operation modes are no longer exposed by the air purifier as valid. Mode medium, high and strong removed.

.gitignore

@@ -1 +1,2 @@
 __pycache__
+.idea/

mirobo/__init__.py

@@ -3,5 +3,6 @@
 from mirobo.vacuumcontainers import VacuumStatus, ConsumableStatus, CleaningDetails, CleaningSummary, Timer
 from mirobo.vacuum import Vacuum, VacuumException
 from mirobo.plug import Plug
+from mirobo.airpurifier import AirPurifier
 from mirobo.strip import Strip
 from mirobo.device import Device, DeviceException

mirobo/airpurifier.py

@@ -0,0 +1,183 @@
+from .device import Device
+from typing import Any, Dict
+import enum
+
+
+class OperationMode(enum.Enum):
+    Auto = 'auto'
+    Silent = 'silent'
+    Favorite = 'favorite'
+    Idle = 'idle'
+
+
+class LedBrightness(enum.Enum):
+    Bright = 0
+    Dim = 1
+    Off = 2
+
+
+class AirPurifier(Device):
+    """Main class representing the air purifier."""
+
+    def status(self):
+        """Retrieve properties."""
+
+        # A few more properties:
+        properties = ['power', 'aqi', 'humidity', 'temp_dec',
+                      'mode', 'led', 'led_b', 'buzzer', 'child_lock',
+                      'limit_hum', 'trans_level', 'bright',
+                      'favorite_level', 'filter1_life', 'act_det',
+                      'f1_hour_used', 'use_time', 'motor1_speed']
+
+        values = self.send(
+            "get_prop",
+            properties
+        )
+        return AirPurifierStatus(dict(zip(properties, values)))
+
+    def set_mode(self, mode: OperationMode):
+        """Set mode."""
+
+        # auto, silent, favorite, idle
+        return self.send("set_mode", [mode.value])
+
+    def set_favorite_level(self, level: int):
+        """Set favorite level."""
+
+        # Set the favorite level used when the mode is `favorite`,
+        # should be  between 0 and 16.
+        return self.send("favorite_level", [level])  # 0 ... 16
+
+    def set_led_brightness(self, brightness: LedBrightness):
+        """Set led brightness."""
+
+        # bright: 0, dim: 1, off: 2
+        return self.send("set_led_b", [brightness.value])
+
+    def set_led(self, led: bool):
+        """Turn led on/off."""
+        if led:
+            return self.send("set_led", ['on'])
+        else:
+            return self.send("set_led", ['off'])
+
+    def set_buzzer(self, buzzer: bool):
+        """Set buzzer."""
+        if buzzer:
+            return self.send("set_mode", ["on"])
+        else:
+            return self.send("set_mode", ["off"])
+
+    def set_humidity_limit(self, limit: int):
+        """Set humidity limit."""
+
+        # 40, 50, 60, 70 or 80
+        return self.send("set_limit_hum", [limit])
+
+
+class AirPurifierStatus:
+    """Container for status reports from the air purifier."""
+    def __init__(self, data: Dict[str, Any]) -> None:
+        # Response of a Air Purifier Pro:
+        # ['power': 'off', 'aqi': 41, 'humidity': 62, 'temp_dec': 293,
+        #  'mode': 'auto', 'led': 'on', 'led_b': null, 'buzzer': null,
+        #  'child_lock': 'off', 'limit_hum': null, 'trans_level': null,
+        #  'bright': 71, 'favorite_level': 17, 'filter1_life': 77,
+        #  'act_det': null, 'f1_hour_used': 771, 'use_time': 2776200,
+        #  'motor1_speed': 0]
+        self.data = data
+
+    @property
+    def power(self) -> str:
+        return self.data["power"]
+
+    @property
+    def is_on(self) -> bool:
+        return self.power == "on"
+
+    @property
+    def aqi(self) -> int:
+        return self.data["aqi"]
+
+    @property
+    def humidity(self) -> int:
+        return self.data["humidity"]
+
+    @property
+    def temperature(self) -> float:
+        return self.data["temp_dec"] / 10.0
+
+    @property
+    def mode(self) -> OperationMode:
+        return OperationMode(self.data["mode"])
+
+    @property
+    def led(self) -> bool:
+        return self.data["led"] == "on"
+
+    @property
+    def led_brightness(self) -> LedBrightness:
+        if self.data["led_b"] is not None:
+            return LedBrightness(self.data["led_b"])
+
+    @property
+    def buzzer(self) -> bool:
+        return self.data["buzzer"] == "on"
+
+    @property
+    def child_lock(self) -> bool:
+        return self.data["child_lock"] == "on"
+
+    @property
+    def humidity_limit(self) -> int:
+        return self.data["limit_hum"]
+
+    @property
+    def trans_level(self) -> str:
+        return self.data["trans_level"]
+
+    @property
+    def bright(self) -> int:
+        return self.data["bright"]
+
+    @property
+    def favorite_level(self) -> int:
+        # Favorite level used when the mode is `favorite`. Between 0 and 16.
+        return self.data["favorite_level"]
+
+    @property
+    def filter_life_remaining(self) -> int:
+        return self.data["filter1_life"]
+
+    @property
+    def act_det(self) -> bool:
+        return self.data["act_det"] == "on"
+
+    @property
+    def filter_hours_used(self) -> int:
+        return self.data["f1_hour_used"]
+
+    @property
+    def use_time(self) -> int:
+        return self.data["use_time"]
+
+    @property
+    def motor_speed(self) -> int:
+        return self.data["motor1_speed"]
+
+    def __str__(self) -> str:
+        s = "<AirPurifierStatus power=%s, aqi=%s temperature=%s%%, " \
+            "humidity=%s%% mode=%s%%, led=%s%%, " \
+            "led_brightness=%s%% buzzer=%s%%, " \
+            "child_lock=%s%%, humidity_limit=%s%%, trans_level=%s%%, " \
+            "bright=%s%%, favorite_level=%s%%, filter_life_remaining=%s%%, " \
+            "act_det=%s%%, filter_hours_used=%s%%, use_time=%s%%, " \
+            "motor_speed=%s%%>" % \
+            (self.power, self.aqi, self.temperature,
+             self.humidity, self.mode, self.led,
+             self.led_brightness, self.buzzer,
+             self.child_lock, self.humidity_limit, self.trans_level,
+             self.bright, self.favorite_level, self.filter_life_remaining,
+             self.act_det, self.filter_hours_used, self.use_time,
+             self.motor_speed)
+        return s