mini_program_gizwits_sdk 3.7.0-kuka → 3.7.0

package/README.md

@@ -3,13 +3,6 @@
 # 机智云小程序 SDK
 
 
-## 🔴 破坏性更新
-
-- 3.2.4（含）开始蓝牙广播包过滤增加了 `['ABF8', 'ABF0', 'F0AB', 'F8AB']` 四个过滤字段，为了兼容部分低端手机不过滤，长时间挂机会假死的问题。
-- 乐鑫_0ESP32C3_0403000G 和 博流_00BL602L_0403000B 之后的版本都支持这个特性。
-- 如果您使用的是更早期的固件，请联系我们。
-
-
 ## ⚠️ 重要
 
 使用小程序 sdk 前，请在微信开发者后台-开发管理-开发设置-服务器域名添加以下请求地址。
@@ -28,6 +21,17 @@ wss://wxstage.gizwits.com
 wss://wxm2m.gizwits.com
 ```
 
+- 关于services
+
+为了搜索效率，sdk会根据`services `过滤蓝牙设备。默认  ['ABF8', 'ABF0', 'F0AB', 'F8AB']。
+如果有特殊情况，不想用`services `过滤设备，可以
+
+```js
+sdk.scanBleDevice(3000, [])
+sdk.startAutoScan([])
+```
+
+
 ## 🔧 安装
 
 ```bash
@@ -40,13 +44,13 @@ yarn add mini_program_gizwits_sdk
 
 > 采用小程序代码片段，安装新版小程序开发工具，点击链接即可打开
 
-### 蓝牙和 softAp 配网
+### 蓝牙配网
 
-[点击打开微信开发者工具](https://developers.weixin.qq.com/s/UQI8fpm87jDI)
+[点击打开微信开发者工具](https://developers.weixin.qq.com/s/Wk0aZlmg7jOR)
 
 ### 设备控制
 
-[点击打开微信开发者工具](https://developers.weixin.qq.com/s/NZI5gpmX7qD1)
+[点击打开微信开发者工具](https://developers.weixin.qq.com/s/Kh0CMlmq77OA)
 
 ## 🏍 初始化 Sdk
 
@@ -82,9 +86,9 @@ export default class Index extends Component {
 ## 📋 日志
 sdk.setLogLevel("debug")
 
-## 📖 BLE API
+## 📖 API
 
-小程序 BLE 相关 API。
+小程序相关 API。
 
 ### sdk.initBle()
 
@@ -108,7 +112,7 @@ sdk.setLogLevel("debug")
 
 ### sdk.deviceSafetyRegister(Object object)
 
-安全注册目标设备，否则无法发起设备绑定。返回值中可以拿到注册结果。
+安全注册目标设备，蓝牙设备绑定前，需要调用这个接口，否则无法发起设备绑定。返回值中可以拿到注册结果。
 
 #### 参数
 
@@ -123,6 +127,10 @@ sdk.setLogLevel("debug")
 
 绑定远程设备，否则无法发起设备订阅。返回值中可以拿到绑定结果。
 
+### sdk.unbindDevice({devices: [IDevice]})
+
+解绑设备
+
 #### 参数
 
 - Object object
@@ -132,10 +140,14 @@ sdk.setLogLevel("debug")
 | mac        | string | 待绑定设备 mac     |
 | productKey | string | 待绑定设备所属产品 |
 
-### sdk.subscribe(device:[IDevice](#IDevice) )
+### sdk.subscribe(device:[IDevice](#IDevice),connectType:[TConnectType](#TConnectType))
 
 订阅目标设备，订阅成功后可控制设备。返回值中可以拿到订阅结果。
 
+### sdk.getDeviceStatus(device:[IDevice](#IDevice), attrNames?: string[])
+
+查询目标设备当前状态，attrNames 不传则查询所有数据
+
 ### sdk.write(device:[IDevice](#IDevice),cmd:{[key]:value})
 
 向目标设备发送指令。 其中`key`为数据点名称，value 为数据点的值。
@@ -144,16 +156,49 @@ sdk.setLogLevel("debug")
 
 取消订阅目标设备。蓝牙设备会断开连接。返回值中可拿到取消订阅结果。
 
+### sdk.getDevices()
+刷新设备列表(同时也会在 GizDeviceListNotifications 事件里推送)
+```ts
+const data = await sdk.getDevices()
+console.log(data)
+```
+
+### sdk.stopDeviceOnboardingDeploy
+停止配网
+
+### sdk.setDeviceOnboardingDeploy
+开始配网
+
+详细参数请查阅类型定义
+
 ### sdk.addEventListener(type,listener)
 
 #### 概览
 
 | 事件种类 type               | 回调参数类型                          | 回调参数描述         |
 | --------------------------- | ------------------------------------- | -------------------- |
-| onScanListChange            | [IDevice[]](#IDevice)                 | 扫描设备列表变更通知 |
+| GizDeviceListNotifications | [IDevice[]](#IDevice) | 设备列表变更   |
+| GizDeviceStatusNotifications | [IDeviceStatusNoti](#IDeviceStatusNoti) | 设备在线状态变更   |
 | GizDeviceAttrsNotifications | [IDeviceAttrsNoti](#IDeviceAttrsNoti) | 设备数据点变更通知   |
+| onScanListChange            | [IDevice[]](#IDevice)                 | 扫描设备列表变更通知 |
 | onBleHandleError            | [IError](#IError)                     | ble 错误通知         |
 
+- <a id="GizDeviceListNotifications"> GizDeviceListNotifications </a>
+
+```ts
+this.gizSdk.addEventListener('GizDeviceListNotifications', (deviceList: IDevice[]) => {
+  console.log('列表发生变化', deviceList);
+});
+```
+
+- <a id="GizDeviceStatusNotifications"> GizDeviceStatusNotifications </a>
+
+```ts
+this.gizSdk.addEventListener('GizDeviceStatusNotifications', (e: IDeviceStatusNoti) => {
+  console.log('设备在线状态变化', e);
+});
+```
+
 - <a id="onScanListChange">onScanListChange</a>
 
 ```ts
@@ -203,6 +248,15 @@ interface IDevice {
   isOnline: boolean; // 代表大循环在线
   isLanOnline: boolean; // 代表小循环在线
   isBleOnline: boolean; // 代表蓝牙在线
+  bleWorkStatus?: number; // 蓝牙设备状态 0 默认状态 1 配网状态
+  connectType: TConnectType; // 当前连接类型
+}
+```
+
+- <a id="TConnectType">TConnectType</a>
+
+```ts
+type TConnectType = 'BLE' | 'BLE_BROADCAST' | 'LAN' | 'WAN' | 'NONE';
 }
 ```
 
@@ -215,6 +269,21 @@ interface IDeviceAttrsNoti {
 }
 ```
 
+- <a id="IDeviceStatusNoti">IDeviceStatusNoti</a>
+
+```ts
+interface IDeviceStatusNoti {
+  device: IDevice;
+  connectType: TConnectType;
+}
+```
+
+- <a id="TConnectType">TConnectType</a>
+
+```ts
+type TConnectType = 'BLE' | 'BLE_BROADCAST' | 'LAN' | 'WAN' | 'NONE';
+```
+
 - <a id="IError">IError</a>
 
 ```ts
@@ -228,22 +297,24 @@ interface IError {
 
 销毁事件监听。
 
-# 机智云小程序 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,
-});
+const configData = {
+  appID: "xxx",
+  appSecret: "xxx",
+  productInfo: [
+    {
+      productKey: "xxx",
+      productSecret: "xxx",
+    },
+  ],
+};
+const sdk = new GizwitsSdk(configData);
 
 try {
   const data = await sdk.setDeviceOnboardingDeploy({

package/{index.ts → dist/index.d.ts}

@@ -1,7 +1,7 @@
 import 'miniprogram-api-typings';
 import gizwitsSdk from './src/sdk';
-import errorCode from './src/errorCode';
+import errorCode from './src/utils/errorCode';
 import { BleHandle } from './src/handler/ble';
-
 export { errorCode, BleHandle };
-export default gizwitsSdk;
+export default gizwitsSdk;
+export * from './src/types';