getDeviceInfo(params: Object)

版本要求:
DeviceKit≥1.2.6@ray-js/ray≥0.6.23
支持平台:
iOSAndroid
import { device } from '@ray-js/ray';

const { getDeviceInfo } = device;

// Promise 调用
try {
  const res = await getDeviceInfo({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

获取设备的设备信息

参数

属性类型必填说明
deviceIdstring是deviceId 设备id 支持跨面板获取其他的设备信息，当前面板可以传当前设备的 id 来进行获取
否dps
complete() => void否接口调用结束的回调函数（调用成功、失败都会执行）
success(params: Object) => void否接口调用成功的回调函数
fail(params: Object) => void否接口调用失败的回调函数
success 回调参数
属性类型说明DeviceKit 最低版本
roomNamestring设备所处房间名v3.6.0
产品信息，schema，功能定义都在里面v3.3.0
dps 设备的功能点状态，可以根据对应的 dpid 拿到具体的状态值去做业务逻辑v3.3.0
attributenumberattribute 产品属性定义，在 backend-ng 平台上可查到对应配置，使用二进制位运算的方式进行管理v3.3.0
baseAttributenumberbaseAttribute 基础产品属性定义v3.5.0
capabilitynumbercapability 产品能力值，在 backend-ng 平台上可以查询对应的勾选项，整体业务逻辑会根据该数据进行划分 区分设备类型也可以根据该属性进行调整，按二进制位运算的方式进行管理v3.3.0
dpName 自定义 dp 的名字，通常在面板里会使用到v3.3.0
abilitynumberability 目前业务很少使用，用于区分特殊类型的设备v3.3.0
iconstringicon 设备的 icon urlv3.3.0
devIdstringdevId 设备的唯一 idv3.3.0
verSwstringverSw 设备固件版本号v3.3.0
isSharebooleanisShare 是否为分享设备，true 则是分享设备v3.3.0
bvstringbv 设备的基线版本号v3.3.0
uuidstringuuid 设备的固件唯一标识v3.3.0
panelConfig 产品面板里的配置项，通常在 IoT 平台上可以查看到对应的配置v3.3.0
activeTimenumberactiveTime 设备激活时间，时间戳v3.3.0
devAttributenumberdevAttribute 设备的业务能力拓展，二进制位的方式进行运算v3.3.0
pccstringpcc Thing自研蓝牙 mesh 产品的分类标识v3.3.0
nodeIdstringnodeId 子设备的短地址v3.3.0
parentIdstringparentId 上级节点 id，子设备/或蓝牙 mesh 设备通常会有该字段，用于内部寻找相关的网关或上级模型来进行业务处理v3.3.0
categorystringcategory 产品的分类v3.3.0
standSchemaModel 标准产品功能集定义模型v3.3.0
productIdstringproductId 设备对应的产品 idv3.3.0
productVerstringproductVer 设备对应的产品的版本号v4.3.6
bizAttributenumberbizAttribute 业务属性能力v3.3.0
meshIdstringmeshId 当前设备对应的蓝牙 mesh idv3.3.0
sigmeshIdstring【废弃】sigmeshId 当前设备所属行业属性对应的蓝牙 mesh idv3.3.0
meta 设备自定义配置元属性，用于存放业务数据v3.3.0
isLocalOnlinebooleanisLocalOnline 本地局域网是否在线v3.3.0
isCloudOnlineboolean设备云端在线情况v3.3.0
isOnlinebooleanisOnline 设备总的在线情况，只要一个情况在线，就是在线，复合在线情况v3.3.0
namestringname 设备名称v3.3.0
groupIdstringgroupId 设备所属群组 id，非群组场景下为空字符串v3.3.0
dpCodes 标准功能集 codev3.3.0
devTimezoneIdstring时区信息v3.3.0
设备的功能点执行的时间v3.3.0
latitudestring设备纬度v3.3.0
longitudestring设备经度v3.3.0
ipstring设备ip地址v3.3.0
isVirtualDeviceboolean是否为虚拟设备v3.3.0
isZigbeeInstallCodeboolean是否为 Zigbee 安装码网关v3.3.0
protocolAttributenumber子设备激活能力标志位v3.3.0
connectionStatusnumber连接状态，nearby状态v3.3.0
macstring部分设备需要用mac进行唯一识别 ，比如meshv3.3.0
bluetoothCapabilitystring蓝牙的设备能力值，由设备进行上报v3.3.0
isTripartiteMatterboolean是否三方matter设备v3.6.0
isGWboolean是否网关设备v3.6.0
isSupportGroupboolean是否支持群组v3.6.0
isZigBeeSubDevboolean是否zigbee子设备v3.6.0
cadvstringcadv版本号v3.6.0
isSupportOTAboolean设备是否支持OTAv3.6.0
iconUrlstring设备图标v3.6.0
hasWifiboolean设备是否有Wi-Fi模块v3.6.0
switchDpnumber快捷控制dpv3.7.0
switchDpsnumber[]快捷控制dpv3.7.0
wifiEnableStatenumber设备Wi-Fi模块的状态：1:不可用 2:可用v4.0.0
设备产品配置v4.0.0
isMatterboolean是否为matter设备v4.0.0
isSupportLinkboolean设备是否支持双控v4.0.0
isSupportAppleHomeKitboolean是否支持将设备添加到苹果家庭中v4.0.0
attributeStringstringattribute 格式化的二进制字符串 产品属性定义，在 backend-ng 平台上可查到对应配置，使用二进制位运算的方式进行管理v4.0.0
extModuleTypenumber设备的扩展模块的类型 0：无扩展模块 1：表示存在扩展模块，即设备为ble+x的设备 2：扩展模块为Wi-Fi模块。即设备为ble+Wi-Fi的设备v4.3.4
isRelayOpenbooleanmesh设备的relay功能是否开启v4.6.1
isProxyOpenbooleanmesh设备的proxy功能是否开启v4.6.1
isSupportProxyAndRelaybooleanmesh设备是否支持proxy和relay功能v4.6.1
yuNetStatenumber设备大禹通道用户启用状态，0-不启用，1-启用v4.11.0
fail 回调参数
属性类型说明
errorMsgstring错误信息
errorCodestring | number错误码
错误扩展

返回值

无

示例代码

import { device } from '@ray-js/ray'

device.getDeviceInfo({
  deviceId: "xx",
  dps: { "xx": {} },
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});