mini_program_gizwits_sdk 3.6.0 → 3.6.2

package/src/errorCode.ts

@@ -1,6 +1,6 @@
-interface IErrorCode {
-  [key: string]: IError;
-}
+import { IError, IErrorCode } from "./types";
+
+
 const errorCode: IErrorCode = {
   GIZ_OPENAPI_DEVICE_NOT_BOUND: {
     errorCode: 9017,

package/src/handler/ble.ts

@@ -1,6 +1,6 @@
 import GizLog from '../GizLog';
 import Bind from '../protocol/Bind';
-import { padBoradcastData } from '../protocol/DataPoint';
+import { padBoradcastData } from '../protocol/dataPoint';
 import GetDeviceStatus from '../protocol/GetDeviceStatus';
 import Login from '../protocol/Login';
 import ProtocolBase from '../protocol/ProtocolBase';
@@ -22,7 +22,6 @@ import {
 } from '../utils';
 import { downloadFile, retryConnect, unpackWriteBLECharacteristicValue } from '../wechatApi';
 import EventListener from './EventListener';
-import { IOTAType, IResult } from '../sdk';
 import { checkUpdate } from '../services/ota';
 import errorCode from '../errorCode';
 import DeviceInfo from '../protocol/DeviceInfo';
@@ -32,82 +31,8 @@ import ResetPosition from '../protocol/OTA/ResetPosition';
 import OTAPackPackage from '../protocol/OTA/OTAPackPackage';
 import AwaitNoti from '../protocol/OTA/AwaitNoti';
 import OtaComplete from '../protocol/OTA/OtaComplete';
+import { BleConnectDevice, IDevice, IOTAType, IResult, TBleHandleEvent, BleConstructorParams, GizwitsWxBlueToothDevice, IStartScanResult, TBleDataListener, IDeviceReq, StartUpgradeParams, CheckOTAParams } from '../types';
 
-type GizBleDeviceListotifications = (devices: IDevice[]) => void;
-type GizBleDeviceDataNotifications = (
-  curDevice: WechatMiniprogram.OnBLECharacteristicValueChangeListenerResult,
-  hexString: string
-) => void;
-type GizBleErrorNotifications = (err: { errCode: number; errMsg: string }) => void;
-// 返回true 代表放弃监听
-type TBleDataListener<T> = (_curDevice: WechatMiniprogram.OnBLECharacteristicValueChangeListenerResult,
-  hexString: string) => T | null | undefined;
-
-interface CheckOTAParams {
-  device: IDevice;
-  type: IOTAType;
-}
-
-type OTAEventCode = 'GizOTAEventPretreatment' | 'GizOTAEventDownload' | 'GizOTAEventTransmit' | 'GizOTAEventReboot' | 'GizOTAEventFinish'
-interface OTAEvent {
-  code: OTAEventCode; //
-};
-interface OTAProgressEvent {
-  firmwareSize: number;
-  packageMaxLen: number;
-  currentNumber: number;
-  currentProgress: number; // 0 ~ 100
-}
-
-export type OTAProgressEventCallback = (event: OTAProgressEvent) => void;
-export type OTAEventCallback = (event: OTAEvent) => void;
-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';
-}
-
-interface BleHandleParams {
-  serviceUUIDSuffix: string;
-  characteristicUUIDSuffix: string;
-}
-
-export interface IStartScanResult {
-  scanList: IDevice[];
-  err?: ReturnType<typeof wrapErrorInfo>;
-}
-
-interface IDeviceReq<T> {
-  success: boolean;
-  data: T;
-}
-
-// export type BleHandle = ReturnType<typeof createBleHandle>;
-
-export type OnScanDevice = (scanList: IDevice[]) => void;
-interface ConnectDevice {
-  deviceId?: string;
-  serviceId?: string;
-  characteristicId?: string;
-  errMsg?: string;
-}
-
-interface ConstructorParams {
-  pks: string[];
-  bleHandleParams?: BleHandleParams;
-  offlineThreshold?: number;
-}
 
 function createUUID32() {
   let dt = new Date().getTime();
@@ -180,7 +105,7 @@ function reportConnectEvent(
 export class BleHandle extends EventListener<TBleHandleEvent> {
   private serviceUUIDSuffix: string;
   // private characteristicUUIDSuffix: string;
-  public connectedList: ConnectDevice[] = [];
+  public connectedList: BleConnectDevice[] = [];
   private connectingDevId: string | null = null;
   public pks: string[] = [];
   private listenDevOfflineTimer: any = null;
@@ -219,7 +144,7 @@ export class BleHandle extends EventListener<TBleHandleEvent> {
       characteristicUUIDSuffix: 'abf7',
     },
     offlineThreshold,
-  }: ConstructorParams) {
+  }: BleConstructorParams) {
     super();
     const { serviceUUIDSuffix } = bleHandleParams;
     this.serviceUUIDSuffix = serviceUUIDSuffix;

package/src/handler/lan.ts

@@ -4,35 +4,14 @@ import DiscoverUDP from "../protocol/DiscoverUDP";
 import Login from "../protocol/Login";
 import ProtocolBase from "../protocol/ProtocolBase";
 import { arrayToUint8, hexStrint2byte } from "../protocol/tool";
-import { IResult } from "../sdk";
 import sleep from "../sleep";
+import { IDevice, ILanDevice, IResult, LanConnectDevice, TLanHandleEvent } from "../types";
 import { ab2hex, ab2numbers } from "../utils";
 import EventListener from "./EventListener";
 
-// 局域网连接设备结构
-interface ConnectDevice {
-  mac: string
-  productKey: string
-  socketHandle: TCPHandler
-}
-
-// 局域网设备
-interface ILanDevice extends IDevice {
-  expandData: DiscoverUDP
-  ip: string
-}
-
-type GizLanDeviceListNotifications = (devices: IDevice[]) => void;
-type GizLanDeviceDataNotifications = (mac: string, data: string) => void;
-export interface TLanHandleEvent {
-  GizLanDeviceList: GizLanDeviceListNotifications;
-  GizLanDeviceData: GizLanDeviceDataNotifications
-}
-
-
 export class LanHandle extends EventListener<TLanHandleEvent> {
   // private characteristicUUIDSuffix: string;
-  public connectedList: ConnectDevice[] = [];
+  public connectedList: LanConnectDevice[] = [];
   public pks: string[] = [];
   // private globalListenerMap = {};
   public scanList: ILanDevice[] = [];
@@ -273,7 +252,7 @@ interface ITCPHandlerProps {
   onClose: (ip) => void
   onData: (mac: string, data: string) => void
 }
-class TCPHandler {
+export class TCPHandler {
   private deviceTCPPort = 12416
   private ip = ""
   private productKey = ""

package/src/handler/socket.ts

@@ -1,6 +1,9 @@
 import errorCode from "../errorCode";
 import GizLog from "../GizLog";
 import request from "../openApiRequest";
+import { IDevice, IError, IOnDeviceStatusChanged, 
+  IDeviceStatusChangedProps, IDeviceRawStatusChangedProps,
+  IOnSocketStatusChanged, IEmptyFn, ICommonObj } from "../types";
 import { compareWXSDKVersion, isError } from '../utils';
 
 // commType = 'custom' | 'attrs_v4'

package/src/openApiRequest.ts

@@ -1,19 +1,7 @@
 import errorCode from './errorCode';
 import { getGlobalData } from "./globalData";
 import request from './request';
-
-interface IResult<T> {
-  data: T;
-  errMsg: string;
-  statusCode: number;
-}
-
-export interface IServiceResult<T> {
-  success: boolean;
-  data?: T;
-  err?: IError;
-}
-
+import { IError, IServiceResult, IWechatApiResult } from './types';
 
 const openApiRequest = async <T>(url: string, options: any, needToken: boolean = true): Promise<IServiceResult<T>> => {
   const requestOptions = { ...options };
@@ -29,7 +17,7 @@ const openApiRequest = async <T>(url: string, options: any, needToken: boolean =
   requestOptions.header = { ...headers, ...options.headers };
   delete requestOptions.headers;
   const openApiUrl = getGlobalData('cloudServiceInfo').openAPIInfo;
-  const res = await request<IResult<T>>('https://' + openApiUrl + url, requestOptions);
+  const res = await request<IWechatApiResult<T>>('https://' + openApiUrl + url, requestOptions);
   // 统一封装OPEN API的错误码
   if (res.statusCode >= 200 && res.statusCode < 300) {
     return {

package/src/productConfigFileManage.ts

@@ -1,12 +1,10 @@
 import openApiRequest from './openApiRequest';
-import { IDataPointConfig } from './protocol/DataPoint';
+import { IProductConfigData, IDataPointConfig } from './types';
 // 管理配置文件
 
-interface IData {
-  [key: string]: IDataPointConfig;
-}
+
 class ProductConfigFileManage {
-  data: IData = {};
+  data: IProductConfigData = {};
   key = 'dataPointConfig';
 
   init = async () => {

package/src/protocol/OTA/AwaitNoti.ts

@@ -1,6 +1,4 @@
-import { IOTAType } from "../../sdk";
 import ProtocolBase from "../ProtocolBase";
-import { arrayToString, fillString, hexStrint2byte } from "../tool";
 
 class AwaitNoti extends ProtocolBase {
   state = 0; // 0继续 1失败

package/src/protocol/OTA/CheckCanOTA.ts

@@ -1,6 +1,5 @@
-import { IOTAType } from "../../sdk";
+import { IOTAType } from "../../types";
 import ProtocolBase from "../ProtocolBase";
-import { arrayToString } from "../tool";
 
 class CheckCanOTA extends ProtocolBase {
   type: IOTAType = 'MCU';

package/src/protocol/OTA/OTAPackPackage.ts

@@ -1,5 +1,5 @@
 import { crc16modbus } from '../../crc'
-import { getVariableLength } from "../DataPoint";
+import { getVariableLength } from "../dataPoint";
 import ProtocolBase from "../ProtocolBase";
 import { bytesToInt, fillString, hexStrint2byte } from "../tool";
 

package/src/protocol/OTA/PreOTA.ts

@@ -1,7 +1,6 @@
-import { IOTAType } from "../../sdk";
-import { getVariableLength } from "../DataPoint";
+import { getVariableLength } from "../dataPoint";
 import ProtocolBase from "../ProtocolBase";
-import { arrayToString, bytesToHexString, bytesToInt, fillString, hexStrint2byte, string2Bytes } from "../tool";
+import { bytesToHexString, bytesToInt, fillString, hexStrint2byte, string2Bytes } from "../tool";
 
 type TState = 0 | 1 | 2 | 3 // 0x00 正常升级 0x01 pk不一致 0x02 版本低于当前 0x03 大小超过范围
 class PreOTA extends ProtocolBase {

package/src/protocol/OTA/ResetPosition.ts

@@ -1,6 +1,5 @@
-import { IOTAType } from "../../sdk";
 import ProtocolBase from "../ProtocolBase";
-import { arrayToString, fillString, hexStrint2byte } from "../tool";
+import { fillString, hexStrint2byte } from "../tool";
 
 class ResetPosition extends ProtocolBase {
   constructor(data: number[]) {

package/src/protocol/dataPoint.ts

@@ -1,48 +1,7 @@
 import productConfigFileManage from "../productConfigFileManage";
+import { IDataPointAttr, TDataOptionType, TDataType } from "../types";
 import { arrayToString, checkHeader, fillString, getProtocolLen, hexStrint2byte, completeBlock} from "./tool";
 
-export interface IDataPointConfig {
-  name: string;
-  protocolType: 'var_len' | 'standard';
-  entities: IDataPointEntitie[];
-}
-
-
-
-interface IDataPointEntitie {
-  display_name: string;
-  attrs: IDataPointAttr[];
-}
-
-interface IDataPointPosition {
-  byte_offset: number;
-  unit: 'bit' | 'byte';
-  len: number;
-  bit_offset: number;
-}
-
-type TDataType = 'bool' | 'uint8' | 'uint16' | 'uint32' | 'binary' | 'enum' | 'number';
-
-
-interface IUnitSpec {
-  addition: number;
-  max: number;
-  ratio: number;
-  min: number;
-}
-
-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;
-}
 
 const fixType = (type: TDataType) => {
   return type.indexOf('uint') !== -1 ? 'number' : type;

package/src/randomCode.ts

@@ -1,16 +1,5 @@
 import {MD5, AES, enc, pad, mode} from 'crypto-js';
-
-interface IGetRandomCodes {
-  SSID: string;
-  password: string;
-  pks: string[];
-}
-
-interface IGetRandomCode {
-  SSID: string;
-  password: string;
-  pk: string;
-}
+import { IGetRandomCode, IGetRandomCodes } from './types';
 
 const getRandomCodes = ({ SSID, password, pks }: IGetRandomCodes): string[] => {
   const randomCodes: string[] = [];

package/src/sdk.ts

@@ -3,12 +3,12 @@ import { getGlobalData, setGlobalData } from './globalData';
 import sdkConfig from '../package.json';
 import { LanHandle } from './handler/lan';
 import productConfigFileManage from './productConfigFileManage';
-import { formatEnum, IDataPointConfig, pack, unpack } from './protocol/DataPoint';
+import { formatEnum, pack, unpack } from './protocol/dataPoint';
 import Ntp from './protocol/Ntp';
 import { CancelSync, DeletePackage, RequestSync, SyncPackage } from './protocol/OffLineData';
 import ProtocolBase from './protocol/ProtocolBase';
 import { arrayToString, hexStrint2byte } from './protocol/tool';
-import { BleHandle, OTAEventCallback, OTAProgressEventCallback } from './handler/ble';
+import { BleHandle } from './handler/ble';
 import GizwitsWS from './handler/socket';
 import Reset from './protocol/Reset';
 import SetReset from './protocol/SetReset';
@@ -20,13 +20,12 @@ import {
   bindMac,
   editBindInfo,
   getBindingList,
-  IOpenApiDevice,
   ISafeRegisterReturn,
   IUnbindReturn,
   safeRegister,
   unbindDevice
 } from './services/devices';
-import { AnonymousLogin, ILoginRes } from './services/login';
+import { AnonymousLogin } from './services/login';
 import { uploadP0 } from './services/uploadP0';
 import sleep from './sleep';
 import {
@@ -41,118 +40,16 @@ import {
 import ApConfig from './wifiConfig/ap';
 import BLEConfig from './wifiConfig/ble';
 import NFCConfig from './wifiConfig/nfc';
-import { ConfigEventData } from './wifiConfig/ConfigBase';
+import { IDevice, TConnectType, IOnDeviceStatusChanged, 
+  IOpenApiDevice,
+  IDeviceStatusChangedProps, IOnSocketStatusChanged, 
+  IProductInfo, GizwitsSdkOption, SyncCallBack, ISDKResult,
+   IResult, IOTAType, IBindRemoteDeviceParams, ICloudServiceInfo, 
+   TListenerType, IDeviceSafetyParams, ISetDeviceOnboardingDeployProps, 
+   IDataPointConfig, OTAEventCallback, OTAProgressEventCallback, ILoginRes,
+   IDeviceSafetyRegisterParams } from './types';
 
 const version = sdkConfig.version;
-interface SyncCallBackParams {
-  event: TSyncEvnet;
-  currentNum?: number;
-  totalNum?: number;
-  message?: string;
-}
-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;
-}
-
-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;
-}
-
-export type TimeoutHandle = ReturnType<typeof setTimeout> | null;
-export type IntervalHandle = ReturnType<typeof setInterval> | null;
-export interface IProductInfo {
-  productKey: string;
-  productSecret: string;
-}
-interface GizwitsSdkOption {
-  appID: string;
-  appSecret: string;
-  productInfo: IProductInfo[];
-  cloudServiceInfo?: ICloudServiceInfo;
-  token?: string;
-  uid?: string;
-  offlineThreshold?: number;
-}
-
 class GizwitsMiniSDK {
   private listenerMap: any = {};
   private keepScanTimer: any = null;

package/src/services/devices.ts

@@ -1,31 +1,11 @@
 import {  enc, AES, mode, pad } from 'crypto-js';
-import openApiRequest, { IServiceResult } from '../openApiRequest';
+import openApiRequest from '../openApiRequest';
 import getRandomCodes from '../randomCode';
-import { IRandomCodesResult } from '../sdk';
 import { psKeySign } from './tool';
+import { IDevice, IDeviceRes, IOpenApiDevice, IRandomCodesResult, IServiceResult } from '../types';
 // eslint-disable-next-line import/no-commonjs
 // const CryptoJS = require('crypto-js');
 
-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';
-}
-
-interface IDeviceRes {
-  devices: IOpenApiDevice[];
-}
-
 // 云端aes 特殊解码
 class Padding {
   /**

package/src/services/login.ts

@@ -1,10 +1,6 @@
 import openApiRequest from "../openApiRequest";
+import { ILoginRes } from "../types";
 
-export interface ILoginRes {
-  expire_at: number;
-  token: string;
-  uid: string;
-}
 export async function AnonymousLogin ({uid}: {uid: string}) {
   return openApiRequest<ILoginRes>('/app/users', {
     data: {

package/src/services/monitor.ts

@@ -1,6 +1,7 @@
 import { version } from '../../package.json';
 import { getGlobalData } from "../globalData";
 import openApiRequest from '../openApiRequest';
+import { IDevice } from '../types';
 
 interface MobileInfo {
   brand: string;

package/src/services/ota.ts

@@ -1,10 +1,6 @@
 import openApiRequest from "../openApiRequest";
-import { IOTAType } from "../sdk";
+import { IOTAType, OTARes } from "../types";
 
-export interface OTARes {
-  download_url: string;
-  soft_ver: string; // 新的版本号
-}
 
 //type 指定固件类型,1代表WiFi模组,2代表MCU
 export async function checkUpdate ({did, type, hardVersion, softVersion}: {did: string, type: IOTAType, hardVersion: string, softVersion: string}) {

package/src/services/uploadP0.ts

@@ -1,5 +1,6 @@
 import openApiRequest from "../openApiRequest";
 import {  enc, AES, mode, pad } from 'crypto-js';
+import { IDevice } from "../types";
 
 export interface IUploadRes {
 }