语言
Service tree
扫地机#2 · vacuum属性 11动作 8事件 1
扫地机
#2 · vacuum
Properties
工作状态
#1 · status
- 格式
- uint8
- 读写
- R / N
- 值
- 0睡眠1待机2暂停3回充中4充电中5扫地中6扫拖中7拖地中
故障
#2 · fault
- 格式
- uint32
- 读写
- R / N
- 值
- 0No Error1没电啦，充电去咯2低电关机3主轮子卡住了4碰撞卡住5机器倾斜6雷达遮挡7前方防撞传感器异常8沿墙传感器异常9中刷卡住10边刷卡住11风机异常12雷达外罩卡住13清理尘盒和滤网，或者检查尘盒和滤网是否放置到位14尘盒不见了15尘满需要清理取出尘盒16机器被困17机器被抱起20无法到达21禁区启动22擦拭悬崖传感器，并远离悬崖后启动23水泵异常24回充失败18水箱好像不见了25请安装拖布26电量不足，无法开始清扫19水量不足请加水
清扫方式
#11 · wdr-mode
- 格式
- uint8
- 读写
- R / W / N
- 值
- 0扫地1扫拖2单拖
箱子状态
#12 · door-state
- 格式
- uint8
- 读写
- R / N
- 值
- 0无1尘盒2水箱3二合一水箱
抹布状态
#13 · contact-state
- 格式
- uint8
- 读写
- R / N
- 值
- 0没装1装
清扫完成后全图对应url地址
#14 · stream-address
- 格式
- string
- 读写
- 值
- —
清扫时间，单位分钟，工作或暂停中代表本次清扫时间，其它状态则代表上次清扫时间
#15 · contact-state
- 格式
- uint16
- 读写
- R / N
- 值
- 0 ~ 999，步长 1
清扫面积，单位㎡，工作或暂停中代表本次清扫面积，其它状态则代表上次清扫面积
#16 · contact-state
- 格式
- uint16
- 读写
- R / N
- 值
- 0 ~ 1200，步长 1
0：语音关闭 ； 1~10：语音音量值大小
#17 · mute
- 格式
- uint8
- 读写
- R / W / N
- 值
- 0 ~ 10，步长 1
清扫模式
#4 · sweep-type
- 格式
- uint8
- 读写
- R / W / N
- 值
- 0全局清扫2沿边清扫3区域清扫4定点清扫5遥控器模式
吸力大小
#19 · mode
- 格式
- uint8
- 读写
- R / W / N
- 值
- 0安静/静音1标准2中档3强力
Actions
开始工作
#1 · start-sweep
停止工作
#2 · stop-sweeping
暂停工作
#3 · pause
开始回充
#4 · start-charge
停止回充
#5 · stop-massage
开始拖地
#6 · start-mop
开始单扫地
#7 · start-only-sweep
开始扫拖
#8 · start-sweep-mop
Events
设备异常事件
#2 · exception-occurred
触发参数
#2故障uint32
电池#3 · battery属性 1
电池
#3 · battery
Properties
电池电量
#1 · battery-level
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 100，步长 1
扫地机#4 · viomi-vacuum属性 33动作 4事件 5
扫地机
#4 · viomi-vacuum
Properties
二次清扫开关
#1 · repeat-state
- 格式
- uint8
- 读写
- R / W / N
- 值
- 0关1开
记忆地图开关
#3 · remember-state
- 格式
- uint8
- 读写
- W / N / R
- 值
- 0关1开
拖地/扫拖路线
#6 · mop-route
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0弓字形1Y字形
边刷剩余寿命百分比
#8 · side-brush-life
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 100，步长 1
边刷剩余寿命小时
#9 · side-brush-hours
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 180，步长 1
主刷剩余寿命百分比
#10 · main-brush-life
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 100，步长 1
主刷剩余寿命小时
#11 · main-brush-hours
- 格式
- uint16
- 读写
- R / N
- 值
- 0 ~ 360，步长 1
尘盒剩余寿命百分比
#12 · hypa-life
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 100，步长 1
尘盒剩余寿命小时
#13 · hypa-hours
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 180，步长 1
拖布剩余寿命百分比
#14 · mop-life
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 100，步长 1
拖布剩余寿命小时
#15 · mop-hours
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 180，步长 1
遥控器方法参数
#16 · direction
- 格式
- uint8
- 读写
- W
- 值
- 1向前2向左3向右4向后5停止
吸力大小
#17 · suction-grade
- 格式
- uint8
- 读写
- W / R / N
- 值
- 0安静1标准2中档3强力
出水量大小
#18 · water-grade
- 格式
- uint8
- 读写
- R / N / W
- 值
- 01挡12挡23挡
当前储存的地图数量
#23 · map-num
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 5，步长 1
设备时区属性
#24 · time-zone
- 格式
- int32
- 读写
- R / N / W
- 值
- -99999 ~ 99999，步长 1
清扫开始时间，时间戳，单位秒
#25 · clean-start-time
- 格式
- int64
- 读写
- R / N
- 值
- 0 ~ 9999999999，步长 1
清扫使用时间，单位秒
#26 · clean-use-time
- 格式
- uint32
- 读写
- R / N
- 值
- 0 ~ 99999，步长 1
清扫总面积，单位m2
#27 · clean-area
- 格式
- uint32
- 读写
- R / N
- 值
- 0 ~ 9999，步长 1
清扫地图url
#28 · clean-map-url
- 格式
- string
- 读写
- R / N
- 值
- —
清扫模式
#29 · clean-mode
- 格式
- uint8
- 读写
- R / N
- 值
- 0全局1沿边2区域3定点
清扫方式
#30 · clean-way
- 格式
- uint8
- 读写
- R / N
- 值
- 0扫地1扫拖2拖地
设备当前语言de en ru zh
#31 · cur-lang
- 格式
- string
- 读写
- R / N / W
- 值
- —
当前地图id
#32 · cur-map-id
- 格式
- uint32
- 读写
- R / N
- 值
- 0 ~ 2147483647，步长 1
当前完整的地图url
#33 · cur-map-url
- 格式
- string
- 读写
- R / N / W
- 值
- —
当前记忆地图最后更新的时间戳
#34 · last-update-time
- 格式
- int64
- 读写
- R / N
- 值
- 0 ~ 9999999999，步长 1
重置耗材方法参数
#35 · consumable-index
- 格式
- uint8
- 读写
- W
- 值
- 0边刷1主刷2尘盒3拖布
选房间清扫模式
#36 · clean-room-mode
- 格式
- uint8
- 读写
- W
- 值
- 0全局1沿边
选房间清扫操作
#37 · clean-room-oper
- 格式
- uint8
- 读写
- W
- 值
- 0停止1开始2暂停
选房间清扫时，传的房间id字符串参数，逗号分割，如：‘10,11,12,13’，若传空则是全局清扫
#38 · clean-room-ids
- 格式
- string
- 读写
- W
- 值
- —
是否有记忆地图
#39 · has-map
- 格式
- uint8
- 读写
- R / N
- 值
- 0没有记忆图1有记忆图
清扫完成后，机器是否识别到新的地图，0否 1是并创建新地图 2是并覆盖当前地图
#40 · has-newmap
- 格式
- uint8
- 读写
- R / N
- 值
- 0None1New2Cover
集尘开关
#41 · dust-collection
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0Close1Open
Actions
重置地图
#7 · reset-map
标定
#10 · set-calibration
重置指定耗材的使用时间
#11 · reset-consumable
入参
#35重置耗材方法参数uint8
选房间清扫
#13 · set-room-clean
入参
#36选房间清扫模式uint8#37选房间清扫操作uint8#38选房间清扫时，传的房间id字符串参数，逗号分割，如：‘10,11,12,13’，若传空则是全局清扫string
Events
拖布取下提示。当设备开始充电时，拖布未取下触发
#1 · mop-remind
待机时间超过6小时，推送并自动关机
#2 · wait-remind
低电关机，电量低于5%推送并自动关机
#3 · low-remind
清扫结束上报
#4 · clean-end
触发参数
#25清扫开始时间，时间戳，单位秒int64#26清扫使用时间，单位秒uint32#27清扫总面积，单位m2uint32#28清扫地图urlstring#29清扫模式uint8#30清扫方式uint8
清扫完成
#5 · upload-clean-record
预约、勿扰相关#5 · order属性 21动作 2
预约、勿扰相关
#5 · order
Properties
预约id
#1 · order-id
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 100，步长 1
是否开启该条预约
#2 · enable
- 格式
- uint8
- 读写
- W
- 值
- 0关1开
转换成二进制后，每一位代表一天，1 - 预约 0 - 无预约，bit0-bit6 星期日-星期六
#3 · day
- 格式
- uint16
- 读写
- W
- 值
- 0 ~ 256，步长 1
预约小时（24小时制）
#4 · hour
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 23，步长 1
预约分钟
#5 · minute
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 59，步长 1
是否重复
#6 · repeat
- 格式
- uint8
- 读写
- W
- 值
- 0不重复1重复
预约清扫方式
#8 · clean-way
- 格式
- uint8
- 读写
- W
- 值
- 0扫地1扫拖2拖地
预约吸力大小
#9 · suction
- 格式
- uint8
- 读写
- W
- 值
- 0安静1节能2标准3强劲
预约出水量大小
#10 · water
- 格式
- uint8
- 读写
- W
- 值
- 01挡12挡23挡
是否二次清扫
#11 · twice-clean
- 格式
- uint8
- 读写
- W
- 值
- 0关闭1打开
预约的地图id，若没地图则传0
#12 · mapid
- 格式
- uint32
- 读写
- W
- 值
- 0 ~ 99999999，步长 1
预约的房间数量
#13 · room-count
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 64，步长 1
预约的房间数据JSON字符串[{name:'房间1',id:10},{name:'房间2‘,id:11},{...},{...}...]
#14 · room-data
- 格式
- string
- 读写
- W
- 值
- —
勿扰是否打开
#15 · dnd-enable
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0关闭1打开
勿扰开始小时
#16 · dnd-start-hour
- 格式
- uint8
- 读写
- W / R / N
- 值
- 0 ~ 23，步长 1
勿扰开始分钟
#17 · dnd-start-minute
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0 ~ 59，步长 1
勿扰结束小时
#18 · dnd-end-hour
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0 ~ 23，步长 1
勿扰结束分钟
#19 · dnd-end-minute
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0 ~ 59，步长 1
时区参数
#20 · dnd-timezone
- 格式
- int32
- 读写
- R / N / W
- 值
- -99999 ~ 99999，步长 1
预约时区偏移
#21 · timestamp
- 格式
- int64
- 读写
- N / W / R
- 值
- -999999 ~ 999999，步长 1
N组预约数据逗号分割，每组数据内的具体数据用下划线_分割 {order_id}_{order_enable}_{week}_{hour}_{minute}_{repeat}_{mode}_{suction}_{water}_{twice}_{mapid}_{room_size}_{roomid}_{roomname}
#22 · orderdata
- 格式
- string
- 读写
- R / N
- 值
- —
Actions
删除一组预约
#2 · del
入参
#1预约iduint8
获取预约数据
#3 · get
出参
#22N组预约数据逗号分割，每组数据内的具体数据用下划线_分割 {order_id}_{order_enable}_{week}_{hour}_{minute}_{repeat}_{mode}_{suction}_{water}_{twice}_{mapid}_{room_size}_{roomid}_{roomname}string
指哪扫那 划区 虚拟墙#6 · point-zone属性 3动作 4
指哪扫那 划区 虚拟墙
#6 · point-zone
Properties
指哪扫那目标点，XY逗号分割，如’3.23,6.89‘
#1 · target-point
- 格式
- string
- 读写
- W / R / N
- 值
- —
划区的四个顶点坐标 'x1,y1,x2,y2,x3,y3,x4,y4'
#2 · zone-points
- 格式
- string
- 读写
- W
- 值
- —
虚拟墙JSON数据如[2,'2_2_-6.34_-3.6_-8.6_-10.23','3_3_2.33_1.33_4.23_3.44_2.44_6.77_1.22_3.44']，就是设置了2组虚拟墙坐标第1组id是2,类型值是2表示线段，两端坐标为(-6.34,-3.6)和(-8.6,-10.23)第2组id是3,类型值是3表示四边形，4个点按顺序依次相连并闭合，坐标为(2.33,1.33)(4.23,3.44)(2.44,6.77)(1.22,3.44)
#3 · restrict-points
- 格式
- string
- 读写
- W
- 值
- —
Actions
开始指哪扫那清扫
#1 · start-point-clean
暂停指哪扫那清扫
#2 · pause-point-clean
开始区域清扫
#5 · start-zone-clean
暂停区域清扫
#6 · pause-zone-clean
地图相关#7 · map属性 15动作 12
地图相关
#7 · map
Properties
上传的地图url类型
#1 · map-type
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0上传到url01上传到url12上传到url2
地图id
#2 · map-id
- 格式
- int64
- 读写
- R / N / W
- 值
- 0 ~ 9999999999，步长 1
地图名字
#4 · map-name
- 格式
- string
- 读写
- R / N / W
- 值
- —
语言参数
#5 · lang
- 格式
- string
- 读写
- W
- 值
- —
要合并的房间id参数，逗号分割，如：‘10,11,12’表示合并房间id为10,11,12的房间；
#6 · arrange-room-ids
- 格式
- string
- 读写
- W
- 值
- —
目标房间id
#7 · target-room-id
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 128，步长 1
分割线段的两个端点坐标，如：'3.45,6.78|4.56,-3.45'
#8 · split-points
- 格式
- string
- 读写
- W
- 值
- —
房间名称
#9 · room-name
- 格式
- string
- 读写
- W
- 值
- —
机器人当前清扫轨迹坐标 : {deg:0.02,posArray:[[14,23],[23,22],[23,21]......]}
#10 · cur-cleaning-path
- 格式
- string
- 读写
- R / N
- 值
- —
地图列表数据[{name : '地图1',id:1585849584,cur : true},{name : '地图2',id : 1585849784,cur : false}]
#11 · map-list
- 格式
- string
- 读写
- R / N
- 值
- —
历史路径最后一个点的序号
#12 · last-point-index
- 格式
- int32
- 读写
- 值
- 0 ~ 2147483647，步长 1
操作结果
#13 · oper-result
- 格式
- string
- 读写
- R / N
- 值
- —
自动分区id
#14 · auto-area-id
- 格式
- int64
- 读写
- R / N
- 值
- 0 ~ 9999999999，步长 1
根据obj_name获取到的地图的实际下载地址
#15 · map-download-url
- 格式
- string
- 读写
- 值
- —
0放弃 1新增 2覆盖
#16 · new-map-oper
- 格式
- uint8
- 读写
- 值
- 0 ~ 2，步长 1
Actions
上传指定类型的地图
#1 · upload-by-maptype
设置机器主动上传指定id的地图到指定url
#2 · upload-by-mapid
设置当前地图
#3 · set-cur-map
入参
#2地图idint64#15根据obj_name获取到的地图的实际下载地址string
删除指定id的地图
#5 · del-map
入参
#2地图idint64
重命名地图
#7 · rename-map
入参
#2地图idint64#4地图名字string
合并房间
#8 · arrange-room
入参
#2地图idint64#5语言参数string#6要合并的房间id参数，逗号分割，如：‘10,11,12’表示合并房间id为10,11,12的房间；string#14自动分区idint64
出参
#13操作结果string
分割房间
#9 · split-room
入参
#2地图idint64#5语言参数string#7目标房间iduint8#8分割线段的两个端点坐标，如：'3.45,6.78|4.56,-3.45'string#14自动分区idint64
房间重命名
#10 · rename-room
入参
#2地图idint64#7目标房间iduint8#9房间名称string#14自动分区idint64
获取地图列表数据
#11 · get-map-list
出参
#11地图列表数据[{name : '地图1',id:1585849584,cur : true},{name : '地图2',id : 1585849784,cur : false}]string
获取实时清扫路径
#12 · get-cleaning-path
入参
#12历史路径最后一个点的序号int32
出参
#10机器人当前清扫轨迹坐标 : {deg:0.02,posArray:[[14,23],[23,22],[23,21]......]}string
设备执行该action后，紧跟着的一次完整清扫会新增一张地图。如果这次清扫被中断了，之后再开始新的清扫则不会新建地图，而是覆盖地图。
#13 · set-new-map
0放弃 1新增 2覆盖
#14 · deal-new-map
入参
#160放弃 1新增 2覆盖uint8
声音相关#8 · voice属性 6动作 3
声音相关
#8 · voice
Properties
当前下载的语音包名字
#3 · target-voice
- 格式
- string
- 读写
- N / W / R
- 值
- —
当前在用的语音包名字
#4 · cur-voice
- 格式
- string
- 读写
- R / N
- 值
- —
下载状态
#5 · download-status
- 格式
- uint8
- 读写
- R / N
- 值
- 0121213141516171819202122
下载进度
#6 · download-progress
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 100，步长 1
要下载的语音包链接
#7 · voice-url
- 格式
- string
- 读写
- W
- 值
- —
要狭隘的语音包md5值
#8 · voice-mdfive
- 格式
- string
- 读写
- W
- 值
- —
Actions
寻找扫地机
#2 · find-device
开始下载语音包
#3 · download-voice
入参
#3当前下载的语音包名字string#7要下载的语音包链接string#8要狭隘的语音包md5值string
获取语音包文件下载状态
#4 · get-downloadstatus
出参
#6下载进度uint8#3当前下载的语音包名字string#4当前在用的语音包名字string#5下载状态uint8