智能小程序 Ray 开发设备连接通信 —— 免配网和局域网 API 接口汇总

免配网 API

startDirectlyConnectedDeviceActivator

免配网-开始设备激活

引入

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

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

参数

Object object

属性	类型	默认值	必填	说明
device	Device		是	设备 Id device Device 设备模型
timeout	number		是	timeout 超时时间设定（秒），建议值 120
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

Device

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id

 

startDirectlyConnectedSearchDevice

免配网-开始设备扫描

引入

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

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

参数

Object object

属性	类型	默认值	必填	说明
device	Device		是	设备 Id device Device 设备模型
timeout	number		是	timeout 超时时间设定（秒），建议值 120
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

Device

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id

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

 

stopDirectlyConnectedDeviceActivator

免配网-停止设备激活

引入

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

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

参数

Object object

属性	类型	默认值	必填	说明
device	Device		是	设备 Id device Device 设备模型
timeout	number		是	timeout 超时时间设定（秒），建议值 120
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

Device

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id

 

stopDirectlyConnectedSearchDevice

免配网-结束设备扫描

引入

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

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

参数

Object object

属性	类型	默认值	必填	说明
device	Device		是	设备 Id device Device 设备模型
timeout	number		是	timeout 超时时间设定（秒），建议值 120
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

Device

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id

 

onDirectlyConnectedSearchDeviceEvent

免配网-设备扫描结果事件

引入

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

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

参数

function callback

免配网-设备扫描结果事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
isActive	boolean		是	设备是否激活 isActive 激活结果

 

offDirectlyConnectedSearchDeviceEvent

取消监听：免配网-设备扫描结果事件

引入

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

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

参数

function callback

取消监听：免配网-设备扫描结果事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
isActive	boolean		是	设备是否激活 isActive 激活结果

 

局域网 API

publishLanMessage

通过 局域网 消息通道下发消息

引入

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

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

参数

Object object

属性	类型	默认值	必填	说明
message	string		是	消息内容
deviceId	string		是	设备 id
protocol	number		是	协议号
options	any		否	预留下发逻辑配置标记，后续可以拓展，例如下发声音，下发操作后续动作等等
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

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