场景

本文介绍了当前设备的所有场景操作。

注意：使用 commonApi 需先安装依赖，点击此处安装依赖。

获取设备绑定场景

名称

getAllBindScenes

描述

获取当前设备已绑定的所有场景。

请求参数

参数	数据类型	说明	是否必填
devId	String	设备 ID	是

返回参数

参数	数据类型	说明
actionExcutor	String	执行器类型。
bindType	Number	绑定类型：0：Zigbee 1：Wi-Fi。
btnId	Number	按键 ID。
condRuleId	String	条件规则 ID。
devId	String	设备 ID。
dpId	Number	触发 DP 点。
dpValue	String	触发条件。
gwId	String	设备归属网关。
localSid	String	标准场景标记。
ruleBackground	String	规则背景图片。
ruleId	String	规则 ID。
ruleName	String	规则名称。

请求示例

import { commonApi } from '@tuya/tuya-panel-api';

commonApi.sceneApi
  .getAllBindScenes(TYSdk.devInfo.devId)
  .then(response => {
    console.log(response);
  })
  .catch();

返回示例

{
  "actionExcutor": "ruleTrigger"
  "bindType": 1
  "btnId": 1
  "condRuleId": "ZWMEhApntHz7p4jR"
  "devId": "vdevo159297901023732"
  "dpId": 2
  "dpValue": "scene"
  "gwId": ""
  "localSid": ""
  "ruleBackground": "https://images.tuyacn.com/smart/rule/cover/game.png"
  "ruleId": "pEsqbS4OOpDPKfTg"
  "ruleName": "222"    
}

获取设备创建场景

名称

getAllCreatedScenes

描述

获取当前设备创建的所有场景。

请求参数

参数	数据类型	说明	是否必填
devId	String	设备 ID	是

返回参数

参数	数据类型	说明
attribute	Number	属性标记。
auditStatus	Number	审核状态。
background	String	背景。
boundForPanel	Boolean	是否被场景面板绑定。
boundForWiFiPanel	Boolean	是否被WIFI场景面板绑定。
code	String	规则编码。
commonField	String	公共属性。
coverIcon	String	图标。
disableTime	Number	失效时间。
displayColor	String	颜色。
enabled	Boolean	是否启用。
gmtCreate	Number	创建时间戳。
gmtModified	Number	更新时间戳。
id	String	规则 ID。
localLinkage	Boolean	是否为本地联动。
matchType	Number	匹配类型，1：ANY，任意类型；2：ALL，所有类型；3：EXPR，通过表达式匹配。
name	String	规则名称。
newLocalScene	Boolean	是否为 APP 管控本地联动。
ownerId	String	家庭 ID。
ruleSource	Number	规则来源，标记外部事件来源。
ruleType	Number	规则类型，3：用户定义。
scenarioRule	Boolean	场景类型，1：标准智能场景中的联动， 0：其他定制联动。
stickyOnTop	Boolean	场景是否显示在首页。
uid	String	用户 ID。

请求示例

import { commonApi } from '@tuya/tuya-panel-api'
 
commonApi.sceneApi
  .getAllCreatedScenes(TYSdk.devInfo.devId)
  .then(response => {
    console.log(response);
  })
  .catch();

返回示例

{
  "attribute": 68
  "auditStatus": 0
  "background": "https://images.tuyacn.com/smart/rule/cover/sport.png"
  "boundForPanel": false
  "boundForWiFiPanel": true
  "code": ""
  "commonField": ""
  "coverIcon": "https://images.tuyacn.com/smart/rule/glyphicons/label.png"
  "disableTime": 0
  "displayColor": "E67578"
  "enabled": true
  "gmtCreate": 1587882013266
  "gmtModified": 1587893193584
  "id": "syQnbkArISqHlGvm"
  "iotAutoAlarm": false
  "localLinkage": false
  "logicRule": false
  "matchType": 1
  "name": ""【公版】消毒控制器-vdevo"消毒开关:开启"
  "newLocalScene": false
  "ownerId": "11740421"
  "ruleSource": 0
  "ruleType": 3
  "scenarioRule": true
  "stickyOnTop": true
  "uid": "ay1539583689295nLjlV"
}

绑定场景

名称

bindSelectedScene

描述

绑定选中场景。

请求参数

参数	数据类型	说明	是否必填
devId	String	设备 ID	是
btnId	Double	按键 ID	是
ruleId	String	规则 ID	是
dpId	Double	绑定按键 ID	是
dpValue	String	触发条件	是

返回参数

参数	数据类型	说明
response	Boolean	是否成功绑定场景

请求示例

import { commonApi } from '@tuya/tuya-panel-api'
 
commonApi.sceneApi
  .bindSelectedScene({
    devId: 'vdevo159297901023732',
    btnId: '1',
    dpId: 2,
    dpValue: 'scene',
    ruleId: 'ZRfxzOhXJAP2aI2a',
  })
  .then(response => {
    console.log(response);
  })
  .catch();

返回示例

true

解绑场景

名称

unBindScene

描述

解绑场景。

请求参数

参数	数据类型	说明	是否必填
devId	String	设备 ID	是
btnId	Double	按键 ID	是

返回参数

参数	数据类型	说明
response	Boolean	是否成功解绑场景

请求示例

import { commonApi } from '@tuya/tuya-panel-api'
 
commonApi.sceneApi
  .unBindScene({
    devId: 'vdevo159297901023732',
    btnId: '1',
  })
  .then(response => {
    console.log(response);
  })
  .catch();

返回示例

true

触发场景

名称

triggerScene

描述

触发场景。

请求参数

参数	数据类型	说明	是否必填
ruleId	String	场景规则 ID	是

返回参数

参数	数据类型	说明
response	Boolean	是否成功触发场景

请求示例

import { commonApi } from '@tuya/tuya-panel-api'
 
commonApi.sceneApi
  .triggerScene('vdevo159297901023732')
  .then(response => {
    console.log(response);
  })
  .catch();

返回示例

true