MIOT
语言
Service tree
扫地机#2 · vacuum属性 6动作 6
扫地机
#2 · vacuum
Properties
工作状态
#1 · status
- 格式
- uint8
- 读写
- R / N
- 值
- 0睡眠1待机2暂停3回充中4充电中5扫地中6扫拖中7拖地中8升级中
故障
#2 · fault
- 格式
- uint32
- 读写
- R / N
- 值
- 0 ~ 3000,步长 1
模式
#4 · mode
- 格式
- uint8
- 读写
- R / W / N
- 值
- 0扫地1扫拖2拖地
清扫方式
#8 · sweep-type
- 格式
- uint8
- 读写
- R / W / N
- 值
- 0全局1拖地2沿边3区域4定点5遥控6建图7房间定制8地板定制
第一位 1 使用读取指定编号区间的轨迹点
第二位 1 使用 fds 传输预约信息
第三位 1 新建地图完成标志
第四位 1 获取地图方法
第五位 1 使用新的拉图接口,和原来的区别为:返回参数增加一个是否更新图参数 --- 20201112 添加
第六位 1 使用新的重置地图和新建图接口 --- 20201121 添加
第七位 1 使用数组 get 属性 --- 20201130 添加
第八位 1 使用新的多个房间材质设置接口 --- 20201217 添加
第九位 1 设置定制增加选中参数 --- 20210108 添加
[1,1,"on",101,"3.5.3_0010"]
#9 · on
- 格式
- string
- 读写
- R / W / N
- 值
- —
米家房间id参数
#10 · room-ids
- 格式
- string
- 读写
- 值
- —
Actions
开始清扫
#1 · start-sweep
停止
#2 · stop-sweeping
开始单扫地
#3 · start-only-sweep
开始扫拖
#5 · start-sweep-mop
开始拖地
#6 · start-mop
打扫房间
#7 · start-room-sweep
入参
#10米家房间id参数string
电池#3 · battery属性 1动作 1事件 1
电池
#3 · battery
Properties
电池电量
#1 · battery-level
- 格式
- int8
- 读写
- R / N
- 值
- -1 ~ 100,步长 1
Actions
开始回充
#1 · start-charge
Events
电量低(15%电量时上报)
#1 · low-battery
提示音#4 · alarm属性 2
提示音
#4 · alarm
Properties
提示音,寻找机器人
#1 · alarm
- 格式
- uint8
- 读写
- R / W / N
- 值
- 1播放
音量
#2 · volume
- 格式
- uint8
- 读写
- R / W / N
- 值
- 0 ~ 10,步长 1
清扫#7 · sweep属性 45动作 10事件 3
清扫
#7 · sweep
Properties
二次清扫开关
#1 · repeat-state
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0关1开
箱子状态
#3 · door-state
- 格式
- uint8
- 读写
- R / N
- 值
- 0无1尘盒2水箱3二合一水箱
抹布状态
#4 · cloth-state
- 格式
- uint8
- 读写
- R / N
- 值
- 0没装1装了
吸力大小
#5 · suction-state
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0关1节能2标准3强劲
水量大小
#6 · water-state
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0低1中2高
拖地/扫拖路线
#7 · 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停止10退出模式
重置耗材方法参数
#17 · consumable-index
- 格式
- uint8
- 读写
- 值
- 1主刷2边刷3滤网4拖布
时区属性
#20 · time-zone
- 格式
- int32
- 读写
- R / N / W
- 值
- -99999 ~ 99999,步长 1
地图语言属性: de, en, zh_hk, th, ...
#21 · cur-lang
- 格式
- string
- 读写
- R / N / W
- 值
- —
清扫中累计运行时长 min
设备工作或暂停表示当前时长,其他状态表示上一次时长
#22 · cleaning-time
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 120,步长 1
清扫中当前累计面积 ㎡
设备工作或暂停表示当前面积,其他状态表示上一次面积
#23 · cleaning-area
- 格式
- uint16
- 读写
- R / N
- 值
- 0 ~ 1200,步长 1
选房间清扫时,传的房间 id 字符串参数,逗号分割,如:‘10,11,12,13’,若传空则是全局清扫
#24 · clean-room-ids
- 格式
- string
- 读写
- 值
- —
选房间清扫模式
#25 · clean-room-mode
- 格式
- uint8
- 读写
- 值
- 0全局1沿边
选房间清扫操作
#26 · clean-room-oper
- 格式
- uint8
- 读写
- 值
- 0停止1开始2暂停3假暂停
清扫开始时间,时间戳,单位秒
#27 · record-start-time
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
清扫使用时间,单位秒
#28 · record-use-time
- 格式
- uint32
- 读写
- 值
- 0 ~ 99999,步长 1
清扫总面积 ㎡
#29 · record-clean-area
- 格式
- uint32
- 读写
- 值
- 0 ~ 99999,步长 1
清扫地图 url
#30 · record-map-url
- 格式
- string
- 读写
- 值
- —
清扫模式
20201121 确认
#31 · record-clean-mode
- 格式
- uint8
- 读写
- 值
- 0Auto1Mopping2Corner3Local4Point5Explore6Room7Material
清扫方式
#32 · record-clean-way
- 格式
- uint8
- 读写
- 值
- 0扫地1扫拖2单拖
清扫指定 mapid
#33 · clean-current-map
- 格式
- uint32
- 读写
- 值
- 1 ~ 4294967295,步长 1
各房间清扫偏好 ['xx_xx_xx',' xx_xx_xx']
全局清扫则要把全部房间设成相同偏好
N组偏好逗号分割,下划线_分割
第一位定制类型: 1 房间定制 2 地板定制
第二位材质 id 或房间 id
{prefer_type}_{id}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{choose}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
choose: 0 该房间没被选中 1 该房间选中 --- 20210108 增加
#34 · clean-preference
- 格式
- string
- 读写
- 值
- —
脏污识别开关
#35 · dirt-recognize
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0关1开
宠物识别开关
#36 · pet-recognize
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0关1开
清扫记录设备状况
#37 · record-task-status
- 格式
- uint32
- 读写
- 值
- 1正常结束2app 停止3按键停止4异常5xx
定制清扫类型
#38 · clean-prefer-type
- 格式
- uint8
- 读写
- 值
- 1房间定制2地板材质定制0自动清扫
定制方案启用情况
#39 · clean-prefer-on
- 格式
- uint8
- 读写
- 值
- 0关1开
地板清扫偏好 ['xx_xx_xx',' xx_xx_xx'] 全局清扫则要把全部房间设成相同偏好 N组偏好逗号分割,下划线_分割 第一位定制类型: 1 房间定制 2 地板定制 第二位材质 id 或房间 id {prefer_type}_{id}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{choose}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
choose: 默认 0,为了与房间定制的参数对齐 --- 20210108 增加
#40 · clean-preference-ii
- 格式
- string
- 读写
- 值
- —
地板定制方案启用情况
#41 · clean-prefer-on-ii
- 格式
- uint8
- 读写
- 值
- 0关闭1开启
AI 识别开关
AI 识别开关关闭:脏污识别开关、宠物识别开关自动关闭
AI 识别开关打开:脏污识别开关、宠物识别开关读取上次启动值
#42 · ai-recognize
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0关1开
回充
#43 · go-charging
- 格式
- uint8
- 读写
- 值
- 0停止回充1开始回充
全局地毯增压开关
#44 · carpet-booster
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0关闭1开启
siid7 多参数数组
"[1,0,1,...]"
二次清扫1,
箱子状态3,
抹布状态4,
吸力5,
水量6,
扫拖路线7,
时区20,
清扫用时22,
清扫面积23,
脏污识别35,
宠物识别36,
ai开关42,
地毯增压44 --- 20201130
定制类型 38 --- 20201211
语言 21 --- 20201218
地毯避让 47 --- 20210120
sn --- 20210127
上次清扫模式 31 --- 20210223
是否自动切换成扫地 --- 20210301
#45 · multi-prop-vacuum
- 格式
- string
- 读写
- R / N
- 值
- —
地毯避让开关 --- 20210120 添加
#47 · carpet-avoid
- 格式
- uint8
- 读写
- W
- 值
- 0Close1Open
震动水箱开关
#48 · tank-shake
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0Close1Open
电解水开关
#49 · electrolysis
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0Close1Open
Actions
重置指定耗材的使用时间
#1 · reset-consumable
入参
#17重置耗材方法参数uint8
设备标定
#2 · set-calibration
选房间清扫,不传房间 id 则为全局清扫
#3 · set-room-clean
入参
#24选房间清扫时,传的房间 id 字符串参数,逗号分割,如:‘10,11,12,13’,若传空则是全局清扫string#25选房间清扫模式uint8#26选房间清扫操作uint8
设置定制方案
#4 · set-preference-clean
入参
#34各房间清扫偏好 ['xx_xx_xx',' xx_xx_xx']
全局清扫则要把全部房间设成相同偏好
N组偏好逗号分割,下划线_分割
第一位定制类型: 1 房间定制 2 地板定制
第二位材质 id 或房间 id
{prefer_type}_{id}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{choose}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
choose: 0 该房间没被选中 1 该房间选中 --- 20210108 增加string#33清扫指定 mapiduint32
获取偏好
{
房间定制方案
房间定制开关
地板定制方案
地板定制开关
}
#5 · get-preference-clean
入参
#33清扫指定 mapiduint32
出参
#34各房间清扫偏好 ['xx_xx_xx',' xx_xx_xx']
全局清扫则要把全部房间设成相同偏好
N组偏好逗号分割,下划线_分割
第一位定制类型: 1 房间定制 2 地板定制
第二位材质 id 或房间 id
{prefer_type}_{id}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{choose}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
choose: 0 该房间没被选中 1 该房间选中 --- 20210108 增加string#39定制方案启用情况uint8#40地板清扫偏好 ['xx_xx_xx',' xx_xx_xx'] 全局清扫则要把全部房间设成相同偏好 N组偏好逗号分割,下划线_分割 第一位定制类型: 1 房间定制 2 地板定制 第二位材质 id 或房间 id {prefer_type}_{id}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{choose}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
choose: 默认 0,为了与房间定制的参数对齐 --- 20210108 增加
string#41地板定制方案启用情况uint8
设置清扫启动方案
自动清扫/房间定制清扫/地板定制清扫
#6 · set-preference-type
入参
#38定制清扫类型uint8
回充控制
#7 · set-go-charging
入参
#43回充uint8
删除定制内容
ids 为空串时,即为清空该类型的全部定制内容
#8 · erase-preference
入参
#24选房间清扫时,传的房间 id 字符串参数,逗号分割,如:‘10,11,12,13’,若传空则是全局清扫string#33清扫指定 mapiduint32#38定制清扫类型uint8
设置定制方案,带选中信息 --- 20210108 添加
#9 · set-preference-ii
入参
#34各房间清扫偏好 ['xx_xx_xx',' xx_xx_xx']
全局清扫则要把全部房间设成相同偏好
N组偏好逗号分割,下划线_分割
第一位定制类型: 1 房间定制 2 地板定制
第二位材质 id 或房间 id
{prefer_type}_{id}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{choose}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
choose: 0 该房间没被选中 1 该房间选中 --- 20210108 增加string#33清扫指定 mapiduint32
新获取偏好接口,包括选中参数 --- 20210108 添加
#10 · get-preference-ii
入参
#33清扫指定 mapiduint32
出参
#34各房间清扫偏好 ['xx_xx_xx',' xx_xx_xx']
全局清扫则要把全部房间设成相同偏好
N组偏好逗号分割,下划线_分割
第一位定制类型: 1 房间定制 2 地板定制
第二位材质 id 或房间 id
{prefer_type}_{id}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{choose}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
choose: 0 该房间没被选中 1 该房间选中 --- 20210108 增加string#39定制方案启用情况uint8#40地板清扫偏好 ['xx_xx_xx',' xx_xx_xx'] 全局清扫则要把全部房间设成相同偏好 N组偏好逗号分割,下划线_分割 第一位定制类型: 1 房间定制 2 地板定制 第二位材质 id 或房间 id {prefer_type}_{id}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{choose}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
choose: 默认 0,为了与房间定制的参数对齐 --- 20210108 增加
string#41地板定制方案启用情况uint8
Events
清扫记录上报
#1 · clean-end
触发参数
#27清扫开始时间,时间戳,单位秒uint32#28清扫使用时间,单位秒uint32#29清扫总面积 ㎡uint32#30清扫地图 urlstring#31清扫模式
20201121 确认uint8#32清扫方式
uint8#33清扫指定 mapiduint32#34各房间清扫偏好 ['xx_xx_xx',' xx_xx_xx']
全局清扫则要把全部房间设成相同偏好
N组偏好逗号分割,下划线_分割
第一位定制类型: 1 房间定制 2 地板定制
第二位材质 id 或房间 id
{prefer_type}_{id}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{choose}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
choose: 0 该房间没被选中 1 该房间选中 --- 20210108 增加string#37清扫记录设备状况
uint32
清扫记录上报精简版
#2 · clean-end-lite
建图完成
#3 · build-end-lite
预约#8 · order属性 19动作 5
预约
#8 · order
Properties
预约 id
#1 · order-id
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 100,步长 1
是否开启该条预约
#2 · enable
- 格式
- uint8
- 读写
- W
- 值
- 0否1是
转换成二进制后,每一位代表一天,1 - 预约 0 - 无预约,bit0-bit6 星期日-星期六
#3 · day
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 255,步长 1
预约小时(24小时制)
#4 · hour
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 23,步长 1
预约分钟
#5 · minute
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 59,步长 1
重复任务
#6 · repeat
- 格式
- uint8
- 读写
- W
- 值
- 0单次任务1重复任务
清扫方式
#7 · clean-way
- 格式
- uint8
- 读写
- W
- 值
- 0扫地1扫拖2单拖
吸力大小
#8 · suction
- 格式
- uint8
- 读写
- W
- 值
- 0关1节能2标准3强劲
水量大小
#9 · water
- 格式
- uint8
- 读写
- W
- 值
- 0低水量1中水量2高水量
二次清扫
#10 · twice-clean
- 格式
- uint8
- 读写
- W
- 值
- 0否1是
选择的地图 id,如没有地图则传 0
#11 · mapid
- 格式
- uint32
- 读写
- W
- 值
- 0 ~ 4294967295,步长 1
预约的房间数量
#12 · room-count
- 格式
- uint8
- 读写
- W
- 值
- 0 ~ 64,步长 1
room-count 为 0 时不需要;预约的房间数据 JSON 字符串 [{name:'房间1',id:10},{name:'房间2‘,id:11},{...},{...}]
#13 · room-data
- 格式
- string
- 读写
- W
- 值
- —
当地时区(get 中不回传该参数)
#14 · time-zone
- 格式
- int32
- 读写
- W
- 值
- -43200 ~ 43200,步长 1
N组预约数据逗号分割,每组数据内的具体数据用下划线_分割 "xx_xx_xx_xx_[\"xx_xx_xx\"]_[\"xx_xx_xx\"]"
增加 is_global 字段 1106
{order_id}_{order_enable}_{week}_{hour}_{minute}_{repeat}_{mapid}_{prefer_type}_{is_global}_{perfre_size}_[{room_id} _{room_name}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}]
#15 · orderdata
- 格式
- string
- 读写
- 值
- —
各房间清扫偏好 ['xx_xx_xx',' xx_xx_xx']
全局清扫则要把全部房间设成相同偏好
N组偏好逗号分割,下划线_分割 {room_id}_{room_name}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{metrial_id}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
metrial_id: 0=无材质 其他为各材质类型
#16 · room-preference
- 格式
- string
- 读写
- 值
- —
定制类型
#17 · prefer-type
- 格式
- uint8
- 读写
- 值
- 0Empty1Room-preference2Material-preference
预约的总个数,预约开启的个数
"[10,6]"
#18 · all-enable-count
- 格式
- string
- 读写
- R / N
- 值
- —
是否为全局清扫
1106添加
#19 · is-global
- 格式
- uint8
- 读写
- 值
- 0Area1Global
Actions
新建一条预约,全局预约房间数量选全部,偏好也要设好
#1 · add
入参
#1预约 iduint8#2是否开启该条预约uint8#3转换成二进制后,每一位代表一天,1 - 预约 0 - 无预约,bit0-bit6 星期日-星期六
uint8#4预约小时(24小时制)uint8#5预约分钟uint8#6重复任务uint8#11选择的地图 id,如没有地图则传 0uint32#14当地时区(get 中不回传该参数)int32#12预约的房间数量uint8#16各房间清扫偏好 ['xx_xx_xx',' xx_xx_xx']
全局清扫则要把全部房间设成相同偏好
N组偏好逗号分割,下划线_分割 {room_id}_{room_name}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{metrial_id}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
metrial_id: 0=无材质 其他为各材质类型string
删除指定预约
#2 · del
入参
#1预约 iduint8
获取全部预约
#3 · get
出参
#15N组预约数据逗号分割,每组数据内的具体数据用下划线_分割 "xx_xx_xx_xx_[\"xx_xx_xx\"]_[\"xx_xx_xx\"]"
增加 is_global 字段 1106
{order_id}_{order_enable}_{week}_{hour}_{minute}_{repeat}_{mapid}_{prefer_type}_{is_global}_{perfre_size}_[{room_id} _{room_name}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}]string
新建一条预约,全局预约房间数量选全部,偏好也要设好
这里增加一个参数用于区分是地板定制预约还是房间定制预约
#4 · add-ii
入参
#1预约 iduint8#2是否开启该条预约uint8#3转换成二进制后,每一位代表一天,1 - 预约 0 - 无预约,bit0-bit6 星期日-星期六
uint8#4预约小时(24小时制)uint8#5预约分钟uint8#6重复任务uint8#11选择的地图 id,如没有地图则传 0uint32#12预约的房间数量uint8#14当地时区(get 中不回传该参数)int32#16各房间清扫偏好 ['xx_xx_xx',' xx_xx_xx']
全局清扫则要把全部房间设成相同偏好
N组偏好逗号分割,下划线_分割 {room_id}_{room_name}_{clean_mode}_{wind_power}_{water_level}_{twice_clean}_{carpet}_{metrial_id}
carpet: 0 代表没有设置(跟随全局) 1 设置为开(自动增压开) 2 设置为关(自动增压关)
metrial_id: 0=无材质 其他为各材质类型string#17定制类型uint8#19是否为全局清扫
1106添加uint8
获取指定地图的预约总数和开启个数
#5 · get-map-order-count
入参
#11选择的地图 id,如没有地图则传 0uint32
出参
#18预约的总个数,预约开启的个数
"[10,6]"string
指哪扫哪 划区 虚拟墙#9 · point-zone属性 8动作 8
指哪扫哪 划区 虚拟墙
#9 · point-zone
Properties
划区的四个顶点坐标 'x1,y1,x2,y2,x3,y3,x4,y4'
#2 · zone-points
- 格式
- string
- 读写
- W
- 值
- —
设置虚拟墙坐标
[3,
"1_1_2.34_3.6_8.6_10.23",
"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"]
三组虚拟墙数据
第一组 id 1,类型 1 矩形,左上角点(2.34,3.6),右下角点(8.6,10.23)
第二组 id 2,类型 2 线段,两点 (-6.34,-3.6)和(-8.6,-10.23)
第三组 id 3,类型 3 四边形,四个点闭合:(2.33,1.33)(4.23,3.44)(2.44,6.77)(1.22,3.44)
#3 · restrict-points
- 格式
- string
- 读写
- W
- 值
- —
暂停类型
#4 · pause-type
- 格式
- uint8
- 读写
- 值
- 0暂停1假暂停(启动不需要重定位)
指哪扫那目标点,XY逗号分割,如’3.23,6.89‘
#5 · target-point
- 格式
- string
- 读写
- R / N / W
- 值
- —
墙体编辑坐标,两个点或三个点,逗号隔开,‘x1,y1,x2,y2,x3,y3’
#6 · beauty-point
- 格式
- string
- 读写
- 值
- —
地图 id
#7 · map-id
- 格式
- uint32
- 读写
- 值
- 1 ~ 4294967295,步长 1
地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图
#8 · map-type
- 格式
- uint8
- 读写
- 值
- 00112233
时间戳
#9 · timestamp
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
Actions
开始指哪扫哪清扫
#1 · start-point-clean
暂停指哪扫哪清扫
#2 · pause-point-clean
入参
#4暂停类型uint8
开始区域清扫
#3 · start-zone-clean
暂停区域清扫
#4 · pause-zone-clean
入参
#4暂停类型uint8
地图美化,墙体编辑
#5 · set-beauty-wall
入参
#6墙体编辑坐标,两个点或三个点,逗号隔开,‘x1,y1,x2,y2,x3,y3’string
出参
#7地图 iduint32#8地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图uint8#9时间戳uint32
设置虚拟墙坐标 [3, "1_1_2.34_3.6_8.6_10.23", "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"] 三组虚拟墙数据 第一组 id 1,类型 1 矩形,左上角点(2.34,3.6),右下角点(8.6,10.23) 第二组 id 2,类型 2 线段,两点
(-6.34,-3.6)和(-8.6,-10.23) 第三组 id 3,类型 3 四边形,四个点闭合:(2.33,1.33)(4.23,3.44)(2.44,6.77)(1.22,3.44)
#6 · set-virtual-wall
入参
#3设置虚拟墙坐标
[3,
"1_1_2.34_3.6_8.6_10.23",
"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"]
三组虚拟墙数据
第一组 id 1,类型 1 矩形,左上角点(2.34,3.6),右下角点(8.6,10.23)
第二组 id 2,类型 2 线段,两点 (-6.34,-3.6)和(-8.6,-10.23)
第三组 id 3,类型 3 四边形,四个点闭合:(2.33,1.33)(4.23,3.44)(2.44,6.77)(1.22,3.44)string
出参
#7地图 iduint32#8地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图uint8#9时间戳uint32
设置划区点
划区的四个顶点坐标 'x1,y1,x2,y2,x3,y3,x4,y4'
#8 · set-zone-point
入参
#2划区的四个顶点坐标 'x1,y1,x2,y2,x3,y3,x4,y4'string
出参
#7地图 iduint32#8地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图uint8#9时间戳uint32
开始指哪清扫
带点开始
#9 · start-point-clean-ii
入参
#5指哪扫那目标点,XY逗号分割,如’3.23,6.89‘string
出参
#7地图 iduint32#8地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图uint8#9时间戳uint32
地图相关#10 · map属性 22动作 18事件 7
地图相关
#10 · map
Properties
记忆地图开关
#1 · remember-state
- 格式
- uint8
- 读写
- R / N / W
- 值
- 0关1开
当前地图 id
#2 · cur-map-id
- 格式
- uint32
- 读写
- R / N
- 值
- 0 ~ 4294967295,步长 1
当前储存的地图数量
#3 · map-num
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 5,步长 1
地图列表数据,地图名称+地图 id+是否为当前地图
[{name : '地图1',id:1585849584,cur : true},{name : '地图2',id : 1585849784,cur : false}]
#4 · map-list
- 格式
- string
- 读写
- 值
- —
机器人清扫轨迹坐标 : [123,3.456,4.555,0.2,1, ...]
[first_poseid, x, y, phi, update, ...]
#5 · cur-cleaning-path
- 格式
- string
- 读写
- R / N
- 值
- —
地图 id
#6 · upload-id
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
通过类型获取对应记忆图
#7 · upload-type
- 格式
- uint8
- 读写
- 值
- 0实时图1指哪图2划区图3记忆图
地图名字
#8 · map-name
- 格式
- string
- 读写
- 值
- —
房间 id
#9 · room-id
- 格式
- uint8
- 读写
- 值
- 0 ~ 255,步长 1
房间名称
#10 · room-name
- 格式
- string
- 读写
- 值
- —
要合并的房间 id 参数,逗号分割
如:'10,11,12' 表示合并房间 id 为 10,11,12 的房间;
#11 · arrange-room-ids
- 格式
- string
- 读写
- 值
- —
分割线段的两个端点坐标
如:'3.45,6.78|4.56,-3.45'
#12 · split-points
- 格式
- string
- 读写
- 值
- —
语言参数: de, en, zh_hk, th, ...
分割合并后自动生成对应语言的房间名称
#13 · lang
- 格式
- string
- 读写
- 值
- —
新建地图方式
#14 · build-map
- 格式
- uint8
- 读写
- R / N
- 值
- 0不新建图(不写)1只建图不清扫2建图+清扫(暂时无效)
待获取的起始位置点
#15 · start-cleaning-point
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
待获取的结束位置点
#16 · end-cleaning-point
- 格式
- uint32
- 读写
- 值
- 1 ~ 4294967295,步长 1
房间 id 和名称的集合
[{id:10,name:'房间1'},{id:11,name:'房间2'}]
#17 · room-id-name-list
- 格式
- string
- 读写
- 值
- —
时间戳
#18 · timestamp
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
设备清扫结束保存了一张新图
待保存或待重命名
#19 · has-new-map
- 格式
- uint8
- 读写
- R / N
- 值
- 0Without Map To Save1Wait To Rename Map
上传地图成功
#20 · test-for-upload-map
- 格式
- uint8
- 读写
- 值
- 1RealMap2MemoryMap
是否更新新的地图
0 不更新 1 更新
20201110
#21 · renew-map
- 格式
- uint8
- 读写
- 值
- 0False1True
米家房间 id 和设备房间 id 对应表
[
[mijia_room_id1, device_room_id1_1, device_room_id1_2],
[mijia_room_id2, device_room_id2_1, device_room_id2_2],
[mijia_room_id3, device_room_id3],
...}
例:
[
[340001249787,10,12],
[340001249487,11,17],
[340001248861,13]
] --- 20210222 添加
#22 · mijia-room-list
- 格式
- string
- 读写
- 值
- —
Actions
获取地图列表数据
#1 · get-map-list
出参
#4地图列表数据,地图名称+地图 id+是否为当前地图
[{name : '地图1',id:1585849584,cur : true},{name : '地图2',id : 1585849784,cur : false}]string
获取指定 id 的地图
#2 · upload-by-mapid
入参
#6地图 iduint32
出参
#6地图 iduint32#7通过类型获取对应记忆图uint8#18时间戳uint32
设置为当前地图
#3 · set-cur-map
入参
#6地图 iduint32
删除指定 id 的地图
#4 · del-map
入参
#6地图 iduint32
重命名地图
#5 · rename-map
入参
#6地图 iduint32#8地图名字string
上传指定类型的地图
#6 · upload-by-maptype
入参
#7通过类型获取对应记忆图uint8
出参
#6地图 iduint32#7通过类型获取对应记忆图uint8#18时间戳uint32
房间重命名
#7 · rename-room
入参
#6地图 iduint32#9房间 iduint8#10房间名称string
出参
#6地图 iduint32#7通过类型获取对应记忆图uint8#18时间戳uint32
合并房间
#8 · arrange-room
入参
#6地图 iduint32#11要合并的房间 id 参数,逗号分割
如:'10,11,12' 表示合并房间 id 为 10,11,12 的房间;string#13语言参数: de, en, zh_hk, th, ...
分割合并后自动生成对应语言的房间名称string
出参
#6地图 iduint32#7通过类型获取对应记忆图uint8#18时间戳uint32
分割房间
#9 · split-room
入参
#6地图 iduint32#9房间 iduint8#12分割线段的两个端点坐标
如:'3.45,6.78|4.56,-3.45'string#13语言参数: de, en, zh_hk, th, ...
分割合并后自动生成对应语言的房间名称string
出参
#6地图 iduint32#7通过类型获取对应记忆图uint8#18时间戳uint32
清除已有所有地图
#10 · reset-map
新建地图,下次清扫完成的地图为新地图
#11 · build-new-map
入参
#14新建地图方式uint8
获取清扫轨迹
#12 · get-cur-path
入参
#15待获取的起始位置点uint32#16待获取的结束位置点uint32
出参
#5机器人清扫轨迹坐标 : [123,3.456,4.555,0.2,1, ...]
[first_poseid, x, y, phi, update, ...]string
获取指定地图的全部房间信息:id 和房间名称
#13 · get-map-room-list
入参
#2当前地图 iduint32
出参
#17房间 id 和名称的集合
[{id:10,name:'房间1'},{id:11,name:'房间2'}]string
上传指定 id 的地图
和 a2 的区别是:回复中包含是否需要上传新图的参数
20201110
#14 · upload-by-mapid-ii
入参
#6地图 iduint32
出参
#6地图 iduint32#7通过类型获取对应记忆图uint8#18时间戳uint32#21是否更新新的地图
0 不更新 1 更新
20201110uint8
上传指定类型的地图
0 实时图 1 指哪图 2 划区图 3 记忆图
和 a6 的区别是:回复中包含是否需要上传新图的参数
20201110
#15 · upload-by-maptype-ii
入参
#7通过类型获取对应记忆图uint8
出参
#6地图 iduint32#7通过类型获取对应记忆图uint8#18时间戳uint32#21是否更新新的地图
0 不更新 1 更新
20201110uint8
清除已有所有地图,推送新地图时间戳 20201121
#16 · reset-map-ii
出参
#18时间戳uint32
新建地图,下次清扫完成的地图为新地图,回复时间戳 20201121
#17 · build-map-ii
入参
#14新建地图方式uint8
出参
#18时间戳uint32
发送匹配好的米家房间-设备房间列表到设备端,用于小爱语控 --- 20210222 添加
#18 · set-mijia-room-list
入参
#6地图 iduint32#22米家房间 id 和设备房间 id 对应表
[
[mijia_room_id1, device_room_id1_1, device_room_id1_2],
[mijia_room_id2, device_room_id2_1, device_room_id2_2],
[mijia_room_id3, device_room_id3],
...}
例:
[
[340001249787,10,12],
[340001249487,11,17],
[340001248861,13]
] --- 20210222 添加
string
Events
分割合并房间以后推送,提醒用户预约房间发生变化,地图变更
#1 · map-change
触发参数
#2当前地图 iduint32
推送实时图后上报消息
#2 · global-push
分割合并房间/墙体美化成功后上报消息
墙体美化结果
0:一键撤销成功;
1:吸附失败;
2:美化区域过小;
3:成功(包括美化、拆分、合并);
4: 房间过小
1000:超时
#3 · arrange-end
触发参数
#2当前地图 iduint32
拉图的校验数据
#4 · upload-verify
触发参数
#6地图 iduint32#7通过类型获取对应记忆图uint8#18时间戳uint32
cur-cleaning-path
#5 · cleaning-path
触发参数
#5机器人清扫轨迹坐标 : [123,3.456,4.555,0.2,1, ...]
[first_poseid, x, y, phi, update, ...]string
上传地图成功
#6 · test-upload-map
触发参数
#20上传地图成功uint8#18时间戳uint32
回充成功 5 分钟清除地图路径 20201118
#7 · clear-path
安防相关#11 · security
安防相关
#11 · security
勿扰相关#12 · disturb属性 7动作 1
勿扰相关
#12 · disturb
Properties
勿扰是否打开
#1 · dnd-enable
- 格式
- uint8
- 读写
- R / N
- 值
- 0关1开
勿扰开始小时
#2 · dnd-start-hour
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 23,步长 1
勿扰开始分钟
#3 · dnd-start-minute
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 59,步长 1
勿扰结束小时
#4 · dnd-end-hour
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 23,步长 1
勿扰结束分钟
#5 · dnd-end-minute
- 格式
- uint8
- 读写
- R / N
- 值
- 0 ~ 59,步长 1
时区参数
#6 · dnd-timezone
- 格式
- int32
- 读写
- 值
- -99999 ~ 99999,步长 1
siid12 多参数数组
"[1,0,1,...]"
[开关1,开始小时2,开始分钟3,结束小时4,结束分钟5] --- 20201130 添加
#7 · multi-prop-dnd
- 格式
- string
- 读写
- R / N
- 值
- —
Actions
设置勿扰时间
#1 · set-notdisturb
入参
#1勿扰是否打开uint8#2勿扰开始小时uint8#3勿扰开始分钟uint8#4勿扰结束小时uint8#5勿扰结束分钟uint8#6时区参数int32
家居物体、材质#13 · home属性 22动作 5事件 3
家居物体、材质
#13 · home
Properties
物体 id
#1 · object-id
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
物体类别
#2 · object-type
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
物体名称
#3 · object-name
- 格式
- string
- 读写
- 值
- —
确认(可选)
#4 · object-confirm
- 格式
- uint8
- 读写
- 值
- 0未确认1自动确认2手动确认
物体坐标 x
#5 · objcect-pos-x
- 格式
- float
- 读写
- 值
- -9999 ~ 9999,步长 1
物体坐标 y
#6 · objcect-pos-y
- 格式
- float
- 读写
- 值
- -9999 ~ 9999,步长 1
物体上传后 url (可选)
#7 · object-url
- 格式
- string
- 读写
- 值
- —
家具 id
#8 · furniture-id
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
家具类型
#9 · furniture-type
- 格式
- uint32
- 读写
- 值
- 0 ~ 9999,步长 1
家具顶点坐标,两个一组
[x1,y1,x2,y2,x3,y3,x4,y4]
#10 · furniture-point
- 格式
- string
- 读写
- 值
- —
家具上传后 url (可选)
#11 · furniture-url
- 格式
- string
- 读写
- 值
- —
房间 id
#12 · home-room-id
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
地图编号
#13 · home-map-id
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
房间类型
#14 · room-type-id
- 格式
- uint32
- 读写
- 值
- 2001卧室2002餐厅2003洗手间2004走廊2005厨房2006客厅2007阳台2020其他
材质类型
#15 · room-material-id
- 格式
- uint32
- 读写
- 值
- 1水泥地板2瓷砖3木地板30其他0未知
返回房间类型材质列表
{mapid}_{roomid_1}_{type_id_1}_{material_id_1}_{roomid_2}_{type_id_2}_{material_id_2}
#16 · type-material-list
- 格式
- string
- 读写
- 值
- —
多个家具列表
[2, "{id}_{type}_{x1}_{y1}_{x2}_{y2}_{x3}_{y3}_{x4}_{y4}","{id}_{type}_{x1}_{y1}_{x2}_{y2}_{x3}_{y3}_{x4}_{y4}"]
#17 · furniture-list
- 格式
- string
- 读写
- 值
- —
地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图
#18 · home-map-type
- 格式
- uint8
- 读写
- 值
- 00112233
时间戳
#19 · timestamp
- 格式
- uint32
- 读写
- 值
- 0 ~ 4294967295,步长 1
分包标志,用于接口下发大量数据时显示当前为第几包数据
[3,1]
字符串数组,第一位表示数据包总数,第二位表示当前为第几包数据
#20 · package
- 格式
- string
- 读写
- 值
- —
房间 id 和材质列表
[[roomid1, materid1],[roomid2, materid2],...]
例:[[10,2],[11,1],[12,2]]
--- 20201217 添加
#21 · room-material-list
- 格式
- string
- 读写
- 值
- —
家具集合
[家具 id,家具类型,[四个定点] ]
"[
[id1, type1, [x1,y1,x2,y2,x3,y3,x4,y4] ],
[id2, type2, [x1,y1,x2,y2,x3,y3,x4,y4] ],
[],
...]"
--- 20210111 添加
#22 · multi-furniture
- 格式
- string
- 读写
- 值
- —
Actions
设置房间类型
#1 · set-room-type
入参
#12房间 iduint32#13地图编号uint32#14房间类型uint32
出参
#13地图编号uint32#18地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图uint8#19时间戳uint32
设置地板材质
#3 · set-room-material
入参
#12房间 iduint32#13地图编号uint32#15材质类型uint32
出参
#13地图编号uint32#18地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图uint8#19时间戳uint32
新增/修改家具
#4 · new-furniture
入参
#17多个家具列表
[2, "{id}_{type}_{x1}_{y1}_{x2}_{y2}_{x3}_{y3}_{x4}_{y4}","{id}_{type}_{x1}_{y1}_{x2}_{y2}_{x3}_{y3}_{x4}_{y4}"]string
出参
#13地图编号uint32#18地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图uint8#19时间戳uint32
新增/修改家具,支持多包数据
#5 · new-furniture-ii
入参
#17多个家具列表
[2, "{id}_{type}_{x1}_{y1}_{x2}_{y2}_{x3}_{y3}_{x4}_{y4}","{id}_{type}_{x1}_{y1}_{x2}_{y2}_{x3}_{y3}_{x4}_{y4}"]string#20分包标志,用于接口下发大量数据时显示当前为第几包数据
[3,1]
字符串数组,第一位表示数据包总数,第二位表示当前为第几包数据
string
出参
#13地图编号uint32#18地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图uint8#19时间戳uint32#20分包标志,用于接口下发大量数据时显示当前为第几包数据
[3,1]
字符串数组,第一位表示数据包总数,第二位表示当前为第几包数据
string
设置多个房间的地板材质 --- 20201217 增加
#6 · multi-room-material
入参
#13地图编号uint32#21房间 id 和材质列表
[[roomid1, materid1],[roomid2, materid2],...]
例:[[10,2],[11,1],[12,2]]
--- 20201217 添加
string
出参
#13地图编号uint32#18地图类型 0:实时图 1:指哪图 2:划区图 3:记忆图uint8#19时间戳uint32
Events
物体识别
#1 · object-remind
触发参数
#1物体 iduint32#2物体类别uint32#3物体名称string#4确认(可选)uint8#5物体坐标 xfloat#6物体坐标 yfloat#7物体上传后 url (可选)string
家具识别
#2 · furniture-remind
触发参数
#8家具 iduint32#9家具类型uint32#10家具顶点坐标,两个一组
[x1,y1,x2,y2,x3,y3,x4,y4]
string#11家具上传后 url (可选)string
家具识别集合上报
#3 · multi-furniture
触发参数
#22家具集合
[家具 id,家具类型,[四个定点] ]
"[
[id1, type1, [x1,y1,x2,y2,x3,y3,x4,y4] ],
[id2, type2, [x1,y1,x2,y2,x3,y3,x4,y4] ],
[],
...]"
--- 20210111 添加
string