简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

全屋管理

更新时间:2021-10-20 03:07:39下载pdf

API 列表

action 说明
home.add 添加家庭
home.edit 修改家庭
home.delete 删除家庭
home.infos 查询家庭信息
home.devices 查询家庭下的设备详情
home.addRoom 添加房间
home.editRoom 修改房间
home.deleteRoom 删除房间
home.roomList 查询家庭下所有房间的信息
home.roomDevices 查询家庭房间下的所有设备
home.memberAuthority 设置家庭成员权限
home.deleteMember 删除家庭成员
home.memberList 查询家庭成员列表
home.memberInfos 查询⽤户的所有家庭信息

添加家庭

接口说明

给某个⽤户添加⼀个家庭以及家庭下的房间。房间可空,则只添加家庭。

接口地址

action: home.add

params请求参数

参数名 类型 说明 必填
uid String 涂鸦用户id
home Object 家庭信息
rooms List 房间名称

home说明

参数名 类型 说明 必填
name String 家庭名字
geo_name String 家庭地理位置
lon Double 经度
lat Double 纬度

请求示例

{
	"action":"home.add",
  "params":{
		"uid":"ay1528964101460qLVPu",
		"home":{
     	"geo_name":"杭州市,西湖景区",
     	"name":"我的家庭",
     	"lat":30.1624,
     	"lon":120.545
   	},
    "rooms":[
      "厨房",
      "洗澡间"
    ]
  }
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Long 家庭ID(即home_id)

响应示例

{
 "success": true,
 "t": 1540615024283,
 "result": 3182004
}

修改家庭

接口说明

修改家庭基础信息。

接口地址

action: home.edit

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID
name String 家庭名字
geo_name String 家庭地理位置
lon Double 经度
lat Double 维度

请求示例

{
	"action":"home.edit",
  "params": {
    "home_id":3182004,
    "geo_name":"杭州市,涂鸦智能",
    "name":"我的家庭",
    "lat":30.1624,
    "lon":120.545
  }
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Boolean 修改成功true

响应示例

{
 "success": true,
 "t": 1540616318050,
 "result": true
}

删除家庭

接口说明

根据家庭ID删除家庭。

接口地址

action: home.delete

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID

请求示例

{
	"action": "home.delete",
	"params": {
		"home_id": 3182004
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Boolean 删除成功true

响应示例

{
 "success": true,
 "t": 1540958118207,
 "result": true
}

查询家庭

接口说明

根据家庭ID查询家庭信息。

接口地址

action: home.infos

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID

请求示例

{
	"action": "home.infos",
	"params": {
		"home_id": 3182004
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Object 家庭对象

result说明

参数名 类型 说明
home_id Long 场景id
name String 家庭名称
geo_name String 家庭地理位置
lon Double 经度
lat Double 纬度

响应示例

{
 "success": true,
 "t": 1540955256215,
 "result": {
   "name": "⼩明的家庭",
   "lon": 120.545,
   "lat": 30.1624,
   "home_id": 3182004,
   "geo_name": "杭州市,涂鸦智能"
 }
}

查询家庭下的设备详情

接口说明

根据家庭ID查询家庭下的设备详情。

接口地址

action: home.devices

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID

请求示例

{
	"action": "home.devices",
	"params": {
		"home_id": 3182004
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Object 返回结果,设备详情列表

result说明

参数名 类型 说明
id String 设备编码
uid String ⽤户id
local_key String 密钥
category String 产品类别
product_id String 产品ID
sub Boolean 是否是⼦设备
true:是
false:不是
uuid String 设备唯⼀标识
owner_id String 设备拥有者ID
online Boolean 设备在线状态
ip String 设备IP
name String 设备的名字
time_zone String 设备所在时区
status Object 设备功能状态

status说明

参数名 类型 说明
code String 功能点的code
value String 功能点的值

响应示例

{
    "success":true,
    "t":1541509099860,
    "result":[
        {
            "uuid":"vdevo153500827491970",
            "uid":"ay1528964101460qLVPu",
            "name":"湖北电信插座",
            "ip":null,
            "sub":false,
            "status":[
   {
       "code":"switch",
       "value":"true"
   },
   {
       "code":"countdown_1",
       "value":"0"
   }
            ],
            "category":"cz",
            "online":true,
            "id":"vdevo153500827491970",
            "time_zone":"+08:00",
            "local_key":"47a5a361719f16b9",
            "owner_id":"2422120",
            "product_id":"T62ZA4lyVXFgtvE7"
        },
        {
            "uuid":"vdevo154017769539389",
            "uid":"ay1528964101460qLVPu",
            "name":"公版窗帘vdevo",
            "ip":null,
            "sub":false,
            "status":[
   {
       "code":"control",
       "value":"open"
   },
   {
       "code":"percent_control",
       "value":"0"
   },
   {
       "code":"percent_state",
       "value":"0"
   },
   {
       "code":"mode",
       "value":"morning"
   },
   {
       "code":"control_back",
       "value":"false"
   },
   {
       "code":"auto_power",
       "value":"false"
   },
   {
       "code":"work_state",
       "value":"opening"
   },
   {
       "code":"countdown",
       "value":"2"
   },
   {
       "code":"countdown_left",
       "value":"0"
   },
   {
       "code":"fault",
       "value":"0"
   },
   {
       "code":"time_total",
       "value":"0"
   }
            ],
            "category":"qt",
            "online":true,
            "id":"vdevo154017769539389",
            "time_zone":"+08:00",
            "local_key":"75bc0238e71ef011",
            "owner_id":"2422120",
            "product_id":"9ysAXds4ohDAnXwh"
        }
    ]
}

添加房间

接口说明

根据家庭ID添加房间。

接口地址

action: home.addRoom

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID
name String 房间名称

请求示例

{
	"action": "home.addRoom",
	"params": {
		"home_id": 3182004,
    "name": "厨房"
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Long 房间ID,即room_id

响应示例

{
 "success": true,
 "t": 1540958436848,
 "result": 1408001
}

修改房间

接口说明

根据家庭ID和房间ID修改房间。

接口地址

action: home.editRoom

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID
room_id Long 房间ID
name String 房间名称

请求示例

{
	"action": "home.editRoom",
	"params": {
		"home_id": 3182004,
    "room_id": 1408001,
    "name": "厨房"
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Object 修改成功返回true

响应示例

{
 "success": true,
 "t": 1540635347168,
 "result": true
}

删除房间

接口说明 根据家庭ID和房间ID删除房间。

接口地址

action: home.deleteRoom

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID
room_id Long 房间ID

请求示例

{
	"action": "home.deleteRoom",
	"params": {
		"home_id": 3182004,
    "room_id": 1408001
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Boolean 删除成功返回true

响应示例

{
 "success": true,
 "t": 1540635347168,
 "result": true
}

查询家庭和房间信息

接口说明

根据家庭ID查询家庭和房间信息。

接口地址

action: home.roomInfos

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID

请求示例

{
	"action": "home.roomInfos",
	"params": {
		"home_id": 3182004
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
home_id Long 场景id
name String 家庭名称
geo_name String 家庭地理位置
lon Double 经度
lat Double 纬度
rooms List 房间列表

rooms说明

参数名 类型 说明
room_id Long 房间ID
name String 房间名字

响应示例

{
    "success":true,
    "t":1540869200562,
    "result":{
        "home_id":3196002,
        "name":"⼩王的家庭",
        "lon":120.545,
        "lat":30.1624,
        "geo_name":"杭州市,西湖景区",
        "rooms":[
            {
   "room_id":1398001,
   "name":"厨房"
            },
            {
   "room_id":1398002,
   "name":"洗澡间"
            }
        ]
    }
}

添加家庭下房间内的设备

接口说明

新增家庭下房间内的设备。

接口地址

action: home.roomAddDevices

params请求参数

参数名 类型 说明 是否必需
home_id Long 家庭ID
room_id Long 房间ID
device_ids List 新增的设备ID

请求示例

{
	"action": "home.roomAddDevices",
	"params": {
		"home_id": 3182004,
		"room_id": 74332323,
    "device_ids": ["ve23u92932","ve23u929321"]
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Boolean 返回结果

响应示例

{
 "success": true,
 "t": 1540958436848,
 "result": 1408001
}

错误码

以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码。

错误码 说明
500 系统错误,请联系管理员

修改家庭下房间内的设备

接口说明

修改家庭下房间内的设备。

接口地址

action: home.roomEditDevices

params请求参数

参数名 类型 说明 是否必需
home_id Long 家庭ID
room_id Long 房间ID
device_ids List 房间最后保留的设备id

请求示例

{
	"action": "home.roomEditDevices",
	"params": {
		"home_id": 3182004,
		"room_id": 74332323,
    "device_ids": ["ve23u92932","ve23u929321"]
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Boolean 返回结果

响应示例

{
 "success": true,
 "t": 1540958436848,
 "result": 1408001
}

错误码

以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码。

错误码 说明
500 系统错误,请联系管理员

删除家庭下房间内的设备

接口说明

删除家庭下房间内的设备。

接口地址

action: home.roomDeleteDevices

params请求参数

参数名 类型 说明 是否必需
home_id Long 家庭ID
room_id Long 房间ID
device_ids List 删除的设备ID

请求示例

{
	"action": "home.roomDeleteDevices",
	"params": {
		"home_id": 3182004,
		"room_id": 74332323,
    "device_ids": ["ve23u92932","ve23u929321"]
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Boolean 返回结果

响应示例

{
 "success": true,
 "t": 1540958436848,
 "result": 1408001
}

错误码

以下为该接口常见的业务异常,更多的异常错误,请参见全局错误码。

错误码 说明
500 系统错误,请联系管理员

查询家庭房间下的所有设备

接口说明

根据家庭ID和房间ID查询房间⾥的设备详情信息。

接口地址

action: home.roomDevices

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID
room_id Long 房间ID

请求示例

{
	"action": "home.roomDevices",
	"params": {
		"home_id": 3182004,
    "room_id": 1408001
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result List 返回结果,设备详情列表

result说明

参数名 类型 说明
id String 设备编码
uid String 涂鸦的用户ID
local_key String 密钥
category String 产品类别
product_id String 产品ID
sub Boolean 是否是⼦设备
true:是
false:不是
uuid String 设备唯⼀标识
owner_id String 设备拥有者ID
online Boolean 设备在线状态
ip String 设备IP
name String 设备的名字
time_zone String 设备所在时区
status Object 设备功能状态

status说明

参数名 类型 说明
code String 功能点code
value String 功能点的值

响应示例

{
    "success":true,
    "t":1541509099860,
    "result":[
        {
            "uuid":"vdevo153500827491970",
            "uid":"ay1528964101460qLVPu",
            "name":"湖北电信插座",
            "ip":null,
            "sub":false,
            "status":[
   {
       "code":"switch",
       "value":"true"
   },
   {
       "code":"countdown_1",
       "value":"0"
   }
            ],
            "category":"cz",
            "online":true,
            "id":"vdevo153500827491970",
            "time_zone":"+08:00",
            "local_key":"47a5a361719f16b9",
            "owner_id":"2422120",
            "product_id":"T62ZA4lyVXFgtvE7"
        },
        {
            "uuid":"vdevo154017769539389",
            "uid":"ay1528964101460qLVPu",
            "name":"公版窗帘vdevo",
            "ip":null,
            "sub":false,
            "status":[
   {
       "code":"control",
       "value":"open"
   },
   {
       "code":"percent_control",
       "value":"0"
   },
   {
       "code":"percent_state",
       "value":"0"
   },
   {
       "code":"mode",
       "value":"morning"
   },
   {
       "code":"control_back",
       "value":"false"
   },
   {
       "code":"auto_power",
       "value":"false"
   },
   {
       "code":"work_state",
       "value":"opening"
   },
   {
       "code":"countdown",
       "value":"2"
   },
   {
       "code":"countdown_left",
       "value":"0"
   },
   {
       "code":"fault",
       "value":"0"
   },
   {
       "code":"time_total",
       "value":"0"
   }
            ],
            "category":"qt",
            "online":true,
            "id":"vdevo154017769539389",
            "time_zone":"+08:00",
            "local_key":"75bc0238e71ef011",
            "owner_id":"2422120",
            "product_id":"9ysAXds4ohDAnXwh"
        }
    ]
}

设置成员权限

接口说明

为家庭成员设置权限(管理员、⾮管理员),修改家庭成员的名字。

接口地址

action: home.memberAuthority

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID
uid String 涂鸦的用户ID
admin Boolean 家庭管理员标示,true是管理员,false不是管理员

请求示例

{
	"action": "home.memberAuthority",
	"params": {
		"home_id": 3182004,
    "uid": "ay15309353754999xY2T",
    "admin": false
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Object 修改成功返回true

响应示例

{
 "success": true,
 "t": 1540807132951,
 "result": true
}

删除家庭成员

接口说明

在某个家庭下删除成员。

接口地址

action: home.deleteMember

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID
uid String 涂鸦的用户ID

请求示例

{
	"action": "home.deleteMember",
	"params": {
		"home_id": 3182004,
    "uid": "ay15309353754999xY2T"
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Object 删除成功返回true

响应示例

{
 "success": true,
 "t": 1540967859608,
 "result": true
}

查询家庭成员

接口说明

查询家庭成员列表。

接口地址

action: home.memberList

params请求参数

参数名 类型 说明 必填
home_id Long 家庭ID

请求示例

{
	"action": "home.memberList",
	"params": {
		"home_id": 3182004
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result Object 家庭成员列表

result说明

参数名 类型 说明
uid String 涂鸦的用户ID
admin Boolean ⽤户是否为家庭管理员标示。(true:是,false:否)
mame String 家庭成员的用户名
country_code String 家庭成员的国家编码
menber_account String 家庭成员的账号,账号脱敏处理

响应示例

{
    "success":true,
    "t":1540799929837,
    "result":[
        {
            "country_code":"86",
            "member_account":"18******176",
            "uid":"ay1528964101460qLVPu",
            "admin":true,
            "name":"小华"
        },
        {
            "country_code":"86",
            "member_account":"15******196",
            "uid":"ay15309353754999xY2T",
            "admin":false,
            "name":"⼩明"
        }
    ]
}

查询⽤户的所有家庭信息

接口说明

根据uid查询⽤户的所有家庭信息。

接口地址

action: home.memberHomeList

params请求参数

参数名 类型 说明 必填
uid String 涂鸦的用户ID

请求示例

{
	"action": "home.memberHomeList",
	"params": {
		"uid": "ay15309353754999xY2T"
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功
true:成功
false:失败
msg String 请求失败的信息,成功为空
result List 家庭详情列表

result说明

参数名 类型 说明
home_id Long 家庭ID
name String 家庭名称
geo_name String 家庭地理位置
lon Double 经度
lat Double 纬度

响应示例

{
    "success":true,
    "t":1541508940996,
    "result":[
        {
            "name":"老家",
            "lon":120.100791,
            "lat":30.270856,
            "home_id":2422120,
            "geo_name":"西湖景区"
        },
        {
            "name":"哈哈的⼩家",
            "lon":120.090286,
            "lat":30.303958,
            "home_id":3177459,
            "geo_name":"龙井景区"
        },
        {
            "name":"我的的家庭",
            "lon":120.545,
            "lat":30.1624,
            "home_id":3196002,
            "geo_name":"杭州市,涂鸦智能"
        }
    ]
}