mini_program_gizwits_sdk 3.0.1 → 3.0.6

package/src/sdk.ts

@@ -0,0 +1,811 @@
+import { setGlobalData, getGlobalData } from './globalData';
+import { BleHandle } from './ble';
+import GizwitsWS from './socket';
+
+import ApConfig from './wifiConfig/ap';
+import BLEConfig from './wifiConfig/ble';
+import { errorCode } from '..';
+import { AnonymousLogin, ILoginRes } from './services/login';
+import {
+  bindMac,
+  getBindingList,
+  IOpenApiDevice,
+  ISafeRegisterReturn,
+  IUnbindReturn,
+  safeRegister,
+  unbindDevice,
+} from './services/devices';
+import {
+  getFirstConnectType,
+  getProductInfoThroughPK,
+  isSameDevice,
+  merageBleLocalDevices,
+  merageLanLocalDevices,
+  numberArray2Uint8Array,
+} from './utils';
+import productConfigFileManage from './productConfigFileManage';
+import { IDataPointConfig, pack, unpack } from './protocol/DataPoint';
+import { fillString, hexStrint2byte } from './protocol/tool';
+
+// 接口返回格式
+interface ISDKResult<T> {
+  data?: T;
+  err?: IError;
+  success: boolean;
+}
+export interface ISetCommonDeviceOnboardingDeployProps {
+  ssid: string;
+  password: string;
+  timeout: number;
+  isBind?: boolean;
+  mode?: 0 | 3; // 0 AP 3 BLE
+  softAPSSIDPrefix?: string;
+}
+
+export interface ISetDeviceOnboardingDeployProps
+  extends ISetCommonDeviceOnboardingDeployProps {
+  softAPSSIDPrefix: string;
+}
+
+export interface IRandomCodesResult {
+  random_code: string;
+  product_key: string;
+  mac: string;
+  did: string;
+  user_id: string;
+  timestamp: number;
+  type: string;
+  wifi_soft_ver: string;
+  lan_proto_ver: string;
+}
+
+interface IBindRemoteDeviceParams {
+  productKey: string;
+  mac: string;
+  beOwner?: boolean;
+  alias?: string;
+}
+
+interface IDeviceStatusNoti {
+  device: IDevice;
+  connectType: TConnectType;
+}
+interface IDeviceAttrsNoti {
+  device: IDevice;
+  data: object;
+}
+
+export interface TListenerType {
+  GizDeviceListNotifications: TDeviceListNotifications;
+  GizDeviceStatusNotifications: TDeviceStatusNotifications;
+  GizDeviceAttrsNotifications: TDeviceAttrsNotifications;
+  onScanListChange: OnScanListChange;
+  onBleHandleError: OnBleHandleError;
+}
+
+type TDeviceListNotifications = (devices: IDevice[]) => void;
+type TDeviceStatusNotifications = (data: IDeviceStatusNoti) => void;
+type TDeviceAttrsNotifications = (data: IDeviceAttrsNoti) => void;
+type OnScanListChange = (devices: IDevice[]) => void;
+type OnBleHandleError = (error: IError) => void;
+
+interface IDeviceSafetyRegisterParams {
+  mac: string;
+  productKey: string;
+}
+
+interface IDeviceSafetyParams extends IDeviceSafetyRegisterParams {
+  isReset: boolean;
+}
+export interface IResult<T> {
+  success: boolean;
+  data?: T;
+  err?: IError;
+}
+
+interface ICloudServiceInfo {
+  openAPIInfo: string;
+  siteInfo: string;
+}
+
+export type TimeoutHandle = ReturnType<typeof setTimeout> | null;
+export type IntervalHandle = ReturnType<typeof setInterval> | null;
+export interface IProductInfo {
+  productKey: string;
+  productSecrets: string;
+}
+interface GizwitsSdkOption {
+  appID: string;
+  appSecret: string;
+  productInfo: IProductInfo[];
+  cloudServiceInfo?: any;
+  token?: string;
+  uid?: string;
+  offlineThreshold?: number;
+}
+
+class SDK {
+  private version = '3.0.5';
+  private listenerMap: any = {};
+
+  // 云端获取的设备列表
+  private _deviceList: IDevice[] = [];
+  private get devieList() {
+    return this._deviceList;
+  }
+  private set devieList(data: IDevice[]) {
+    // TODO 覆盖的时候 需要保留netStatus
+    this._deviceList = data;
+
+    // TODO 判断是否发生改变
+    this.notiDeviveList();
+  }
+  // 云端获取的设备列表
+
+  // ble device
+  private _bleDevices: IDevice[] = [];
+  public get bleDevices() {
+    return this._bleDevices;
+  }
+  public set bleDevices(data: IDevice[]) {
+    this._bleDevices = data;
+
+    this.notiDeviveList();
+  }
+  // ble device
+
+  // udp device
+  private _udpDevices: IDevice[] = [];
+  private get udpDevices() {
+    return this._udpDevices;
+  }
+  private set udpDevices(data: IDevice[]) {
+    this._udpDevices = data;
+    this.notiDeviveList();
+  }
+  // udp device
+
+  private get allDevices() {
+    let newDevices = merageBleLocalDevices(
+      [...this.devieList],
+      this.bleDevices
+    );
+    newDevices = merageLanLocalDevices(newDevices, this.udpDevices);
+    /**
+     * 只能有一种通讯方式
+     * 依次LAN BLE WAN
+     * 现在没有局域网，先跳过
+     */
+    this.bleHandle.connectedList.map((item) => {
+      const index = newDevices.findIndex(
+        (device) => device.bleDeviceID === item.deviceId
+      );
+      if (index !== -1) {
+        newDevices[index].connectType = 'BLE';
+      }
+    });
+    return newDevices;
+  }
+
+  private set allDevice(data: IDevice[]) {
+    this.allDevice = data;
+    this.notiDeviveList();
+  }
+
+  private get bleScanDevice() {
+    return this.bleDevices.filter((item) => item.isBleOnline === true);
+  }
+
+  // private set bleScanDevice(data: IDevice[]){
+  //   this.bleDevices = data;
+  // }
+
+  private productInfo: IProductInfo[] = [];
+  // private cloudServiceInfo: any;
+  // 保存当前执行中的配网handle
+
+  private currentWifiConfigHandle: any;
+
+  private _bleHandle: BleHandle;
+  private autoScanInterval: IntervalHandle = null;
+
+  private _gizSocket: GizwitsWS;
+  private offlineThreshold?: number;
+
+  constructor({
+    appID,
+    appSecret,
+    productInfo,
+    cloudServiceInfo,
+    token,
+    uid,
+    offlineThreshold,
+  }: GizwitsSdkOption) {
+    // this.appID = appID;
+    // this.appSecret = appSecret;
+    this.productInfo = productInfo;
+    // this.token = token;
+    // this.uid = uid;
+    // this.cloudServiceInfo = null;
+
+    // 保存相关信息
+    setGlobalData('appID', appID);
+    setGlobalData('appSecret', appSecret);
+    setGlobalData('productInfo', productInfo);
+    setGlobalData('token', token);
+    setGlobalData('uid', uid);
+
+    /**
+     * 同时也设置域名信息
+     */
+    this.setDomain(cloudServiceInfo);
+
+    this.offlineThreshold = offlineThreshold;
+
+    console.debug(`init sdk success, current version: ${this.version}`);
+  }
+
+  private get bleHandle() {
+    // 初始化蓝牙能力
+    if (!this._bleHandle) {
+      this._bleHandle = new BleHandle({
+        pks: this.specialProductKeys,
+        globalListenerMap: this.listenerMap,
+        gizSdk: this,
+        offlineThreshold: this.offlineThreshold,
+      });
+    }
+    return this._bleHandle;
+  }
+
+  private get socketHandle() {
+    if (!this._gizSocket) {
+      this._gizSocket = new GizwitsWS({
+        appID: getGlobalData('appID'),
+        token: getGlobalData('token'),
+        uid: getGlobalData('uid'),
+      });
+      this._gizSocket.subscribeDeviceStatus(this.handleSockerDeviceData);
+    }
+    return this._gizSocket;
+  }
+
+  get specialProductKeys() {
+    return this.productInfo.map((item) => item.productKey ?? '');
+  }
+
+  get specialProductKeySecrets() {
+    return this.productInfo.map((item) => item.productSecrets ?? '');
+  }
+
+  private handleBleDeviceData = async (
+    curDevice: WechatMiniprogram.OnBLECharacteristicValueChangeCallbackResult,
+    hexString: string
+  ) => {
+    const target = this.allDevices.find(
+      (item) => item.bleDeviceID === curDevice.deviceId
+    );
+    if (target) {
+      const data = await unpack(hexStrint2byte(hexString), target.productKey);
+      // 如果有kydata 则上报
+      if (data?.kvData && this.listenerMap['GizDeviceAttrsNotifications']) {
+        this.listenerMap['GizDeviceAttrsNotifications'].map((item) => {
+          item({
+            device: target,
+            data: data?.kvData,
+          });
+        });
+      }
+    }
+  };
+
+  private handleSockerDeviceData: IOnDeviceStatusChanged = (data) => {
+    const target = this.allDevices.find((item) => item.did === data.did);
+    if (!target) {
+      return;
+    }
+    if (this.listenerMap['GizDeviceAttrsNotifications']) {
+      this.listenerMap['GizDeviceAttrsNotifications'].map((item) => {
+        item({
+          device: target,
+          ...('attrs' in data ? { data: data.attrs } : { raw: data.raw }),
+        });
+      });
+    }
+  };
+
+  private notiDeviveList = () => {
+    // 找到所有挂载的列表通知
+    this.listenerMap['GizDeviceListNotifications']?.map((notifyFn) => {
+      notifyFn(this.allDevices);
+    });
+
+    this.listenerMap['onScanListChange']?.map((notifyFn) => {
+      console.log('this.scanBleDevice', this.bleScanDevice);
+      notifyFn(this.bleScanDevice);
+    });
+  };
+
+  /**
+   * @description 开启后台自动扫描
+   */
+  public startAutoScan = () => {
+    if (this.autoScanInterval) {
+      clearInterval(this.autoScanInterval);
+    }
+    this.autoScanInterval = setInterval(async () => {
+      const data = await this.bleHandle.startScan(() => {}, 6000);
+      console.log('auto scan result', data);
+      this.bleDevices = data.scanList;
+    }, 6000);
+  };
+
+  /**
+   * @description 停止后台自动扫描
+   */
+
+  public stopAutoScan = () => {
+    if (this.autoScanInterval) {
+      clearInterval(this.autoScanInterval);
+    }
+  };
+
+  /**
+   * @description 更改设备列表中的元信息，包括设备mac，设备在线状态等
+   */
+  public setDeviceMeta = <K extends keyof IDevice>(
+    curDev: IDevice,
+    key: K,
+    value: IDevice[K]
+  ) => {
+    const target = this.allDevices.find((dev) => dev.mac === curDev.mac);
+    if (!target || this.allDevices.length === 0) {
+      return;
+    }
+    target[key] = value;
+    console.log('setDeviceMeta', this.allDevices);
+    this.notiDeviveList();
+  };
+
+  getVersion = () => {
+    return {
+      success: true,
+      data: this.version,
+    };
+  };
+
+  /**
+   * 初始化蓝牙能力
+   * @returns {Promise<{success: boolean, err: string}>}
+   */
+  public initBle = async (): Promise<ISDKResult<null>> => {
+    const permissionData = await this.bleHandle.checkPermission();
+    if (!permissionData.success) {
+      console.error('init BLE Error', permissionData);
+      return {
+        success: false,
+        err: errorCode.GIZ_SDK_BLE_BLUETOOTH_FUNCTION_NOT_TURNED_ON,
+      };
+    }
+
+    this.bleHandle.addDeviceListener('ALL', this.handleBleDeviceData);
+    console.debug('init BLE succcess', permissionData);
+    return { success: true };
+  };
+
+  /**
+   * @description 扫描附近的机智云ble设备
+   * @param delay 超时时间
+   * @returns {success:boolean,data:IDevice[]}
+   */
+  public scanBleDevice = async (
+    delay: number
+  ): Promise<ISDKResult<IDevice[]>> => {
+    console.log('start scanBleDevice');
+    this.bleHandle.scanList = [];
+    const data = await this.bleHandle.startScan((deviceList) => {
+      this.bleDevices = deviceList;
+    }, delay);
+    console.debug('scanBleDevice', data);
+    return {
+      success: true,
+      data: data.scanList,
+    };
+  };
+
+  write = async (device: IDevice, attrs: object) => {
+    console.log('待发送指令:', device, attrs);
+    const target = this.allDevices.find((item) => isSameDevice(item, device));
+    if (!target) {
+      return { success: false, message: 'target is undefind' };
+    }
+    if (target.connectType !== 'NONE') {
+      switch (target.connectType) {
+        case 'BLE': {
+          const value = await pack(attrs, target.productKey);
+          if (value) {
+            console.log('write cmd', value, attrs);
+            this.bleHandle.write(
+              target.bleDeviceID as string,
+              numberArray2Uint8Array(value).buffer
+            );
+          } else {
+            // 解码失败
+          }
+
+          break;
+        }
+        case 'WAN': {
+          this.socketHandle.writeData(target, attrs);
+        }
+      }
+    }
+  };
+
+  getProductConfig = async (
+    pk: string
+  ): Promise<ISDKResult<IDataPointConfig>> => {
+    const data = await productConfigFileManage.getConfigFile(pk);
+    if (data) {
+      return {
+        success: true,
+        data,
+      };
+    }
+    return {
+      success: false,
+    };
+  };
+
+  stopScanBleDevice = () => {
+    this.bleHandle.stopScan();
+  };
+
+  // 微信匿名登陆
+  login = async (openID: string): Promise<ISDKResult<ILoginRes>> => {
+    const data = await AnonymousLogin({ uid: openID });
+    if (data.success) {
+      setGlobalData('token', data.data?.token);
+      setGlobalData('uid', data.data?.uid);
+    }
+    return data;
+  };
+
+  getDeviceStatus = async (device: IDevice, attrNames?: string[]) => {
+    // 根据PK和mac 找到设备，确认他的连接类型，再用不同的渠道下发
+    const target = this.allDevices.find((item) => isSameDevice(item, device));
+    if (!target) {
+      return { success: false, message: 'target is undefind' };
+    }
+    switch (target.connectType) {
+      case 'BLE': {
+        return await this.bleHandle.getDeviceStatus(
+          target.bleDeviceID as string,
+          target.productKey,
+          target.rootDeviceId,
+          attrNames
+        );
+      }
+      case 'WAN':
+        return this.socketHandle.readStatus(target, attrNames);
+      default: {
+        return {
+          success: false,
+          message: 'Device connectType is unsupported',
+        };
+      }
+    }
+  };
+
+  /**
+   * 发起设备订阅
+   * @param device 待订阅设备
+   * @param connectType 设备连接类型
+   * @param _autoGetDeviceStatus 自动获取设备状态
+   * @returns
+   */
+  subscribe = async (
+    device: IDevice,
+    connectType?: TConnectType,
+    _autoGetDeviceStatus: boolean = true
+  ) => {
+    const type: TConnectType = getFirstConnectType(device, connectType);
+    switch (type) {
+      case 'BLE': {
+        // 连接BLE
+        const target = this.bleDevices.find((item) =>
+          isSameDevice(item, device)
+        );
+        if (!target) {
+          return { success: false };
+        }
+        const data = await this.bleHandle.connectDevice(target.bleDeviceID);
+        if (data.success) {
+          this.setDeviceMeta(target, 'connectType', 'BLE');
+          setTimeout(() => {
+            this.getDeviceStatus(target);
+          }, 500);
+        } else {
+          this.bleHandle.disConnectDevice(target.bleDeviceID);
+        }
+        return data;
+      }
+      case 'WAN': {
+        // 大循环设备
+        const data = this.socketHandle.connectDevice(device);
+        if (data.success) {
+          this.setDeviceMeta(device, 'connectType', 'WAN');
+        }
+        return data;
+      }
+    }
+    return {
+      success: false,
+    };
+  };
+
+  /**
+   *
+   * @param device 待取消订阅设备
+   * @returns 取消订阅结果
+   */
+  unSubscribe = async (device: IDevice) => {
+    switch (device.connectType) {
+      case 'BLE': {
+        const disconnectRes = await this.bleHandle.disConnectDevice(
+          device.bleDeviceID as string
+        );
+        if (disconnectRes.success) {
+          this.setDeviceMeta(device, 'connectType', 'NONE');
+        }
+        return disconnectRes;
+      }
+    }
+    return {
+      success: false,
+    };
+  };
+
+  /**
+   * 绑定注册到云端的设备
+   * 设备必须要注册到云端才能正常绑定
+   */
+  bindRemoteDevice = async ({
+    mac,
+    productKey,
+    alias,
+    beOwner,
+  }: IBindRemoteDeviceParams): Promise<ISDKResult<IOpenApiDevice>> => {
+    const target = getProductInfoThroughPK(productKey, this.productInfo);
+    if (target) {
+      const data = await bindMac({
+        mac,
+        productKey,
+        productSecret: target.productSecrets,
+        alias,
+        beOwner,
+      });
+      // 绑定成功主动获取设备列表
+      this.getBindingList();
+      return data;
+    }
+    return {
+      success: false,
+      err: errorCode.GIZ_SDK_PRODUCTKEY_NOT_IN_SPECIFY,
+    };
+  };
+
+  unbindDevice = async ({
+    devices,
+  }: {
+    devices: IDevice[];
+  }): Promise<ISDKResult<IUnbindReturn>> => {
+    const data = await unbindDevice({ devices });
+    // 主动刷新列表
+    if (data.success) {
+      this.getBindingList();
+    }
+    return data;
+  };
+
+  deviceSafetyRegister = async ({
+    mac,
+    productKey,
+  }: IDeviceSafetyRegisterParams): Promise<ISDKResult<ISafeRegisterReturn>> => {
+    return await this.deviceSafetyApi({ mac, productKey, isReset: false });
+  };
+  deviceSafetyUnbind = async ({
+    mac,
+    productKey,
+  }: IDeviceSafetyRegisterParams): Promise<ISDKResult<ISafeRegisterReturn>> => {
+    return await this.deviceSafetyApi({ mac, productKey, isReset: true });
+  };
+
+  /**
+   * 配网接口
+   * setDeviceOnboardingDeploy方法不可重复调用
+   */
+  setDeviceOnboardingDeploy = async ({
+    ssid,
+    password,
+    mode = 0,
+    timeout,
+    isBind = true,
+    softAPSSIDPrefix,
+  }: ISetDeviceOnboardingDeployProps): Promise<ISDKResult<IDevice[]>> => {
+    if (this.currentWifiConfigHandle) {
+      return {
+        success: false,
+        err: errorCode.GIZ_SDK_DEVICE_CONFIG_IS_RUNNING,
+      };
+    }
+    const sTime = new Date().getTime();
+    console.debug('GIZ_SDK: 配网开始时间:' + sTime);
+    try {
+      switch (mode) {
+        case 0: {
+          this.currentWifiConfigHandle = new ApConfig(
+            ssid,
+            password,
+            this.specialProductKeys,
+            this.specialProductKeySecrets
+          );
+          const data =
+            await this.currentWifiConfigHandle.setDeviceOnboardingDeploy({
+              timeout,
+              isBind,
+              softAPSSIDPrefix,
+            });
+          this.currentWifiConfigHandle = null;
+          const eTime = new Date().getTime();
+          console.debug('GIZ_SDK: 配网结束时间:' + eTime);
+          console.debug('GIZ_SDK: 配网用时:' + (eTime - sTime));
+          return data;
+        }
+        case 3: {
+          this.currentWifiConfigHandle = new BLEConfig(
+            ssid,
+            password,
+            this.specialProductKeys,
+            this.specialProductKeySecrets
+          );
+          const data =
+            await this.currentWifiConfigHandle.setDeviceOnboardingDeploy({
+              timeout,
+              isBind,
+              softAPSSIDPrefix,
+            });
+          this.currentWifiConfigHandle = null;
+          const eTime = new Date().getTime();
+          console.debug('GIZ_SDK: 配网结束时间:' + eTime);
+          console.debug('GIZ_SDK: 配网用时:' + (eTime - sTime));
+          return data;
+        }
+      }
+    } catch (error) {
+      console.error(error);
+      if (
+        (error as ISDKResult<IDevice[]>).err &&
+        (error as ISDKResult<IDevice[]>).err!.errorCode
+      ) {
+        return error as ISDKResult<IDevice[]>;
+      }
+      return {
+        success: false,
+        err: errorCode.GIZ_SDK_OTHERWISE,
+      };
+    } finally {
+      this.currentWifiConfigHandle = null;
+    }
+  };
+
+  /**
+   * 设置域名
+   */
+  private setDomain = (cloudServiceInfo: ICloudServiceInfo) => {
+    const openAPIInfo =
+      (cloudServiceInfo && cloudServiceInfo.openAPIInfo) || 'api.gizwits.com';
+
+    const siteInfo =
+      (cloudServiceInfo && cloudServiceInfo.siteInfo) || 'site.gizwits.com';
+
+    const newData = { ...(cloudServiceInfo || {}), openAPIInfo, siteInfo };
+    setGlobalData('cloudServiceInfo', newData);
+  };
+
+  private deviceSafetyApi = async ({
+    mac,
+    productKey,
+    isReset,
+  }: IDeviceSafetyParams): Promise<ISDKResult<ISafeRegisterReturn>> => {
+    const target = getProductInfoThroughPK(productKey, this.productInfo);
+    if (target) {
+      return await safeRegister({
+        productKey,
+        productSecret: target.productSecrets,
+        mac,
+        isReset,
+        passcode: '1234567890',
+      });
+    }
+    return {
+      success: false,
+      err: errorCode.GIZ_SDK_PRODUCTKEY_NOT_IN_SPECIFY,
+    };
+  };
+
+  // 内部刷新设备列表的方法
+  public getBindingList = async () => {
+    const data = await getBindingList();
+    this.devieList = data.data || [];
+  };
+
+  /**
+   * 刷新云端设备列表
+   * 并合并数据
+   */
+  public getDevices = async (): Promise<ISDKResult<IDevice[]>> => {
+    // merage
+    await this.getBindingList();
+    // 简单粗暴的先合并
+    return {
+      success: true,
+      data: this.allDevices,
+    };
+  };
+
+  /**
+   * 停止配网
+   */
+  stopDeviceOnboardingDeploy = (): void => {
+    if (this.currentWifiConfigHandle) {
+      this.currentWifiConfigHandle.stopDeviceOnboardingDeploy();
+      this.currentWifiConfigHandle = null;
+    }
+  };
+
+  /**
+   * 移除事件监听
+   * @param type 事件监听名称，详见下表
+   * @param func 事件监听回调
+   * @returns
+   */
+  public removeEventListener = <K extends keyof TListenerType>(
+    type: K,
+    func: TListenerType[K]
+  ) => {
+    if (this.listenerMap[type]) {
+      const index = this.listenerMap[type].indexOf(func);
+      if (index !== -1) {
+        // 删除数组中的这一行
+        this.listenerMap[type].splice(index, 1);
+        return {
+          success: true,
+        };
+      }
+    }
+    return {
+      success: false,
+      // err: errorCode.GIZ_SDK_BLE_BLUETOOTH_FUNCTION_NOT_TURNED_ON
+    };
+  };
+
+  public addEventListener = async <K extends keyof TListenerType>(
+    type: K,
+    func: TListenerType[K]
+  ) => {
+    if (!this.listenerMap[type]) {
+      // 创建一个新的
+      this.listenerMap[type] = [];
+    }
+
+    if (this.listenerMap[type].indexOf(func) === -1) {
+      this.listenerMap[type].push(func);
+    }
+    return {
+      success: true,
+    };
+  };
+}
+
+export default SDK;