publishDps
下发 DP 功能点
引入
import { publishDps } from '@ray-js/ray';
需引入DeviceKit,且在>=1.2.6版本才可使用
publishDps 在 @ray-js/ray^0.10.4
支持以下两种模式,在之前的版本仅支持 模式二。
模式一
若无特殊场景需求,建议使用智能设备模型控制 DP 功能点
请求参数
参数 | 数据类型 | 说明 | 是否必填 |
---|---|---|---|
data | DpState |
要下发的 DP 功能点集合 | 是 |
options | PublishDpsOptions |
下发配置 | 否 |
类型
declare type DpValue = boolean | number | string;
declare type DpState = Record<string, DpValue>;
declare type PublishDpsOptions = {
/**
* 下发通道类型
* 0: 局域网
* 1: 网络
* 2: 自动
*/
mode: number;
/**
* 下发通道的优先级
* LAN = 0, // LAN
* MQTT = 1, // MQTT
* HTTP = 2, // Http
* BLE = 3, // Single Point Bluetooth
* SIGMesh = 4, // Sig Mesh
* BLEMesh = 5, // Tuya Private Mesh
* BLEBeacon = 6, // Beacon
*/
pipelines: number[];
/** 预留下发逻辑配置标记,后续可以拓展,例如下发声音,下发操作后续动作等等 */
options: Record<string, {}>;
};
export declare function publishDps(
data: DpState,
options?: PublishDpsOptions,
): Promise<boolean>;
返回结果
- success
Boolean boolean
- fail
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string |
插件错误信息 |
errorCode | string |