智能小程序 Ray 开发场景 API —— 查询 API 合集

getBindRuleList

接口描述

查询设备条件已绑定的场景。

请求参数

参数	数据类型	说明	是否必填
bizDomain	String	业务域	是
devId	String	设备 ID	是 @ray-js/ray^1.4.61 开始支持
entityType	Number	实体类型	是
gid	String	家庭 ID	是 引入HomeKit并使用getCurrentHomeInfo获取homeId传入

返回参数

参数	数据类型	说明
data	Array	规则列表

请求示例

import { getBindRuleList, home } from '@ray-js/ray';
// Need HomeKit
const { homeId } = await home.getCurrentHomeInfo()
 
getBindRuleList({
  devId: 'vdevo161469104176416',
  bizDomain: 'wirelessSwitchBindScene',
  entityType: 2,
  gid: homeId
})
  .then((response) => {
    console.log(response);
  })
  .catch();

返回示例

[{
    associativeEntityId: '1#single_click'
    associativeEntityValueList: [],
    bizDomain: 'wirelessSwitchBindScene',
    sourceEntityId: 'vdevo161473760344855'
}]

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

getLinkageDeviceList

接口描述

查询家庭下支持联动的所有设备。

请求参数

参数	数据类型	说明	是否必填
gid	String	家庭 ID	是 引入HomeKit并使用getCurrentHomeInfo获取homeId传入
sourceType	String	请求类型	是

返回参数

参数	数据类型	说明
data	Array	设备列表

请求示例

import { getLinkageDeviceList, home } from '@ray-js/ray';
// Need HomeKit
const { homeId } = await home.getCurrentHomeInfo()
 
getLinkageDeviceList({
  gid: homeId,
  sourceType: 'wirelessSwitch',
})
  .then((response) => {
    console.log(response);
  })
  .catch();

返回示例

[
  {
    "category": "wxkg",
    "datapoints": [],
    "devId": "vdevo161473760344855",
    "iconUrl": "xxxx",
    "name": "无线开关",
    "productId": "xxxx"
  }
]

getSceneList

接口描述

查询设备支持的一键执行场景。

请求参数

参数	数据类型	说明	是否必填
devId	String	设备 ID	是 @ray-js/ray^1.4.61 开始支持
gid	String	家庭 ID	是 引入HomeKit并使用getCurrentHomeInfo获取homeId传入

返回参数

参数	数据类型	说明
data	Array	场景列表

请求示例

import { getSceneList, Home } from '@ray-js/ray';
// Need HomeKit
const { homeId } = await home.getCurrentHomeInfo()
 
getSceneList({
  devId: 'vdevo161469104176416',
  gid: homeId
})
  .then((response) => {
    console.log(response);
  })
  .catch();

返回示例

[
  {
    "actions": [],
    "attribute": 4,
    "auditStatus": 0,
    "background": "",
    "boundForPanel": false,
    "boundForWiFiPanel": false,
    "code": "",
    "commonField": "",
    "coverIcon": "xxx",
    "disableTime": 0,
    "displayColor": "23AFA9",
    "enabled": true,
    "devId": "vdevo161473760344855",
    "name": "222",
    "id": "tgnVdPuWVoAZ1W89"
  }
]

showSceneDialog

展示场景的风格弹窗

引入

import { showSceneDialog } from '@ray-js/ray';

需引入DeviceKit，且在>=2.5.4版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
smartType	string		否	智能类型：scene,auto scene:一键执行 auto：自动化
color	string		否	颜色
icon	string		否	图标
image	string		否	图片
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
color	string	颜色
icon	string	图标
image	string	图片

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。