设备方法

本文介绍了有关设备的操作方法。

说明：4.0 及以上版本支持。

下发 dp 点状态

名称

TYSdk.device.putDeviceData()

描述

需要下发的 dp 点状态。

请求参数

参数	数据类型	说明	是否必选
dpState	{ dpCode: number | string | boolean }	需要下发的 dp 点状态	是

请求示例

TYSdk.device.putDeviceData(dpState);

// 如：给某个产品的开关（dpCode 为 switch_1）下发 true。

TYSdk.device.putDeviceData({ switch_1: true });

下发局域网内 dp 点状态

名称

TYSdk.device.putLocalDpData()

描述

局域网情况下需要下发的 dp 点状态

请求参数

参数	数据类型	说明	是否必选
dpState	{ dpCode: number | string | boolean }	局域网情况下需要下发的 dp 点状态	是

请求示例

TYSdk.device.putLocalDpData(dpState);

检查 dp 是否存在

名称

TYSdk.device.checkDpExist()

描述

检查 dp 是否存在。

请求参数

参数	数据类型	说明	是否必填
idOrCode	String	dpId 或 dpCode	是

返回参数

参数	数据类型	说明
idOrCode	String	dpId 或 dpCode

请求示例

TYSdk.device.checkDpExist(idOrCode);
// 若输入 dpCode 则返回 dpId
const data = TYSdk.device.checkDpExist('switch_1');
// 若输入 dpId 则返回 dpCode
const data = TYSdk.device.checkDpExist('1');
console.log('data: ', data);

返回示例

'1'
'switch_1'

获取设备信息

名称

TYSdk.device.getDeviceInfo()

描述

获取设备信息。

请求参数

参数	数据类型	说明	是否必填
idOrCode	String	dpId 或 dpCode	是

返回参数

参数	数据类型	说明
DevInfo	DevInfo	获取设备信息

请求示例

TYSdk.device.getDeviceInfo()
  .then((data: DevInfo) => {
    console.log('data :>> ', data);
  })
  .catch(error => {
    console.log('error :>> ', error);
  });

获取设备状态信息

名称

TYSdk.device.getDeviceState()

描述

获取设备状态信息。

返回参数

参数	数据类型	说明
DpState	{ dpCode: number | string | boolean }	获取设备状态信息

请求示例

TYSdk.device.getDeviceState()
.then(data => {
    console.log('data :>> ', data);
  })
  .catch(error => {
    console.log('error :>> ', error);
  });

返回示例

{
  "switch_1": true,
  "countdown_1": 0,
  "add_ele": 0,
  "cur_current": 0,
  "cur_power": 0,
  "cur_voltage": 0,
  "test_bit": 0,
  "voltage_coe": 0,
  "electric_coe": 0,
  "power_coe": 0,
  "electricity_coe": 0,
  "fault": 0
}

获取 dpCode

名称

TYSdk.device.getDpCodeById()

描述

根据 dpId 获取 dpCode。

请求参数

参数	数据类型	说明	是否必填
dpId	String	dpId	是

返回参数

参数	数据类型	说明
dpCode	String	根据 dpId 获取 dpCode

请求示例

TYSdk.device.getDpCodeById('22');

返回示例

'bright_value'

获取 dpCodes

名称

TYSdk.device.getDpCodes()

描述

获取设备的所有 dpCode。

返回参数

参数	数据类型	说明
dpCodes	String[]	获取设备的所有 dpCode

请求示例

TYSdk.device.getDpCodes();

返回示例

[
  "1",
  "9",
  "17",
  "18",
  "19",
  "20",
  "21",
  "22",
  "23",
  "24",
  "25",
  "26"
]

获取 dp 点状态

名称

TYSdk.device.getDpDataFromDevice()

描述

从设备主动获取的 dp 点状态。

请求参数

参数	数据类型	说明	是否必填
idOrCode	String	dpId 或 dpCode	是

请求示例

TYSdk.device.getDpDataFromDevice(idOrCode)
 .then(data => {
    console.log('data :>> ', data);
  })
  .catch(error => {
    console.log('error :>> ', error);
  });

获取 dpId

名称

TYSdk.device.getDpIdByCode()

描述

根据 dpCode 获取 dpId。

请求参数

参数	数据类型	说明	是否必填
dpCode	String	dpCode	是

返回参数

参数	数据类型	说明
dpId	String	根据 dpCode 获取 dpId

请求示例

TYSdk.device.getDpIdByCode('bright_value');

返回示例

22

获取 schema 信息

名称

TYSdk.device.getDpSchema()

描述

获取该设备对应 dp 点的 schema 信息。

请求参数

参数	数据类型	说明	是否必填
dpCode	String	dpCode	否

返回参数

参数	数据类型	说明
DpSchema	DpSchema	获取该设备对应 dp 点的 schema 信息

请求示例

TYSdk.device.getDpSchema(dpCode);
// 获取开关 switch_1 的 Schema 信息
const data = TYSdk.device.getDpSchema('switch_1');
console.log('data: ', data);

返回示例

{
  "mode": "rw",
  "code": "switch_1",
  "name": "开关1",
  "iconname": "icon-dp_power2",
  "id": "1",
  "type": "bool",
  "dptype": "obj"
}

获取 dp 的 value 值

名称

TYSdk.device.getState()

描述

获取 dp 的 value 值，如果不传参数则获取全部 dpValue。

请求参数

参数	数据类型	说明	是否必填
idOrCode	String	dpId 或者 dpCode	No

返回参数

参数	数据类型	说明
dpState	{ dpCode: number | string | boolean }	获取 dp 的 value 值，如果不传参数则获取全部 dpValue

请求示例

TYSdk.device.getState(idOrCode);

返回示例

{
  "switch_1": false,
  "countdown_1": 0,
  "add_ele": 0,
  "cur_current": 0,
  "cur_power": 0,
  "cur_voltage": 0,
  "test_bit": 0,
  "voltage_coe": 0,
  "electric_coe": 0,
  "power_coe": 0,
  "electricity_coe": 0,
  "fault": 0
}

是否是蓝牙设备

名称

TYSdk.device.isBleDevice()

描述

检测是否是蓝牙设备。

返回参数

参数	数据类型	说明
isBleDevice	Boolean	是否是蓝牙设备

请求示例

TYSdk.device.isBleDevice();

返回示例

true

是否是局域网

名称

TYSdk.device.isLocalLAN()

描述

检测是否局域网。

返回参数

参数	数据类型	说明
isLocalLAN	Boolean	是否局域网

请求示例

TYSdk.device.isLocalLAN();

返回示例

false

是否是组网设备

名称

TYSdk.device.isMeshDevice()

描述

检测是否是组网设备。

返回参数

参数	数据类型	说明
isMeshDevice	Boolean	是否是组网设备

请求示例

TYSdk.device.isMeshDevice();

返回示例

false

是否是无线组网设备

名称

TYSdk.device.isMeshWifiDevice()

描述

检测是否是无线组网设备。

返回参数

参数	数据类型	说明
isMeshWifiDevice	Boolean	是否是无线组网设备

请求示例

TYSdk.device.isMeshWifiDevice();

返回示例

false

是否设备共享

名称

TYSdk.device.isShareDevice()

描述

检测是否分享设备。

返回参数

参数	数据类型	说明
isShareDevice	Boolean	是否设备共享

请求示例

TYSdk.device.isShareDevice();

返回示例

false

是否是 SigMesh 设备

名称

TYSdk.device.isSigMeshDevice()

描述

检测是否是 SigMesh 设备。

返回参数

参数	数据类型	说明
isSigMeshDevice	Boolean	是否 SigMesh 设备

请求示例

TYSdk.device.isSigMeshDevice();

返回示例

true

是否是无线 Wi-Fi 设备

名称

TYSdk.device.isWifiDevice()

描述

检测是否是无线 Wi-Fi 设备。

返回参数

参数	数据类型	说明
isWifiDevice	Boolean	是否是无线 Wi-Fi 设备

请求示例

TYSdk.device.isWifiDevice();

返回示例

false