mini_program_gizwits_sdk 3.4.8 → 3.4.9-configEvent

package/dist/src/sdk.d.ts

@@ -3,6 +3,7 @@ import { OTAEventCallback, OTAProgressEventCallback } from './handler/ble';
 import { TLogType } from './GizLog';
 import { IOpenApiDevice, ISafeRegisterReturn, IUnbindReturn } from './services/devices';
 import { ILoginRes } from './services/login';
+import { ConfigEventData } from './wifiConfig/ConfigBase';
 interface SyncCallBackParams {
     event: TSyncEvnet;
     currentNum?: number;
@@ -29,6 +30,7 @@ export interface ISetCommonDeviceOnboardingDeployProps {
 }
 export interface ISetDeviceOnboardingDeployProps extends ISetCommonDeviceOnboardingDeployProps {
     softAPSSIDPrefix: string;
+    eventCallBack: (event: ConfigEventData) => void;
 }
 export interface IRandomCodesResult {
     random_code: string;
@@ -204,7 +206,7 @@ declare class GizwitsMiniSDK {
     }) => Promise<ISDKResult<IUnbindReturn>>;
     deviceSafetyRegister: ({ mac, productKey, }: IDeviceSafetyRegisterParams) => Promise<ISDKResult<ISafeRegisterReturn>>;
     deviceSafetyUnbind: ({ mac, productKey, }: IDeviceSafetyRegisterParams) => Promise<ISDKResult<ISafeRegisterReturn>>;
-    setDeviceOnboardingDeploy: ({ ssid, bssid, password, mode, timeout, isBind, softAPSSIDPrefix, }: ISetDeviceOnboardingDeployProps) => Promise<ISDKResult<IDevice[]>>;
+    setDeviceOnboardingDeploy: ({ ssid, bssid, password, mode, timeout, isBind, softAPSSIDPrefix, eventCallBack }: ISetDeviceOnboardingDeployProps) => Promise<ISDKResult<IDevice[]>>;
     private setDomain;
     private deviceSafetyApi;
     getBindingList: () => Promise<import("./openApiRequest").IServiceResult<IDevice[]>>;

package/dist/src/wifiConfig/ConfigBase.d.ts

@@ -2,6 +2,11 @@ import { IRandomCodesResult, IResult } from "../sdk";
 interface IRejectCallback {
     (result: IResult<unknown>): void;
 }
+export type TConfigEvent = 'GIZ_CONFIG_START' | 'GIZ_DISCOVER_SUCCESS' | 'GIZ_CONNECT_SUCCESS' | 'GIZ_CONFIG_SEND_SUCCESS' | 'GIZ_CONFIG_RECV_SUCCESS' | 'GIZ_CONFIG_SUCCESS';
+export interface ConfigEventData {
+    event: TConfigEvent;
+    deviceID?: string;
+}
 declare class ConfigBase {
     ssid: string;
     bssid: string;
@@ -10,6 +15,7 @@ declare class ConfigBase {
     disableSearchDevice: boolean;
     specialProductKeySecrets: string[];
     private timeoutHandler;
+    eventCallBack: (event: ConfigEventData) => void;
     private setDeviceOnboardingDeployRej?;
     constructor(ssid: string, bssid: string, password: string, specialProductKeys: string[], specialProductKeySecrets: string[]);
     cleanTimeout: () => void;

package/dist/src/wifiConfig/ble.d.ts

@@ -1,14 +1,15 @@
 import { IRandomCodesResult, IResult } from "../sdk";
 import { BleHandle } from "../handler/ble";
-import ConfigBase from "./ConfigBase";
+import ConfigBase, { ConfigEventData } from "./ConfigBase";
 interface IArgs {
     bleDeviceId: string;
     arrayBuffer: ArrayBuffer;
     serviceUUIDSuffix?: string;
     characteristicUUIDSuffix?: string;
     bleHandle: BleHandle;
+    eventCallBack: (event: ConfigEventData) => void;
 }
-export declare function sendBLEConfigCmd({ bleDeviceId, arrayBuffer, serviceUUIDSuffix, characteristicUUIDSuffix, bleHandle }: IArgs): Promise<boolean | void>;
+export declare function sendBLEConfigCmd({ bleDeviceId, arrayBuffer, serviceUUIDSuffix, characteristicUUIDSuffix, bleHandle, eventCallBack }: IArgs): Promise<boolean | void>;
 interface configBLEDeviceParams {
     ssid: string;
     password: string;
@@ -19,6 +20,7 @@ interface ISetDeviceOnboardingDeployProps {
     timeout: number;
     isBind: boolean;
     softAPSSIDPrefix: string;
+    eventCallBack: (event: ConfigEventData) => void;
 }
 declare class BLEConfig extends ConfigBase {
     bleHandle: BleHandle;
@@ -38,7 +40,7 @@ declare class BLEConfig extends ConfigBase {
         success: true;
         bleDevices?: WechatMiniprogram.BlueToothDevice[];
     }>;
-    setDeviceOnboardingDeploy: ({ timeout, isBind, softAPSSIDPrefix, }: ISetDeviceOnboardingDeployProps) => Promise<IResult<IDevice[]>>;
+    setDeviceOnboardingDeploy: ({ timeout, isBind, softAPSSIDPrefix, eventCallBack, }: ISetDeviceOnboardingDeployProps) => Promise<IResult<IDevice[]>>;
     configBLEDevice: ({ ssid, password, softAPSSIDPrefix, }: configBLEDeviceParams) => Promise<IResult<IRandomCodesResult[]>>;
 }
 export default BLEConfig;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mini_program_gizwits_sdk",
-  "version": "3.4.8",
-  "description": "修正随机码生成方式",
+  "version": "3.4.9-configEvent",
+  "description": "增加配网回调",
   "main": "./dist/index.js",
   "scripts": {
     "test": "node_modules/mocha/bin/_mocha -r ts-node/register tests/**/*.spec.ts -file ./tests/setup-wx.js -timeout 60s",

package/src/sdk.ts

@@ -41,6 +41,7 @@ import {
 import ApConfig from './wifiConfig/ap';
 import BLEConfig from './wifiConfig/ble';
 import NFCConfig from './wifiConfig/nfc';
+import { ConfigEventData } from './wifiConfig/ConfigBase';
 
 const version = sdkConfig.version;
 interface SyncCallBackParams {
@@ -73,6 +74,7 @@ export interface ISetCommonDeviceOnboardingDeployProps {
 export interface ISetDeviceOnboardingDeployProps
   extends ISetCommonDeviceOnboardingDeployProps {
   softAPSSIDPrefix: string;
+  eventCallBack: (event: ConfigEventData) => void, // 配网回调
 }
 
 export interface IRandomCodesResult {
@@ -1391,6 +1393,7 @@ class GizwitsMiniSDK {
     timeout,
     isBind = true,
     softAPSSIDPrefix,
+    eventCallBack
   }: ISetDeviceOnboardingDeployProps): Promise<ISDKResult<IDevice[]>> => {
     if (this.currentWifiConfigHandle) {
       return {
@@ -1408,13 +1411,14 @@ class GizwitsMiniSDK {
             bssid,
             password,
             this.specialProductKeys,
-            this.specialProductKeySecrets
+            this.specialProductKeySecrets,
           );
           const data =
             await this.currentWifiConfigHandle.setDeviceOnboardingDeploy({
               timeout,
               isBind,
               softAPSSIDPrefix,
+              eventCallBack,
             });
           this.currentWifiConfigHandle = null;
           const eTime = new Date().getTime();
@@ -1436,6 +1440,7 @@ class GizwitsMiniSDK {
               timeout,
               isBind,
               softAPSSIDPrefix,
+              eventCallBack,
             });
           this.currentWifiConfigHandle = null;
           const eTime = new Date().getTime();
@@ -1470,6 +1475,7 @@ class GizwitsMiniSDK {
               timeout,
               isBind,
               softAPSSIDPrefix,
+              eventCallBack,
             });
           this.currentWifiConfigHandle = null;
           const eTime = new Date().getTime();

package/src/wifiConfig/ConfigBase.ts

@@ -8,6 +8,11 @@ import GizLog from "../GizLog";
 interface IRejectCallback {
   (result: IResult<unknown>): void;
 }
+export type TConfigEvent = 'GIZ_CONFIG_START' | 'GIZ_DISCOVER_SUCCESS' | 'GIZ_CONNECT_SUCCESS' | 'GIZ_CONFIG_SEND_SUCCESS' | 'GIZ_CONFIG_RECV_SUCCESS' | 'GIZ_CONFIG_SUCCESS'
+export interface ConfigEventData {
+  event: TConfigEvent;
+  deviceID?: string;
+}
 class ConfigBase {
   ssid = '';
   bssid = '';
@@ -16,6 +21,8 @@ class ConfigBase {
   disableSearchDevice = false;
   specialProductKeySecrets: string[] = []
   private timeoutHandler: TimeoutHandle = null;
+  eventCallBack: (event: ConfigEventData) => void;
+
   private setDeviceOnboardingDeployRej?: (value: unknown) => void = () => {}; // 保存promise的rej，用于临时中断
   // private setDeviceOnboardingDeployRes?: (value: unknown) => void = () => {}; // 保存promise的res，用于临时中断
 
@@ -150,6 +157,9 @@ class ConfigBase {
             !this.disableSearchDevice && query();
           } else {
             // 搜索到设备
+            this.eventCallBack?.({
+              event: "GIZ_CONFIG_SUCCESS",
+            });
             GizLog.debug('GIZ_SDK: 大循环搜索到设备', data);
             res({
               success: true,

package/src/wifiConfig/ble.ts

@@ -10,7 +10,7 @@ import {
   getBLEDeviceCharacteristics, getBLEDeviceServices, getBluetoothAdapterState, getBluetoothDevices,
   notifyBLECharacteristicValueChange, retryConnect, startBluetoothDevicesDiscovery, unpackWriteBLECharacteristicValue
 } from '../wechatApi';
-import ConfigBase from "./ConfigBase";
+import ConfigBase, { ConfigEventData } from "./ConfigBase";
 
 interface IArgs {
   bleDeviceId: string;
@@ -18,6 +18,7 @@ interface IArgs {
   serviceUUIDSuffix?: string;
   characteristicUUIDSuffix?: string;
   bleHandle: BleHandle;
+  eventCallBack: (event: ConfigEventData) => void, // 配网回调
 }
 
 const configAck = '0000000303000002';
@@ -27,7 +28,8 @@ export function sendBLEConfigCmd({
   arrayBuffer,
   serviceUUIDSuffix = 'abf0',
   characteristicUUIDSuffix = 'abf7',
-  bleHandle
+  bleHandle,
+  eventCallBack
 }: IArgs) {
   let sendInterval = null;
   let closeTimeout = null;
@@ -119,6 +121,10 @@ export function sendBLEConfigCmd({
       GizLog.debug(
         'GIZ_SDK: check characteristic and  service success',
       );
+      eventCallBack?.({
+        event: "GIZ_CONNECT_SUCCESS",
+        deviceID: bleDeviceId
+      })
 
       await notifyBLECharacteristicValueChange(
         bleDeviceId,
@@ -126,10 +132,19 @@ export function sendBLEConfigCmd({
         characteristic.uuid
       );
 
+      eventCallBack?.({
+        event: "GIZ_CONFIG_SEND_SUCCESS",
+        deviceID: bleDeviceId
+      })
+
       // 这里有个问题，模组好像不一定每次都会回
       const handleBLECharacteristicValueChange = (res: WechatMiniprogram.OnBLECharacteristicValueChangeListenerResult) => {
         const hexString = ab2hex(res.value);
         GizLog.debug('GIZ_SDK: 收到设备返回ack', hexString)
+        eventCallBack({
+          event: "GIZ_CONFIG_RECV_SUCCESS",
+          deviceID: bleDeviceId
+        })
         if (hexString === configAck) {
           // 发送成功
           bleHandle.removeEventListener("GizBleDeviceData", handleBLECharacteristicValueChange)
@@ -198,13 +213,19 @@ interface ISetDeviceOnboardingDeployProps {
   timeout: number;
   isBind: boolean;
   softAPSSIDPrefix: string;
+  eventCallBack: (event: ConfigEventData) => void; // 配网回调
 }
 
 
 class BLEConfig extends ConfigBase {
   bleHandle: BleHandle;
 
-  constructor(ssid: string, bssid: string, password: string, specialProductKeys: string[], specialProductKeySecrets: string[],bleHandle: BleHandle) {
+  constructor(
+    ssid: string, bssid: string, 
+    password: string, specialProductKeys: string[], 
+    specialProductKeySecrets: string[],
+    bleHandle: BleHandle,
+    ) {
     super(ssid, bssid, password,specialProductKeys,specialProductKeySecrets)
     this.bleHandle = bleHandle;
   }
@@ -286,8 +307,14 @@ class BLEConfig extends ConfigBase {
     timeout,
     isBind = true,
     softAPSSIDPrefix,
+    eventCallBack = (e) => {},
   }: ISetDeviceOnboardingDeployProps) => {
+    this.eventCallBack = eventCallBack;
     return new Promise<IResult<IDevice[]>>(async (res, rej) => {
+      this.eventCallBack?.({
+        event: "GIZ_CONFIG_START",
+        deviceID: null
+      })
       const ssid = this.ssid;
       const password = this.password;
       this.destroy();
@@ -388,6 +415,10 @@ class BLEConfig extends ConfigBase {
         }
         const bleDevice = bleDevices.shift();
         if (bleDevice) {
+          this.eventCallBack?.({
+            event: "GIZ_DISCOVER_SUCCESS",
+            deviceID: bleDevice.deviceId
+          })
           GizLog.debug('GIZ_SDK: startConfigDevice, target device: ', bleDevice);
         }
 
@@ -396,7 +427,8 @@ class BLEConfig extends ConfigBase {
           (await sendBLEConfigCmd({
             bleDeviceId: bleDevice.deviceId,
             arrayBuffer: uint8Array.buffer,
-            bleHandle: this.bleHandle
+            bleHandle: this.bleHandle,
+            eventCallBack: this.eventCallBack
           }));
 
         if (!success) {