mini_program_gizwits_sdk 3.6.0 → 3.6.2

package/README.md

@@ -152,16 +152,49 @@ sdk.setLogLevel("debug")
 
 取消订阅目标设备。蓝牙设备会断开连接。返回值中可拿到取消订阅结果。
 
+### sdk.getDevices()
+刷新设备列表(同时也会在 GizDeviceListNotifications 事件里推送)
+```ts
+const data = await sdk.getDevices()
+console.log(data)
+```
+
+### sdk.stopDeviceOnboardingDeploy
+停止配网
+
+### sdk.setDeviceOnboardingDeploy
+开始配网
+
+详细参数请查阅类型定义
+
 ### sdk.addEventListener(type,listener)
 
 #### 概览
 
 | 事件种类 type               | 回调参数类型                          | 回调参数描述         |
 | --------------------------- | ------------------------------------- | -------------------- |
-| onScanListChange            | [IDevice[]](#IDevice)                 | 扫描设备列表变更通知 |
+| GizDeviceListNotifications | [IDevice[]](#IDevice) | 设备列表变更   |
+| GizDeviceStatusNotifications | [IDeviceStatusNoti](#IDeviceStatusNoti) | 设备在线状态变更   |
 | GizDeviceAttrsNotifications | [IDeviceAttrsNoti](#IDeviceAttrsNoti) | 设备数据点变更通知   |
+| onScanListChange            | [IDevice[]](#IDevice)                 | 扫描设备列表变更通知 |
 | onBleHandleError            | [IError](#IError)                     | ble 错误通知         |
 
+- <a id="GizDeviceListNotifications"> GizDeviceListNotifications </a>
+
+```ts
+this.gizSdk.addEventListener('GizDeviceListNotifications', (deviceList: IDevice[]) => {
+  console.log('列表发生变化', deviceList);
+});
+```
+
+- <a id="GizDeviceStatusNotifications"> GizDeviceStatusNotifications </a>
+
+```ts
+this.gizSdk.addEventListener('GizDeviceStatusNotifications', (e: IDeviceStatusNoti) => {
+  console.log('设备在线状态变化', e);
+});
+```
+
 - <a id="onScanListChange">onScanListChange</a>
 
 ```ts
@@ -202,23 +235,17 @@ this.gizSdk.addEventListener(
 
 ```ts
 interface IDevice {
-  mac: string;
-  productKey: string;
-  did: string;
-  bleWorkStatus?: number; // 0 默认状态 1 配网状态
-  name: string;
-  isBind: boolean;
-  rootDeviceId?: string;
-  bleDeviceID?: string;
-  remark?: string;
-  passcode?: string;
-  connectType: TConnectType;
+  mac: string; // 设备mac
+  productKey: string; // 机智云pk
+  did?: string; // 云平台did
+  name: string; // 设备名称
+  isBind: boolean; // 是否绑定
+  bleDeviceID?: string; // 本地蓝牙设备id
   isOnline: boolean; // 代表大循环在线
   isLanOnline: boolean; // 代表小循环在线
   isBleOnline: boolean; // 代表蓝牙在线
-  host?: string;
-  wss_port?: number;
-  ctime?: number;
+  bleWorkStatus?: number; // 蓝牙设备状态 0 默认状态 1 配网状态
+  connectType: TConnectType; // 当前连接类型
 }
 ```
 
@@ -238,6 +265,21 @@ interface IDeviceAttrsNoti {
 }
 ```
 
+- <a id="IDeviceStatusNoti">IDeviceStatusNoti</a>
+
+```ts
+interface IDeviceStatusNoti {
+  device: IDevice;
+  connectType: TConnectType;
+}
+```
+
+- <a id="TConnectType">TConnectType</a>
+
+```ts
+type TConnectType = 'BLE' | 'BLE_BROADCAST' | 'LAN' | 'WAN' | 'NONE';
+```
+
 - <a id="IError">IError</a>
 
 ```ts

package/dist/index.d.ts

@@ -2,5 +2,7 @@ import 'miniprogram-api-typings';
 import gizwitsSdk from './src/sdk';
 import errorCode from './src/errorCode';
 import { BleHandle } from './src/handler/ble';
+import * as types from './src/types';
 export { errorCode, BleHandle };
+export { types };
 export default gizwitsSdk;