智能小程序 Ray 开发面板 SDK —— Hooks SDK 汇总（二）

useProtocolRun

根据给定的 props 协议执行

代码演示

基础用法

/**
 * title.zh-CN: 根据协议执行对应的逻辑
 * desc.zh-CN:
 */
import React from 'react';
import { useProtocolRun } from '@ray-js/panel-sdk';
 
export default () => {
  const run = useProtocolRun({
    devId: 'xxxx',
    wifi() {
      // TODO:
    },
    zigbee() {
      // TODO:
    },
    sigMesh() {
      // TODO:
    },
    default() {
      // TODO:
    }
  });
 
  return (
    <div onClick={() => run()}>
      根据协议执行对应的逻辑
    </div>
  );
};

API

const run = useProtocolRun({
  devId: 'xxxx',
  wifi() {
    // TODO:
  },
  zigbee() {
    // TODO:
  },
  sigMesh() {
    // TODO:
  },
  default() {
    // TODO:
  }
})

Result

参数	描述	类型
run	执行对应协议的函数	() => void

Params

参数	描述	类型
devId	设备ID	string
wifi	处理 WiFi 协议的函数	() => void
zigbee	处理 Zigbee 协议的函数	() => void
sigMesh	处理 SigMesh 协议的函数	() => void
default	默认处理函数	() => void

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

 

useScreenAlwaysOn

保持设备屏幕常亮，在当前组件起效，卸载当前组件失效

代码演示

基础用法

/**
 * title.zh-CN: 设备屏幕常亮
 * desc.zh-CN: 在当前组件起效，卸载当前组件失效
 */
import React from 'react';
import { useScreenAlwaysOn } from '@ray-js/panel-sdk';
 
export default () => {
  useScreenAlwaysOn();
  return (
    <div>
      保持设备屏幕常亮，在当前组件起效，卸载当前组件失效
    </div>
  );
};

API

useScreenAlwaysOn();

Result

无

Params

无

 

useTopBarTitle

设置小程序顶部标题

代码演示

基础用法

/**
 * title.zh-CN: 设置小程序顶部标题
 * desc.zh-CN: 设置小程序顶部标题
 */
import React from 'react';
import { useTopBarTitle } from '@ray-js/panel-sdk';
 
export default () => {
  const [ updateTitle ] = useTopBarTitle('new title');
  const handleClick = () => {
    updateTitle('另一个title');
  }
  return (
    <div>
      <button onClick={handleClick}>设置小程序顶部标题</button>
    </div>
  );
};

API

const [updateTitle] = useTopBarTitle('new title');

Result

Parameter	Description	Type
updateTitle	更新顶部标题的函数	(title: string) => void

Params

Parameter	Description	Type
title	要设置的初始标题	string

 

useIsSigmeshGatewayConnected

判断 sigmesh 设备是否连接网关

代码演示

基础用法

/**
 * title.zh-CN: 判断 sigmesh 设备是否连接网关
 * desc.zh-CN:
 */
import React from 'react';
import { useIsSigmeshGatewayConnected } from '@ray-js/panel-sdk';
 
export default () => {
  const isConnected = useIsSigmeshGatewayConnected();
  return (
    <div>
      {isConnected ? 'sigmesh Device gateway is Online' : 'sigmesh Device gateway is Offline'}
    </div>
  );
};

API

const devId = 'xxx';
const isConnected = useIsSigmeshGatewayConnected(devId);

Result

参数	说明	类型
isConnected	Sigmesh 设备是否已连接网关	boolean

Params

参数	说明	类型
devId	Sigmesh 设备 ID	string

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