Add a timeout mechanism during device scanning and connection to avoid lagging issues caused by slow or unresponsive devices.

Json031 · Json031 · commit fc089189c2f3 · 2025-04-17T21:31:29.000+08:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "mcblekit",
-  "version": "1.0.6",
+  "version": "1.0.9",
   "description": "该微信小程序开源代码库用于管理微信小程序中的蓝牙功能。支持初始化蓝牙适配器、扫描和连接蓝牙设备、获取设备服务和特征、监听特征值变化、读写特征值以及断开连接等操作。通过设置不同的监听器，可灵活处理蓝牙连接状态变化、设备发现、服务和特征发现等事件，适用于需要与蓝牙设备进行数据交互的微信小程序开发场景。This WeChat mini program open-source code library is used to manage the Bluetooth function in WeChat mini programs. Support initialization of Bluetooth adapters, scanning and connecting Bluetooth devices, obtaining device services and features, monitoring feature value changes, reading and writing feature values, and disconnecting. By setting different listeners, it is possible to flexibly handle events such as changes in Bluetooth connection status, device discovery, service and feature discovery, which is suitable for WeChat mini program development scenarios that require data interaction with Bluetooth devices. ",
   "main": "src/MCBleKit.js",
   "scripts": {
diff --git a/src/MCBleKit.js b/src/MCBleKit.js
@@ -1,5 +1,17 @@
+/**
+ * MCBleKit.js.
+ * MCBleKit
+ * 
+ * Created by Morgan Chen on 2025/4/8.
+ * https://github.com/Json031
+ */
+
 var util = require('./MCUtil.js');
 var mcrssi = require('./MCrssi.js');
+var mcTimeout = require('./MCTimeout.js');
+
+let ScanDeviceTimeout = 35000;//扫描蓝牙超时时间，单位毫秒
+let ConnectDeviceTimeout = 60000;//连接蓝牙超时时间，单位毫秒
 
 var __instance = (function () {
     var instance;
@@ -207,17 +219,24 @@ MCBleKit.prototype.getBluetoothAdapterState = function () {
 
 // 开始扫描
 MCBleKit.prototype.startBluetoothDevicesDiscovery = function () {
+    mcTimeout.withTimeout(this.startScan(), ScanDeviceTimeout, '设备扫描超时')
+};
+MCBleKit.prototype.startScan = function () {
+    return new Promise((resolve, reject) => {
     if (util.isEmptyStr(this.blueName)) {
+        reject;
         return;
     }
     var that = this;
     wx.startBluetoothDevicesDiscovery({
         success: function (res) {
+            resolve;
             console.log('🔍 开始扫描设备', res)
             that.onBluetoothDeviceFound();
             that.startDiscoverListener();
         },
         fail: function (res) {
+            reject;
             console.log('❌ 扫描设备失败', res)
             if (res.errCode === 10004) {
                 wx.showToast({
@@ -228,8 +247,8 @@ MCBleKit.prototype.startBluetoothDevicesDiscovery = function () {
             console.log('startBluetoothDevicesDiscovery fail' + res.errMsg);
         }
     });
+      })
 };
-
 //连接设备
 // 获取所有已发现的设备
 MCBleKit.prototype.onBluetoothDeviceFound = function () {
@@ -266,71 +285,80 @@ MCBleKit.prototype.stopBluetoothDevicesDiscovery = function () {
 };
 
 MCBleKit.prototype.connectToBluetoothDevice = function () {
-    if (util.isNullObject(this.bleDevice)) {
-        return;
-    }
-    if (this.connected) {
-        return;
-    }
-    if (this.connecting) {
-        return;
-    }
-    this.connecting = true;
-    // 连接外设
-    var that = this;
-    wx.createBLEConnection({
-        deviceId: this.bleDevice.deviceId,
-        success: function (res) {
-            console.log('连接设备成功', res);
-            that.connected = true;
-            wx.setBLEMTU({
-                deviceId: that.bleDevice.deviceId,
-                mtu: that.bleMTU,
-                success: function (res) {
-                    console.log('setBLEMTU succ');
-                },
-                fail: function (err) {
-                    that.errorOccurListener(err);
-                    console.log('setBLEMTU fail' + JSON.stringify(err));
-                }
-            });
-            that.getBLEDeviceServices();
-            that.getRssi();
-        },
-        fail: function (res) {
-            console.log('❌ 连接设备失败', res)
-            if (res.errno == 1509001 && res.errCode == 10003 && util.containsIgnoreCase(res.errMsg, 'status:133')) {
-                wx.openBluetoothAdapter({
+    mcTimeout.withTimeout(this.connectDeviceWithTimeout(), ConnectDeviceTimeout, '连接设备超时')
+};
+MCBleKit.prototype.connectDeviceWithTimeout = function () {
+    return new Promise((resolve, reject) => {
+        if (util.isNullObject(this.bleDevice)) {
+            reject;
+            return;
+        }
+        if (this.connected) {
+            reject;
+            return;
+        }
+        if (this.connecting) {
+            reject;
+            return;
+        }
+        this.connecting = true;
+        // 连接外设
+        var that = this;
+        wx.createBLEConnection({
+            deviceId: this.bleDevice.deviceId,
+            success: function (res) {
+                resolve;
+                console.log('连接设备成功', res);
+                that.connected = true;
+                wx.setBLEMTU({
+                    deviceId: that.bleDevice.deviceId,
+                    mtu: that.bleMTU,
                     success: function (res) {
-                        console.log('初始化蓝牙成功', res);
-                        var coTimer = setInterval(function () {
-                            that.connectToBluetoothDevice();
-                            clearInterval(coTimer);
-                        }, 1000);
+                        console.log('setBLEMTU succ');
                     },
-                    fail: function (res) {
-                        that.errorOccurListener(res);
-                        console.log('初始化蓝牙失败', res);
+                    fail: function (err) {
+                        that.errorOccurListener(err);
+                        console.log('setBLEMTU fail' + JSON.stringify(err));
                     }
                 });
-                return;
-            }
-            if (res.errno == 1509007) {
                 that.getBLEDeviceServices();
+                that.getRssi();
+            },
+            fail: function (res) {
+                reject;
+                console.log('❌ 连接设备失败', res)
+                if (res.errno == 1509001 && res.errCode == 10003 && util.containsIgnoreCase(res.errMsg, 'status:133')) {
+                    wx.openBluetoothAdapter({
+                        success: function (res) {
+                            console.log('初始化蓝牙成功', res);
+                            var coTimer = setInterval(function () {
+                                that.connectToBluetoothDevice();
+                                clearInterval(coTimer);
+                            }, 1000);
+                        },
+                        fail: function (res) {
+                            that.errorOccurListener(res);
+                            console.log('初始化蓝牙失败', res);
+                        }
+                    });
+                    return;
+                }
+                if (res.errno == 1509007) {
+                    that.getBLEDeviceServices();
+                }
+                console.log('连接失败', res);
+                //超时情况不提示
+                if (!util.containsIgnoreCase(res.errMsg, 'connect time out')) {
+                    that.errorOccurListener(res);
+                    wx.showToast({
+                        title: '连接失败:' + res.errno,
+                        icon: 'none'
+                    });
+                }
             }
-            console.log('连接失败', res);
-            //超时情况不提示
-            if (!util.containsIgnoreCase(res.errMsg, 'connect time out')) {
-                that.errorOccurListener(res);
-                wx.showToast({
-                    title: '连接失败:' + res.errno,
-                    icon: 'none'
-                });
-            }
-        }
-    });
-};
-
+        });   
+    });   
+}
 /**
  * 获取信号强度
  */
diff --git a/src/MCTimeout.js b/src/MCTimeout.js
@@ -0,0 +1,41 @@
+/**
+ * MCTimeout.js.
+ * MCBleKit
+ * 
+ * Created by Morgan Chen on 2025/4/17.
+ * https://github.com/Json031
+ */
+
+/**
+ * Creates a timeout for function's promise.
+ *
+ * @param {function} promise function's promise.
+ *
+ * @param {timeoutMs} timeoutMs timeout milliseconds.
+ * 
+ * @param {string} timeoutMessage timeout message.
+ *
+ * @return {Promise} new Promise
+ *
+ */
+function withTimeout(promise, timeoutMs, timeoutMessage = '操作超时') {
+    return new Promise((resolve, reject) => {
+      const timer = setTimeout(() => {
+        reject(new Error(timeoutMessage))
+      }, timeoutMs)
+  
+      promise
+        .then((res) => {
+          clearTimeout(timer)
+          resolve(res)
+        })
+        .catch((err) => {
+          clearTimeout(timer)
+          reject(err)
+        })
+    })
+  }
+  
+module.exports = {
+    withTimeout: withTimeout
+};
diff --git a/src/MCUtil.js b/src/MCUtil.js
@@ -1,14 +1,44 @@
-// 空字符串
+/**
+ * MCUtil.js.
+ * MCBleKit
+ * 
+ * Created by Morgan Chen on 2025/4/8.
+ * https://github.com/Json031
+ */
+
+/**
+ * Determine if it is an empty string
+ *
+ * @param {string} str determine object
+ *
+ * @return {Boolean} true/false
+ *
+ */
 function isEmptyStr(str) {
     return str === null || str === undefined || str === "";
 }
 
-// 空对象
+/**
+ * Determine if it is an empty object
+ *
+ * @param {object} object determine object
+ *
+ * @return {Boolean} true/false
+ *
+ */
 function isNullObject(object) {
     return object === null || object === undefined;
 }
 
-// 含有子字符串
+/**
+ * Determine if there are substrings present
+ *
+ * @param {string} str determine object
+ * @param {string} subStr substrings
+ *
+ * @return {Boolean} true/false
+ *
+ */
 function contains(str, subStr) {
     if (isEmptyStr(str)) {
         return false;
@@ -19,12 +49,28 @@ function contains(str, subStr) {
     return str.indexOf(subStr) >= 0;
 }
 
-// 忽略大小写敏感判断是否含有子字符串
+/**
+ * Ignore case sensitivity to determine if there are substrings
+ *
+ * @param {string} str determine object
+ * @param {string} subStr substrings
+ *
+ * @return {Boolean} true/false
+ *
+ */
 function containsIgnoreCase(str, subStr) {
     return contains(str.toLowerCase(), subStr.toLowerCase());
 }
 
-// 忽略大小写敏感对比字符串
+/**
+ * Ignore case sensitive comparison strings
+ *
+ * @param {string} str1 determine object
+ * @param {string} sub2 determine object
+ *
+ * @return {Boolean} true/false
+ *
+ */
 function isEqualIgnoreCase(str1, str2) {
     if (isEmptyStr(str1)) {
         return false;
@@ -35,6 +81,12 @@ function isEqualIgnoreCase(str1, str2) {
     return str1.toUpperCase() === str2.toUpperCase();
 }
 
+/**
+ * handle Bluetooth Error
+ *
+ * @param {object} err Bluetooth Error
+ *
+ */
 function handleBluetoothError(err) {
     const code = err.errCode
     let message = '发生未知错误'
diff --git a/src/MCrssi.js b/src/MCrssi.js
@@ -1,4 +1,18 @@
-// MCrssi.js
+/**
+ * MCrssi.js.
+ * MCBleKit
+ * 
+ * Created by Morgan Chen on 2025/4/17.
+ * https://github.com/Json031
+ */
+
+/**
+ * get Bluetooth Device RSSI
+ *
+ * @param {string} deviceId Bluetooth device id
+ *
+ * @return {number} RSSI value
+ */
 function getDeviceRSSI(deviceId) {
     return new Promise((resolve, reject) => {
       wx.getBLEDeviceRSSI({

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "mcblekit",`
`3`		`- "version": "1.0.6",`
	`3`	`+ "version": "1.0.9",`
`4`	`4`	"description": "该微信小程序开源代码库用于管理微信小程序中的蓝牙功能。支持初始化蓝牙适配器、扫描和连接蓝牙设备、获取设备服务和特征、监听特征值变化、读写特征值以及断开连接等操作。通过设置不同的监听器，可灵活处理蓝牙连接状态变化、设备发现、服务和特征发现等事件，适用于需要与蓝牙设备进行数据交互的微信小程序开发场景。This WeChat mini program open-source code library is used to manage the Bluetooth function in WeChat mini programs. Support initialization of Bluetooth adapters, scanning and connecting Bluetooth devices, obtaining device services and features, monitoring feature value changes, reading and writing feature values, and disconnecting. By setting different listeners, it is possible to flexibly handle events such as changes in Bluetooth connection status, device discovery, service and feature discovery, which is suitable for WeChat mini program development scenarios that require data interaction with Bluetooth devices. ",
`5`	`5`	`"main": "src/MCBleKit.js",`
`6`	`6`	`"scripts": {`