Data Models

ResInfo

{
  "rid": "string",
  "rtype": "string"
}

Fields

Field	Type	Required	Description
rid	string	Yes	Resource UUID
rtype	string	Yes	Resource type

DeviceDetail

{
  "id": "string",
  "type": "string",
  "name": "string",
  "join_status": 0,
  "online": 0,
  "has_new": 0,
  "product": {
    "cat1_id": 0,
    "cat1_name": "string",
    "cat2_id": 0,
    "cat2_name": "string",
    "cat3_id": 0,
    "cat3_name": "string",
    "manufacturer": "string",
    "model": "string",
    "hardware_version": "string",
    "software_version": "string",
    "zigbee_version": "string"
  },
  "services": [
    {
      "rid": "string",
      "rtype": "string"
    }
  ]
}

Fields

Field	Type	Required	Description
id	string	Yes	Device UUID
type	string	Yes	Always device.
name	string	Yes	Name
join_status	integer	Yes	Filter for join_status=1 to show devices the user has added. A value of 0 identifies a device that has not been selected.
online	integer	Yes	1 if online; 0 if offline.
has_new	integer	Yes	1 if an update is available; otherwise 0.
product	object	Yes	Product information
product.cat1_id	integer	Yes	Level 1 category ID. 1: gateway; 2: light; 3: sync device.
product.cat1_name	string	Yes	Level 1 category name
product.cat2_id	integer	Yes	Product category ID; for example, 203 for CW lights or 205 for RGBCW lights.
product.cat2_name	string	Yes	Level 2 category name
product.cat3_id	integer	Yes	Product-specific category ID; for example, 20504 for a Bar light.
product.cat3_name	string	Yes	Level 3 category name
product.manufacturer	string	Yes	Manufacturer reported by the Zigbee Basic cluster.
product.model	string	Yes	Model reported by the Zigbee Basic cluster.
product.hardware_version	string	Yes	Hardware version
product.software_version	string	Yes	Software version
product.zigbee_version	string	Yes	Zigbee version
services	ResInfo[]	Yes	—

PowerOn

{
  "mode": 0,
  "on_mode": 0,
  "on": 0,
  "brightness_mode": 0,
  "brightness": 0,
  "color_mode": 0,
  "color_x": 0,
  "color_y": 0,
  "color_cw": 0
}

Fields

Field	Type	Required	Description
mode	integer	Yes	Mode. 0: default; 1: restore previous state; 2: custom; 3: on; 4: off.
on_mode	integer	Yes	On/off mode. 0: default; 1: restore previous state; 2: custom.
on	integer	Yes	On/off state
brightness_mode	integer	Yes	Brightness mode. 0: default; 1: restore previous state; 2: custom.
brightness	integer	Yes	Brightness, from 0 to 100.
color_mode	integer	Yes	Color mode. 0: default; 1: restore previous state; 2: custom XY; 3: custom color temperature.
color_x	integer	Yes	Color X coordinate
color_y	integer	Yes	Color Y coordinate
color_cw	integer	Yes	Color temperature, from 2000 to 6500.

ColorXY

{
  "x": 0,
  "y": 0
}

Fields

Field	Type	Required	Description
x	integer	Yes	X coordinate
y	integer	Yes	Y coordinate

LightDetail

{
  "id": "string",
  "type": "string",
  "name": "string",
  "on": 0,
  "brightness": 0,
  "color_mode": 0,
  "color_cw": 0,
  "color_x": 0,
  "color_y": 0,
  "color_len": 0,
  "color_arr": [
    {
      "x": 0,
      "y": 0
    }
  ],
  "pack": [
    "string"
  ],
  "position_x": 0,
  "position_y": 0,
  "positions": "string",
  "power_on": {
    "mode": 0,
    "on_mode": 0,
    "on": 0,
    "brightness_mode": 0,
    "brightness": 0,
    "color_mode": 0,
    "color_x": 0,
    "color_y": 0,
    "color_cw": 0
  },
  "support_segment": 0
}

Fields

Field	Type	Required	Description
id	string	Yes	Light UUID
type	string	Yes	Always light.
name	string	Yes	Name
on	integer	Yes	On/off state
brightness	integer	Yes	Brightness, from 1 to 100.
color_mode	integer	Yes	Color mode. 0: HSV color; 1: XY color; 2: color temperature; 3: multi-segment XY color.
color_cw	integer	Yes	Color temperature, from 2000 to 6500.
color_x	integer	Yes	X coordinate in the XY color space.
color_y	integer	Yes	Y coordinate in the XY color space.
color_len	integer	Yes	Number of individually controlled light segments.
color_arr	object[]	Yes	Segment data
color_arr[].x	integer	Yes	X coordinate
color_arr[].y	integer	Yes	Y coordinate
pack	string[]	No	For BweeApp use only.
position_x	integer	No	For BweeApp use only.
position_y	integer	No	For BweeApp use only.
positions	string	Yes	For BweeApp use only.
power_on	PowerOn	No	Power-on behavior
support_segment	integer	Yes	1 if the light supports segmented color; otherwise 0.

RoomDetail

{
  "id": "string",
  "type": "string",
  "name": "string",
  "room_kind": 0,
  "room_type": "string",
  "icon": "string",
  "background": 0,
  "sequence": 0,
  "children": [
    {
      "rid": "string",
      "rtype": "string"
    }
  ],
  "services": [
    {
      "rid": "string",
      "rtype": "string"
    }
  ]
}

Fields

Field	Type	Required	Description
id	string	Yes	Room UUID
type	string	Yes	Always room.
name	string	Yes	Room name.
room_kind	integer	Yes	0 for a standard room; 1 for Whole Home; 2 for Unassigned.
room_type	string	Yes	A free-form room category, such as "Bedroom" or "Kitchen".
icon	string	Yes	For BweeApp use only.
background	integer	Yes	For BweeApp use only.
sequence	integer	Yes	For BweeApp use only.
children	ResInfo[]	Yes	Devices in the room. Each entry currently refers to a device resource.
services	ResInfo[]	Yes	Typically includes a group_light service for controlling the room's lights.

SceneDetail

Check your firmware: This model assigns scene_type=1 to image scenes and 2 to color scenes. The scene endpoints and MQTT reference reverse these values. Verify the mapping on your gateway before using this field.

{
  "id": "string",
  "type": "string",
  "parent_id": "string",
  "parent_type": "string",
  "name": "string",
  "scene_type": 0,
  "is_active": 0,
  "picture_id": "string",
  "picture_type": "string",
  "picture_url": "string",
  "icon": "string",
  "background": "string",
  "sequence": 0,
  "colors": [
    0
  ]
}

Fields

Field	Type	Required	Description
id	string	Yes	Scene ID
type	string	Yes	Always scene.
parent_id	string	Yes	Parent resource
parent_type	string	Yes	Always group_light.
name	string	Yes	Name
scene_type	integer	Yes	1 for an image scene; 2 for a color scene.
is_active	integer	Yes	1 if active; otherwise 0.
picture_id	string	Yes	Image. Used for image scenes.
picture_type	string	Yes	Always file.
picture_url	string	Yes	Image URL
icon	string	Yes	For BweeApp use only.
background	string	Yes	For BweeApp use only.
sequence	integer	Yes	For BweeApp use only.
colors	integer[]	Yes	For BweeApp use only.

SyncDetail

{
  "id": "string",
  "type": "string",
  "name": "string",
  "ability": 0,
  "on": 0,
  "brightness": 0,
  "source": 0,
  "mode": 0,
  "frequency": 0,
  "stop_action": 0,
  "color_config": 0,
  "color_config_1": [
    {
      "x": 0,
      "y": 0
    }
  ],
  "color_config_2": [
    {
      "x": 0,
      "y": 0
    }
  ],
  "color_config_3": [
    {
      "x": 0,
      "y": 0
    }
  ],
  "color_config_4": [
    {
      "x": 0,
      "y": 0
    }
  ],
  "area_id": "string",
  "area_name": "string"
}

Fields

Field	Type	Required	Description
id	string	Yes	Sync device ID
type	string	Yes	Always sync.
name	string	Yes	Name
ability	integer	Yes	Capabilities. Reserved.
on	integer	Yes	On/off state. 0: off; 1: on.
brightness	integer	Yes	Brightness, from 1 to 100.
source	integer	Yes	Input source. 0: HDMI1; 1: HDMI2.
mode	integer	Yes	Mode. 0: video; 1: music; 2: game.
frequency	integer	Yes	Intensity. 0: low; 1: medium; 2: high; 3: maximum.
stop_action	integer	Yes	Stop action. 0 keeps the current state; 2 turns the lights off.
color_config	integer	Yes	Selects the active preset: 1 uses color_config_1, 2 uses color_config_2, and so on.
color_config_1	object[]	Yes	Configuration 1
color_config_1[].x	integer	Yes	X coordinate
color_config_1[].y	integer	Yes	Y coordinate
color_config_2	object[]	Yes	Configuration 2
color_config_2[].x	integer	Yes	X coordinate
color_config_2[].y	integer	Yes	Y coordinate
color_config_3	object[]	Yes	Configuration 3
color_config_3[].x	integer	Yes	X coordinate
color_config_3[].y	integer	Yes	Y coordinate
color_config_4	object[]	Yes	Configuration 4
color_config_4[].x	integer	Yes	X coordinate
color_config_4[].y	integer	Yes	Y coordinate
area_id	string	Yes	ID of the associated synchronization area.
area_name	string	Yes	Name of the associated synchronization area.