mini_program_gizwits_sdk 3.7.0-cozev5 → 3.7.2-cozev5

package/README.md

@@ -2,7 +2,6 @@
 
 # 机智云小程序 SDK
 
-
 ## ⚠️ 重要
 
 使用小程序 sdk 前，请在微信开发者后台-开发管理-开发设置-服务器域名添加以下请求地址。
@@ -22,17 +21,16 @@ wss://wxstage.gizwits.com
 wss://wxm2m.gizwits.com
 ```
 
-- 关于services
+- 关于 services
 
-为了搜索效率，sdk会根据`services `过滤蓝牙设备。默认  ['ABF8', 'ABF0', 'F0AB', 'F8AB']。
+为了搜索效率，sdk 会根据`services `过滤蓝牙设备。默认 ['ABF8', 'ABF0', 'F0AB', 'F8AB']。
 如果有特殊情况，不想用`services `过滤设备，可以
 
 ```js
-sdk.scanBleDevice(3000, [])
-sdk.startAutoScan([])
+sdk.scanBleDevice(3000, []);
+sdk.startAutoScan([]);
 ```
 
-
 ## 🔧 安装
 
 ```bash
@@ -83,6 +81,7 @@ export default class Index extends Component {
 ```
 
 ## 📋 日志
+
 sdk.setLogLevel("debug")
 
 ## 用户相关
@@ -90,6 +89,7 @@ sdk.setLogLevel("debug")
 SDK 提供了两种登录方式：匿名登录和微信登录。
 
 ### 匿名登录
+
 ```typescript
 // 使用 唯一ID 进行匿名登录
 // 适用于 已经有业务后台的场景
@@ -101,6 +101,7 @@ if (result.success) {
 ```
 
 ### 微信登录
+
 ```typescript
 // 使用微信登录 直接登录到 Gizwits
 const result = await sdk.wxLogin();
@@ -119,19 +120,22 @@ if (result.success) {
 ### 登录结果说明
 
 登录成功后会：
+
 1. 自动保存 token 和 uid 到全局数据
 2. 更新 WebSocket 连接的认证信息
 3. 返回登录结果，包含：
    - token: 访问令牌
-   - uid: 用户ID
+   - uid: 用户 ID
    - expire_at: 令牌过期时间（仅微信登录返回）
 
 #### 注意事项
+
 1. 登录是使用其他功能的前提，建议在初始化 SDK 后立即进行登录
 2. 微信登录需要确保小程序已经获取了用户授权
 3. 登录成功后，SDK 会自动处理 token 的存储和更新
 
 #### 错误处理
+
 ```typescript
 try {
   const result = await sdk.wxLogin();
@@ -166,14 +170,14 @@ if (result.success) {
 
 #### 参数说明
 
-| 参数 | 类型 | 必填 | 说明 |
-|------|------|------|------|
-| deviceId | string | 是 | 设备 ID |
+| 参数     | 类型   | 必填 | 说明    |
+| -------- | ------ | ---- | ------- |
+| deviceId | string | 是   | 设备 ID |
 
 #### 返回值说明
 
-| 字段 | 类型 | 说明 |
-|------|------|------|
+| 字段         | 类型   | 说明       |
+| ------------ | ------ | ---------- |
 | soft_version | string | 软件版本号 |
 | hard_version | string | 硬件版本号 |
 
@@ -188,16 +192,15 @@ if (result.success) {
 ```typescript
 try {
   const result = await sdk.getDeviceVersion(deviceId);
-  
+
   if (!result.success) {
     // 处理获取失败
     console.error('获取版本失败:', result.err);
     return;
   }
-  
+
   // 获取成功，可以开始使用版本信息
   const { soft_version, hard_version } = result.data;
-  
 } catch (error) {
   // 处理异常
   console.error('获取版本异常:', error);
@@ -205,26 +208,27 @@ try {
 ```
 
 ### 检查更新
+
 ```typescript
 const result = await sdk.checkAvailableUpdates(deviceInfo.id, deviceInfo.soft_version);
-console.log('resultresultresult', result)
+console.log('resultresultresult', result);
 if (result.success && result.data) {
   setUpdateInfo(result.data);
-
 } else {
   setUpdateInfo(null);
   Taro.showToast({
     title: '没有可用的更新',
-    icon: 'none'
-  })
+    icon: 'none',
+  });
 }
 ```
 
 ### 开始更新
+
 ```typescript
 const sdk = getGlobalData('gizSdk');
 const result = await sdk.startUpdate(deviceInfo.id);
-console.log('resultresultresult', result)
+console.log('resultresultresult', result);
 ```
 
 ### 查询进度
@@ -249,14 +253,14 @@ if (result.success) {
 
 #### 参数说明
 
-| 参数 | 类型 | 必填 | 说明 |
-|------|------|------|------|
-| deviceId | string | 是 | 设备 ID |
+| 参数     | 类型   | 必填 | 说明    |
+| -------- | ------ | ---- | ------- |
+| deviceId | string | 是   | 设备 ID |
 
 #### 返回值说明
 
-| 字段 | 类型 | 说明 |
-|------|------|------|
+| 字段 | 类型           | 说明                                                  |
+| ---- | -------------- | ----------------------------------------------------- |
 | data | number \| null | 更新进度百分比（0-100），如果为 null 表示暂无进度信息 |
 
 #### 注意事项
@@ -271,13 +275,13 @@ if (result.success) {
 ```typescript
 try {
   const result = await sdk.getOtaStatus(deviceId);
-  
+
   if (!result.success) {
     // 处理获取失败
     console.error('获取 OTA 进度失败:', result.err);
     return;
   }
-  
+
   // 获取成功，处理进度信息
   if (result.data !== null) {
     // 有进度信息
@@ -286,7 +290,6 @@ try {
     // 没有进度信息
     console.log('暂无 OTA 更新进度');
   }
-  
 } catch (error) {
   // 处理异常
   console.error('获取 OTA 进度异常:', error);
@@ -300,10 +303,11 @@ try {
 初始化 sdk 蓝牙能力。使用其他`BLE API`前**必须**进行初始化。
 
 ```typescript
-sdk.initBle()
+sdk.initBle();
 ```
 
 ### 搜索蓝牙
+
 搜索蓝牙设备。搜索到的蓝牙设备会被 [onScanListChange](#onScanListChange) 事件监听。
 
 ```
@@ -328,14 +332,13 @@ sdk.startAutoScan(services?: string[])
 
 ## 设备管理
 
-
 ### 获取设备列表
 
 刷新设备列表(同时也会在 GizDeviceListNotifications 事件里推送)
 
 ```typescript
-const data = await sdk.getDevices()
-console.log(data)
+const data = await sdk.getDevices();
+console.log(data);
 ```
 
 ### 开始配网
@@ -344,16 +347,18 @@ console.log(data)
 
 ```typescript
 const result = await sdk.setDeviceOnboardingDeploy({
-  ssid: 'wifi_ssid',           // WiFi 名称
-  password: 'wifi_password',   // WiFi 密码
-  mode: 3,                     // 配网模式：0-SoftAP, 3-BLE, 5-NFC
-  timeout: 60,                 // 配网超时时间（秒）
-  productKey: 'product_key',   // 产品 Key
-  isBind: true,               // 是否自动绑定设备
+  ssid: 'wifi_ssid', // WiFi 名称
+  password: 'wifi_password', // WiFi 密码
+  mode: 3, // 配网模式：0-SoftAP, 3-BLE, 5-NFC
+  timeout: 60, // 配网超时时间（秒）
+  productKey: 'product_key', // 产品 Key
+  isBind: true, // 是否自动绑定设备
   softAPSSIDPrefix: 'XPG-GAgent-', // SoftAP 模式下的设备热点前缀，蓝牙配网模式下的蓝牙设备名称
-  eventCallBack: (event) => {  // 配网过程事件回调
+  eventCallBack: event => {
+    // 配网过程事件回调
     console.log('配网事件:', event);
-  }
+  },
+  mac: '123456', // BLE配网下使用mac对蓝牙设备进行过滤
 });
 
 if (result.success) {
@@ -368,25 +373,27 @@ if (result.success) {
 
 #### 参数说明
 
-| 参数 | 类型 | 必填 | 说明 |
-|------|------|------|------|
-| ssid | string | 是 | WiFi 网络名称 |
-| password | string | 是 | WiFi 网络密码 |
-| mode | number | 是 | 配网模式：0-SoftAP, 3-BLE, 5-NFC |
-| timeout | number | 否 | 配网超时时间，单位秒，默认 60 |
-| productKey | string | 否 | 产品 Key |
-| isBind | boolean | 否 | 是否自动绑定设备，默认 true |
-| softAPSSIDPrefix | string | 否 | SoftAP 模式下的设备热点前缀 |
-| eventCallBack | function | 否 | 配网过程事件回调 |
+| 参数             | 类型     | 必填 | 说明                             |
+| ---------------- | -------- | ---- | -------------------------------- |
+| ssid             | string   | 是   | WiFi 网络名称                    |
+| password         | string   | 是   | WiFi 网络密码                    |
+| mode             | number   | 是   | 配网模式：0-SoftAP, 3-BLE, 5-NFC |
+| timeout          | number   | 否   | 配网超时时间，单位秒，默认 60    |
+| productKey       | string   | 否   | 产品 Key                         |
+| isBind           | boolean  | 否   | 是否自动绑定设备，默认 true      |
+| softAPSSIDPrefix | string   | 否   | SoftAP 模式下的设备热点前缀      |
+| eventCallBack    | function | 否   | 配网过程事件回调                 |
 
 #### 配网模式说明
 
 1. **SoftAP 模式 (mode: 0)**
+
    - 设备会创建一个 WiFi 热点
    - 手机需要先连接到设备热点
    - 适用于大多数 WiFi 设备
 
 2. **BLE 模式 (mode: 3)**
+
    - 通过蓝牙传输配网信息
    - 设备需要支持蓝牙功能
    - 适用于支持蓝牙的 WiFi 设备
@@ -411,18 +418,17 @@ try {
   const result = await sdk.setDeviceOnboardingDeploy({
     ssid: 'wifi_ssid',
     password: 'wifi_password',
-    mode: 3
+    mode: 3,
   });
-  
+
   if (!result.success) {
     // 处理配网失败
     console.error('配网失败:', result.err);
     return;
   }
-  
+
   // 配网成功，可以开始使用设备
   const devices = result.data;
-  
 } catch (error) {
   // 处理异常
   console.error('配网异常:', error);
@@ -443,10 +449,10 @@ sdk.stopDeviceOnboardingDeploy();
 
 ```typescript
 const result = await sdk.bindRemoteDevice({
-  mac: 'device_mac',        // 设备 MAC 地址
+  mac: 'device_mac', // 设备 MAC 地址
   productKey: 'product_key', // 产品 Key
-  alias: 'device_name',     // 可选，设备别名
-  beOwner: true            // 可选，是否作为设备所有者
+  alias: 'device_name', // 可选，设备别名
+  beOwner: true, // 可选，是否作为设备所有者
 });
 
 if (result.success) {
@@ -461,12 +467,12 @@ if (result.success) {
 
 #### 参数说明
 
-| 参数 | 类型 | 必填 | 说明 |
-|------|------|------|------|
-| mac | string | 是 | 设备的 MAC 地址 |
-| productKey | string | 是 | 产品 Key，用于标识设备类型 |
-| alias | string | 否 | 设备别名，用于自定义设备名称 |
-| beOwner | boolean | 否 | 是否作为设备所有者，默认为 true |
+| 参数       | 类型    | 必填 | 说明                            |
+| ---------- | ------- | ---- | ------------------------------- |
+| mac        | string  | 是   | 设备的 MAC 地址                 |
+| productKey | string  | 是   | 产品 Key，用于标识设备类型      |
+| alias      | string  | 否   | 设备别名，用于自定义设备名称    |
+| beOwner    | boolean | 否   | 是否作为设备所有者，默认为 true |
 
 #### 注意事项
 
@@ -480,18 +486,17 @@ if (result.success) {
 try {
   const result = await sdk.bindRemoteDevice({
     mac: 'device_mac',
-    productKey: 'product_key'
+    productKey: 'product_key',
   });
-  
+
   if (!result.success) {
     // 处理绑定失败
     console.error('绑定失败:', result.err);
     return;
   }
-  
+
   // 绑定成功，可以开始使用设备
   const device = result.data;
-  
 } catch (error) {
   // 处理异常
   console.error('绑定异常:', error);
@@ -501,7 +506,7 @@ try {
 ### 解绑设备
 
 ```typescript
-sdk.unbindDevice({devices: [{mac: string, productKey: string}]})
+sdk.unbindDevice({ devices: [{ mac: string, productKey: string }] });
 ```
 
 #### 参数
@@ -523,7 +528,6 @@ sdk.getDeviceStatus(device:[IDevice], attrNames?: string[])
 
 向目标设备发送指令。 其中`key`为数据点名称，value 为数据点的值。
 
-
 ```typescript
 sdk.write(device:[IDevice])
 ```
@@ -533,16 +537,16 @@ sdk.write(device:[IDevice])
 ### 注册事件监听
 
 ```typescript
-sdk.addEventListener(type,listener)
+sdk.addEventListener(type, listener);
 ```
 
-| 事件种类 type               | 回调参数类型                          | 回调参数描述         |
-| --------------------------- | ------------------------------------- | -------------------- |
-| GizDeviceListNotifications | [IDevice[]](#IDevice) | 设备列表变更   |
-| GizDeviceStatusNotifications | [IDeviceStatusNoti](#IDeviceStatusNoti) | 设备在线状态变更   |
-| GizDeviceAttrsNotifications | [IDeviceAttrsNoti](#IDeviceAttrsNoti) | 设备数据点变更通知   |
-| onScanListChange            | [IDevice[]](#IDevice)                 | 扫描设备列表变更通知 |
-| onBleHandleError            | [IError](#IError)                     | ble 错误通知         |
+| 事件种类 type                | 回调参数类型                            | 回调参数描述         |
+| ---------------------------- | --------------------------------------- | -------------------- |
+| GizDeviceListNotifications   | [IDevice[]](#IDevice)                   | 设备列表变更         |
+| GizDeviceStatusNotifications | [IDeviceStatusNoti](#IDeviceStatusNoti) | 设备在线状态变更     |
+| GizDeviceAttrsNotifications  | [IDeviceAttrsNoti](#IDeviceAttrsNoti)   | 设备数据点变更通知   |
+| onScanListChange             | [IDevice[]](#IDevice)                   | 扫描设备列表变更通知 |
+| onBleHandleError             | [IError](#IError)                       | ble 错误通知         |
 
 #### GizDeviceListNotifications