saveLightScene – 涂鸦小程序

saveLightScene(data: SaveLightSceneParams)

版本要求:

@tuya-miniapp/cloud-api≥1.2.0

描述

新增、编辑并保存照明场景。该接口用于保存灯光场景的规则配置，包括场景名称、图标、执行动作等信息。

参数

参数	类型	必填	说明
		是	请求参数：ownerId（家庭 ID）、sceneExpr（场景规则 JSON 数据，包含场景的完整配置信息；SaveExprData 字段说明见文档「sceneExpr 字段说明」）

返回值

类型：Promise<SaveLightSceneResult>

保存后的场景信息（含 id、code、name、parentRegionId、ownerId、icon、enabled、status、sceneType 等，详见文档「返回参数」表）；

引用对象

interfaceSaveLightSceneResult

属性	类型	描述
`id`	number	主键 ID
`code`	string	场景编码
`name`	string	名称
`parentRegionId`	string	归属父区域 ID
`ownerId`	string	家庭 ID
`uid`	string	用户 ID
`actualRuleId`	string	真实规则 ID
`icon`	string	图标
`clickIcon`	string	根据 icon 字段，拼接点击图标
`enabled`	number	是否启用 (1: 启用, 0: 未启用)
`status`	number	状态 (0: 已删除, 1: 正常)
`sort`	number	排序
`sceneType`	1 \| 2 \| 3	场景类型 (1: 基础场景开, 2: 基础场景关, 3: 自定义场景)
`subSceneType`	number	子类型，0 是默认值，无业务含义
		执行动作
		条件，目前只有分布式蓝牙灯光场景会使用该字段
`modifyUid`	string	更新当前记录的用户 ID
`brightPercent`	number	亮度值百分比
`brightVisible`	boolean	亮度值百分比是否可见
`displayColor`	string	背景色
`background`	string	背景图片
`scheduleBound`	boolean	是否被日程引用
`distributedAbnormalCode`	0 \| 1 \| 2 \| 100	分布式灯光场景的异常状态 (0: 正常, 1: 暂存状态, 2: 房间设备变动导致的未同步, 100: 其他异常状态)
`distributeShortAddress`	number	分布式规则的短地址
`matchType`	number	条件匹配类型, 目前只有蓝牙分布式灯光场景才会用到该字段
`gmtCreate`	number	创建时间
`gmtModified`	number	更新时间

合法值

`SaveLightSceneResult.sceneType`

值	说明	最低版本
`1`	-	-
`2`	-	-
`3`	-	-

`SaveLightSceneResult.distributedAbnormalCode`

值	说明	最低版本
`0`	-	-
`1`	-	-
`2`	-	-
`100`	-	-

示例代码

请求示例

import { saveLightScene } from '@tuya-miniapp/cloud-api';

const params = {
  ownerId: '194137',
  sceneExpr: JSON.stringify({
    actions: [
      {
        actionExecutor: 'lightDevice',
        entityId: 'vdevo176127325226099',
        entityName: '调试-步进调光-vdevo',
        executorProperty: {
          switch_led: true,
          work_mode: 'scene',
          smb_scene: '0132010100000000000003e80000320101000000000000000a0000',
        },
        extraProperty: {
          parentRegionId: '57939115',
          sceneName: '500毫秒渐变（暖光）',
          sceneId: '22304912',
          sceneType: 1,
          selectCellBackground: 'https://images.tuyacn.com/light/library/icon/img_scene.png',
        },
      },
    ],
    parentRegionId: 57939115,
    name: '500毫秒渐变（暖光）',
    displayColor: 'BA7B69',
    sceneType: 3,
    matchType: 1,
    icon: 'https://images.tuyacn.com/smart/rule/light/dianji_default.png',
  }),
};

saveLightScene(params)
  .then(result => {
    console.log('场景保存成功:', result);
  })
  .catch(error => {
    console.error('场景保存失败:', error);
  });

返回示例

{
  "id": 123456,
  "code": "light_scene_001",
  "name": "500毫秒渐变（暖光）",
  "parentRegionId": "57939115",
  "ownerId": "194137",
  "uid": "ay1234567890",
  "icon": "https://images.tuyacn.com/smart/rule/light/dianji_default.png",
  "enabled": 1,
  "status": 1,
  "sort": 1,
  "sceneType": 3,
  "displayColor": "BA7B69",
  "matchType": 1,
  "gmtCreate": 1766558627585,
  "gmtModified": 1766558627585
}