Add support for Air Purifier 4 (zhimi.airpurifier.mb5), update Air Purifier 3H (zhimi.airpurifier.mb3)

DEVICES.md

@@ -385,8 +385,8 @@
       <td>zhimi.airpurifier.mb3</td>
       <td>Mi Air Purifier 3H</td>
       <td><img src="https://cdn.awsde0.fds.api.mi-img.com/miio.files/developer_15504816557tej1pj6.png" width="100"></td>
-      <td><ul><li>getPower</li><li>getMode</li><li>getFanLevel</li><li>getTemperature</li><li>getHumidity</li><li>getPM2_5</li><li>getFilterRemaining</li><li>getBuzzer</li><li>getLcdBrightness</li></ul></td>
-      <td><ul><li>setPower</li><li>setMode</li><li>setFanLevel</li><li>setBuzzer</li><li>setLcdBrightness</li><li>setChildLock</li></ul></td>
+      <td><ul><li>getPower</li><li>getMode</li><li>getFanLevel</li><li>getFavLevel</li><li>getSpeed</li><li>getSetSpeed</li><li>getTemperature</li><li>getHumidity</li><li>getPM2_5</li><li>getFilterRemaining</li><li>getBuzzer</li><li>getUseTime</li><li>getLcdBrightness</li><li>getAqiRealtimeUpdateDuration</li></ul></td>
+      <td><ul><li>setPower</li><li>setMode</li><li>setFanLevel</li><li>setFavLevel</li><li>setBuzzer</li><li>setLcdBrightness</li><li>setChildLock</li><li>setAqiRealtimeUpdateDuration</li></ul></td>
     </tr>
     <tr>
       <td>48</td>
@@ -436,5 +436,13 @@
       <td><ul><li>getPower</li><li>getFanLevel</li><li>getTartgetHumidity</li><li>getWaterLevel</li><li>getTemperature</li><li>getHumidity</li><li>getMode</li><li>getChildLock</li><li>getLedBrightness</li><li>getBuzzer</li></ul></td>
       <td><ul><li>setPower</li><li>setBuzzer</li><li>setFanLevel</li><li>setTargetHumidity</li><li>setLedBrightness</li><li>setChildLock</li><li>setMode</li></ul></td>
     </tr>
+    <tr>
+      <td>54</td>
+      <td>zhimi.airpurifier.mb5</td>
+      <td>Mi Air Purifier 4</td>
+      <td><img src="https://cdn.awsde0.fds.api.mi-img.com/miio.files/developer_15504816557tej1pj6.png" width="100"></td>
+      <td><ul><li>getPower</li><li>getMode</li><li>getFault</li><li>getFanLevel</li><li>getFavLevel</li><li>getAnion</li><li>getTemperature</li><li>getHumidity</li><li>getPM2_5</li><li>getFilterRemaining</li><li>getBuzzer</li><li>getLcdBrightness</li><li>getAqiRealtimeUpdateDuration</li></ul></td>
+      <td><ul><li>setPower</li><li>setMode</li><li>setFanLevel</li><li>setFavSpeed</li><li>setFavLevel</li><li>setAnion</li><li>setBuzzer</li><li>setLcdBrightness</li><li>setChildLock</li><li>setAqiRealtimeUpdateDuration</li></ul></td>
+    </tr>
   </tbody>
 </table>

lib/devices/zhimi.airpurifier.mb3.js

@@ -23,7 +23,12 @@ module.exports = class extends Device {
       'alarm:alarm',
       'indicator-light:brightness',
       'indicator-light:on',
-      'physical-controls-locked:physical-controls-locked'];
+      'motor-speed:motor-speed',
+      'motor-speed:motor-set-speed',
+      'motor-speed:favorite-fan-level',
+      'use-time:use-time',
+      'physical-controls-locked:physical-controls-locked',
+      'aqi:aqi-updata-heartbeat'];
   }
 
   getPower() {
@@ -43,6 +48,18 @@ module.exports = class extends Device {
     return this.properties['air-purifier:fan-level'];
   }
 
+  getFavLevel() { // 1 - 9
+    return this.properties['motor-speed:favorite-fan-level'];
+  }
+
+  getSpeed() {
+    return this.properties['motor-speed:motor-speed'];
+  }
+
+  getSetSpeed() {
+    return this.properties['motor-speed:motor-set-speed'];
+  }
+
   getTemperature() {
     return this.properties['environment:temperature'];
   }
@@ -69,10 +86,18 @@ module.exports = class extends Device {
     return this.properties['alarm:alarm'];
   }
 
+  getUseTime() {
+    return this.properties['use-time:use-time'];
+  }
+
   getLcdBrightness() {
     return this.properties['indicator-light:brightness'];
   }
 
+  getAqiRealtimeUpdateDuration() {
+    return this.properties['aqi:aqi-updata-heartbeat'];
+  }
+
   setPower(v) {
     return this.miotSetProperty('air-purifier:on', v);
   }
@@ -89,6 +114,10 @@ module.exports = class extends Device {
     return this.miotSetProperty('air-purifier:fan-level', v);
   }
 
+  setFavLevel(v) { // 1 - 9
+    return this.miotSetProperty('motor-speed:favorite-fan-level', v);
+  }
+
   setBuzzer(v) {
     return this.miotSetProperty('alarm:alarm', v);
   }
@@ -101,4 +130,9 @@ module.exports = class extends Device {
     return this.miotSetProperty('physical-controls-locked:physical-controls-locked', v);
   }
 
+  // Sets duration for which the PM2.5-sensor provides real-time data. Duration is automatically decreased until "0" is reached
+  setAqiRealtimeUpdateDuration(v) {
+    return this.miotSetProperty('aqi:aqi-updata-heartbeat', v);
+  }
+
 };

lib/devices/zhimi.airpurifier.mb5.js

@@ -0,0 +1,148 @@
+const Device = require('../device-miio');
+
+module.exports = class extends Device {
+
+    static model = 'zhimi.airpurifier.mb5';
+    static name = 'Mi Air Purifier 4';
+    static image = 'https://cdn.awsde0.fds.api.mi-img.com/miio.files/developer_15504816557tej1pj6.png';
+
+    constructor(opts) {
+        super(opts);
+
+        this._miotSpecType = 'urn:miot-spec-v2:device:air-purifier:0000A007:zhimi-mb5:1';
+        this._propertiesToMonitor = [
+            'air-purifier:fault',
+            'air-purifier:on',
+            'air-purifier:fan-level',
+            'air-purifier:mode',
+            'air-purifier:anion',
+            'environment:pm2.5-density',
+            'environment:relative-humidity',
+            'environment:temperature',
+            'filter:filter-life-level',
+            'filter:filter-used-time',
+            'filter:filter-left-time',
+            'alarm:alarm',
+            'custom-service:favorite-level',
+            'screen:brightness',
+            'physical-controls-locked:physical-controls-locked',
+            'aqi:aqi-updata-heartbeat'];
+    }
+
+    getPower() {
+        return this.properties['air-purifier:on'];
+    }
+
+    getMode() {
+        const mode = this.properties['air-purifier:mode'];
+        if (mode === 0) return 'auto';
+        if (mode === 1) return 'sleep';
+        if (mode === 2) return 'favorite';
+        if (mode === 3) return 'manual';
+        return undefined;
+    }
+
+    getFault() {
+        const fault = this.properties['air-purifier:fault'];
+        if (fault === 0) return 'No Faults"';
+        if (fault === 1) return 'Sensor PM Error';
+        if (fault === 2) return 'Temp Error';
+        if (fault === 3) return 'Hum Error';
+        if (fault === 4) return 'No Filter';
+        return undefined;
+    }
+
+    getFanLevel() { // 1 - 3
+        const fanLevel = this.properties['air-purifier:fan-level'];
+        if (fanLevel === 1) return 'Level1';
+        if (fanLevel === 2) return 'Level2';
+        if (fanLevel === 3) return 'Level3';
+        return undefined;
+    }
+
+    getFavLevel() { // 0 - 11
+        return this.properties['custom-service:favorite-level'];
+    }
+
+    getAnion() {
+        return this.properties['air-purifier:anion'];
+    }
+
+    getTemperature() {
+        return this.properties['environment:temperature'];
+    }
+
+    getHumidity() {
+        return this.properties['environment:relative-humidity'];
+    }
+
+    // eslint-disable-next-line camelcase
+    getPM2_5() {
+        return this.properties['environment:pm2.5-density'];
+    }
+
+    getFilterRemaining() {
+        return this.properties['filter:filter-left-time'];
+    }
+
+    getBuzzer() {
+        return this.properties['alarm:alarm'];
+    }
+
+    getLcdBrightness() {
+        return this.properties['screen:brightness'];
+    }
+
+    getAqiRealtimeUpdateDuration() {
+        return this.properties['aqi:aqi-updata-heartbeat'];
+    }
+
+    setPower(v) {
+        return this.miotSetProperty('air-purifier:on', v);
+    }
+
+    setMode(v) {
+        if (v === 'auto') v = 0;
+        else if (v === 'sleep') v = 1;
+        else if (v === 'favorite') v = 2;
+        else if (v === 'none') v = 3;
+        return this.miotSetProperty('air-purifier:mode', v);
+    }
+
+    setFavSpeed(v) { // 200-2300
+        return this.miotSetProperty('custom-service:favorite-speed', v);
+    }
+
+    setFanLevel(v) { // 1-3
+        if (v === 'Level1') v = 1;
+        else if (v === 'Level2') v = 2;
+        else if (v === 'Level3') v = 3;
+        return this.miotSetProperty('air-purifier:fan-level', v);
+    }
+
+    setFavLevel(v) { // 0 - 11
+        return this.miotSetProperty('custom-service:favorite-level', v);
+    }
+
+    setAnion(v) {
+        return this.miotSetProperty('air-purifier:anion', v);
+    }
+
+    setBuzzer(v) {
+        return this.miotSetProperty('alarm:alarm', v);
+    }
+
+    setLcdBrightness(v) { // 0-Close, 1-Bright, 2-Brightest
+        return this.miotSetProperty('screen:brightness', v);
+    }
+
+    setChildLock(v) {
+        return this.miotSetProperty('physical-controls-locked:physical-controls-locked', v);
+    }
+
+    // Sets duration for which the PM2.5-sensor provides real-time data. Duration is automatically decreased until "0" is reached
+    setAqiRealtimeUpdateDuration(v) {
+        return this.miotSetProperty('aqi:aqi-updata-heartbeat', v);
+    }
+
+};