mini_program_gizwits_sdk 3.6.1 → 3.6.3

package/src/types/index.ts

@@ -0,0 +1,455 @@
+import { TCPHandler } from "../handler/lan";
+import DiscoverUDP from "../protocol/DiscoverUDP";
+import { wrapErrorInfo } from "../utils";
+
+
+export type TUtf8 = {
+  toBytes: (data: any) => any
+}
+
+export type TUtils = {
+  utf8: TUtf8;
+}
+
+export interface ecb {
+  new(data: any): any;
+}
+
+export type TModeOfOperation = {
+  ecb: ecb;
+}
+export interface IError {
+  errorCode: number;
+  errorMessage?: string;
+}
+
+export interface ICommonObj {
+  [key: string]: any
+}
+
+export interface IDeviceStatusChangedProps {
+  did: string;
+  attrs: ICommonObj;
+}
+
+export interface IDeviceRawStatusChangedProps {
+  did: string;
+  raw: Uint8Array;
+}
+
+export interface IOnDeviceStatusChanged {
+  (data: IDeviceStatusChangedProps | IDeviceRawStatusChangedProps): void;
+}
+
+export interface IOnSocketStatusChanged {
+  (dids: string[], enabled: boolean): void;
+}
+
+export interface IEmptyFn {
+  (): void;
+}
+
+export 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;
+  isOnline: boolean; // 代表大循环在线
+  isLanOnline: boolean; // 代表小循环在线
+  isBleOnline: boolean; // 代表蓝牙在线
+  host?: string;
+  wss_port?: number;
+  ctime?: number;
+}
+
+export type TConnectType = 'BLE' | 'BLE_BROADCAST' | 'LAN' | 'WAN' | 'NONE';
+
+export interface IBluetoothAdapterStateResult {
+  discovering: boolean;
+  available: boolean;
+}
+
+export interface IWechatResult {
+  errMsg: string;
+  errCode: number;
+}
+
+export interface IWXDevicesResult {
+  success: true;
+  bleDevices: WechatMiniprogram.BlueToothDevice[];
+}
+
+/**sdk */
+
+export interface SyncCallBackParams {
+  event: TSyncEvnet;
+  currentNum?: number;
+  totalNum?: number;
+  message?: string;
+}
+export type TSyncEvnet = 'SYNC_START' | 'SYNC_END' | 'SYNC_FAIL' | 'SYNC_CANCEL' | 'SYNC_PROGRESS';
+export type SyncCallBack = (data: SyncCallBackParams) => void
+export type IOTAType = 'MCU' | 'MODULE'
+
+// 接口返回格式
+export interface ISDKResult<T> {
+  data?: T;
+  err?: IError;
+  message?: string;
+  success: boolean;
+}
+export interface ISetCommonDeviceOnboardingDeployProps {
+  ssid: string;
+  bssid?: string;
+  password: string;
+  timeout: number;
+  isBind?: boolean;
+  mode?: 0 | 3 | 5; // 0 AP 3 BLE 5 NFC
+  softAPSSIDPrefix?: string;
+}
+
+export interface ISetDeviceOnboardingDeployProps
+  extends ISetCommonDeviceOnboardingDeployProps {
+  softAPSSIDPrefix: string;
+  eventCallBack: (event: ConfigEventData) => void, // 配网回调
+}
+
+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;
+}
+
+export interface IBindRemoteDeviceParams {
+  productKey: string;
+  mac: string;
+  beOwner?: boolean;
+  alias?: string;
+}
+
+export interface IDeviceStatusNoti {
+  device: IDevice;
+  connectType: TConnectType;
+}
+export interface IDeviceAttrsNoti {
+  device: IDevice;
+  data: object;
+}
+
+export interface TListenerType {
+  GizDeviceListNotifications: TDeviceListNotifications;
+  GizDeviceStatusNotifications: TDeviceStatusNotifications;
+  GizDeviceAttrsNotifications: TDeviceAttrsNotifications;
+  onScanListChange: OnScanListChange;
+  onBleHandleError: OnBleHandleError;
+}
+
+export type TDeviceListNotifications = (devices: IDevice[]) => void;
+export type TDeviceStatusNotifications = (data: IDeviceStatusNoti) => void;
+export type TDeviceAttrsNotifications = (data: IDeviceAttrsNoti) => void;
+export type OnScanListChange = (devices: IDevice[]) => void;
+export type OnBleHandleError = (error: IError) => void;
+
+export interface IDeviceSafetyRegisterParams {
+  mac: string;
+  productKey: string;
+}
+
+export interface IDeviceSafetyParams extends IDeviceSafetyRegisterParams {
+  isReset: boolean;
+}
+export interface IResult<T> {
+  success: boolean;
+  data?: T;
+  err?: IError;
+}
+
+export interface ICloudServiceInfo {
+  openAPIInfo: string;
+}
+
+export type TimeoutHandle = ReturnType<typeof setTimeout> | null;
+export type IntervalHandle = ReturnType<typeof setInterval> | null;
+export interface IProductInfo {
+  productKey: string;
+  productSecret: string;
+}
+export interface GizwitsSdkOption {
+  appID: string;
+  appSecret: string;
+  productInfo: IProductInfo[];
+  cloudServiceInfo?: ICloudServiceInfo;
+  token?: string;
+  uid?: string;
+  offlineThreshold?: number;
+}
+
+/**sdk */
+
+
+export 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;
+}
+
+export interface IOpenApiDevice {
+  product_key: string;
+  did: string;
+  mac: string;
+  passcode: string;
+  is_online: boolean;
+  host: string;
+  port: string;
+  port_s: string;
+  ws_port: number;
+  wss_port: number;
+  dev_alias: string;
+  remark: string;
+  type: 'normal' | 'center_control' | 'sub_dev';
+}
+
+export interface IDeviceRes {
+  devices: IOpenApiDevice[];
+}
+
+export interface IErrorCode {
+  [key: string]: IError;
+}
+
+export interface IWechatApiResult<T> {
+  data: T;
+  errMsg: string;
+  statusCode: number;
+}
+
+export interface IServiceResult<T> {
+  success: boolean;
+  data?: T;
+  err?: IError;
+}
+
+
+export interface IGetRandomCodes {
+  SSID: string;
+  password: string;
+  pks: string[];
+}
+
+export interface IGetRandomCode {
+  SSID: string;
+  password: string;
+  pk: string;
+}
+
+
+export interface IProductConfigData {
+  [key: string]: IDataPointConfig;
+}
+
+
+export interface IDataPointConfig {
+  name: string;
+  protocolType: 'var_len' | 'standard';
+  entities: IDataPointEntitie[];
+}
+
+
+
+export interface IDataPointEntitie {
+  display_name: string;
+  attrs: IDataPointAttr[];
+}
+
+export interface IDataPointPosition {
+  byte_offset: number;
+  unit: 'bit' | 'byte';
+  len: number;
+  bit_offset: number;
+}
+
+export type TDataType = 'bool' | 'uint8' | 'uint16' | 'uint32' | 'binary' | 'enum' | 'number';
+
+
+export interface IUnitSpec {
+  addition: number;
+  max: number;
+  ratio: number;
+  min: number;
+}
+
+export type TDataOptionType = 'status_writable' | 'status_readonly' | 'alert' | 'fault' | 'ALL';
+export interface IDataPointAttr {
+  display_name: string;
+  uint_spec: IUnitSpec;
+  name:string;
+  data_type: TDataType;
+  position: IDataPointPosition;
+  type: TDataOptionType;
+  id: number;
+  enum: string[];
+  desc: string;
+}
+
+/**
+ * 蓝牙
+ */
+
+export type GizBleDeviceListotifications = (devices: IDevice[]) => void;
+export type GizBleDeviceDataNotifications = (
+  curDevice: WechatMiniprogram.OnBLECharacteristicValueChangeListenerResult,
+  hexString: string
+) => void;
+export type GizBleErrorNotifications = (err: { errCode: number; errMsg: string }) => void;
+// 返回true 代表放弃监听
+export type TBleDataListener<T> = (_curDevice: WechatMiniprogram.OnBLECharacteristicValueChangeListenerResult,
+  hexString: string) => T | null | undefined;
+
+export interface CheckOTAParams {
+  device: IDevice;
+  type: IOTAType;
+}
+
+export type OTAEventCode = 'GizOTAEventPretreatment' | 'GizOTAEventDownload' | 'GizOTAEventTransmit' | 'GizOTAEventReboot' | 'GizOTAEventFinish'
+export interface OTAEvent {
+  code: OTAEventCode; //
+};
+export interface OTAProgressEvent {
+  firmwareSize: number;
+  packageMaxLen: number;
+  currentNumber: number;
+  currentProgress: number; // 0 ~ 100
+}
+
+export type OTAProgressEventCallback = (event: OTAProgressEvent) => void;
+export type OTAEventCallback = (event: OTAEvent) => void;
+export interface StartUpgradeParams extends CheckOTAParams {
+  onProgress: OTAProgressEventCallback
+  onEvent: OTAEventCallback
+  productKey: string
+}
+
+
+export interface TBleHandleEvent {
+  GizBleDeviceData: GizBleDeviceDataNotifications;
+  GizBleDeviceList: GizBleDeviceListotifications;
+  GizBleError: GizBleErrorNotifications;
+}
+
+export interface GizwitsWxBlueToothDevice extends WechatMiniprogram.BlueToothDevice {
+  communicationType: 'BLE_BROADCAST' | 'BLE';
+}
+
+export interface BleHandleParams {
+  serviceUUIDSuffix: string;
+  characteristicUUIDSuffix: string;
+}
+
+export interface IStartScanResult {
+  scanList: IDevice[];
+  err?: ReturnType<typeof wrapErrorInfo>;
+}
+
+export interface IDeviceReq<T> {
+  success: boolean;
+  data: T;
+}
+
+// export type BleHandle = ReturnType<typeof createBleHandle>;
+
+export type OnScanDevice = (scanList: IDevice[]) => void;
+export interface BleConnectDevice {
+  deviceId?: string;
+  serviceId?: string;
+  characteristicId?: string;
+  errMsg?: string;
+}
+
+export interface BleConstructorParams {
+  pks: string[];
+  bleHandleParams?: BleHandleParams;
+  offlineThreshold?: number;
+}
+/**
+ * 蓝牙
+ */
+
+
+
+// 局域网连接设备结构
+export interface LanConnectDevice {
+  mac: string
+  productKey: string
+  socketHandle: TCPHandler
+}
+
+// 局域网设备
+export interface ILanDevice extends IDevice {
+  expandData: DiscoverUDP
+  ip: string
+}
+
+export type GizLanDeviceListNotifications = (devices: IDevice[]) => void;
+export type GizLanDeviceDataNotifications = (mac: string, data: string) => void;
+export interface TLanHandleEvent {
+  GizLanDeviceList: GizLanDeviceListNotifications;
+  GizLanDeviceData: GizLanDeviceDataNotifications
+}
+
+
+
+export interface IBLEService {
+  uuid: string;
+  isPrimary: boolean;
+}
+export interface IBLECharacteristic {
+  uuid: string;
+  properties: {
+    read: boolean;
+    write: boolean;
+    notify: boolean;
+    indicate: boolean;
+  }
+}
+
+export interface ILoginRes {
+  expire_at: number;
+  token: string;
+  uid: string;
+}
+
+export interface OTARes {
+  download_url: string;
+  soft_ver: string; // 新的版本号
+}
+
+export interface configDeviceParams {
+  ssid: string;
+  password: string;
+  softAPSSIDPrefix: string;
+}
+
+
+
+export interface configBLEDeviceParams {
+  ssid: string;
+  password: string;
+  softAPSSIDPrefix?: string;
+  timeout: number;
+}

package/src/utils.ts

@@ -1,8 +1,7 @@
 import { lib } from "crypto-js/core";
 
-import { IProductInfo } from './sdk';
-import { GizwitsWxBlueToothDevice } from './handler/ble';
 import GizLog from './GizLog';
+import { IDevice, IError, IWXDevicesResult, TConnectType, IProductInfo, GizwitsWxBlueToothDevice } from "./types";
 
 export function ab2hex(buffer: ArrayBuffer) {
   let hexArr = Array.prototype.map.call(new Uint8Array(buffer), function (bit) {
@@ -55,10 +54,6 @@ export const unionBy = <T>(array: T[], key: string) => {
   }, []);
 };
 
-interface IWXDevicesResult {
-  success: true;
-  bleDevices: WechatMiniprogram.BlueToothDevice[];
-}
 export function isWXDevicesResult(res: unknown): res is IWXDevicesResult {
   return (
     (res as IWXDevicesResult).success &&

package/src/wechatApi.ts

@@ -1,15 +1,7 @@
 import GizLog from "./GizLog";
 import sleep from "./sleep";
+import { IBluetoothAdapterStateResult, IWechatResult, IBLEService, IBLECharacteristic } from "./types";
 
-interface IBluetoothAdapterStateResult {
-  discovering: boolean;
-  available: boolean;
-}
-
-export interface IWechatResult {
-  errMsg: string;
-  errCode: number;
-}
 
 /**
  * 重连
@@ -98,10 +90,6 @@ export function createBLEConnection(deviceId: string, timeout: number) {
   })
 }
 
-interface IBLEService {
-  uuid: string;
-  isPrimary: boolean;
-}
 
 export function getBLEDeviceServices(deviceId: string) {
   return new Promise<IBLEService[]>((res, rej) => {
@@ -113,15 +101,6 @@ export function getBLEDeviceServices(deviceId: string) {
   })
 }
 
-interface IBLECharacteristic {
-  uuid: string;
-  properties: {
-    read: boolean;
-    write: boolean;
-    notify: boolean;
-    indicate: boolean;
-  }
-}
 
 export function getBLEDeviceCharacteristics(deviceId: string, serviceId: string) {
   return new Promise<IBLECharacteristic[]>((res, rej) => {

package/src/wifiConfig/ConfigBase.ts

@@ -1,18 +1,10 @@
-import { IRandomCodesResult, IResult, TimeoutHandle } from "../sdk";
+import { IRandomCodesResult, IRejectCallback, IResult, TimeoutHandle } from "../types";
 import sleep from "../sleep";
 import errorCode from "../errorCode";
 import { bindMac, checkDeviceRegister } from '../services/devices';
 import GizLog from "../GizLog";
+import { ConfigEventData, IDevice } from "../types";
 // import timeZoneDic from './timeZoneName.json'
-
-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 = '';

package/src/wifiConfig/ap.ts

@@ -1,21 +1,9 @@
 import errorCode from "../errorCode";
 import GizLog from "../GizLog";
 import WifiConfig from "../protocol/WifiConfig";
-import { IRandomCodesResult, IResult, IntervalHandle } from "../sdk";
+import { IDevice, IRandomCodesResult, IResult, IntervalHandle, configDeviceParams, ISetDeviceOnboardingDeployProps } from "../types";
 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;

package/src/wifiConfig/ble.ts

@@ -1,5 +1,4 @@
 import errorCode from "../errorCode";
-import { IRandomCodesResult, IResult } from "../sdk";
 import { ab2hex, advertisData2PkAndMac, isWXDevicesResult } from '../utils';
 
 import GizLog from "../GizLog";
@@ -10,7 +9,8 @@ import {
   getBLEDeviceCharacteristics, getBLEDeviceServices, getBluetoothAdapterState, getBluetoothDevices,
   notifyBLECharacteristicValueChange, retryConnect, startBluetoothDevicesDiscovery, unpackWriteBLECharacteristicValue
 } from '../wechatApi';
-import ConfigBase, { ConfigEventData } from "./ConfigBase";
+import ConfigBase from "./ConfigBase";
+import { IDevice, IError, ConfigEventData, IRandomCodesResult, IResult, configBLEDeviceParams } from "../types";
 
 type EnableAndGetBluetoothDevicesRes = Promise<
 | { success: false; err: IError }
@@ -28,13 +28,6 @@ interface IArgs {
 
 const configAck = '0000000303000002';
 
-interface configBLEDeviceParams {
-  ssid: string;
-  password: string;
-  softAPSSIDPrefix?: string;
-  timeout: number;
-}
-
 
 interface ISetDeviceOnboardingDeployProps {
   timeout: number;

package/src/wifiConfig/nfc/index.ts

@@ -2,11 +2,8 @@ import { disposeData } from './disposeData';
 import { formatData } from './formatData';
 import { formatSSID } from './formatSSID';
 import { transceive } from './transceive.wx';
-import errorCode from "../../errorCode";
-import GizLog from "../../GizLog";
-import WifiConfig from "../../protocol/WifiConfig";
-import { IRandomCodesResult, IResult, IntervalHandle } from "../../sdk";
 import ConfigBase from "../ConfigBase";
+import { IDevice, IResult } from '../../types';
 
 // type IParams = {
 //   SSID: string;

package/src/global.d.ts

@@ -1,52 +0,0 @@
-interface IError {
-  errorCode: number;
-  errorMessage?: string;
-}
-
-interface ICommonObj {
-  [key: string]: any
-}
-
-interface IDeviceStatusChangedProps {
-  did: string;
-  attrs: ICommonObj;
-}
-
-interface IDeviceRawStatusChangedProps {
-  did: string;
-  raw: Uint8Array;
-}
-
-interface IOnDeviceStatusChanged {
-  (data: IDeviceStatusChangedProps | IDeviceRawStatusChangedProps): void;
-}
-
-interface IOnSocketStatusChanged {
-  (dids: string[], enabled: boolean): void;
-}
-
-interface IEmptyFn {
-  (): void;
-}
-
-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;
-  isOnline: boolean; // 代表大循环在线
-  isLanOnline: boolean; // 代表小循环在线
-  isBleOnline: boolean; // 代表蓝牙在线
-  host?: string;
-  wss_port?: number;
-  ctime?: number;
-}
-
-type TConnectType = 'BLE' | 'BLE_BROADCAST' | 'LAN' | 'WAN' | 'NONE';