bt-sensors-plugin-sk 1.2.0-beta.0.0.1.test → 1.2.0-beta.0.0.3

package/BTSensor.js

@@ -1,6 +1,7 @@
 const { Variant } = require('dbus-next');
 const { log } = require('node:console');
 const EventEmitter = require('node:events');
+const AutoQueue = require("./Queue")
 
 /** 
  * @author Andrew Gerngross <oh.that.andy@gmail.com>
@@ -11,6 +12,7 @@ const EventEmitter = require('node:events');
  */
 
 const BTCompanies = require('./bt_co.json');
+const connectQueue = new AutoQueue()
 
 /**
  * @global A map of company names keyed by their Bluetooth ID
@@ -449,6 +451,39 @@ class BTSensor extends EventEmitter {
         throw new Error("::initGATTNotifications() should be implemented by the BTSensor subclass")
     }
 
+    deviceConnect() {
+
+        /* CAUTION: HACK AHEAD 
+
+        Bluez for some cockamamie reason (It's 2025 for chrissake. 
+        BLUETOOTH ISN'T JUST FOR DESKTOPS ANYMORE, BLUEZ DEVS!)
+        SUSPENDS scanning while connected to a device.
+
+        The next line of code gives the scanner a kick in the arse, 
+        starting it up again so, I dunno, another device might be able 
+        to connect and sensor classes could maybe get beacon updates.
+
+        You know, the little things.
+      */
+        return connectQueue.enqueue( async ()=>{
+            this.debug(`Connecting to ${this.getName()}`)
+            await this.device.connect()
+            try {
+
+                await this._adapter.helper.callMethod('StopDiscovery')
+                await this._adapter.helper.callMethod('SetDiscoveryFilter', {
+                    Transport: new Variant('s', this._adapter?._transport??"le")
+                })
+                await this._adapter.helper.callMethod('StartDiscovery')   
+                
+            } catch (e){
+                //probably ignorable error. probably.
+                console.log(e)
+            }
+        })
+    /* END HACK*/
+  }
+
     /**
      * 
      * Subclasses do NOT need to override this function
@@ -739,12 +774,15 @@ class BTSensor extends EventEmitter {
     //End instance utility functions
 
      createPaths(config, id){
+//        const source = `${this.getName()} (${id})`
+
 		Object.keys(this.getPaths()).forEach((tag)=>{
             const pathMeta=this.getPath(tag)
             const path = config.paths[tag]
             if (!(path===undefined))
                 this.app.handleMessage(id, 
                 {
+//                $source: source,
                 updates: 
                     [{ meta: [{path: preparePath(this, path), value: { units: pathMeta?.unit }}]}]
                 })
@@ -752,6 +790,7 @@ class BTSensor extends EventEmitter {
 	}
 
 	 initPaths(deviceConfig, id){
+        const source = this.getName()
 		Object.keys(this.getPaths()).forEach((tag)=>{
             const pathMeta=this.getPath(tag)
 			const path = deviceConfig.paths[tag];
@@ -760,14 +799,14 @@ class BTSensor extends EventEmitter {
 					if (pathMeta.notify){
 						this.app.notify(tag, val, id )
 					} else {
-						this.updatePath(preparePath(this,path),val,id)
+						this.updatePath(preparePath(this,path),val, id, source)
 					}
                 })
 			}
 		})
 	}
-	updatePath(path, val,id){
-		this.app.handleMessage(id, {updates: [ { values: [ {path: path, value: val }] } ] })
+	updatePath(path, val, id, source){
+		this.app.handleMessage(id, {updates: [ { $source: source, values: [ { path: path, value: val }] } ] })
   	}  
     elapsedTimeSinceLastContact(){
         return (Date.now()-this?._lastContact??Date.now())/1000

package/Queue.js

@@ -0,0 +1,48 @@
+/*
+see: https://stackoverflow.com/questions/53540348/js-async-await-tasks-queue 
+*/
+class Queue {
+    constructor() { this._items = []; }
+    enqueue(item) { this._items.push(item); }
+    dequeue()     { return this._items.shift(); }
+    get size()    { return this._items.length; }
+  }
+  
+  class AutoQueue extends Queue {
+    constructor() {
+      super();
+      this._pendingPromise = false;
+    }
+  
+    enqueue(action) {
+      return new Promise((resolve, reject) => {
+        super.enqueue({ action, resolve, reject });
+        this.dequeue();
+      });
+    }
+  
+    async dequeue() {
+      if (this._pendingPromise) return false;
+  
+      let item = super.dequeue();
+  
+      if (!item) return false;
+  
+      try {
+        this._pendingPromise = true;
+  
+        let payload = await item.action(this);
+  
+        this._pendingPromise = false;
+        item.resolve(payload);
+      } catch (e) {
+        this._pendingPromise = false;
+        item.reject(e);
+      } finally {
+        this.dequeue();
+      }
+  
+      return true;
+    }
+  }
+  module.exports = AutoQueue

package/index.js

@@ -47,6 +47,12 @@ class MissingSensor  {
 	hasGATT(){
 		return this.config.gattParams
 	}
+	initGATTConnection(){
+		
+	}
+	getGATTDescription(){
+		return ""
+	}
 	getMetadata(){
 		return this.metadata
 	}
@@ -196,6 +202,12 @@ module.exports =   function (app) {
 				app.debug(req.body)
 				const i = deviceConfigs.findIndex((p)=>p.mac_address==req.body.mac_address) 
 				if (i<0){
+					if (!options.peripherals){
+						if (!options.hasOwnProperty("peripherals"))
+							options.peripherals=[]
+			
+						options.peripherals=[]
+					}
 					options.peripherals.push(req.body)
 				} else {
 					options.peripherals[i] = req.body
@@ -330,13 +342,15 @@ module.exports =   function (app) {
 			//filter options which can cause issues with Device::Connect() 
 			//turning off Discovery
 			//try {await adapter.startDiscovery()}
+			const _transport = transport?plugin.schema.properties.transport.default:transport
 			try{ 
-				if (transport) {
-					app.debug(`Setting Bluetooth transport option to ${transport}`)
+				if (_transport) {
+					app.debug(`Setting Bluetooth transport option to ${_transport}`)
 					await adapter.helper.callMethod('SetDiscoveryFilter', {
-						Transport: new Variant('s', transport)
+						Transport: new Variant('s', _transport)
 					  })
 					}
+				adapter._transport=_transport
 				await adapter.helper.callMethod('StartDiscovery') 
 			} 
 			catch (error){	
@@ -370,7 +384,7 @@ module.exports =   function (app) {
 			var s
 			const startNumber=starts
 			//app.debug(`Waiting on ${deviceNameAndAddress(config)}`)
-			adapter.waitDevice(config.mac_address,config.discoveryTimeout*1000)
+			adapter.waitDevice(config.mac_address,(config?.discoveryTimeout??30)*1000)
 			.then(async (device)=> { 
 				if (startNumber != starts ) {
 					debugger
@@ -382,7 +396,6 @@ module.exports =   function (app) {
 				if (s instanceof BLACKLISTED)
 					reject ( `Device is blacklisted (${s.reasonForBlacklisting()}).`)
 				else{
-				
 					addSensorToList(s)
 					s.on("RSSI",(()=>{
 						updateSensor(s)
@@ -413,6 +426,8 @@ module.exports =   function (app) {
 					const sensor = new c(device,config?.params, config?.gattParams)
 					sensor.debug=app.debug
 					sensor.app=app
+					sensor._adapter=adapter //HACK!
+
 					await sensor.init()
 					//app.debug(`instantiated ${await BTSensor.getDeviceProp(device,"Address")}`)
 					
@@ -427,15 +442,15 @@ module.exports =   function (app) {
 			//if we're here ain't got no class for the device
 			var sensor
 			if (config.params?.sensorClass){
-				const c = classMap.get(config.params.sensorClass)
-				c.debug=app.debug
-				sensor = new c(device,config?.params, config?.gattParams)
-				sensor.debug=app.debug
-				sensor.app=app
+				var c = classMap.get(config.params.sensorClass)
 			} else{
-				sensor = new (classMap.get('UNKNOWN'))(device)
-				sensor.app=app
+				c = classMap.get('UNKNOWN')
 			}
+			c.debug=app.debug
+			sensor = new c(device,config?.params, config?.gattParams)
+			sensor.debug=app.debug
+			sensor.app=app
+
 			await sensor.init()
 			return sensor
 		}	
@@ -626,11 +641,14 @@ module.exports =   function (app) {
 				if (sensor.elapsedTimeSinceLastContact()> dt)
 					channel.broadcast(getSensorInfo(sensor), "sensorchanged")
 			})
-		}, minTimeout*1000)
+		}, (minTimeout==Infinity)?(options?.discoveryTimeout??plugin.schema.properties.discoveryTimeout.default):minTimeout)
 		
+		if (!options.hasOwnProperty("discoveryInterval" )) //no config -- first run
+			options.discoveryInterval = plugin.schema.properties.discoveryInterval.default
+
 		if (options.discoveryInterval && !discoveryIntervalID) 
-			findDeviceLoop(options.discoveryTimeout, options.discoveryInterval)
-	
+			findDeviceLoop(options?.discoveryTimeout??plugin.schema.properties.discoveryTimeout.default, 
+						   options.discoveryInterval)
 	} 
 	plugin.stop =  async function () {
 		app.debug("Stopping plugin")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.2.0-beta.0.0.1.test",
+  "version": "1.2.0-beta.0.0.3",
   "description": "Bluetooth Sensors for Signalk -- support for Victron devices, RuuviTag, Xiaomi, ATC and Inkbird, Ultrasonic wind meters, Mopeka tank readers, Renogy Battery and Solar Controllers, Aranet4 environment sensors, SwitchBot temp and humidity sensors, KilovaultHLXPlus smart batteries, and Govee GVH51xx temp sensors",
   "main": "index.js",
   "dependencies": {
@@ -65,6 +65,7 @@
     "signalk-category-hardware",
     "signalk-plugin-configurator"
   ],
+  "signalk-plugin-enabled-by-default": true,
   "author": "Andrew Gerngross",
   "license": "ISC",
   "bugs": {

package/sensor_classes/ATC.js

@@ -23,7 +23,8 @@ class ATC extends BTSensor{
             {
                 title:'data parsing strategy',
                 type: 'string',
-                enum:["ATC-LE","ATC-BE"]
+                enum:["ATC-LE","ATC-BE"],
+                default: ["ATC-LE"]
             }
         )
         if (!this.parser){

package/sensor_classes/JBDBMS.js

@@ -49,7 +49,7 @@ class JBDBMS extends BTSensor {
       this.addMetadatum('FET', '', 'FET Control',
           (buffer)=>{return buffer.readUInt8(24)} )
   
-      await this.device.connect()
+      await this.deviceConnect()
       await this.initCharacteristics()
       const cellsAndTemps = await this.getNumberOfCellsAndTemps()
       this.numberOfCells=cellsAndTemps.cells
@@ -74,14 +74,14 @@ class JBDBMS extends BTSensor {
     return true
   }
   initCharacteristics(){ 
-    return new Promise((resolve,reject )=>{ this.device.connect().then(async ()=>{ 
+    return new Promise( async (resolve,reject )=>{ 
       const gattServer = await this.device.gatt()
       const txRxService= await gattServer.getPrimaryService(this.constructor.TX_RX_SERVICE)
       this.rxChar = await txRxService.getCharacteristic(this.constructor.NOTIFY_CHAR_UUID)
       this.txChar = await txRxService.getCharacteristic(this.constructor.WRITE_CHAR_UUID)
       await this.rxChar.startNotifications()
       resolve(this)
-    }) .catch((e)=>{ reject(e.message) }) }) 
+   .catch((e)=>{ reject(e.message) }) }) 
   }
 
   async initGATTNotifications(){
@@ -92,7 +92,7 @@ class JBDBMS extends BTSensor {
 
   emitGATT(){
     this.getAndEmitBatteryInfo()
-    setTimeout(()=>{this.getAndEmitCellVoltages()}, 5000)
+    setTimeout(()=>{this.getAndEmitCellVoltages()}, 10000)
   }
 
   async getNumberOfCellsAndTemps(){

package/sensor_classes/KilovaultHLXPlus.js

@@ -175,7 +175,7 @@ class KilovaultHLXPlus extends BTSensor{
     }
 
     initGATTConnection(){ 
-        return new Promise((resolve,reject )=>{ this.device.connect().then(async ()=>{ 
+        return new Promise((resolve,reject )=>{ this.deviceConnect().then(async ()=>{ 
             if (!this.gattServer) { 
                 this.gattServer = await this.device.gatt() 
                 this.battService = await this.gattServer.getPrimaryService("0000ffe0-0000-1000-8000-00805f9b34fb") 

package/sensor_classes/Renogy/RenogySensor.js

@@ -57,7 +57,7 @@ class RenogySensor extends BTSensor{
         )
       
 
-        await this.device.connect()
+        await this.deviceConnect()
         const rw = await this.constructor.getReadWriteCharacteristics(this.device)
 
         this.readChar = rw.read    

package/sensor_classes/UltrasonicWindMeter.js

@@ -40,7 +40,7 @@ class UltrasonicWindMeter extends BTSensor{
     }
 
     initGATTConnection(){ 
-        return new Promise((resolve,reject )=>{ this.device.connect().then(async ()=>{ 
+        return new Promise((resolve,reject )=>{ this.deviceConnect().then(async ()=>{ 
             if (!this.gattServer) { 
                 this.gattServer = await this.device.gatt() 
                 this.battService = await this.gattServer.getPrimaryService("0000180f-0000-1000-8000-00805f9b34fb") 

package/sensor_classes/VictronBatteryMonitor.js

@@ -125,7 +125,7 @@ class VictronBatteryMonitor extends VictronSensor{
         return new Promise((resolve,reject )=>{
             if (!this.valueIfVariant(this.currentProperties.Paired))
                 reject(`${this.getName()} must be paired with the Signalk server to use GATT protocol`)
-            this.device.connect().then(async ()=>{
+            this.deviceConnect().then(async ()=>{
                 this.debug(`${this.getName()} connected.`)
                 if (!this.gattServer) {
                     this.gattServer = await this.device.gatt()

package/sensor_classes/VictronOrionXS.js

@@ -23,7 +23,7 @@ class VictronOrionXS extends VictronSensor{
         this.addMetadatum('inputCurrent','A','input current', 
             (buff)=>{return this.NaNif(buff.readUInt16LE(8),0xFFFF)/10})
         this.addMetadatum('deviceOffReason','', 'device off reason', 
-            (buff)=>{return VC.OffReasons(buff.readUInt32(10))})    
+            (buff)=>{return VC.OffReasons(buff.readUInt32BE(10))})    
         }
 
 }

package/sensor_classes/XiaomiMiBeacon.js

@@ -110,7 +110,7 @@ class XiaomiMiBeacon extends BTSensor{
             this.gattWarningDelivered=true
         }
         return new Promise((resolve,reject )=>{
-            this.device.connect().then(async ()=>{
+            this.deviceConnect().then(async ()=>{
                 if (!this.gattServer) {
                     this.gattServer = await this.device.gatt()
                     this.gattService = await this.gattServer.getPrimaryService("ebe0ccb0-7a0a-4b0c-8a1a-6ff2997da3a6")