bt-sensors-plugin-sk 1.3.6 → 1.3.8-beta1

package/BTSensor.js

@@ -105,7 +105,7 @@ class BTSensor extends EventEmitter {
 
         Object.assign(this,config)
         Object.assign(this,gattConfig)
-    
+
         this._state = "UNKNOWN"
     }
     /**
@@ -155,7 +155,7 @@ class BTSensor extends EventEmitter {
     static _test(data, key, config={}){
         var b = Buffer.from(data.replaceAll(" ",""),"hex")
         const d = new this(null,config)
-        d.initMetadata() 
+        d.initSchema() 
         Object.keys(d.getPaths()).forEach((tag)=>{
                 d.on(tag,(v)=>console.log(`${tag}=${v}`))
         })
@@ -319,15 +319,17 @@ class BTSensor extends EventEmitter {
                     type: "integer", default:30,
                     minimum: 10,
                     maximum: 600 },
-                noContactThreshhold: {title: "If no contact (in seconds), raise warning. Set to 0 to disable", 
-                    type: "integer", 
-                    minimum: 0,
-                    maximum: 600,
-                    default: 2*(this?.discoveryTimeout??30) },
+
                 params:{
                     title:`Device parameters`,
                     type:"object",
-                    properties:{}
+                    properties:{
+                        noContactThreshold: {title: "If no contact (in seconds), raise warning. Set to 0 to disable", 
+                        type: "integer", 
+                        minimum: 0,
+                        maximum: 600,
+                        default: 2*(this?.discoveryTimeout??30) }
+                    }
                 },
                 paths:{
                     title:"Signalk Paths",
@@ -349,7 +351,13 @@ class BTSensor extends EventEmitter {
                     pollFreq: { type: "number", title: "Polling frequency in seconds"}
                 }
 			}
-		}
+		} else{
+            this._schema.properties.params.properties.minUpdateInterval=                        
+                {title: "Minimum update interval in milliseconds (0 to disable rate limiting).", 
+                type: "integer", 
+                minimum: 0,
+                default: 0 }
+        }
 
 
         //create the 'name' parameter
@@ -367,9 +375,8 @@ class BTSensor extends EventEmitter {
 
     }
     async init(){
-        this.setState("INITIALIZING")
-
         this.currentProperties = await this.constructor.getDeviceProps(this.device)
+        this.setState("INITIALIZING");
         await this.initSchema()
 
         this.initListen()
@@ -580,7 +587,7 @@ class BTSensor extends EventEmitter {
     isError(){
         return this._error
     }
-    deviceConnect(isReconnecting=false, autoReconnect=false) {
+    deviceConnect(isReconnecting=false, autoReconnect=false, timeout=30000) {
      
         return connectQueue.enqueue( async ()=>{
             this.debug(`Connecting... ${this.getName()}`)
@@ -595,10 +602,27 @@ class BTSensor extends EventEmitter {
                     this.setConnected(true)
                 })    
             }
-            await this.device.helper.callMethod('Connect')
+            const connectTimeoutID = setTimeout(
+                ()=>{
+                    const e = `Connect timed out. Unable to connect after ${timeout}ms.`
+                    this.setError(e)
+                    throw new Error(e)
+                }
+                ,timeout
+            ) 
+            try {
+                await this.device.helper.callMethod('Connect')
+            } catch (e) {
+                this.debug(e)
+                throw new Error(e.message)
+            }
+            finally {
+                clearTimeout(connectTimeoutID)
+            }
             this.setConnected(true)
-
+            this._lastContact = Date.now()
             this.debug(`Connected to ${this.getName()}`)
+            
             if (!isReconnecting) {
               this.device.helper.on(
                     "PropertiesChanged",
@@ -698,23 +722,24 @@ class BTSensor extends EventEmitter {
      */
 
     async initGATTInterval(){
-        await this.deviceDisconnect()
-
+        async function _emitGATT() {
+        try {
+           await this.initGATTConnection(true);
+           await this.emitGATT();
+         } catch (error) {
+           this.debug(error);
+           this.setError(`Unable to emit values for device: ${error.message}`);
+         } finally {
+           await this.deactivateGATT().catch((e) => {
+             this.debug(`Error deactivating GATT Connection: ${e.message}`);
+           });
+           this.setState("WAITING");
+        }
+        }
+        _emitGATT = _emitGATT.bind(this);
+        _emitGATT()
         this.intervalID = setInterval( async () => {
-            try {
-                await this.initGATTConnection(true)
-                await this.emitGATT()
-            }
-            catch(error) {
-                this.debug(error)
-                this.setError(`Unable to emit values for device: ${error.message}`)
-            }
-            finally{ 
-                await this.deactivateGATT().catch( (e)=>{
-                    this.debug(`Error deactivating GATT Connection: ${e.message}`)
-                })
-                this.setState("WAITING")
-            }
+            await _emitGATT()
         }
         , this.pollFreq*1000)
     }
@@ -726,13 +751,20 @@ class BTSensor extends EventEmitter {
      * DBUS connection stays alive, doesn't tax resources and doesn't spit out spurious errors.
      */
     initPropertiesChanged(){
-
+        let lastPropsChanged = -1
         this._propertiesChanged.bind(this)
         this.device.helper._prepare()
         this.device.helper.on("PropertiesChanged",
             ((props)=> {
+                if ( this.minUpdateInterval && 
+                     lastPropsChanged>0 && 
+                     (Date.now() - lastPropsChanged) < this.minUpdateInterval) {
+                        this.debug(`Ignoring properties changed. Last update was ${Date.now() - lastPropsChanged} ms ago.`)
+                    return
+                }
                 try{
                     this._propertiesChanged(props)
+                    lastPropsChanged = Date.now()
                 }
                 catch(error){
                     this.debug(`Error occured on ${this.getNameAndAddress()}: ${error?.message??error}`)
@@ -766,7 +798,7 @@ class BTSensor extends EventEmitter {
     //Sensor description functions
 
     getMacAddress(){
-        return this.currentProperties.Address
+        return this.currentProperties?.Address??"Unknown MAC"
     }
 
     static ImageFile = "bluetooth-logo.png" 
@@ -849,7 +881,7 @@ class BTSensor extends EventEmitter {
     }
 
     getManufacturerData(key=null){
-        if (this.currentProperties.ManufacturerData)
+        if (this.currentProperties?.ManufacturerData)
             if (key)
                 return this.valueIfVariant (this.currentProperties.ManufacturerData[key])
             else
@@ -949,8 +981,8 @@ class BTSensor extends EventEmitter {
             this.currentProperties.ManufacturerData=this.valueIfVariant(props.ManufacturerData)
         if (this.isActive())
             this.propertiesChanged(props)
-
     }
+    
     propertiesChanged(props){
         //implemented by subclass
     }
@@ -971,8 +1003,11 @@ class BTSensor extends EventEmitter {
         this._currentValues[tag]=value
     }
 
-    emit(tag, value){
+    _emit(tag, value){
         super.emit(tag, value)
+        if (this.usingGATT()) //update last contact time only for GATT devices 
+                              //which do not receive propertyChanged events when connected
+            this._lastContact=Date.now()
         this.setCurrentValue(tag,value)
     }
 
@@ -1069,7 +1104,7 @@ class BTSensor extends EventEmitter {
                 this._app.handleMessage(id, 
                 {
                 updates: 
-                    [{ meta: [{path:  this.preparePath(path), value: { units: pathMeta?.unit, zones:pathMeta?.zones } }]}] 
+                    [{ meta: [{path:  this.preparePath(path), value: { units: pathMeta?.unit, zones:pathMeta?.zones, renderer:pathMeta?.renderer } }]}] 
                 })
             }
         })
@@ -1089,8 +1124,10 @@ class BTSensor extends EventEmitter {
 		})
 	}
 	updatePath(path, val, id, source){
+
 		this._app.handleMessage(id, {updates: [ { $source: source, values: [ { path: path, value: val }] } ] })
   	}  
+
     elapsedTimeSinceLastContact(){
         if (this.device instanceof OutOfRangeDevice)
             return Infinity

package/OutOfRangeDevice.js

@@ -1,5 +1,4 @@
 
-const { toPathSchema } = require('@rjsf/utils');
 const EventEmitter = require('node:events');
 
 class OutOfRangeDevice extends EventEmitter{

package/README.md

@@ -2,6 +2,34 @@
 
 ## WHAT'S NEW  
 
+# Version 1.3.8-beta1
+
+## New sensors
+
+- MicrotikTag 
+- SensorPush 
+
+## New features
+
+- Rate limiter
+
+# Version 1.3.7
+
+### Issues Addressed
+
+- https://github.com/naugehyde/bt-sensors-plugin-sk/issues/113
+- https://github.com/naugehyde/bt-sensors-plugin-sk/issues/108
+- https://github.com/naugehyde/bt-sensors-plugin-sk/issues/107
+- https://github.com/naugehyde/bt-sensors-plugin-sk/issues/106
+- https://github.com/naugehyde/bt-sensors-plugin-sk/issues/103
+
+### Pull Requests included
+
+- https://github.com/naugehyde/bt-sensors-plugin-sk/pull/97
+- https://github.com/naugehyde/bt-sensors-plugin-sk/pull/104
+- https://github.com/naugehyde/bt-sensors-plugin-sk/pull/111
+- https://github.com/naugehyde/bt-sensors-plugin-sk/pull/114
+
 # Version 1.3.6
 
 - New sensor parameter: no contact threshhold.
@@ -153,6 +181,8 @@ It's pretty easy to write and deploy your own sensor class for any currently uns
 |[Remoran](https://remoran.eu)| [Remoran Wave.3](https://remoran.eu/wave.html)|
 |[AC DC Systems](https://marinedcac.com) | [Bank Manager](https://marinedcac.com/pages/bankmanager) hybrid (Pb and Li) charger|
 |[Ective](https://ective.de/)| Also Topband(?), Skanbatt and others |
+|[Leagend](https://leagend.com)| BM 2/6/7 Battery Monitors aka Alcel BM200 and others. See: https://leagend.com/products/bm6|
+
 
 ### Environmental 
 | Manufacturer |  Devices | 

package/classLoader.js

@@ -15,7 +15,7 @@ const semver = require('semver')
                     classMap.set(cls.name, cls);
                 } 
                 catch (e) {
-                    console.log(`Unable to load class (${cls?.name}): ${e.message}`)
+                    console.log(`Unable to load classfile (${file}): ${e.message}`)
                     console.log(e)
                 }
 
@@ -38,7 +38,7 @@ const semver = require('semver')
                         const cls = require(module.location+module.module+"/"+classFile);
                         classMap.set(cls.name, cls);
                     } catch (e) {
-                        console.log(`Unable to load class (${cls.name}): ${e.message}`)
+                        console.log(`Unable to load classfile (${file}): ${e.message}`)
                         console.log(e)
                     }
                 })

package/index.js

@@ -589,7 +589,9 @@ module.exports =   function (app) {
 			}
 
 		}	
-		
+		function activeDevices(){
+			return Array.from(sensorMap.values()).filter(s=>s.isActive()).length
+		}
 		function initConfiguredDevice(deviceConfig){
 			const startNumber=starts
 			plugin.setStatusText(`Initializing ${deviceNameAndAddress(deviceConfig)}`);
@@ -600,9 +602,10 @@ module.exports =   function (app) {
 						return
 				}	
 				if (deviceConfig.active && !(sensor.device instanceof OutOfRangeDevice) ) {
-					plugin.setStatusText(`Listening to ${++foundConfiguredDevices} sensors.`);
 					try {
 						await sensor.activate(deviceConfig, plugin)
+						plugin.setStatusText(`Listening to ${activeDevices()} sensors.`);
+
 					} catch (e){
 						sensor.setError(`Unable to activate sensor. Reason: ${e.message}`)
 					}
@@ -788,7 +791,7 @@ module.exports =   function (app) {
 				if (lc > dt) { 
 					updateSensor(sensor)
 				}
-				if (sensor.noContactThreshhold && lc>sensor.noContactThreshold){
+				if (sensor.noContactThreshold && lc>sensor.noContactThreshold){
 					if (sensor.isActive())
 						sensor.notifyNoContact()
 				}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.3.6",
+  "version": "1.3.8-beta1",
   "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": {

package/plugin_defaults.json

@@ -24,7 +24,7 @@
         }
     },
     "environment":{
-        "temperature": 
+        "temperature":
             {
                 "title": "Temperature",
                 "description":"Current zone's temperature",
@@ -51,6 +51,29 @@
                 "default":"environment.{zone}.pressure"
             }
     },
+    "navigation": {
+        "attitude": {
+            "pitch":
+            {
+                "description":"Current pitch",
+                "unit":"rad",
+                "default":"navigation.attitude.pitch"
+            },
+            "roll":
+            {
+                "description":"Current pitch",
+                "unit":"rad",
+                "default":"navigation.attitude.roll"
+            },
+            "yaw":
+            {
+                "description":"Current pitch",
+                "unit":"rad",
+                "default":"navigation.attitude.yaw"
+            }
+
+        }
+    },
     "electrical":{
         "inverters":{
             "ac":{
@@ -59,17 +82,17 @@
                     "default":"electrical.inverters.{id}.ac.current"
                 },
                 "voltage":
-                { 
+                {
                     "unit": "V",
                     "default":"electrical.inverters.{id}.ac.voltage"
                 },
                 "power":
-                { 
+                {
                     "unit": "W",
                     "default":"electrical.inverters.{id}.ac.power"
                 }
-         
-         
+
+
             },
             "dc":{
                 "current":{
@@ -77,7 +100,7 @@
                     "default":"electrical.inverters.{id}.dc.current"
                 },
                 "voltage":
-                { 
+                {
                     "unit": "V",
                     "default":"electrical.inverters.{id}.dc.voltage"
                 }
@@ -91,19 +114,19 @@
                 "default":"electrical.batteries.{batteryID}.current"
             },
             "voltage":
-            { 
+            {
                 "unit": "V",
                 "default": "electrical.batteries.{batteryID}.voltage"
             },
-            
+
             "power":
-            { 
+            {
                 "unit": "W",
                 "default": "electrical.batteries.{batteryID}.power"
             },
-                        
+
             "impedance":
-            { 
+            {
                 "unit": "Ohm",
                 "default": "electrical.batteries.{batteryID}.impedance"
             },
@@ -136,23 +159,23 @@
                 "stateOfCharge":{
                     "description": "Battery's state of charge as ratio",
                     "unit":"ratio",
-                    "default": "electrical.batteries.{batteryID}.capacity.stateOfCharge" 
+                    "default": "electrical.batteries.{batteryID}.capacity.stateOfCharge"
                 },
                 "stateOfHealth":{
                     "description": "Battery's state of health as ratio",
                     "unit":"ratio",
-                    "default": "electrical.batteries.{batteryID}.capacity.stateOfHealth" 
+                    "default": "electrical.batteries.{batteryID}.capacity.stateOfHealth"
                 },
-                
+
                 "timeRemaining":{
                     "description": "Time in seconds until battery reaches its discharge floor at current usage",
 
                     "unit":"s",
-                    "default": "electrical.batteries.{batteryID}.capacity.timeRemaining" 
-     
+                    "default": "electrical.batteries.{batteryID}.capacity.timeRemaining"
+
                 }
             }
-            
+
         }
     },
     "sensors":{
@@ -178,11 +201,11 @@
                   "lower": 0,
                   "state": "warn",
                   "message": "Battery very low -  change now"
-                }      
+                }
             ],
-            "description":"Sensor battery strength" 
+            "description":"Sensor battery strength"
         },
-    
+
         "batteryVoltage":
         {
             "title":"Battery Voltage",