Appearance
房间管理
一. 房间新增
1. topic
res/room/add
2. payload
json
[
{
"id": "748670A4-EE28-4D08-B9A7-3D7F217A7E6B",
"type": "room",
"name": "主卧",
"room_kind": 0,
"room_type": "",
"background": 1,
"icon": "assets/room/room4.png",
"sequence": 0,
"children": [],
"services": [
{
"rid": "B59EAB99-7D80-4AD2-8C2C-126ED7BED25F",
"rtype": "group_light"
}
]
}
]
数组内元素为设备的UUID
3. 字段说明
序号 | 字段 | 类型 | 说明 |
---|---|---|---|
1 | id | string | 房间的UUID |
2 | type | string | 资源类型, 此处固定为 "room" |
3 | name | string | 房间名称 |
4 | room_kind | int | 此处必然为0 |
5 | room_type | string | 房间类型, 未做限制, 可以是任意字符串 |
6 | sequence | int | 房间序号, 未做限制, 可以是任意数字 |
7 | children | object array | 此处必然是空数组 |
8 | services | object array | 支持的服务列表 |
8.[].1 | rid | string | 资源UUID |
8.[].2 | rtype | string | 资源类型 |
9 | background | int | BweeApp专用, 房间壁纸序号 |
10 | icon | string | BweeApp专用, 房间壁纸名称 |
4. 功能说明
- 此topic会在创建房间时 触发
- 由于刚创建房间时没有设备, 所以报文中的 children 必然是空数组
二. 房间删除
1. topic
res/room/remove
2. payload
json
[
{
"id": "748670A4-EE28-4D08-B9A7-3D7F217A7E6B",
"type": "room"
}
]
3. 字段说明
序号 | 字段 | 类型 | 说明 |
---|---|---|---|
1 | id | string | 房间的UUID |
2 | type | string | 资源类型, 此处固定为 "room" |
4. 功能说明
- 此topic会在房间删除时触发
三. 房间更新
1. topic
res/room/update
2. payload
json
[
{
"id": "748670A4-EE28-4D08-B9A7-3D7F217A7E6B",
"value": {
"name": "主卧(南)"
}
}
]
3. 字段说明
序号 | 字段 | 类型 | 说明 |
---|---|---|---|
1 | id | string | 房间的 ID |
2 | value | object | 有更新的字段 |
value对象
序号 | 字段 | 类型 | 说明 |
---|---|---|---|
1 | name | string | 房间名称 |
2 | room_type | string | 房间类型 |
3 | sequence | int | 房间序号 |
4 | background | int | 房间背景序号 |
5 | icon | string | 房间背景名称 |
6 | device_add | string array | 新增设备, 数组内元素为设备的UUID |
7 | device_del | string array | 移除设备, 数组内元素为设备的UUID |
4. 功能说明
- 在房间信息变更时, 会触发此 topic
- value对象中, key存在代表有更新, key不存在代表未更新