智能小程序 Ray 开发网关、OTA、DOM API 合集

网关 API

openDeviceGWSubHelpList

网关面板配网子设备，打开配网子设备帮助列表

引入

import { openDeviceGWSubHelpList } from '@ray-js/ray';

@ray-js/ray 需在 >=1.4.58版本才可使用。IDE模拟器与真机调试环境当前无法使用。

参数

Object object

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

请求示例

openDeviceGWSubHelpList({
    gwId: 'xxx'
}).then(() => {
  console.log('打开配网子设备帮助列表');
});

openDeviceGWSubSearchConfigure

网关面板配网子设备，打开搜索配网页面

引入

import { openDeviceGWSubSearchConfigure } from '@ray-js/ray';

@ray-js/ray 需在 >=1.4.58版本才可使用。IDE模拟器与真机调试环境当前无法使用。

参数

Object object

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

请求示例

openDeviceGWSubSearchConfigure({
    gwId: 'xxx'
}).then(() => {
  console.log('打开搜索配网页面');
});

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

OTA API

checkOTAUpdateInfo

检查固件升级信息

引入

import { checkOTAUpdateInfo } from '@ray-js/ray';

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

参数

Object object

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

 

checkOTAUpgradeStatus

获取设备的固件版本状态

引入

import { checkOTAUpgradeStatus } from '@ray-js/ray';

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
status	number	status 设备的固件版本状态 0 已是最新版本、1 有待升级的固件、2 正在升级

object.fail 回调参数

参数

Object res

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

 

openOTAUpgrade

跳转设备升级页面

引入

import { openOTAUpgrade } from '@ray-js/ray';

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

参数

Object object

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

 

DOM API

getBoundingClientRect

获取节点的坐标信息

引入

import { getBoundingClientRect } from '@ray-js/ray';

签名

getBoundingClientRect(element) => Promise<Rect>

Rect

export interface Rect {
  right: number;
  left: number;
  top: number;
  bottom: number;
  width: number;
  height: number;
}

示例代码

import { View, getBoundingClientRect, getElementById } from '@ray-js/ray';
import React from 'react';
 
const Index = () => {
  const getSize = async () => {
    try {
      const element = await getElementById('myView');
      if (element) {
        const rect = await getBoundingClientRect(element);
        console.log('Rect:', rect);
      }
    } catch (error) {
      console.error('Error getting size:', error);
    }
  };
 
  return (
    <View id="myView" onClick={getSize}>
      XXX
    </View>
  );
};
 
export default Index;

 

getElementById

获取页面节点

引入

import { getElementById } from '@ray-js/ray';

签名

getElementById(id: string) => Promise<Element>

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