mini_program_gizwits_sdk 3.0.1 → 3.0.6

package/src/wifiConfig/ap.ts

@@ -0,0 +1,193 @@
+import errorCode from "../errorCode";
+import WifiConfig from "../protocol/WifiConfig";
+import { IRandomCodesResult, IResult, IntervalHandle } from "../sdk";
+import ConfigBase from "./ConfigBase";
+
+
+interface configDeviceParams {
+  ssid: string;
+  password: string;
+  softAPSSIDPrefix: string;
+}
+
+interface ISetDeviceOnboardingDeployProps {
+  timeout: number;
+  isBind: boolean;
+  softAPSSIDPrefix: string;
+}
+class ApConfig extends ConfigBase {
+
+  disableSendUDP = false;
+  private sendMessageInterval: IntervalHandle = null;
+  private UDPSocketHandler: WechatMiniprogram.UDPSocket | null = null;
+
+  destroy = () => {
+    this.cleanTimeout();
+    this.sendMessageInterval && clearInterval(this.sendMessageInterval);
+    this.sendMessageInterval = null;
+
+    if (this.UDPSocketHandler) {
+      this.UDPSocketHandler.offError();
+      this.UDPSocketHandler.offMessage();
+      this.UDPSocketHandler.close();
+    }
+  }
+
+  /**
+   * 负责发指令
+   */
+   configDevice = ({ ssid, password, softAPSSIDPrefix }: configDeviceParams) => {
+    return new Promise<IResult<IRandomCodesResult[]>>((res, rej) => {
+      console.debug('GIZ_SDK: start config device');
+      let searchingDevice = false;
+      let UDP_ERROR_NUM = 0;
+      const uint8Array = WifiConfig.pack(ssid,password);
+      /**
+       * 连接socket 发送
+       */
+      this.UDPSocketHandler = wx.createUDPSocket();
+      this.UDPSocketHandler.bind();
+
+      this.disableSendUDP = false;
+
+      /**
+       * TODO
+       * 收到设备回的包后终止
+       * 或者超时
+       * 或者成功
+       */
+      const sendMessage = () => {
+        try {
+          !this.disableSendUDP &&
+            this.UDPSocketHandler!.send({
+              address: '10.10.100.254',
+              port: 12414,
+              message: uint8Array,
+              offset: 0,
+              length: uint8Array.byteLength,
+            });
+        } catch (error) {
+          // console.log('sendMessage', error);
+        }
+      };
+
+      // 执行
+      this.sendMessageInterval = setInterval(() => {
+        // console.debug('发送配置包')
+        sendMessage();
+      }, 2000);
+
+      this.UDPSocketHandler.onError((data: any) => {
+        UDP_ERROR_NUM += 1;
+        // UDPSocketHandler.close();
+        // 重试三次不行还是失败
+        if (UDP_ERROR_NUM > 2) {
+          this.destroy();
+          rej({
+            success: false,
+            err: {
+              errorCode: errorCode.WECHAT_ERROR.errorCode,
+              errorMessage: data.errMsg,
+            },
+          });
+        }
+      });
+
+      // 清理一些监听，调用搜索设备
+      const searchDeviceHandle = async () => {
+        if (searchingDevice) return;
+        this.UDPSocketHandler!.offMessage();
+        this.UDPSocketHandler!.offError();
+        this.sendMessageInterval && clearInterval(this.sendMessageInterval);
+        this.disableSendUDP = true;
+        // 标记可以停止监听
+        searchingDevice = true;
+        // 关闭socket
+        try {
+          const devicesReturn = await this.searchDevice({ ssid, password });
+          res(devicesReturn);
+        } catch (error) {
+          rej(error);
+        }
+      };
+
+      this.UDPSocketHandler.onMessage((_data) => {
+        // 收到回调 可以停止发包
+        searchDeviceHandle();
+      });
+
+      // 没有收到udp回复的时候不进入配网
+      wx.onNetworkStatusChange(async () => {
+        // 发生网络切换的时候也停止发包，进入大循环配网
+        // 搜索中的时候不要重复搜索
+        !searchingDevice &&
+          wx.getConnectedWifi({
+            success: async (data) => {
+              /**
+               * 检查当前网络还是不是热点网络
+               */
+              data.wifi.SSID.indexOf(softAPSSIDPrefix) === -1 &&
+                searchDeviceHandle();
+            },
+          });
+      });
+    });
+  };
+  /**
+   * 配网接口
+   * setDeviceOnboardingDeploy方法不可重复调用
+   */
+   setDeviceOnboardingDeploy = ({
+    timeout,
+    isBind = true,
+    softAPSSIDPrefix,
+  }: ISetDeviceOnboardingDeployProps) => {
+    const ssid = this.ssid;
+    const password = this.password;
+    return new Promise<IResult<IDevice[]>>(async (res, rej) => {
+      this.destroy();
+      this.initDeviceOnboardingDeploy(res, rej);
+      this.startTimeoutTimer(timeout);
+
+      try {
+        const result = await this.configDevice({
+          ssid,
+          password,
+          softAPSSIDPrefix,
+        });
+        const newData: IDevice[] = (result.data || []).map(item => {
+          return {
+            mac: item.mac,
+            productKey: item.product_key,
+            did: item.did,
+            name: '',
+            isBind: false,
+            connectType: 'NONE',
+            isBleOnline: false,
+            isLanOnline: false,
+            isOnline: false,
+          }
+        })
+        if (isBind) {
+          try {
+            res(await this.bindDevices(newData));
+          } catch (error) {
+            rej(error);
+          }
+        } else {
+          // 不需要绑定 直接返回成功
+          res({
+            success: true,
+            data: newData,
+          });
+        }
+      } catch (error) {
+        rej(error);
+      } finally {
+        this.destroy();
+      }
+    });
+  };
+}
+
+export default ApConfig;

package/src/wifiConfig/ble.ts

@@ -0,0 +1,417 @@
+import errorCode from "../errorCode";
+import { IRandomCodesResult, IResult } from "../sdk";
+import { ab2hex, advertisData2PkAndMac, isWXDevicesResult } from '../utils';
+
+import {
+  getBluetoothAdapterState,
+  openBluetoothAdapter,
+  startBluetoothDevicesDiscovery,
+  getBluetoothDevices,
+  closeBluetoothAdapter,
+  notifyBLECharacteristicValueChange,
+  unpackWriteBLECharacteristicValue,
+  createBLEConnection,
+  getBLEDeviceServices,
+  getBLEDeviceCharacteristics,
+} from '../wechatApi';
+import sleep from "../sleep";
+import ConfigBase from "./ConfigBase";
+import WifiConfig from "../protocol/WifiConfig";
+
+interface IArgs {
+  bleDeviceId: string;
+  arrayBuffer: ArrayBuffer;
+  serviceUUIDSuffix?: string;
+  characteristicUUIDSuffix?: string;
+}
+
+const configAck = '0000000303000002';
+
+export function sendBLEConfigCmd({
+  bleDeviceId,
+  arrayBuffer,
+  serviceUUIDSuffix = 'abf0',
+  characteristicUUIDSuffix = 'abf7',
+}: IArgs) {
+  let sendInterval = null;
+  // 10秒循环发送
+  let closeTimeout = null;
+  return new Promise<boolean>(async (resolve, reject) => {
+    try {
+      console.debug(
+        'GIZ_SDK: ssid info: ', arrayBuffer
+      );
+      // 设置超时
+      closeTimeout = setTimeout(() => {
+        sendInterval && clearInterval(sendInterval);
+        // 发送超时 返回失败
+        closeTimeout = null;
+        resolve(false);
+      }, 5 * 1000)
+      console.debug(
+        'GIZ_SDK: createBLEConnection start: ', bleDeviceId
+      );
+      const connectData = await createBLEConnection(bleDeviceId, 10 * 1000);
+      console.debug(
+        'GIZ_SDK: createBLEConnection end, res:', connectData
+      );
+      const services = await getBLEDeviceServices(bleDeviceId);
+      console.debug(
+        'GIZ_SDK: getBLEDeviceServices end, res:', services
+      );
+      const service = services.find((s) =>
+        s.uuid.split('-')[0].toLowerCase().endsWith(serviceUUIDSuffix)
+      );
+      if (!service) {
+        // 获取蓝牙设备服务异常
+        console.debug(
+          'GIZ_SDK: get ble device services fail',
+          bleDeviceId,
+          services
+        );
+        resolve(false);
+        return;
+      }
+
+      const characteristics = await getBLEDeviceCharacteristics(
+        bleDeviceId,
+        service.uuid
+      );
+      console.debug(
+        'GIZ_SDK: getBLEDeviceCharacteristics end, res:', characteristics
+      );
+      const characteristic = characteristics.find((c) =>
+        c.uuid.split('-')[0].toLowerCase().endsWith(characteristicUUIDSuffix)
+      );
+      if (!characteristic) {
+        // 获取蓝牙设备特征值异常
+        console.debug(
+          'GIZ_SDK: get ble device characteristics fail',
+          bleDeviceId,
+          characteristics
+        );
+        resolve(false);
+        return;
+      }
+
+      if (
+        !characteristic.properties.notify &&
+        !characteristic.properties.indicate
+      ) {
+        console.debug(
+          'GIZ_SDK: the ble device characteristic not support notify or indicate',
+          bleDeviceId,
+          characteristic
+        );
+        // 该设备不支持 notify & indicate 操作
+        resolve(false);
+        return;
+      }
+
+      console.debug(
+        'GIZ_SDK: check characteristic and  service success',
+      );
+
+      await notifyBLECharacteristicValueChange(
+        bleDeviceId,
+        service.uuid,
+        characteristic.uuid
+      );
+      
+      // 这里有个问题，模组好像不一定每次都会回
+      const handleBLECharacteristicValueChange = (res: WechatMiniprogram.OnBLECharacteristicValueChangeCallbackResult) => {
+        const hexString = ab2hex(res.value);
+        console.debug('GIZ_SDK: 收到设备返回ack', hexString)
+        if (hexString === configAck) {
+          // 发送成功
+          wx.offBLECharacteristicValueChange(handleBLECharacteristicValueChange);
+          resolve(true);
+        }
+      };
+
+      // 订阅特征值变化
+      wx.onBLECharacteristicValueChange(handleBLECharacteristicValueChange);
+
+      console.debug(
+        'GIZ_SDK: on notifyBLECharacteristicValueChange success',
+      );
+
+      // 写特征值
+      if (closeTimeout === null) {
+        sendInterval && clearInterval(sendInterval);
+        return;
+      }
+      await unpackWriteBLECharacteristicValue(
+        bleDeviceId,
+        service.uuid,
+        characteristic.uuid,
+        arrayBuffer
+      );
+      sendInterval = setInterval(() => {
+        if (closeTimeout === null) {
+          sendInterval && clearInterval(sendInterval);
+          return;
+        }
+        unpackWriteBLECharacteristicValue(
+          bleDeviceId,
+          service.uuid,
+          characteristic.uuid,
+          arrayBuffer
+        );
+      }, 2000)
+      
+      // if (res.errCode === 0) {
+      //   resolve(true);
+      // } else{
+      //   resolve(false);
+      // }
+      console.debug('GIZ_SDK: unpackWriteBLECharacteristicValue end');
+    } catch (error) {
+      reject(false);
+      console.debug('GIZ_SDK: sendBLEConfigCmd error', error);
+    }
+  })
+    .catch((error) => {
+      console.debug('GIZ_SDK: sendBLEConfigCmd error', error);
+    })
+    .finally(() => {
+      // 关闭连接
+      closeTimeout && clearTimeout(closeTimeout);
+      sendInterval && clearInterval(sendInterval);
+      wx.closeBLEConnection({ deviceId: bleDeviceId });
+    });
+}
+
+interface configBLEDeviceParams {
+  ssid: string;
+  password: string;
+  softAPSSIDPrefix?: string;
+  timeout: number;
+}
+
+
+interface ISetDeviceOnboardingDeployProps {
+  timeout: number;
+  isBind: boolean;
+  softAPSSIDPrefix: string;
+}
+
+
+class BLEConfig extends ConfigBase {
+  destroy = () => {
+    this.cleanTimeout();
+  }
+  isValidBleDevice = (
+    bleDevice: WechatMiniprogram.BlueToothDevice,
+    softAPSSIDPrefix?: string
+  ) => {
+    if (!bleDevice || !bleDevice.advertisData) {
+      // 无效蓝牙设备或者蓝牙设备广播数据为空，返回失败
+      return false;
+    }
+    
+    const {productKey, mac} = advertisData2PkAndMac(bleDevice.advertisData, this.specialProductKeys)
+
+
+    if (!this.specialProductKeys.includes(productKey)) {
+      // 不在PK列表
+      return false;
+    }
+    console.debug(`GIZ_SDK: isValidBleDevice mac: ${mac} pk: ${productKey} name: ${bleDevice.name}`)
+    console.debug(`GIZ_SDK: softAPSSIDPrefix: ${softAPSSIDPrefix} ismatch : ${bleDevice.name && bleDevice.name.startsWith(softAPSSIDPrefix)}`)
+    return (
+      !softAPSSIDPrefix ||
+      (bleDevice.name && bleDevice.name.startsWith(softAPSSIDPrefix))
+    );
+  };
+
+
+  enableBluetoothDevicesDescovery = async (): Promise<
+    { success: false; err: IError } | { success: true }
+  > => {
+    try {
+      await closeBluetoothAdapter();
+      await openBluetoothAdapter();
+    } catch (error) {
+      
+    }
+    const stateRes = await getBluetoothAdapterState();
+    if (!stateRes.available) {
+      return {
+        success: false,
+        err: {
+          errorCode: errorCode.GIZ_SDK_BLE_BLUETOOTH_FUNCTION_NOT_TURNED_ON.errorCode,
+          errorMessage: '蓝牙状态不可用',
+        },
+      };
+    }
+
+    await startBluetoothDevicesDiscovery();
+    return { success: true };
+  };
+
+
+  enableAndGetBluetoothDevices = async (
+    softAPSSIDPrefix?: string
+  ): Promise<
+    | { success: false; err: IError }
+    | { success: true; bleDevices?: WechatMiniprogram.BlueToothDevice[] }
+  > => {
+    const discoveryRes = await this.enableBluetoothDevicesDescovery();
+    if (!discoveryRes.success) {
+      return discoveryRes;
+    }
+    console.debug('GIZ_SDK: start enableAndGetBluetoothDevices');
+
+    const bleDevices: WechatMiniprogram.BlueToothDevice[] = (
+      await getBluetoothDevices()
+    ).filter((d) => this.isValidBleDevice(d, softAPSSIDPrefix));
+    console.debug('GIZ_SDK: getBluetoothDevices success', bleDevices);
+    return {
+      success: true,
+      bleDevices,
+    };
+  };
+  setDeviceOnboardingDeploy = ({
+    timeout,
+    isBind = true,
+    softAPSSIDPrefix,
+  }: ISetDeviceOnboardingDeployProps) => {
+    return new Promise<IResult<IDevice[]>>(async (res, rej) => {
+      const ssid = this.ssid;
+      const password = this.password;
+      this.destroy();
+      this.initDeviceOnboardingDeploy(res, rej);
+      this.startTimeoutTimer(timeout);
+      try {
+        const result = await this.configBLEDevice({
+          ssid,
+          password,
+          timeout: timeout * 1000,
+          softAPSSIDPrefix,
+        });
+
+        const newData: IDevice[] = (result.data || []).map(item => {
+          return {
+            mac: item.mac,
+            productKey: item.product_key,
+            did: item.did,
+            name: '',
+            isBind: false,
+            connectType: 'NONE',
+            isBleOnline: false,
+            isLanOnline: false,
+            isOnline: false,
+          }
+        })
+        if (isBind) {
+          res(await this.bindDevices(newData));
+        } else {
+          // 不需要绑定 直接返回成功
+          res({
+            success: true,
+            data: newData,
+          });
+        }
+      } catch (error) {
+        rej(error);
+      } finally {
+        this.destroy();
+      }
+    });
+  }
+  /**
+   * 负责发蓝牙设备指令
+   */
+   configBLEDevice = ({
+    ssid,
+    password,
+    softAPSSIDPrefix,
+  }: configBLEDeviceParams) => {
+    return new Promise<IResult<IRandomCodesResult[]>>(async (res, rej) => {
+      console.debug('GIZ_SDK: start config ble device');
+      const enableAndGetRes = await this.enableAndGetBluetoothDevices(
+        softAPSSIDPrefix
+      ).catch((error) => {
+        return {
+          success: false,
+          err: {
+            errorCode: errorCode.WECHAT_ERROR.errorCode,
+            errorMessage: JSON.stringify(error),
+          },
+        };
+      });
+
+      if (!isWXDevicesResult(enableAndGetRes)) {
+        // 开启获取蓝牙失败
+        return rej(enableAndGetRes);
+      }
+
+      const { bleDevices } = enableAndGetRes;
+
+      console.debug('GIZ_SDK: enableAndGetBluetoothDevices success, target devices: ', bleDevices);
+
+      const handleFoundDevices = async ({
+        devices,
+      }: {
+        devices: WechatMiniprogram.BlueToothDevice[];
+      }) => {
+        this.hasTimeoutHandler()
+          ? Array.prototype.push.apply(
+              bleDevices,
+              devices.filter((d) => this.isValidBleDevice(d, softAPSSIDPrefix))
+            )
+          : wx.offBluetoothDeviceFound(handleFoundDevices);
+      };
+
+      wx.onBluetoothDeviceFound(handleFoundDevices);
+
+      const uint8Array = WifiConfig.pack(ssid,password);
+      const startConfigDevice = async () => {
+        console.debug('GIZ_SDK: startConfigDevice');
+        if (!this.hasTimeoutHandler()) {
+          return;
+        }
+        const bleDevice = bleDevices.shift();
+        console.debug('GIZ_SDK: startConfigDevice, target device: ', bleDevice);
+
+        const success =
+          bleDevice &&
+          (await sendBLEConfigCmd({
+            bleDeviceId: bleDevice.deviceId,
+            arrayBuffer: uint8Array.buffer,
+          }));
+
+        if (!success) {
+          // 如果校验设备或者发送不成功，重试下一个设备
+          console.debug("GIZ_SDK: send config fail retry next device")
+          await sleep(500);
+          await startBluetoothDevicesDiscovery();
+          console.debug("GIZ_SDK: startBluetoothDevicesDiscovery")
+          await startConfigDevice();
+          console.debug("GIZ_SDK: search ble device")
+          return;
+        }
+
+        // 如果有一个设备发送成功，则不再发现新设备
+        console.debug("GIZ_SDK: offBluetoothDeviceFound ready search device")
+        wx.offBluetoothDeviceFound(handleFoundDevices);
+      };
+
+      // 开始大循环搜索
+      try {
+        // const devicesReturn = await this.searchDevice({ ssid, password });
+        this.searchDevice({ ssid, password }).then(devicesReturn => {
+          res(devicesReturn);
+        })
+      } catch (error) {
+        rej(error);
+        console.error("GIZ_SDK: searchDevice error", error)
+      }
+
+      await startConfigDevice();
+    });
+  };
+}
+
+export default BLEConfig;