homebridge-miot/lib/modules/robotcleaner/devices/dreame.vacuum.p2041o.js

Homebridge plugin for devices supporting the miot protocol

const RobotCleanerDevice = require('../RobotCleanerDevice.js');
const Constants = require('../../../constants/Constants.js');
const PropFormat = require('../../../constants/PropFormat.js');
const PropUnit = require('../../../constants/PropUnit.js');
const PropAccess = require('../../../constants/PropAccess.js');


class DreameVacuumP2041o extends RobotCleanerDevice {
  constructor(miotDevice, name, logger) {
    super(miotDevice, name, logger);
  }


  /*----------========== DEVICE INFO ==========----------*/

  getDeviceName() {
    return 'Xiaomi Vacuum Mop 2 Pro+';
  }

  getMiotSpecUrl() {
    return 'https://miot-spec.org/miot-spec-v2/instance?type=urn:miot-spec-v2:device:vacuum:0000A006:dreame-p2041o:2';
  }


  /*----------========== CONFIG ==========----------*/

  requiresMiCloud() {
    return false;
  }


  /*----------========== METADATA ==========----------*/

  initDeviceServices() {
    this.createServiceByString('{"siid":2,"type":"urn:miot-spec-v2:service:vacuum:00007810:dreame-p2041o:1","description":"Robot Cleaner"}');
    this.createServiceByString('{"siid":3,"type":"urn:miot-spec-v2:service:battery:00007805:dreame-p2041o:1","description":"Battery"}');
    this.createServiceByString('{"siid":9,"type":"urn:miot-spec-v2:service:brush-cleaner:0000784C:dreame-p2041o:1","description":"Main Cleaning Brush"}');
    this.createServiceByString('{"siid":10,"type":"urn:miot-spec-v2:service:brush-cleaner:0000784C:dreame-p2041o:1","description":"Side Cleaning Brush"}');
    this.createServiceByString('{"siid":11,"type":"urn:miot-spec-v2:service:filter:0000780B:dreame-p2041o:1","description":"Filter"}');
    this.createServiceByString('{"siid":4,"type":"urn:dreame-spec:service:vacuum-extend:00007801:dreame-p2041o:1","description":"扫地机扩展功能协议"}');
    this.createServiceByString('{"siid":5,"type":"urn:dreame-spec:service:do-not-disturb:00007802:dreame-p2041o:1","description":"勿扰设置"}');
    this.createServiceByString('{"siid":6,"type":"urn:dreame-spec:service:map:00007803:dreame-p2041o:1","description":"扫地机地图信息"}');
    this.createServiceByString('{"siid":7,"type":"urn:dreame-spec:service:audio:00007804:dreame-p2041o:1","description":"主机语音相关服务"}');
    this.createServiceByString('{"siid":8,"type":"urn:dreame-spec:service:time:00007805:dreame-p2041o:1","description":"时区读取"}');
    this.createServiceByString('{"siid":12,"type":"urn:dreame-spec:service:clean-logs:00007806:dreame-p2041o:1","description":"清扫日志"}');
    this.createServiceByString('{"siid":13,"type":"urn:dreame-spec:service:vslam-extend:00007807:dreame-p2041o:1","description":"vslam-extend"}');
  }

  initDeviceProperties() {
    this.addPropertyByString('vacuum:status', '{"siid":2,"piid":1,"type":"urn:miot-spec-v2:property:status:00000007:dreame-p2041o:1","description":"Status","format":"uint8","access":["read","notify"],"unit":"none","valueList":[{"value":1,"description":"Sweeping"},{"value":2,"description":"Idle"},{"value":3,"description":"Paused"},{"value":4,"description":"Error"},{"value":5,"description":"Go Charging"},{"value":6,"description":"Charging"},{"value":7,"description":"Mopping"}]}');
    this.addPropertyByString('vacuum:fault', '{"siid":2,"piid":2,"type":"urn:miot-spec-v2:property:fault:00000009:dreame-p2041o:1","description":"Device Fault","format":"uint8","access":["read","notify"],"unit":"none","valueRange":[0,100,1]}');
    this.addPropertyByString('vacuum:mode', '{"siid":2,"piid":3,"type":"urn:miot-spec-v2:property:mode:00000008:dreame-p2041o:1","description":"Mode","format":"uint8","access":["read","write","notify"],"unit":"none","valueList":[{"value":0,"description":"Silent"},{"value":1,"description":"Basic"},{"value":2,"description":"Strong"},{"value":3,"description":"Full Speed"}]}');
    this.addPropertyByString('battery:battery-level', '{"siid":3,"piid":1,"type":"urn:miot-spec-v2:property:battery-level:00000014:dreame-p2041o:1","description":"Battery Level","format":"uint8","access":["read","notify"],"unit":"percentage","valueRange":[0,100,1]}');
    this.addPropertyByString('battery:charging-state', '{"siid":3,"piid":2,"type":"urn:miot-spec-v2:property:charging-state:00000015:dreame-p2041o:1","description":"Charging State","format":"uint8","access":["read","notify"],"unit":"none","valueList":[{"value":1,"description":"Charging"},{"value":2,"description":"Not Charging"},{"value":5,"description":"Go Charging"}]}');
    this.addPropertyByString('brush-cleaner:brush-left-time', '{"siid":9,"piid":1,"type":"urn:miot-spec-v2:property:brush-left-time:00000086:dreame-p2041o:1","description":"Brush Left Time","format":"uint16","access":["read","notify"],"unit":"hours","valueRange":[0,300,1]}');
    this.addPropertyByString('brush-cleaner:brush-life-level', '{"siid":9,"piid":2,"type":"urn:miot-spec-v2:property:brush-life-level:00000085:dreame-p2041o:1","description":"Brush Life Level","format":"uint8","access":["read","notify"],"unit":"percentage","valueRange":[0,100,1]}');
    this.addPropertyByString('brush-cleaner10:brush-life-level', '{"siid":10,"piid":2,"type":"urn:miot-spec-v2:property:brush-life-level:00000085:dreame-p2041o:1","description":"Brush Life Level","format":"uint8","access":["read","notify"],"unit":"percentage","valueRange":[0,100,1]}');
    this.addPropertyByString('filter:filter-life-level', '{"siid":11,"piid":1,"type":"urn:miot-spec-v2:property:filter-life-level:0000001E:dreame-p2041o:1","description":"Filter Life Level","format":"uint8","access":["read","notify"],"unit":"percentage","valueRange":[0,100,1]}');
    this.addPropertyByString('brush-cleaner10:brush-left-time', '{"siid":10,"piid":1,"type":"urn:miot-spec-v2:property:brush-left-time:00000086:dreame-p2041o:1","description":"Brush Left Time","format":"uint16","access":["read","notify"],"unit":"hours","valueRange":[0,200,1]}');
    this.addPropertyByString('filter:filter-left-time', '{"siid":11,"piid":2,"type":"urn:miot-spec-v2:property:filter-left-time:0000001F:dreame-p2041o:1","description":"Filter Left Time","format":"uint16","access":["read","notify"],"unit":"hours","valueRange":[0,150,1]}');
    this.addPropertyByString('vacuum-extend:work-mode', '{"siid":4,"piid":1,"type":"urn:dreame-spec:property:work-mode:00000001:dreame-p2041o:1","description":"工作模式","format":"int32","access":["read","notify"],"unit":"none","valueRange":[0,50,1]}');
    this.addPropertyByString('vacuum-extend:cleaning-time', '{"siid":4,"piid":2,"type":"urn:dreame-spec:property:cleaning-time:00000002:dreame-p2041o:1","description":"清扫时长","format":"int32","access":["read","notify"],"unit":"minutes","valueRange":[0,32767,1]}');
    this.addPropertyByString('vacuum-extend:cleaning-area', '{"siid":4,"piid":3,"type":"urn:dreame-spec:property:cleaning-area:00000003:dreame-p2041o:1","description":"清扫面积","format":"int32","access":["read","notify"],"unit":"none","valueRange":[0,32767,1]}');
    this.addPropertyByString('vacuum-extend:cleaning-mode', '{"siid":4,"piid":4,"type":"urn:dreame-spec:property:cleaning-mode:00000004:dreame-p2041o:1","description":"清扫模式","format":"int8","access":["read","notify","write"],"unit":"none","valueList":[{"value":0,"description":""},{"value":1,"description":""},{"value":2,"description":""},{"value":3,"description":""}]}');
    this.addPropertyByString('vacuum-extend:mop-mode', '{"siid":4,"piid":5,"type":"urn:dreame-spec:property:mop-mode:00000005:dreame-p2041o:1","description":"","format":"int8","access":["read","notify","write"],"unit":"none","valueRange":[1,3,1]}');
    this.addPropertyByString('vacuum-extend:waterbox-status', '{"siid":4,"piid":6,"type":"urn:dreame-spec:property:waterbox-status:00000006:dreame-p2041o:1","description":"水箱状态","format":"int8","access":["read","notify"],"unit":"none","valueList":[{"value":0,"description":""},{"value":1,"description":""}]}');
    this.addPropertyByString('vacuum-extend:task-status', '{"siid":4,"piid":7,"type":"urn:dreame-spec:property:task-status:00000007:dreame-p2041o:1","description":"","format":"int8","access":["read","notify"],"unit":"none","valueList":[{"value":0,"description":"Notask"},{"value":1,"description":"AutoClean"},{"value":2,"description":"CustomClean"},{"value":3,"description":"SelectAreanClean"},{"value":4,"description":"SpotArea"}]}');
    this.addPropertyByString('vacuum-extend:clean-start-time', '{"siid":4,"piid":8,"type":"urn:dreame-spec:property:clean-start-time:00000008:dreame-p2041o:1","description":"当次清扫开始时间","format":"string","access":["notify"],"unit":"none"}');
    this.addPropertyByString('vacuum-extend:clean-log-filename', '{"siid":4,"piid":9,"type":"urn:dreame-spec:property:clean-log-filename:00000009:dreame-p2041o:1","description":"清扫完成生成的日志文件名","format":"string","access":["notify"],"unit":"none"}');
    this.addPropertyByString('vacuum-extend:clean-extend-data', '{"siid":4,"piid":10,"type":"urn:dreame-spec:property:clean-extend-data:0000000a:dreame-p2041o:1","description":"清扫时的扩展参数","format":"string","access":["write"],"unit":"none"}');
    this.addPropertyByString('vacuum-extend:break-point-restart', '{"siid":4,"piid":11,"type":"urn:dreame-spec:property:break-point-restart:0000000b:dreame-p2041o:1","description":"break-point-restart","format":"uint8","access":["notify","write","read"],"unit":"none","valueList":[{"value":0,"description":"关闭"},{"value":1,"description":"打开"}]}');
    this.addPropertyByString('vacuum-extend:carpet-press', '{"siid":4,"piid":12,"type":"urn:dreame-spec:property:carpet-press:0000000c:dreame-p2041o:1","description":"carpet-press","format":"uint8","access":["read","notify","write"],"unit":"none","valueList":[{"value":0,"description":"关闭"},{"value":1,"description":"打开"}]}');
    this.addPropertyByString('vacuum-extend:cleanlog-status', '{"siid":4,"piid":13,"type":"urn:dreame-spec:property:cleanlog-status:0000000d:dreame-p2041o:1","description":"cleanlog-status","format":"uint8","access":[],"unit":"none","valueList":[{"value":0,"description":"Break"},{"value":1,"description":"Finish"}]}');
    this.addPropertyByString('vacuum-extend:serial-number', '{"siid":4,"piid":14,"type":"urn:dreame-spec:property:serial-number:0000000e:dreame-p2041o:1","description":"serial-number","format":"string","access":["read","notify"],"unit":"none"}');
    this.addPropertyByString('vacuum-extend:remote-state', '{"siid":4,"piid":15,"type":"urn:dreame-spec:property:remote-state:0000000f:dreame-p2041o:1","description":"remote-state","format":"string","access":["write"],"unit":"none"}');
    this.addPropertyByString('vacuum-extend:keep-sweeper-time', '{"siid":4,"piid":17,"type":"urn:dreame-spec:property:keep-sweeper-time:00000011:dreame-p2041o:1","description":"keep-sweeper-time","format":"int32","access":["read","notify"],"unit":"minutes","valueRange":[-1,1000000,1]}');
    this.addPropertyByString('vacuum-extend:faults', '{"siid":4,"piid":18,"type":"urn:dreame-spec:property:faults:00000012:dreame-p2041o:1","description":"faults","format":"string","access":["read","notify"],"unit":"none"}');
    this.addPropertyByString('do-not-disturb:enable', '{"siid":5,"piid":1,"type":"urn:dreame-spec:property:enable:00000001:dreame-p2041o:1","description":"使能","format":"bool","access":["read","notify","write"],"unit":"none"}');
    this.addPropertyByString('do-not-disturb:start-time', '{"siid":5,"piid":2,"type":"urn:dreame-spec:property:start-time:00000002:dreame-p2041o:1","description":"勿扰起始时间","format":"string","access":["read","notify","write"],"unit":"none"}');
    this.addPropertyByString('do-not-disturb:end-time', '{"siid":5,"piid":3,"type":"urn:dreame-spec:property:end-time:00000003:dreame-p2041o:1","description":"勿扰结束时间","format":"string","access":["read","notify","write"],"unit":"none"}');
    this.addPropertyByString('map:map-data', '{"siid":6,"piid":1,"type":"urn:dreame-spec:property:map-data:00000001:dreame-p2041o:1","description":"地图数据","format":"string","access":["notify"],"unit":"none"}');
    this.addPropertyByString('map:frame-info', '{"siid":6,"piid":2,"type":"urn:dreame-spec:property:frame-info:00000002:dreame-p2041o:1","description":"帧信息","format":"string","access":["write"],"unit":"none"}');
    this.addPropertyByString('map:object-name', '{"siid":6,"piid":3,"type":"urn:dreame-spec:property:object-name:00000003:dreame-p2041o:1","description":"中转地图数据在FDS上的文件名","format":"string","access":["notify"],"unit":"none"}');
    this.addPropertyByString('map:map-extend-data', '{"siid":6,"piid":4,"type":"urn:dreame-spec:property:map-extend-data:00000004:dreame-p2041o:1","description":"地图编辑参数","format":"string","access":["write"],"unit":"none"}');
    this.addPropertyByString('map:robot-time', '{"siid":6,"piid":5,"type":"urn:dreame-spec:property:robot-time:00000005:dreame-p2041o:1","description":"robot-time","format":"int64","access":["notify"],"unit":"none","valueRange":[0,10000000000000000,1]}');
    this.addPropertyByString('map:result-code', '{"siid":6,"piid":6,"type":"urn:dreame-spec:property:result-code:00000006:dreame-p2041o:1","description":"result-code","format":"int16","access":["notify"],"unit":"none","valueRange":[-10000,10000,1]}');
    this.addPropertyByString('audio:volume', '{"siid":7,"piid":1,"type":"urn:dreame-spec:property:volume:00000001:dreame-p2041o:1","description":"音量","format":"int32","access":["read","notify","write"],"unit":"none","valueRange":[0,100,1]}');
    this.addPropertyByString('audio:voice-packet-id', '{"siid":7,"piid":2,"type":"urn:dreame-spec:property:voice-packet-id:00000002:dreame-p2041o:1","description":"语音包id","format":"string","access":["read","notify","write"],"unit":"none"}');
    this.addPropertyByString('audio:voice-change-state', '{"siid":7,"piid":3,"type":"urn:dreame-spec:property:voice-change-state:00000003:dreame-p2041o:1","description":"语音包切换时的状态","format":"string","access":["read","notify"],"unit":"none"}');
    this.addPropertyByString('audio:set-voice', '{"siid":7,"piid":4,"type":"urn:dreame-spec:property:set-voice:00000004:dreame-p2041o:1","description":"设置个性化语音","format":"string","access":["write"],"unit":"none"}');
    this.addPropertyByString('time:time-zone', '{"siid":8,"piid":1,"type":"urn:dreame-spec:property:time-zone:00000001:dreame-p2041o:1","description":"主机时区获取","format":"string","access":["read","notify"],"unit":"none"}');
    this.addPropertyByString('time:timer-clean', '{"siid":8,"piid":2,"type":"urn:dreame-spec:property:timer-clean:00000002:dreame-p2041o:1","description":"timer-clean","format":"string","access":["read","notify","write"],"unit":"none"}');
    this.addPropertyByString('time:timer-id', '{"siid":8,"piid":3,"type":"urn:dreame-spec:property:timer-id:00000003:dreame-p2041o:1","description":"","format":"string","access":[],"unit":"none"}');
    this.addPropertyByString('clean-logs:first-clean-time', '{"siid":12,"piid":1,"type":"urn:dreame-spec:property:first-clean-time:00000001:dreame-p2041o:1","description":"首次清扫的开始时间","format":"uint32","access":["read","notify"],"unit":"none","valueRange":[0,4294967295,1]}');
    this.addPropertyByString('clean-logs:total-clean-time', '{"siid":12,"piid":2,"type":"urn:dreame-spec:property:total-clean-time:00000002:dreame-p2041o:1","description":"总清扫时间","format":"uint32","access":["read","notify"],"unit":"minutes","valueRange":[0,4294967295,1]}');
    this.addPropertyByString('clean-logs:total-clean-times', '{"siid":12,"piid":3,"type":"urn:dreame-spec:property:total-clean-times:00000003:dreame-p2041o:1","description":"总清扫次数","format":"uint32","access":["read","notify"],"unit":"none","valueRange":[0,4294967295,1]}');
    this.addPropertyByString('clean-logs:total-clean-area', '{"siid":12,"piid":4,"type":"urn:dreame-spec:property:total-clean-area:00000004:dreame-p2041o:1","description":"总清扫面积","format":"uint32","access":["read","notify"],"unit":"none","valueRange":[0,4294967295,1]}');
    this.addPropertyByString('vslam-extend:save-map-status', '{"siid":13,"piid":1,"type":"urn:dreame-spec:property:save-map-status:00000001:dreame-p2041o:1","description":"save-map-status","format":"uint8","access":["read","notify","write"],"unit":"none","valueList":[{"value":0,"description":"关闭"},{"value":1,"description":"打开"}]}');
  }

  initDeviceActions() {
    this.addActionByString('vacuum:start-sweep', '{"siid":2,"aiid":1,"type":"urn:miot-spec-v2:action:start-sweep:00002804:dreame-p2041o:1","description":"Start Sweep","in":[],"out":[]}');
    this.addActionByString('vacuum:stop-sweeping', '{"siid":2,"aiid":2,"type":"urn:miot-spec-v2:action:stop-sweeping:00002805:dreame-p2041o:1","description":"Stop Sweeping","in":[],"out":[]}');
    this.addActionByString('battery:start-charge', '{"siid":3,"aiid":1,"type":"urn:miot-spec-v2:action:start-charge:00002802:dreame-p2041o:1","description":"Start Charge","in":[],"out":[]}');
    this.addActionByString('brush-cleaner:reset-brush-life', '{"siid":9,"aiid":1,"type":"urn:miot-spec-v2:action:reset-brush-life:00002830:dreame-p2041o:1","description":"Reset Brush Life","in":[],"out":[]}');
    this.addActionByString('brush-cleaner10:reset-brush-life', '{"siid":10,"aiid":1,"type":"urn:miot-spec-v2:action:reset-brush-life:00002830:dreame-p2041o:1","description":"Reset Brush Life","in":[],"out":[]}');
    this.addActionByString('filter:reset-filter-life', '{"siid":11,"aiid":1,"type":"urn:miot-spec-v2:action:reset-filter-life:00002803:dreame-p2041o:1","description":"Reset Filter Life","in":[],"out":[]}');
    this.addActionByString('vacuum-extend:start-clean', '{"siid":4,"aiid":1,"type":"urn:dreame-spec:action:start-clean:00002801:dreame-p2041o:1","description":"高级功能的清扫","in":[10],"out":[]}');
    this.addActionByString('vacuum-extend:stop-clean', '{"siid":4,"aiid":2,"type":"urn:dreame-spec:action:stop-clean:00002802:dreame-p2041o:1","description":"停止清扫（非暂停，停止清扫任务）","in":[],"out":[]}');
    this.addActionByString('map:map-req', '{"siid":6,"aiid":1,"type":"urn:dreame-spec:action:map-req:00002801:dreame-p2041o:1","description":"请求地图数据","in":[2],"out":[1,3,5]}');
    this.addActionByString('map:update-map', '{"siid":6,"aiid":2,"type":"urn:dreame-spec:action:update-map:00002802:dreame-p2041o:1","description":"更新地图信息","in":[4],"out":[6]}');
    this.addActionByString('audio:position', '{"siid":7,"aiid":1,"type":"urn:dreame-spec:action:position:00002801:dreame-p2041o:1","description":"定位我的机器人","in":[],"out":[]}');
    this.addActionByString('audio:play-sound', '{"siid":7,"aiid":2,"type":"urn:dreame-spec:action:play-sound:00002802:dreame-p2041o:1","description":"试听语音","in":[],"out":[]}');
    this.addActionByString('time:delete-timer', '{"siid":8,"aiid":1,"type":"urn:dreame-spec:action:delete-timer:00002801:dreame-p2041o:1","description":"delete-timer","in":[3],"out":[]}');
  }

  initDeviceEvents() {
    this.addEventByString('battery:low-battery', '{"siid":3,"eiid":1,"type":"urn:miot-spec-v2:event:low-battery:00005003:dreame-p2041o:1","description":"Low Battery","arguments":[]}');
    this.addEventByString('brush-cleaner:exception-occurred', '{"siid":9,"eiid":1,"type":"urn:miot-spec-v2:event:exception-occurred:00005011:dreame-p2041o:1","description":"Exception Occurred","arguments":[]}');
    this.addEventByString('brush-cleaner:exception-occurred2', '{"siid":9,"eiid":2,"type":"urn:miot-spec-v2:event:exception-occurred:00005011:dreame-p2041o:1","description":"Exception Occurred","arguments":[]}');
    this.addEventByString('brush-cleaner10:exception-occurred', '{"siid":10,"eiid":1,"type":"urn:miot-spec-v2:event:exception-occurred:00005011:dreame-p2041o:1","description":"Exception Occurred","arguments":[]}');
    this.addEventByString('brush-cleaner10:exception-occurred2', '{"siid":10,"eiid":2,"type":"urn:miot-spec-v2:event:exception-occurred:00005011:dreame-p2041o:1","description":"Exception Occurred","arguments":[]}');
    this.addEventByString('filter:exception-occurred', '{"siid":11,"eiid":1,"type":"urn:miot-spec-v2:event:exception-occurred:00005011:dreame-p2041o:1","description":"Exception Occurred","arguments":[]}');
    this.addEventByString('filter:exception-occurred2', '{"siid":11,"eiid":2,"type":"urn:miot-spec-v2:event:exception-occurred:00005011:dreame-p2041o:1","description":"Exception Occurred","arguments":[]}');
    this.addEventByString('vacuum-extend:cleanup-completed', '{"siid":4,"eiid":1,"type":"urn:dreame-spec:event:cleanup-completed:00005001:dreame-p2041o:1","description":"cleanup-completed","arguments":[1,2,3,4,5,6,8,9]}');
    this.addEventByString('vacuum-extend:finish-withwaternox', '{"siid":4,"eiid":2,"type":"urn:dreame-spec:event:finish-withwaternox:00005002:dreame-p2041o:1","description":"finish-withwaternox","arguments":[]}');
    this.addEventByString('vacuum-extend:finish-clean', '{"siid":4,"eiid":3,"type":"urn:dreame-spec:event:finish-clean:00005003:dreame-p2041o:1","description":"finish-clean","arguments":[]}');
  }


  /*----------========== VALUES OVERRIDES ==========----------*/

  statusSweepingValue() {
    return 1;
  }

  statusIdleValue() {
    return 2;
  }

  statusPausedValue() {
    return 3;
  }

  statusErrorValue() {
    return 4;
  }

  statusGoChargingValue() {
    return 5;
  }

  statusChargingValue() {
    return 6;
  }

  statusMoppingValue() {
    return 7;
  }


  /*----------========== PROPERTY OVERRIDES ==========----------*/


  /*----------========== ACTION OVERRIDES ==========----------*/


  /*----------========== OVERRIDES ==========----------*/


}

module.exports = DreameVacuumP2041o;