bt-sensors-plugin-sk 1.3.2 → 1.3.4-beta

package/BTSensor.js

@@ -3,7 +3,7 @@ const { log } = require('node:console');
 const EventEmitter = require('node:events');
 const AutoQueue =  require("./Queue.js")
 const DistanceManager = require("./DistanceManager")
-
+const OutOfRangeDevice = require("./OutOfRangeDevice.js")
 /** 
  * @author Andrew Gerngross <oh.that.andy@gmail.com>
 */
@@ -278,7 +278,7 @@ class BTSensor extends EventEmitter {
 
     unsetError(){
         this._error=false
-        this.emit("error", false)
+        this.emit("errorDetected", false)
     }
 
     setError(message){
@@ -292,7 +292,7 @@ class BTSensor extends EventEmitter {
 
         this._errorLog.push({timestamp:Date.now(), message:message})
         this._error=true
-        this.emit("error", true)
+        this.emit("errorDetected", true)
     }
 
     //Instance Initialization functions
@@ -365,7 +365,10 @@ class BTSensor extends EventEmitter {
         await this.initSchema()
 
         this.initListen()
-        this.setState("DORMANT")
+        if ( this.device instanceof OutOfRangeDevice)
+            this.setState("OUT OF RANGE")
+        else
+            this.setState("DORMANT")
 
     }
 
@@ -1059,11 +1062,11 @@ class BTSensor extends EventEmitter {
 			if (!(path === undefined)) {
                 let preparedPath =  this.preparePath(path)
                 this.on(tag, (val)=>{
-					if (pathMeta.notify){
+/*					if (pathMeta.notify){
 						this._app.notify(tag, val, id )
-					} else {
+					} else {*/
 						this.updatePath(preparedPath,val, id, source)
-					}
+					//}
                 })
 			}
 		})

package/README.md

@@ -1,6 +1,23 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org) 
 
 ## WHAT'S NEW  
+
+
+# Version 1.3.4 - beta
+
+- Experimental inactivity timeout with Bluetooth recycle
+
+# Version 1.3.3 
+
+- Support for additional Xiaomi environmental sensors
+- Out Of Range device automatic retry
+- Pairing guide
+
+# Version 1.3.2-1
+
+- VictronSmartBatteryProtect fix
+- RenogyRoverClient deviceID clarity
+
 # Version 1.3.2
 
 - Victron Alarm Reason improvements

package/index.js

@@ -178,6 +178,11 @@ module.exports =   function (app) {
 				minimum: 10,
 				maximum: 3600 
 			},
+			inactivityTimeout: {title: "Inactivity timeout (in seconds). If no contact with any sensors for this period, the Bluetooth adapter will be recycled.", 
+				type: "integer", default: 60,
+				minimum: 0,
+				maximum: 3600 
+			},
 			discoveryInterval: {title: "Scan for new devices interval (in seconds-- 0 for no new device scanning)", 
 				type: "integer", 
 				default: 10,
@@ -203,6 +208,8 @@ module.exports =   function (app) {
 		plugin.started=true
 		var adapterID=options.adapter
 		var foundConfiguredDevices=0
+		var lastContactDelta=Infinity
+
 
 		if (Object.keys(options).length==0){ //empty config means initial startup. save defaults and enabled=true. 
 			let json = {configuration:{adapter:"hci0", transport:"le", discoveryTimeout:30, discoveryInterval:10}, enabled:true, enableDebug:false}
@@ -445,7 +452,7 @@ module.exports =   function (app) {
 			sensor.on("connected", (state)=>{
 				updateSensor(sensor)			
 			})
-			sensor.on("error",(error)=>{
+			sensor.on("errorDetected",(error)=>{
 				updateSensor(sensor)		
 			})
 			sensor.on("debug", ()=>{
@@ -492,19 +499,21 @@ module.exports =   function (app) {
 					s.stopListening()
 				else{
 					const device = new OutOfRangeDevice(adapter, config)
-					const c = await getClassFor(device,config)
-					if (c.domain==BTSensor.SensorDomains.beacons || c.IsRoaming){
-						s = await instantiateSensor(device,config)
-						device.once("deviceFound",async (device)=>{
-								s.device=device
-								s.listen()
-								await s.activate(config, plugin)
-								removeSensorFromList(s)
-								addSensorToList(s)
-						})
+					s = await instantiateSensor(device,config)
+					device.once("deviceFound",async (device)=>{
+						s.device=device
+						s.listen()
+						if (config.active)
+							await s.activate(config, plugin)
+						else {
+							s.unsetError()
+							s.setState("DORMANT")
+						}
+						removeSensorFromList(s)
 						addSensorToList(s)
-						resolve(s)
-					}
+					})
+					addSensorToList(s)
+					resolve(s)
 				}
 				if (startNumber == starts ) {
 					const errorTxt = `Unable to communicate with device ${deviceNameAndAddress(config)} Reason: ${e?.message??e}`
@@ -755,15 +764,28 @@ module.exports =   function (app) {
 		}
 		const minTimeout=Math.min(...deviceConfigs.map((dc)=>dc?.discoveryTimeout??options.discoveryTimeout))
 		const intervalTimeout = ((minTimeout==Infinity)?(options?.discoveryTimeout??plugin.schema.properties.discoveryTimeout.default):minTimeout)*1000
-		deviceHealthID = setInterval( ()=> {
+		
+		
+
+		deviceHealthID = setInterval( async ()=> {
 			sensorMap.forEach((sensor)=>{
 				const config = getDeviceConfig(sensor.getMacAddress())
 				const dt = config?.discoveryTimeout??options.discoveryTimeout
 				const lc=sensor.elapsedTimeSinceLastContact()
+				if (lc<lastContactDelta) //get min last contact delta
+					lastContactDelta=lc
 				if (lc > dt) { 
 					updateSensor(sensor)
 				}
 			})
+			if (sensorMap.size && lastContactDelta > options.inactivityTimeout)
+			{
+				
+				plugin.debug(`No contact with any sensors for ${lastContactDelta} seconds. Recycling Bluetooth adapter.`)	
+				await adapter.setPowered(false)
+				await adapter.setPowered(true)
+			}
+
 		}, intervalTimeout)
 		
 		if (!options.hasOwnProperty("discoveryInterval" )) //no config -- first run

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.3.2",
+  "version": "1.3.4-beta",
   "description": "Bluetooth Sensors for Signalk - see https://www.npmjs.com/package/bt-sensors-plugin-sk#supported-sensors for a list of supported sensors",
   "main": "index.js",
   "dependencies": {
@@ -13,7 +13,7 @@
     "@jellybrick/dbus-next": "^0.10.3",
     "int24": "^0.0.1",
     "kaitai-struct": "^0.10.0",
-    "@naugehyde/node-ble":"^1.13.4",
+    "@naugehyde/node-ble":"^1.13.5",
     "semver": "^7.7.1",
     "lru-cache": "^11.1.0"
   },

package/pairing.md

@@ -0,0 +1,147 @@
+# Bluetooth Device Pairing using bluetoothctl
+
+This guide provides a step-by-step procedure for pairing, trusting, and connecting a new Bluetooth device using the bluetoothctl command-line utility, which is the official Bluetooth client for BlueZ (the Linux Bluetooth stack).
+
+## Prerequisites
+
+- A running Linux system (e.g., Debian, Ubuntu, Fedora, Arch).
+- The bluez package installed (which includes bluetoothctl).
+- The Bluetooth service (bluetooth.service) is running. 
+- Your local Bluetooth adapter is enabled and powered on.
+
+## The Pairing Process
+
+Follow these steps within your terminal:
+
+### Step 1: Launch bluetoothctl
+
+Open your terminal and run the command to enter the interactive bluetoothctl prompt.
+
+```
+
+bluetoothctl
+
+```
+
+(The prompt should change to [bluetooth]#)
+
+### Step 2: Check Controller Status (Optional but recommended)Ensure your adapter is powered on and set to discoverable/pairable mode.
+
+```
+
+[bluetooth]# show
+
+```
+
+If the Powered field is listed as no, power the adapter on:
+
+```
+
+[bluetooth]# power on
+
+```
+
+### Step 3: Start Scanning for Devices
+
+Put your target Bluetooth device into pairing mode (see device instructions). Then, start the scanning process:
+
+```
+
+[bluetooth]# scan on
+
+```
+
+
+You will see a list of discovered devices scrolling by with their MAC addresses and names.
+
+```
+Discovery started
+[CHG] Device 12:34:56:78:90:AB Name: My Bluetooth Headphones
+[NEW] Device AB:CD:EF:12:34:56 Name: Wireless Mouse
+...
+```
+
+
+### Step 4: Identify and Stop Scanning
+
+Once you see the name of your device, copy its MAC Address (e.g., AB:CD:EF:12:34:56) and stop the scan to save battery and reduce clutter:
+
+```
+
+[bluetooth]# scan off
+
+```
+
+
+Step 5: Trust the Device
+
+Trusting the device is crucial. It allows the device to reconnect automatically after a reboot or disconnection without needing to re-pair. Replace [MAC_ADDRESS] with your device's MAC address.
+
+```
+
+[bluetooth]# trust [MAC_ADDRESS]
+
+Attempting to trust AB:CD:EF:12:34:56
+[CHG] Device AB:CD:EF:12:34:56 Trusted: yes
+...
+
+```
+
+### Step 6: Connect the Device 
+
+This step attempts to establish the active connection. 
+
+```
+
+[bluetooth]# connect [MAC_ADDRESS]
+
+Attempting to connect to AB:CD:EF:12:34:56
+[CHG] Device AB:CD:EF:12:34:56 Connected: yes
+Connection successful
+...
+```
+
+### Step 7: Pair the Device
+
+If the connection attempt in Step 6 did not automatically handle the key exchange, or if you prefer to explicitly perform the key exchange first, use the pair command. This initiates the actual pairing sequence. If your device requires a PIN or Passkey, bluetoothctl will prompt you to enter it (or confirm it). NOTE: Check your device's manual for setting the device's pairing mode.
+
+```
+
+[bluetooth]# pair [MAC_ADDRESS]
+Attempting to pair with AB:CD:EF:12:34:56
+[CHG] Device AB:CD:EF:12:34:56 Paired: yes
+Pairing successful
+...
+
+```
+
+(If prompted, enter or confirm the Passkey. If this command succeeds, you may need to run connect (Step 6) again to establish the active link.)
+
+### Step 8: Exit
+
+Once the connection is established, you can exit the interactive utility.
+
+```
+
+[bluetooth]# exit
+
+```
+
+## Summary of Essential Commands
+
+| **Command** | **Purpose** | 
+| :--- | :--- |
+| `bluetoothctl` | Enter the interactive prompt. | 
+| `power on` | Power on the local Bluetooth adapter. | 
+| `scan on` | Start discovering nearby devices. | 
+| `scan off` | Stop device discovery. | 
+| `trust [MAC]` | Mark the device as trusted for auto-reconnection. **(Crucial)** | 
+| `connect [MAC]` | Establish a connection to the device (may implicitly trigger pairing). | 
+| `pair [MAC]` | Explicitly initiate the pairing process (key exchange). | 
+| `exit` | Exit the `bluetoothctl` utility. | 
+
+### Troubleshooting Tips
+
+* **Adapter Issues:** If `show` or `list` commands don't show an adapter, ensure your Bluetooth hardware is properly recognized by the system (check kernel logs or `rfkill list`).
+
+* **Device Out of Range:** Ensure the device is close to the computer and is fully charged.