智能小程序 Ray 开发设备连接通信 —— MQTT 和 Socket API 接口汇总（二）

 MQTT API（二）

registerMQTTProtocolListener

注册 MQTT 协议监听

引入

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

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

参数

Object object

属性	类型	默认值	必填	说明
protocol	number		是	protocol 协议号 MQTT 预定义的协议号
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

registerTopicListListener

注册需要监听的 topic 列表 [仅 m/m/i topic 订阅]

引入

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

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

参数

Object object

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

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

unregisterMQTTDeviceListener

注销设备的 MQTT 信息监听

引入

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

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

参数

Object object

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

unregisterMQTTProtocolListener

注销 MQTT 协议监听

引入

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

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

参数

Object object

属性	类型	默认值	必填	说明
protocol	number		是	protocol 协议号 MQTT 预定义的协议号
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

unregisterTopicListListener

注销需要监听的 topic 列表

引入

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

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

参数

Object object

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

Socket API 

offSocketMessageReceived

取消监听：socket 消息通道消息上报

引入

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

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

参数

function callback

取消监听：socket 消息通道消息上报的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
message	any		是	消息内容
deviceId	string		是	设备 id
type	number		是	局域网消息 type

onSocketMessageReceived

socket 消息通道消息上报

引入

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

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

参数

function callback

socket 消息通道消息上报的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
message	any		是	消息内容
deviceId	string		是	设备 id
type	number		是	局域网消息 type

publishSocketMessage

通过 Socket 消息通道下发消息

引入

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

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

参数

Object object

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

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