jx-wx-mesh v1.0.20

jx-wx-mesh SDK

晶讯mesh业务 微信小程序SDK。 支持设备控制、状态监听 目前不支持mesh组网

此SDK事件上报依赖于 jx-device-message 插件，使用前请安装此插件

一、 SDK 初始化

1. 安装依赖

npm install jx-wx-mesh jx-device-message

2. 初始化实例

SDK 默认导出构造函数

import JxMesh from 'jx-wx-mesh'
const jxMesh = new JxMesh({
  appKey: string
  netKey: string
  ivIndex: number
  srcAddress: number
  nodes: ExplorerDevice[]
  heartbeat: number
})

3. 参数说明

ExplorerDevice数据结构

二、 实例API

1. 开始运行 run

调用本接口将开始搜索节点、连接节点、校验合法性、发送白名单等、子设备心跳监听等一系列动作，接口调用成功后可向子设备下发消息和监听子设备状态。但蓝牙异常后不会自动重连

接口定义

meshInstance.run()

参数说明

无

返回结果

返回一个 Promise，参数如下

2. 自动运行 autoRun

调用本接口将开始搜索节点、连接节点、校验合法性、发送白名单等、子设备心跳监听等一系列动作，接口调用成功后可向子设备下发消息和监听子设备状态。蓝牙发生异常会自动尝试回连。以下异常情况会尝试自动回连：关闭蓝牙后再打开、断开连接但蓝牙适配器正常。

接口定义

meshInstance.autoRun(count?: number)

参数说明

返回结果

返回一个 Promise，参数如下

3. 搜索代理节点 searchProxyNode

开始搜索初始化实例时传入的代理节点

接口定义

meshInstance.searchProxyNode()

参数说明

无

返回结果

返回一个 Promise，参数如下

4. 连接代理节点 connectProxyNode

连接目标代理节点

接口定义

meshInstance.connectProxyNode(node: MeshProxyNode)

参数说明

MeshProxyNode数据结构

返回结果

返回一个 Promise，参数如下

5. 下发消息给代理节点 sendMsgToProxyNode

下发消息给已连接的代理节点

接口定义

meshInstance.sendMsgToProxyNode(message: { seg: string })

参数说明

返回结果

返回一个 Promise

6. 下发通用消息给代理节点 sendGenericMessage

下发MESH通用消息给代理节点， 最后其实是调用 sendMsgToProxyNode 给代理节点发送消息

接口定义

meshInstance.sendGenericMessage(meshAddress: number, data: ArrayBuffer)

参数说明

返回结果

返回一个 Promise

7. 事件监听 on

监听特定的事件

接口定义

meshInstance.on(event: MeshEventType, listener: function)

参数说明

MeshEvent说明

可选值为：connected | disconnected | message | end

8. 监听特定设备消息 onDeviceMessage

监听特定的单个设备的状态消息

接口定义

meshInstance.onDeviceMessage(meshAddress: number, listener: function)

参数说明

9. 移除监听事件 removeListener

移除监听事件

接口定义

meshInstance.removeListener(meshAddress: number, listener: function)

参数说明

10. 发布设备上报状态 publishAllDeviceStates

通知所有设备上报状态，若需要查询子设备状态，则调用此接口，子设备状态会通过message事件上报。

接口定义

meshInstance.publishAllDeviceStates()

参数说明

无

返回结果

返回一个 Promise

11. 通用开关 genericOnoff

通用的下发开关接口

接口定义

meshInstance.genericOnoff(meshAddress: number, onoff: 0 | 1)

参数说明

返回结果

返回一个 Promise

12. 设置灯的亮度 setBrightness

设置灯的亮度

接口定义

meshInstance.setBrightness(meshAddress: number, brightness: number)

参数说明

返回结果

返回一个 Promise

13. 设置灯的色温 setColorTemperature

设置灯的色温

接口定义

meshInstance.setColorTemperature(meshAddress: number, temperature: number)

参数说明

返回结果

返回一个 Promise

14. 场景激发 sceneRecall

场景激发

接口定义

meshInstance.sceneRecall(sceneAddress: number)

参数说明

返回结果

返回一个 Promise

15. 设置温控器模式 setACMode

设置温控器模式

接口定义

meshInstance.setACMode(meshAddress: number, mode: 0 | 1 | 2 | 3)

参数说明

返回结果

返回一个 Promise

16. 设置温控器目标温度 setACTemperature

设置温控器目标温度

接口定义

meshInstance.setACTemperature(meshAddress: number, temperature: number)

参数说明

返回结果

返回一个 Promise

17. 设置温控器目标温度 setACWindSpeed

设置温控器目标温度

接口定义

meshInstance.setACWindSpeed(meshAddress: number, windSpeed: number)

参数说明

返回结果

返回一个 Promise