mini_program_gizwits_sdk 3.0.7 → 3.1.1

package/README.md

@@ -1,13 +1,24 @@
 <a href='https://coveralls.io/github/gizwits/mini_program_gizwits_sdk?branch=master'><img src='https://coveralls.io/repos/github/gizwits/mini_program_gizwits_sdk/badge.svg?branch=master' alt='Coverage Status' /></a><img alt="npm" src="https://img.shields.io/npm/v/mini_program_gizwits_sdk">[![Build Status](https://travis-ci.org/gizwits/mini_program_gizwits_sdk.svg?branch=master)](https://travis-ci.org/gizwits/mini_program_gizwits_sdk)
 
-# 机智云小程序 SDK
+# 机智云小程序蓝牙 SDK
 
 ## 🔧 安装
 
 ```bash
+npm install mini_program_gizwits_sdk
+// or
 yarn add mini_program_gizwits_sdk
 ```
 
+## 📑 代码示例
+> 采用小程序代码片段，安装新版小程序开发工具，点击链接即可打开
+
+### 蓝牙和softAp配网
+[点击打开微信开发者工具](https://developers.weixin.qq.com/s/SWjCmLmF72y0)
+
+### 设备控制
+[点击打开微信开发者工具](https://developers.weixin.qq.com/s/Cqu8RMmO7pyO)
+
 ## 🏍 初始化 Sdk
 
 ```ts
@@ -25,10 +36,10 @@ export default class Index extends Component {
       productInfo: [
         {
           productKey: 'productKey',
-          productSecrets: 'productSecrets',
+          productSecret: 'productSecret',
         },
       ],
-      uid: 'giz_uid',// 必填
+      uid: 'giz_uid', // 必填
       token: 'giz_token', // 必填
     });
   }
@@ -39,28 +50,17 @@ export default class Index extends Component {
 }
 ```
 
-## 📖 API
+## 📖 BLE API
 
-### sdk.initBle()
+小程序 BLE 相关 API。
 
-初始化 sdk 蓝牙能力。
+### sdk.initBle()
 
-### sdk.addEventListener(type:K,func:TListenerType[K])
+初始化 sdk 蓝牙能力。使用其他`BLE API`前**必须**进行初始化。
 
-注册事件监听。事件种类见下表。
-| 事件种类 type | 回调参数类型 | 回调参数描述 |
-| ---------- | ------ | ------------------ |
-| "OnScanListChange" | IDevice[] | 扫描设备列表 |
-| "TDeviceStatusNotifications" | IDeviceStatusNoti | 设备状态变更通知 |
-| "TDeviceAttrsNotifications" | IDeviceAttrsNoti | 设备数据点变更通知 |
-| "OnBleHandleError" | IError | ble 错误通知 |
+### sdk.scanBleDevice(delay?:number)
 
-### sdk.removeEventListener(type:K,func:TListenerType[K])
-销毁事件监听。
-
-### sdk.scanBleDevice(delay:number)
-
-搜索蓝牙设备。搜索到的蓝牙设备会被`OnScanListChange`监听。
+搜索蓝牙设备。搜索到的蓝牙设备会被 [onScanListChange](#onScanListChange) 事件监听。
 
 #### 参数
 
@@ -92,12 +92,204 @@ export default class Index extends Component {
 | mac        | string | 待绑定设备 mac     |
 | productKey | string | 待绑定设备所属产品 |
 
-### sdk.subscribe(device:IDevice)
+### sdk.subscribe(device:[IDevice](#IDevice) )
 
 订阅目标设备，订阅成功后可控制设备。返回值中可以拿到订阅结果。
-### sdk.write(cmd:{[key]:value})
-控制设备。 其中`key`为数据点名称，value为数据点的值。
 
-### sdk.unSubscribe(device:IDevice)
+### sdk.write(device:[IDevice](#IDevice),cmd:{[key]:value})
+
+向目标设备发送指令。 其中`key`为数据点名称，value 为数据点的值。
+
+### sdk.unSubscribe(device:[IDevice](#IDevice))
 
 取消订阅目标设备。蓝牙设备会断开连接。返回值中可拿到取消订阅结果。
+
+### sdk.addEventListener(type,listener)
+
+#### 概览
+
+| 事件种类 type               | 回调参数类型                          | 回调参数描述         |
+| --------------------------- | ------------------------------------- | -------------------- |
+| onScanListChange            | [IDevice[]](#IDevice)                 | 扫描设备列表变更通知 |
+| GizDeviceAttrsNotifications | [IDeviceAttrsNoti](#IDeviceAttrsNoti) | 设备数据点变更通知   |
+| onBleHandleError            | [IError](#IError)                     | ble 错误通知         |
+
+- <a id="onScanListChange">onScanListChange</a>
+
+```ts
+const initBle = () => {
+  this.gizSdk.initBle();
+};
+
+const scanBle = async () => {
+  const data = await this.gizSdk.scanBleDevice(60000);
+  console.log('scanBle', data);
+};
+
+this.gizSdk.addEventListener('onScanListChange', (deviceList: IDevice[]) => {
+  console.log('扫描列表发生变化', deviceList);
+  deviceListModal.updateScan(deviceList);
+});
+
+initBle();
+scanBle();
+```
+
+- <a id="GizDeviceAttrsNotifications">GizDeviceAttrsNotifications</a>
+
+监听设备上报数据。
+
+```ts
+this.gizSdk.addEventListener(
+  'GizDeviceAttrsNotifications',
+  ({ device, data }) => {
+    console.log("====设备状态发生变化====", device,data);
+  };
+);
+```
+
+#### 类型定义
+
+- <a id="IDevice">IDevice</a>
+
+```ts
+interface IDevice {
+  mac: string; // 设备mac
+  productKey: string; // 机智云pk
+  did?: string; // 云平台did
+  name: string; // 设备名称
+  isBind: boolean; // 是否绑定
+  bleDeviceID?: string; // 本地蓝牙设备id
+  isOnline: boolean; // 代表大循环在线
+  isLanOnline: boolean; // 代表小循环在线
+  isBleOnline: boolean; // 代表蓝牙在线
+}
+```
+
+- <a id="IDeviceAttrsNoti">IDeviceAttrsNoti</a>
+
+```ts
+interface IDeviceAttrsNoti {
+  device: IDevice;
+  data: object; // 设备上报数据点
+}
+```
+
+- <a id="IError">IError</a>
+
+```ts
+interface IError {
+  errorCode: number;
+  errorMessage?: string; // 错误信息
+}
+```
+
+### sdk.removeEventListener(type:K,func:TListenerType[K])
+
+销毁事件监听。
+
+# 机智云小程序 wifi SDK
+
+## 使用方法
+
+```javascript
+import GizwitsSdk, { errorCode } from 'mini_program_gizwits_sdk';
+
+const sdk = new GizwitsSdk({
+  appID: '8f187b1deb9e44b6aa1374b8f13bccb1',
+  appSecret: 'd73fa6d6d7c04d37b6b2cc13a18a9f37',
+  specialProductKeys: ['00e7e327afa74a3d8ff1cc190bad78c0'],
+  specialProductKeySecrets: ['aa3d301fa291466fbed20e4204609abc'],
+  token: token,
+  uid: uid,
+  cloudServiceInfo: null,
+});
+
+try {
+  const data = await sdk.setDeviceOnboardingDeploy({
+    ssid: SSID,
+    password: password,
+    mode:3,// 蓝牙配网
+    // mode:0 // softAp
+    timeout: 60,
+    softAPSSIDPrefix: 'XPG-GAgent-',
+  });
+} catch (error) {
+  console.log(error);
+}
+```
+
+其中`data`代表配网成功的设备。
+
+如果失败的话会返回数据
+
+```javascript
+{
+  success: false,
+  err: {
+    errorCode: 'code',
+    errorMessage: 'message',
+  }
+}
+```
+
+```ts
+const errorCode: IErrorCode = {
+  GIZ_OPENAPI_DEVICE_NOT_BOUND: {
+    errorCode: 9017,
+    errorMessage: 'not bind',
+  },
+  GIZ_SDK_HTTP_REQUEST_FAILED: {
+    errorCode: 8099,
+    errorMessage: '网络请求失败',
+  },
+  GIZ_SDK_SDK_NOT_INITIALIZED: {
+    errorCode: 8300,
+    errorMessage: 'not init',
+  },
+  CONFIG_TIME_OUT: {
+    errorCode: 8023,
+    errorMessage: 'Config Timeout',
+  },
+  WECHAT_ERROR: {
+    errorCode: 10000,
+    errorMessage: 'wechat error',
+  },
+  GIZ_SDK_ONBOARDING_STOPPED: {
+    errorCode: 8318,
+    errorMessage: '配网中断',
+  },
+  GIZ_SDK_DEVICE_CONFIG_IS_RUNNING: {
+    errorCode: 8022,
+    errorMessage: '配置正在进行中',
+  },
+  GIZ_OPENAPI_TOKEN_INVALID: {
+    errorCode: 9004,
+    errorMessage: 'token 失效',
+  },
+  GIZ_SDK_BIND_DEVICE_FAILED: {
+    errorCode: 8039,
+    errorMessage: '设备绑定失败',
+  },
+  GIZ_SDK_BLE_BLUETOOTH_FUNCTION_NOT_TURNED_ON: {
+    errorCode: 8281,
+    errorMessage: '蓝牙未启用',
+  },
+  GIZ_SDK_OTHERWISE: {
+    errorCode: 8100,
+    errorMessage: '',
+  },
+  GIZ_SDK_DEVICE_NOT_SUBSCRIBED: {
+    errorCode: 8029,
+    errorMessage: '设备还未订阅',
+  },
+  GIZ_SDK_PRODUCTKEY_NOT_IN_SPECIFY: {
+    errorCode: 8250,
+    errorMessage: '产品类型不在指定范围内',
+  },
+};
+```
+
+## 🔴 破坏性更新
+
+* 原 `productSecrets ` 字段变更为 `productSecret`