bt-sensors-plugin-sk 1.1.0-beta.1 → 1.1.0-beta.2

package/BTSensor.js

@@ -10,10 +10,15 @@ const BTCompanies = require('./bt_co.json')
  */
 
 const BTCompanyMap=new Map()
+
 BTCompanies.company_identifiers.forEach( (v) =>{
     BTCompanyMap.set(v.value, v.name)
 })
 
+/**
+ * https://www.intuitibits.com/2016/03/23/dbm-to-percent-conversion/
+ */
+
 function signalQualityPercentQuad(rssi, perfect_rssi=-20, worst_rssi=-85) {
     const nominal_rssi=(perfect_rssi - worst_rssi);
     var signal_quality =
@@ -31,6 +36,7 @@ function signalQualityPercentQuad(rssi, perfect_rssi=-20, worst_rssi=-85) {
     }
     return Math.ceil(signal_quality);
 }
+
 class BTSensor extends EventEmitter {
     static metadata=new Map()
     constructor(device, config={}, gattConfig={}) {
@@ -84,35 +90,58 @@ class BTSensor extends EventEmitter {
             }
         }  
 
-    static getMetadata(){
-        return this.metadata
-    }
-
-    static {
-        var md = this.addMetadatum("name", "string","Name of sensor" )
-        md.isParam=true
-
-
+  
+        static async getPropsProxy(device){
+        
+            if (!device._propsProxy) {
+                const objectProxy  = await device.helper.dbus.getProxyObject(device.helper.service, device.helper.object)
+                device._propsProxy = await objectProxy.getInterface('org.freedesktop.DBus.Properties')
+            }
+            return device._propsProxy 
+        }
+        static async getDeviceProps(device, propNames=[]){
+            const _propsProxy = await this.getPropsProxy(device)
+            const rawProps = await _propsProxy.GetAll(device.helper.iface)
+            const props = {}
+            for (const propKey in rawProps) {
+                if (propNames.length==0 || propNames.indexOf(propKey)>=0)
+                    props[propKey] = rawProps[propKey].value
+            }
+            return props
+        }
+        static async getDeviceProp(device, prop){
+            const _propsProxy = await this.getPropsProxy(device)
+            try{
+                const rawProps = await _propsProxy.Get(device.helper.iface,prop)
+                return rawProps?.value
+            }
+            catch(e){
+                return null //Property $prop (probably) doesn't exist in $device
+            }
+        }  
         
-    }
-    static addMetadatum(tag, ...args){
-        var metadatum = new this.Metadatum(tag, ...args)
-        this.getMetadata().set(tag,metadatum)
-        return metadatum
-    }
     
-    emitData(tag, buffer, ...args){
-        this.emit(tag, this.getMetadatum(tag).read(buffer, ...args))
+    static async getManufacturerID(device){
+        const md = await this.getDeviceProp(device,'ManufacturerData')
+        if (!md) return null 
+        const keys = Object.keys(md)
+        if (keys && keys.length>0){
+            return parseInt(keys[0])
+        }
+        return null
     }
+    static NaNif(v1,v2) {  return (v1==v2)?NaN:v1 }
     
     async init(){
+        var md = this.addMetadatum("name", "string","Name of sensor" )
+        md.isParam=true
         this.currentProperties = await this.constructor.getDeviceProps(this.device)
         this.addMetadatum("RSSI","db","Signal strength in db")
         this.getMetadatum("RSSI").default=`sensors.${this.getMacAddress().replaceAll(':', '')}.rssi`
         this.getMetadatum("RSSI").read=()=>{return this.getRSSI()}
         this.getMetadatum("RSSI").read.bind(this)
-        if (this.canUseGATT()) {
-            var md = this.addMetadatum("useGATT", "boolean", "Use GATT connection")
+        if (this.hasGATT()) {
+            md = this.addMetadatum("useGATT", "boolean", "Use GATT connection")
             md.type="boolean"
             md.isParam=true
             md.isGATT=true
@@ -123,21 +152,9 @@ class BTSensor extends EventEmitter {
             md.isGATT=true
         }
     }
-
-    static async getManufacturerID(device){
-        const md = await this.getDeviceProp(device,'ManufacturerData')
-        if (!md) return null 
-        const keys = Object.keys(md)
-        if (keys && keys.length>0){
-            return parseInt(keys[0])
-        }
-        return null
-    }
-    static NaNif(v1,v2) {  return (v1==v2)?NaN:v1 }
     
     NaNif(v1,v2) {  return this.constructor.NaNif(v1,v2) }
 
-
     addMetadatum(tag, ...args){
         var metadatum = new this.Metadatum(tag, ...args)
         this.getMetadata().set(tag, metadatum)
@@ -193,6 +210,8 @@ class BTSensor extends EventEmitter {
         return bars 
 
     }
+
+
     getDescription(){
         return `${this.getName()} from ${this.getManufacturer()}`
     }
@@ -213,7 +232,7 @@ class BTSensor extends EventEmitter {
     getRSSI(){
         return this.currentProperties?.RSSI??NaN
     }
-    canUseGATT(){
+    hasGATT(){
         return false
     }
     usingGATT(){
@@ -226,35 +245,10 @@ class BTSensor extends EventEmitter {
             return obj
         
     }
-
-    static async getPropsProxy(device){
-        
-        const objectProxy  = await device.helper.dbus.getProxyObject(device.helper.service, device.helper.object)
-        if (!device._propsProxy)
-            device._propsProxy = await objectProxy.getInterface('org.freedesktop.DBus.Properties')
-        return device._propsProxy 
-    }
-    static async getDeviceProps(device, propNames=[]){
-        const _propsProxy = await this.getPropsProxy(device)
-        const rawProps = await _propsProxy.GetAll(device.helper.iface)
-        const props = {}
-        for (const propKey in rawProps) {
-            if (propNames.length==0 || propNames.indexOf(propKey)>=0)
-                props[propKey] = rawProps[propKey].value
-        }
-        return props
+    emitData(tag, buffer, ...args){
+        this.emit(tag, this.getMetadatum(tag).read(buffer, ...args))
     }
-    static async getDeviceProp(device, prop){
-        const _propsProxy = await this.getPropsProxy(device)
-        try{
-            const rawProps = await _propsProxy.Get(device.helper.iface,prop)
-            return rawProps?.value
-        }
-        catch(e){
-            return null //Property $prop (probably) doesn't exist in $device
-        }
-    }  
-    
+
 /**
  * callback function on device properties changing
  */
@@ -294,9 +288,13 @@ class BTSensor extends EventEmitter {
         const id = this.getManufacturerID()
         return (id==null)?"Unknown manufacturer":BTCompanyMap.get(parseInt(id))
     }
-    getManufacturerData(key){
+
+    getManufacturerData(key=null){
         if (this.currentProperties.ManufacturerData)
-            return this.valueIfVariant (this.currentProperties.ManufacturerData[key])
+            if (key)
+                return this.valueIfVariant (this.currentProperties.ManufacturerData[key])
+            else
+                return(this.valueIfVariant (this.currentProperties.ManufacturerData))                
         else
             return null
     }

package/index.js

@@ -30,7 +30,7 @@ class MissingSensor  {
 		this.mac_address = config.mac_address
 		
 	}
-	canUseGATT(){
+	hasGATT(){
 		return false
 	}
 	getMetadata(){
@@ -257,7 +257,7 @@ module.exports =  function (app) {
 			oneOf.properties.params.properties[tag]=metadatum.asJSONSchema()
 		})
 
-		if (sensor.canUseGATT()){
+		if (sensor.hasGATT()){
 
 			oneOf.properties.gattParams={
 				title:`GATT Specific device parameters`,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.1.0-beta.1",
-  "description": "Bluetooth Sensors for Signalk - Beta 20241012",
+  "version": "1.1.0-beta.2",
+  "description": "Bluetooth Sensors for Signalk -- support for Victron devices, RuuviTag, Xiaomi, ATC and Inkbird",
   "main": "index.js",
   "dependencies": {
     "dbus-next": "^0.10.2",

package/sensor_classes/ATC.js

@@ -14,8 +14,8 @@ class ATC extends BTSensor{
         return null
     }
   
-    static {
-        this.metadata = new Map(super.getMetadata())
+    async init() {
+        await super.init() 
         this.addMetadatum('temp','K', 'temperature',
             (buff,offset)=>{return ((buff.readInt16LE(offset))/100) + 273.1})
         this.addMetadatum('humidity','ratio', 'humidity',

package/sensor_classes/Inkbird.js

@@ -16,14 +16,10 @@ class Inkbird extends BTSensor{
         return null
     }
 
-    static {
-        this.metadata = new Map(super.getMetadata())
-        this.addMetadatum('temp','K', 'temperature')
-        this.addMetadatum('battery','ratio', 'battery strength')
-    }
-
     async init(){
         await super.init()
+        this.addMetadatum('temp','K', 'temperature')
+        this.addMetadatum('battery','ratio', 'battery strength')
         if (this.getName() == 'sps'){
             this.addMetadatum('humidity','ratio', 'humidity')
         }

package/sensor_classes/RuuviTag.js

@@ -11,11 +11,7 @@ class RuuviTag extends BTSensor{
         }
         return null
     }    
-
-    static {
-        this.metadata = new Map(super.getMetadata())
-    }
-    
+        
     async init(){
         await super.init()
         const md = this.valueIfVariant(this.getManufacturerData(this.constructor.manufacturerID))

package/sensor_classes/Victron/VictronSensor.js

@@ -11,12 +11,6 @@ const VC = require('./VictronConstants.js')
         this.encryptionKey = config?.encryptionKey
     }
    
-    static {
-        this.metadata = new Map(super.getMetadata())
-        const md = this.addMetadatum('encryptionKey','', "Encryption Key")
-        md.isParam = true
-    }
-
     static async identifyMode(device, mode){
 
         try{
@@ -51,6 +45,11 @@ const VC = require('./VictronConstants.js')
 
     async init(){
         await super.init()
+        var md = this.addMetadatum('encryptionKey','', "Encryption Key")
+        md.isParam = true
+        this.metadata = new Map(super.getMetadata())
+        md = this.addMetadatum('encryptionKey','', "Encryption Key")
+        md.isParam = true
         this.model_id=this.getManufacturerData(0x2e1).readUInt16LE(2)
     }
     alarmReason(alarmValue){

package/sensor_classes/VictronACCharger.js

@@ -28,9 +28,8 @@ class VictronACCharger extends VictronSensor{
         return await this.identifyMode(device, 0x0A)
     }   
 
-    static {
-        this.metadata = new Map(super.getMetadata())
-
+    async init(){
+        await super.init()
         this.addMetadatum('state','', 'device state', 
             (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
         this.addMetadatum('error','', 'error code', 
@@ -48,8 +47,8 @@ class VictronACCharger extends VictronSensor{
         this.addMetadatum('curr2','A', 'battery 2 current',
             (buff)=>{return this.NaNif(buff.readUInt16BE(7)&0x7FF,0x7FF)/10})
 
-            this.addMetadatum('batt3','V', 'battery 3 voltage',
-                (buff)=>{return this.NaNif((buff.readUInt16BE(8)>>3), 0x1FFF)/100})
+        this.addMetadatum('batt3','V', 'battery 3 voltage',
+            (buff)=>{return this.NaNif((buff.readUInt16BE(8)>>3), 0x1FFF)/100})
 
         this.addMetadatum('curr3','A', 'battery 3 current',
             (buff)=>{return this.NaNif(buff.readUInt16BE(9)&0x7FF,0x7FF)/10})

package/sensor_classes/VictronBatteryMonitor.js

@@ -1,11 +1,18 @@
 const VictronSensor = require("./Victron/VictronSensor.js");
 const VC=require("./Victron/VictronConstants.js")
 class VictronBatteryMonitor extends VictronSensor{
-    static {
-        this.metadata = new Map(super.getMetadata())
+
+
+    static async identify(device){
+        return await this.identifyMode(device, 0x02)
+    }
+
+    characteristics=[]
+    async init(){
+        await super.init()
         this.addMetadatum('current', 'A', 'house battery amperage', 
-                (buff,offset=0)=>{return buff.readInt32LE(offset)/1000},
-                '6597ed8c-4bda-4c1e-af4b-551c4cf74769')
+            (buff,offset=0)=>{return buff.readInt32LE(offset)/1000},
+            '6597ed8c-4bda-4c1e-af4b-551c4cf74769')
         this.addMetadatum('power','W', 'house battery wattage',
                 (buff,offset=0)=>{return buff.readInt16LE(offset)},
                 '6597ed8e-4bda-4c1e-af4b-551c4cf74769')
@@ -27,15 +34,6 @@ class VictronBatteryMonitor extends VictronSensor{
         this.addMetadatum( 'ttg','s','time to go', 
                 (buff,offset=0)=>{return this.NaNif(buff.readUInt16LE(offset),0xFFFF)*60},
                 '65970ffe-4bda-4c1e-af4b-551c4cf74769')    
-    }
-
-    static async identify(device){
-        return await this.identifyMode(device, 0x02)
-    }
-
-    characteristics=[]
-    async init(){
-        await super.init()
         const modecurrent = this.getAuxModeAndCurrent()
         this.auxMode= modecurrent.auxMode
         switch(this.auxMode){
@@ -138,7 +136,7 @@ class VictronBatteryMonitor extends VictronSensor{
     propertiesChanged(props){
         super.propertiesChanged(props)
     }
-    canUseGATT(){
+    hasGATT(){
         return true
     }
     

package/sensor_classes/VictronDCDCConverter.js

@@ -7,8 +7,8 @@ class VictronDCDCConverter extends VictronSensor{
         return await this.identifyMode(device,0x04)
     }
    
-    static {
-        this.metadata= new Map(super.getMetadata())
+    async init(){
+        await super.init()
         this.addMetadatum('deviceState','', 'device state', 
                 (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
         this.addMetadatum('chargerError','', 'charger error',

package/sensor_classes/VictronDCEnergyMeter.js

@@ -8,6 +8,13 @@ class VictronDCEnergyMeter extends VictronSensor{
     }
     async init(){
         await super.init()
+        this.addMetadatum('meterType','', 'meter type', 
+            (buff)=>{return VC.MeterType.get( buff.readInt16LE(0))})
+        this.addMetadatum('voltage','','voltage',
+            (buff)=>{return buff.readInt16LE(2)/100})
+        this.addMetadatum('alarm','', 'alarm', 
+            (buff)=>{return buff.readUInt16LE(4)})
+        this.addMetadatum('current','A', 'current')    
         const modeCurrent =  this.getAuxModeAndCurrent()
         this.auxMode= modeCurrent.auxMode
         switch(this.auxMode){
@@ -30,16 +37,7 @@ class VictronDCEnergyMeter extends VictronSensor{
                 break
         }
     }
-    static { 
-        this.metadata = new Map(super.getMetadata())
-        this.addMetadatum('meterType','', 'meter type', 
-                (buff)=>{return VC.MeterType.get( buff.readInt16LE(0))})
-        this.addMetadatum('voltage','','voltage',
-                (buff)=>{return buff.readInt16LE(2)/100})
-        this.addMetadatum('alarm','', 'alarm', 
-                (buff)=>{return buff.readUInt16LE(4)})
-        this.addMetadatum('current','A', 'current')    
-    }
+    
     emitValuesFrom(decData){
         this.emitData("meterType",decData,0)
         this.emitData("voltage",decData,2);

package/sensor_classes/VictronGXDevice.js

@@ -26,8 +26,8 @@ TBD
         return await this.identifyMode(device, 0x07)
     }   
 
-    static {
-        this.metadata = new Map(super.getMetadata())
+    async init() {
+        super.init()
         this.addMetadatum('voltage','V', 'channel #1 voltage', 
             (buff)=>{return this.NaNif(buff.readInt16LE(0),0xFFFF)/100})
         this.addMetadatum('pvPower','W','DC input power in watts', 

package/sensor_classes/VictronInverter.js

@@ -7,12 +7,11 @@ class VictronInverter extends VictronSensor{
         return await this.identifyMode(device, 0x03)
     }
 
-    static {
-        var md
-        this.metadata= new Map(super.getMetadata())
+    async init() {
+        await super.init()
         this.addMetadatum('deviceState','', 'inverter device state', 
             (buff)=>{return VC.OperationMode.get(buff.readIntU8(0))})
-        md = this.addMetadatum('alarmReason','', 'reason for alarm',
+        const md = this.addMetadatum('alarmReason','', 'reason for alarm',
             (buff)=>{return buff.readIntU16LE(1)})
         md.notify=true
 

package/sensor_classes/VictronInverterRS.js

@@ -10,12 +10,12 @@ class VictronInverterRS extends VictronSensor{
     }
     
 
-    static {
-        var md
-        this.metadata= new Map(super.getMetadata())
+    async init() {
+        await super.init()
+        
         this.addMetadatum('deviceState','', 'inverter device state', 
                 (buff)=>{return VC.OperationMode.get(buff.readIntU8(0))})
-        md = this.addMetadatum('chargerError','', 'charger error',
+        const md = this.addMetadatum('chargerError','', 'charger error',
                 (buff)=>{return VC.ChargerError(buff.readIntU8(1))})
         md.notify=true
 

package/sensor_classes/VictronLynxSmartBMS.js

@@ -23,9 +23,8 @@ class VictronLynxSmartBMS extends VictronSensor{
         return await this.identifyMode(device, 0x0A)
     }   
 
-    static {
-        this.metadata = new Map(super.getMetadata())
-
+    async init() {
+        await super.init()
         this.addMetadatum('error','', 'error code', 
             (buff)=>{return buff.readUInt8(0)})
  

package/sensor_classes/VictronOrionXS.js

@@ -8,9 +8,8 @@ class VictronOrionXS extends VictronSensor{
     static async identify(device){
         return await this.identifyMode(device, 0x0F)
     }   
-    static {
-        this.metadata = new Map(super.getMetadata())
-
+    async init() {
+        await super.init()
         this.addMetadatum('deviceState','', 'device state', 
             (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
         this.addMetadatum('chargerError','', 'charger error',

package/sensor_classes/VictronSmartBatteryProtect.js

@@ -23,9 +23,8 @@ class VictronSmartBatteryProtect extends VictronSensor{
         return await this.identifyMode(device, 0x09)
     }   
 
-    static {
-        this.metadata = new Map(super.getMetadata())
-
+    async init() {
+        await super.init()
         this.addMetadatum('deviceState','', 'device state', 
                         (buff)=>{return VC.OperationMode.get(buff.readUInt8(1))})
         this.addMetadatum('outputStatus','', 'output status', //TODO

package/sensor_classes/VictronSmartLithium.js

@@ -25,16 +25,14 @@ class VictronSmartLithium extends VictronSensor{
         return await this.identifyMode(device, 0x05)
     }   
 
-    static {
-
+    async init() {
+        await super.init()
         function _toCellVoltage(val){    
             return val==0x7F?NaN:2.6+(val/100)
         }
-        this.metadata = new Map(super.getMetadata())
-
         this.addMetadatum('bmsFlags','', 'BMS Flags', 
                         (buff)=>{return buff.readUInt32BE(0)})
-/
+
         this.addMetadatum('smartLithiumErrors','', 'Smart Lithium Errors Flags',
             (buff)=>{return buff.readUInt16BE(3)})
         this.addMetadatum('cell1Voltage','V', 'cell #1 voltage', 
@@ -58,9 +56,7 @@ class VictronSmartLithium extends VictronSensor{
         this.addMetadatum('balancerStatus','', 'balancer status', //TODO
             (buff)=>{return this.NaNif((buff.readUInt16BE(14)&0xf),0xF)})
         this.addMetadatum('batteryTemp','K', 'battery temperature', 
-            (buff)=>{return this.NaNif((buff.readInt8(15)>>1),0x7F)+233.15})
-    
-                
+            (buff)=>{return this.NaNif((buff.readInt8(15)>>1),0x7F)+233.15})          
     }
 }
 module.exports=VictronSmartLithium

package/sensor_classes/VictronSolarCharger.js

@@ -6,8 +6,8 @@ class VictronSolarCharger extends VictronSensor{
         return await this.identifyMode(device, 0x01)
     }   
 
-    static {
-        this.metadata = new Map(super.getMetadata())
+    async init() {
+        await super.init()
 
         this.addMetadatum('chargeState','', 'charge state', 
             (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})

package/sensor_classes/VictronVEBus.js

@@ -9,8 +9,8 @@ class VictronVEBus extends VictronSensor{
         return await this.identifyMode(device, 0x0C)
     }   
 
-    static {
-        this.metadata = new Map(super.getMetadata())
+    async init() {
+        await super.init()
 
         this.addMetadatum('chargeState','', 'charge state', 
             (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})

package/sensor_classes/XiaomiMiBeacon.js

@@ -91,21 +91,7 @@ class XiaomiMiBeacon extends BTSensor{
         }
         return null
     }
-    static {
-        this.metadata = new Map(super.getMetadata())
-           //3985f4ebc032f276cc316f1f6ecea085
-        //8a1dadfa832fef54e9c1d190
 
-        const md = this.addMetadatum("encryptionKey", "", "encryptionKey (AKA bindKey) for decryption")
-        md.isParam=true
-        this.addMetadatum('temp','K', 'temperature',
-            (buff,offset)=>{return ((buff.readInt16LE(offset))/100) + 273.1})
-        this.addMetadatum('humidity','ratio', 'humidity',
-            (buff,offset)=>{return ((buff.readUInt8(offset))/100)})
-        this.addMetadatum('voltage', 'V',  'sensor battery voltage',
-            (buff,offset)=>{return ((buff.readUInt16LE(offset))/1000)})
-       
-    }
     GATTwarning = "WARNING: Xiaomi GATT connections are known to be unreliable on Debian distributions with Bluez 5.55 and up (earlier BlueZ versions are untested). Using GATT on the Xiaomi may put the system Bluetooth stack into an inconsistent state disrupting and disabling other plugin Bluetooth connections. If by some chance you're successful using GATT with the Xiaomi, let the plugin developer know your configuration. Refer to the plugin documentation for getting the Xiamoi bindKey for non-GATT connections and more information on Xiaomi GATT issues."
     
     emitValues(buffer){
@@ -168,7 +154,7 @@ class XiaomiMiBeacon extends BTSensor{
         return cipher.update(encryptedPayload)
     }
 
-    canUseGATT(){
+    hasGATT(){
         return true
     }
 
@@ -202,6 +188,15 @@ class XiaomiMiBeacon extends BTSensor{
     
     async init(){
         await super.init()
+        const md = this.addMetadatum("encryptionKey", "", "encryptionKey (AKA bindKey) for decryption")
+        md.isParam=true
+        this.addMetadatum('temp','K', 'temperature',
+            (buff,offset)=>{return ((buff.readInt16LE(offset))/100) + 273.1})
+        this.addMetadatum('humidity','ratio', 'humidity',
+            (buff,offset)=>{return ((buff.readUInt8(offset))/100)})
+        this.addMetadatum('voltage', 'V',  'sensor battery voltage',
+            (buff,offset)=>{return ((buff.readUInt16LE(offset))/1000)})
+
         const data = this.getServiceData(this.constructor.SERVICE_MIBEACON)
         const frameControl = data[0] + (data[1] << 8)
         this.deviceID = data[2] + (data[3] << 8)