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

package/.vscode/launch.json

@@ -0,0 +1,7 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": []
+}

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.js")
 
 /** 
  * @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
@@ -98,7 +100,7 @@ function preparePath(obj, str) {
  */
 
 class BTSensor extends EventEmitter {
-    //static metadata=new Map()
+ 
     static DEFAULTS = require('./plugin_defaults.json');
     
     /**
@@ -312,23 +314,25 @@ class BTSensor extends EventEmitter {
 			}
 		}
 
-    }
-    async init(){
-        this.currentProperties = await this.constructor.getDeviceProps(this.device)
-        this.initSchema()
-
 
         //create the 'name' parameter
         this.addDefaultParam("name")
+            .default=this?.currentProperties?.Name
 
         //create the 'location' parameter
 
-        this.addDefaultParam("location")
+        //this.addDefaultParam("location")
 
         //create the 'RSSI' parameter 
         this.addDefaultPath("RSSI","sensors.RSSI")
         this.getPath("RSSI").read=()=>{return this.getRSSI()}
         this.getPath("RSSI").read.bind(this)
+
+    }
+    async init(){
+        this.currentProperties = await this.constructor.getDeviceProps(this.device)
+        this.initSchema()
+
         this.initListen()
     }
 
@@ -361,13 +365,15 @@ class BTSensor extends EventEmitter {
             }
             else 
                 await this.initGATTNotifications()
+        }).catch((e)=>{
+            this.app.debug(`Unable to activate GATT connection for ${this.getName()} (${this.getMacAddress()}): ${e}`)
         })
     }
 
     /**
      * Add a metadatum instance to the sensor instance
      *  
-     * @param {String} tag 
+     * @param {String} tag
      * @param  {...any} args 
      * @returns {this.Metadatum} the new metadatum instance
      */
@@ -449,6 +455,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
@@ -515,6 +554,9 @@ class BTSensor extends EventEmitter {
     getParams(){
         return this._schema.properties.params.properties
     }
+    getParameter(param){
+        return this.getParams()[param]
+    }
     getGATTParams(){
         return this._schema.properties.gattParams.properties
        
@@ -739,12 +781,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 +797,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 +806,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/README.md

@@ -1,8 +1,35 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org)
 
-## Beta 1.0.0
+## What's New
 
-Dynamic configuration added (no more screen refreshing necessary).
+## 1.2.0-beta-0.0.10
+
+Better handling of plugin config screen when Disabled
+
+## 1.2.0-beta-0.0.9
+
+Fixes to config page RSSI update.
+
+## 1.2.0-beta-0.0.8
+
+Improved handling of changed state on config page.
+
+Several small fixes to various sensor classes.
+
+## 1.2.0-beta-0.0.7
+
+Added zone config param for environmental sensors. Removed location parameter. 
+
+## 1.2.0-beta-0.0.6
+Default values for paths for most sensor classes. 
+
+## 1.2.0-beta-0.0.5
+
+Added workaround to support multiple simultaneous GATT connections. Owing to problematic behavior in Bluez where making a GATT connection halted the scanner which made additional updates and connections impossible, added a scanner restart after making each GATT connection. 
+
+## 1.2.0-beta-0.0.1
+
+Dynamic configuration added. List updates when new devices are found by scanner. (No more screen refreshing necessary).
 
 ## WHAT IT IS
 
@@ -33,13 +60,13 @@ Signalk users with a Linux boat-puter (Windows and MacOS are NOT currently suppo
 NOTE: If you're running the 1.0.3 release, you will have to reconfigure your devices.<br>
 
 ### Signalk Appstore
-The plugin is currently available in the Signalk Appstore. <br>
+The beta plugin is not currently available in the Signalk Appstore. <br>
 
 ### NPM
 
 Go to you signalk home (usually ~/.signalk) and run:
 
-npm i bt-sensors-plugin-sk@1.1.0-beta.2.1
+npm i bt-sensors-plugin-sk@1.2.0-beta.0.0.7
 
 ### Linux
 
@@ -48,7 +75,7 @@ If you want to install directly from source (this is mostly of interest to custo
 <pre>  cd ~/[some_dir]
   git clone https://github.com/naugehyde/bt-sensors-plugin-sk
   cd bt-sensors-plugin-sk
-  git switch '1.1.0'
+  git switch '1.2.0-beta'
   git pull
   npm i
   [sudo] npm link
@@ -68,16 +95,11 @@ After installing and restarting Signalk you should see a "BT Sensors Plugin" opt
 
 On initial configuration, wait for your Bluetooth adapter to scan devices. The plugin will scan for new devices at whatever you set the "scan for new devices interval" value to. <br><br>
 
-> TIP: Close and re-open the config screen to refresh the screen. The config screen isn't as <i>reactive</i> as it oughtta be.<br><br>
-
-Then press the + button to add a sensor. Your screen should look something like this:<br><br>
-<img width="1122" alt="Screenshot 2024-10-13 at 6 52 52 PM" src="https://github.com/user-attachments/assets/0487b8d0-4bc0-4358-85c6-a507bc3c97d2">
-
 <br><br>
 
-Select the sensor you want Signalk to listen to from the drop down.<br>
+Select the sensor you want Signalk to listen to from the list.<br>
 
-If you don't see your device and you know that it's on and nearby to the server, it may not be currently supported. But fear not, you can add custom sensor classes yourself. (Check out [the development section](#development).). <br><br>
+If you don't see your device and you know that it's on and nearby to the server, it may not be currently supported (It could also be out of range.) But fear not, you can add custom sensor classes yourself. (Check out [the development section](#development).). <br><br>
 
 Now it's a simple matter of associating the data emitted by the sensor with the Signalk path you want it to update. (Also, you can name your sensor so when it appears in logs its easy to recognize.) <br><br>
 

package/classLoader.js

@@ -0,0 +1,38 @@
+const fs = require('fs')
+const path = require('path')
+const semver = require('semver')
+
+    function loadClasses (dir, ext='.js')
+        {
+            const classMap = new Map()
+            const classFiles = fs.readdirSync(dir)
+            .filter(file => file.endsWith(ext));
+        
+            classFiles.forEach(file => {
+                const filePath = path.join(dir, file);
+                const cls = require(filePath);
+                classMap.set(cls.name, cls);
+            })
+            return classMap
+        }
+
+      function loadClassMap(app) {
+        const _classMap = loadClasses(path.join(__dirname, 'sensor_classes'))
+        const classMap = new Map([..._classMap].filter(([k, v]) => !k.startsWith("_") ))
+        const libPath = app.config.appPath +(
+            semver.gt(app.config.version,"2.13.5")?"dist":"lib"
+        )
+        import(libPath+"/modules.js").then( (modulesjs)=>{
+        const { default:defaultExport} = modulesjs
+            const modules = defaultExport.modulesWithKeyword(app.config, "signalk-bt-sensor-class")
+            modules.forEach((module)=>{
+                module.metadata.classFiles.forEach((classFile)=>{
+                    const cls = require(module.location+module.module+"/"+classFile);
+                    classMap.set(cls.name, cls);
+                })
+            })
+            classMap.get('UNKNOWN').classMap=new Map([...classMap].sort().filter(([k, v]) => !v.isSystem )) // share the classMap with Unknown for configuration purposes
+        })
+        return classMap
+    }
+    module.exports=loadClassMap