智能小程序 Ray 开发设备信息 API 汇总（一）

getDeviceNumWithDpCode

根据 dpCode 获取群组下具备此 dpCode 的设备数量。如果是一个分享的群组，请通过接口获取。

引入

import { device } from '@ray-js/ray';
const { getDeviceNumWithDpCode } = device;

需引入DeviceKit，且在>=2.4.0版本才可使用

请求参数

Object object

属性	类型	默认值	必填	说明
groupId	string		是	groupId 群组 id
dpCode	string		是	dpCode 内容
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

返回结果

• success

属性	类型	说明
devieNum	number	devieNum 设备数量

• fail

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

getDeviceNumWithDpCode({
  groupId: '12894745',
  dpCode: 'switch_1',
})
  .then((res) => {
    console.log(res);
  })
  .catch((error) => {
    console.log(error);
  });

返回示例

{
  "devieNum": 0
}

 👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

getDeviceOfflineReminderState

获取设备离线提醒的开关状态

引入

import { device } from '@ray-js/ray';
const { getDeviceOfflineReminderState } = device;

需引入DeviceKit，且在>=2.2.0版本才可使用

请求参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	deviceId 设备 id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

返回结果

• success

属性	类型	说明
state	number	state 设备离线提醒的开关状态 0:关 1:开

• fail

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

getDeviceOfflineReminderState({
  deviceId: '64710761ecfabcaaf553'
})
  .then((res) => {
    console.log(res);
  })
  .catch((error) => {
    console.log(error);
  });

返回示例

{
  "state": 0
}

getDeviceOfflineReminderWarningText

获取离线提醒警告内容（关闭离线提醒开关后的警告）

引入

import { device } from '@ray-js/ray';
const { getDeviceOfflineReminderWarningText } = device;

需引入DeviceKit，且在>=2.2.0版本才可使用

请求参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

返回结果

• success

属性	类型	说明
warningText	string	离线提醒关闭警告文案

• fail

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

getDeviceOfflineReminderWarningText()
  .then((res) => {
    console.log(res);
  })
  .catch((error) => {
    console.log(error);
  });

返回示例

{
  "warningText": "为避免提醒过于频繁，设备离线超过30分钟后才会提醒（低功耗设备将超过8小时后触发提醒）。"
}

getDeviceOnlineType

检查设备某个通道是否在线

引入

import { device } from '@ray-js/ray';
const { getDeviceOnlineType } = device;

需引入DeviceKit，且在>=2.1.6版本才可使用

请求参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	deviceId 设备 id 支持跨面板获取其他的设备信息，当前面板可以传当前设备的 id 来进行获取
dps	any		否	dps
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

返回结果

• success

属性	类型	说明
onlineType	number	设备网络在线类型

• onlineType 为十进制，需转成二进制，再根据如下所示的图片判断。

• fail

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

getDeviceOnlineType({
  deviceId: '64710761ecfabcaaf553'
})
  .then((res) => {
    console.log(res);
  })
  .catch((error) => {
    console.log(error);
  });

返回示例

{
  "onlineType": 0
}

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。