设备属性API
ty.device.setDeviceProperty
设置设备属性
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
请求参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | deviceId | |
code | string | 是 | the custom data key | |
value | string | 是 | the custom data value | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
返回结果
- success
属性 | 类型 | 说明 |
---|---|---|
deviceId | string | deviceId |
result | boolean | set DeviceProperty successfully |
- fail
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
请求示例
ty.device.setDeviceProperty({
deviceId: '64710761ecfabcaaf553',
code: 'netName',
value: 'Tuya-Test123',
})
.then((res) => {
console.log(res);
})
.catch((error) => {
console.log(error);
});
返回示例
{
"result": true,
"deviceId": '64710761ecfabcaaf553'
}
👉 立即开发。
ty.device.getDeviceProperty
获取设备属性
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
请求参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | deviceId 设备 id 支持跨面板获取其他的设备信息,当前面板可以传当前设备的 id 来进行获取 | |
dps | any | 否 | dps | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
返回结果
- success
属性 | 类型 | 说明 |
---|---|---|
properties | any | the properties map |
- fail
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
请求示例
ty.device.getDeviceProperty({
deviceId: '64710761ecfabcaaf553'
})
.then((res) => {
console.log(res);
})
.catch((error) => {
console.log(error);
});
返回示例
{
"properties": {
"netName": "Tuya-Test"
}
}
设备移除API
ty.device.removeDevice
移除设备
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | deviceId 设备 id 支持跨面板获取其他的设备信息,当前面板可以传当前设备的 id 来进行获取 | |
dps | any | 否 | dps | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.resetFactory
重置设备并恢复出厂设置。
设备数据会被清除并进入待配网状态。
需引入
DeviceKit
,且在>=2.1.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | deviceId 设备 id 支持跨面板获取其他的设备信息,当前面板可以传当前设备的 id 来进行获取 | |
dps | any | 否 | dps | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.removeShareDevice
移除共享设备
需引入
DeviceKit
,且在>=2.2.0
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | deviceId 设备 id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.subscribeDeviceRemoved
订阅设备移除事件 (430 版本之后,请用 registerDeviceListListener 接口替换)
需引入
DeviceKit
,且在>=2.1.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备 id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.unSubscribeDeviceRemoved
取消订阅设备移除事件 (430 版本之后,请用 unregisterDeviceListListener 接口替换)
需引入
DeviceKit
,且在>=2.1.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备 id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.onDeviceRemoved
设备移除事件
需引入
DeviceKit
,且在>=2.1.6
版本才可使用
参数
function callback
设备移除事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备 id |
ty.device.offDeviceRemoved
取消监听:设备移除事件
需引入
DeviceKit
,且在>=2.1.6
版本才可使用
参数
function callback
取消监听:设备移除事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备 id |
👉 立即开发。