bt-sensors-plugin-sk 1.2.0-beta.0.0.4 → 1.2.0-beta.0.0.6

package/BTSensor.js

@@ -101,6 +101,7 @@ function preparePath(obj, str) {
 
 class BTSensor extends EventEmitter {
     //static metadata=new Map()
+ 
     static DEFAULTS = require('./plugin_defaults.json');
     
     /**
@@ -314,11 +315,6 @@ class BTSensor extends EventEmitter {
 			}
 		}
 
-    }
-    async init(){
-        this.currentProperties = await this.constructor.getDeviceProps(this.device)
-        this.initSchema()
-
 
         //create the 'name' parameter
         this.addDefaultParam("name")
@@ -331,6 +327,12 @@ class BTSensor extends EventEmitter {
         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()
     }
 

package/index.js

@@ -20,6 +20,10 @@ class MissingSensor  {
 		this.config=config
 		this.addPath=BTSensor.prototype.addPath.bind(this)
 		this.addParameter=BTSensor.prototype.addParameter.bind(this)
+		this.addDefaultPath=BTSensor.prototype.addDefaultPath.bind(this)
+		this.addDefaultParam=BTSensor.prototype.addDefaultPath.bind(this)
+		this.addDefaultParam=BTSensor.prototype.addDefaultPath.bind(this)
+		this.getPath=BTSensor.prototype.getPath.bind(this)
 
 		this.getJSONSchema = BTSensor.prototype.getJSONSchema.bind(this)
 		this.initSchema = BTSensor.prototype.initSchema.bind(this)
@@ -50,6 +54,7 @@ class MissingSensor  {
 	initGATTConnection(){
 		
 	}
+
 	getGATTDescription(){
 		return ""
 	}
@@ -342,15 +347,13 @@ 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){	

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.2.0-beta.0.0.4",
+  "version": "1.2.0-beta.0.0.6",
   "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": {

package/plugin_defaults.json

@@ -6,29 +6,117 @@
         "location":{
             "description": "Sensor location",
             "examples": ["inside", "outside", "galley", "freezer", "refrigerator", "head", "cabin", "engine", "deck", "cockpit"]
+        },
+        "zone":{
+            "description": "Zone where sensor operates on boat AKA location ",
+            "examples": ["inside", "outside", "galley", "freezer", "refrigerator", "head", "cabin", "engine", "deck", "cockpit"]
+        },
+        "batteryID":{
+            "description": "Battery ID",
+            "examples": ["starter", "house"]
+        },
+        "id":{
+            "description": "Sensor ID"
         }
     },
     "environment":{
-        "temperature":
+        "temperature": 
             {
                 "unit":"K",
-                "default": "environment.{location}.temperature"
+                "default": "environment.{zone}.temperature"
             },
         "humidity":
             {
                 "unit":"ratio",
-                "default":"environment.{location}.humidity"
+                "default":"environment.{zone}.humidity"
+            },
+        "relativeHumidity":
+            {
+                "title":"Current relative humidity",
+                "unit":"ratio",
+                "default":"environment.{zone}.humidity"
+            },
+        "pressure":
+            {
+                "title": "Current outside air ambient pressure",
+                "unit":"Pa",
+                "default":"environment.{zone}.humidity"
             }
     },
     "electrical":{
-        "current":{
-            "unit": "A",
-            "default":"electrical.batteries.0.current"
+        "inverters":{
+            "ac":{
+                "current":{
+                    "unit": "A",
+                    "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":{
+                    "unit": "A",
+                    "default":"electrical.inverters.{id}.dc.current"
+                },
+                "voltage":
+                { 
+                    "unit": "V",
+                    "default":"electrical.inverters.{id}.dc.voltage"
+                }
+
+            }
         },
-        "voltage":
-        { 
-            "unit": "V",
-            "default": "electrical.batteries.0.voltage"
+        "batteries":{
+
+            "current":{
+                "unit": "A",
+                "default":"electrical.batteries.{batteryID}.current"
+            },
+            "voltage":
+            { 
+                "unit": "V",
+                "default": "electrical.batteries.{batteryID}.voltage"
+            },
+            
+            "temperature":{
+                "unit": "K",
+                "default": "electrical.batteries.{batteryID}.temperature"
+            },
+            "cycles":{
+                "unit": "",
+                "default": "electrical.batteries.{batteryID}.cycles"
+            },
+
+            "capacity":{
+                "remaining":{
+                    "unit":"Ah",
+                    "default": "electrical.batteries.{batteryID}.capacity.remaining"
+                },
+                "actual":{
+                    "unit":"Ah",
+                    "default": "electrical.batteries.{batteryID}.capacity.actual"
+                },
+                "stateOfCharge":{
+                    "unit":"ratio",
+                    "default": "electrical.batteries.{batteryID}.capacity.stateOfCharge" 
+                },
+                "timeRemaining":{
+                    "unit":"s",
+                    "default": "electrical.batteries.{batteryID}.capacity.timeRemaining" 
+     
+                }
+            }
+            
         }
     },
     "sensors":{

package/sensor_classes/ATC.js

@@ -30,10 +30,9 @@ class ATC extends BTSensor{
         if (!this.parser){
             this.parser="ATC-LE"
         }
-        this.initMetadata()
     }
-    initMetadata(){
-
+    initSchema(){
+        super.initSchema()
         this.addDefaultPath('batteryStrength','sensors.batteryStrength')
         .read=(buff)=>{return ((buff.readUInt8(12))/100)}
 

package/sensor_classes/Aranet/AranetSensor.js

@@ -19,6 +19,10 @@ class AranetSensor extends BTSensor{
         
         return null
     }
+    initSchema(){
+        super.initSchema()
+        this.addDefaultParam("zone")
+    }
   
 }
 module.exports=AranetSensor

package/sensor_classes/Aranet2.js

@@ -13,25 +13,26 @@ class Aranet2 extends AranetSensor{
             return null //not supported for now
         }
     }
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
 
-    initMetadata(){
-            this.addMetadatum('c02', '',  'c02 concentration',
+    initSchema(){
+            super.initSchema()
+            
+            this.addMetadatum('co2', 'ppm',  'co2 concentration in zone',
                 (buff)=>{return ((buff.readUInt16LE(8)))})
-            this.addMetadatum('temp','K', 'temperature',
-                (buff)=>{return parseFloat((273.15+(buff.readInt16LBE(15))/1000).toFixed(2))})
+                .default="environment.{zone}.co2"
+            
+            this.addDefaultPath('temp', 'environment.temperature')
+            .read=(buff)=>{return parseFloat((273.15+(buff.readInt16LBE(15))/1000).toFixed(2))}
 
-            this.addMetadatum("pressure","","atmospheric pressure", 
-                (buff)=>{return ((buff.readUInt16LE(13)))/10})
-            this.addMetadatum('batteryStrength', 'ratio',  'sensor battery strength',
-                (buff)=>{return ((buff.readUInt8(12))/100)})
+            this.addDefaultPath('pressure', 'environment.pressure')
+            .read=  (buff)=>{return ((buff.readUInt16LE(13)))/10}
+            
+            this.addDefaultPath('relativeHumidity','environment.relativeHumidity')
+            .read=(buff)=>{return ((buff.readUInt16LE(8))/10000)}
+                
+            this.addDefaultPath("battery","sensors.batteryStrength")   
+                .read=(buff)=>{return ((buff.readUInt8(12))/100)}
 
-            this.addMetadatum('humidity','ratio', 'humidity',
-                (buff)=>{return ((buff.readUInt16LE(8))/10000)})
-        
     }
     propertiesChanged(props){
         super.propertiesChanged(props)

package/sensor_classes/Aranet4.js

@@ -15,27 +15,33 @@ class Aranet4 extends AranetSensor{
         return null
     }
     
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
 
-    initMetadata(){
-            this.addMetadatum('co2', 'ppm',  'co2 concentration',
-                (buff)=>{return ((buff.readUInt16LE(8)))})
-            this.addMetadatum('temp','K', 'temperature',
-                (buff)=>{return parseFloat((273.15+(buff.readInt16LE(10))/20).toFixed(2))})
+    initSchema(){
 
-            this.addMetadatum("pressure","hPa","atmospheric pressure", 
-                (buff)=>{return ((buff.readUInt16LE(12)))/10})
 
-            this.addMetadatum('humidity','ratio', 'humidity',
-                (buff)=>{return ((buff.readUInt8(14))/100)})
-            this.addMetadatum('batteryStrength', 'ratio',  'sensor battery strength',
-                (buff)=>{return ((buff.readUInt8(15))/100)})
-            this.addMetadatum('color', '',  'Warning color (G Y R)',
-                (buff)=>{return this.COLOR[buff.readUInt8(16)]})
+        super.initSchema()
+        this.addMetadatum('co2', 'ppm',  'co2 concentration in zone',
+            (buff)=>{return ((buff.readUInt16LE(8)))})
+            .default="environment.{zone}.co2"
+            
+        this.addDefaultPath('temp','environment.temperature')
+        .read=
+            (buff)=>{return parseFloat((273.15+(buff.readInt16LE(10))/20).toFixed(2))}     
             
+        this.addDefaultPath("pressure","environment.pressure") 
+        .read=(buff)=>{return ((buff.readUInt16LE(12)))/10}
+      
+        this.addDefaultPath('relativeHumidity','environment.relative')
+        .read=(buff)=>{return ((buff.readUInt8(14))/100)}
+        
+        this.addMetadatum('color', '',  'Warning color (G Y R)',
+            (buff)=>{return this.COLOR[buff.readUInt8(16)]})
+            .default="environment.{zone}.warningColor"
+        
+        this.addDefaultPath("battery","sensors.batteryStrength")   
+            .read=(buff)=>{return ((buff.readUInt8(15))/100)}
+
+                    
     }
     propertiesChanged(props){
         super.propertiesChanged(props)    

package/sensor_classes/GoveeH50xx.js

@@ -17,18 +17,16 @@ class GoveeH50xx extends  BTSensor {
         t
     }
 
-    async init(){
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata(){
-        this.addMetadatum('temp','K', 'temperature', 
-            (buffer)=>{return 273.15+(buffer.readUInt16LE(1)/100) 
-        })
-        this.addMetadatum('humidity','ratio', 'humidity', 
-            (buffer)=>{return buffer.readUInt16LE(3)/10000    
-        })
-        this.addMetadatum('battery','ratio', 'battery strength', (buffer)=>{return buffer.readUInt8(5)/100})
+    initSchema(){
+        super.initSchema()
+        this.addDefaultPath("temp","environment.temperature")
+            .read= (buffer)=>{return 273.15+(buffer.readUInt16LE(1)/100) }
+        
+        this.addDefaultPath("humidity", "environment.humidity")
+            .read = (buffer)=>{return buffer.readUInt16LE(3)/10000}   
+
+        this.addDefaultPath("battery","sensors.batteryStrength")   
+            .read = (buffer)=>{return buffer.readUInt8(5)/100}
     }
 
     getManufacturer(){

package/sensor_classes/GoveeH510x.js

@@ -34,11 +34,8 @@ class GoveeH510x extends BTSensor{
         
     }
 
-    async init(){
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata(){
+    initSchema(){
+        super.initSchema()
         this.addDefaultPath("temp","environment.temperature")
         this.addDefaultPath("humidity", "environment.humidity")
         this.addDefaultPath("battery","sensors.batteryStrength")        

package/sensor_classes/IBeacon.js

@@ -13,13 +13,10 @@ class IBeacon extends BTSensor {
     return null
     }
 
-    async init() {
-        await super.init();
-        this.initMetadata();
-    }
-
-    initMetadata(){
-        this.addMetadatum('battery','ratio', 'Battery charge state', (buffer)=>{return buffer[6]})
+    initSchema(){
+        super.initSchema()
+        this.addDefaultPath("battery","sensors.batteryStrength")   
+        .read=(buffer)=>{return buffer[6]}
     }
 
     propertiesChanged(props){

package/sensor_classes/Inkbird.js

@@ -13,8 +13,8 @@ class Inkbird extends BTSensor{
         
     }
 
-    async init(){
-        await super.init()
+    initSchema() {
+        super.initSchema()
         this.addDefaultPath('temp','environment.temperature')
         this.addDefaultPath('battery', 'sensors.batteryStrength')
         if (this.getName() == 'sps'){

package/sensor_classes/JBDBMS.js

@@ -28,26 +28,35 @@ class JBDBMS extends BTSensor {
     return await this.txChar.writeValueWithResponse(Buffer.from(this.jbdCommand(command)))
 
 }
-  async init(){
-      await super.init()
-      this.addMetadatum('voltage', 'V', 'Total battery voltage', 
-        (buffer)=>{return buffer.readUInt16BE(4) / 100})
-      this.addMetadatum('current',  'A',  'Current flow',
-        (buffer)=>{return buffer.readInt16BE(6) / 100} )
-      this.addMetadatum('remainingCapacity', 'Ah',  'Remaining battery capacity', 
-        (buffer)=>{return buffer.readUInt16BE(8) / 100} )
-      this.addMetadatum('capacity', 'Ah',  'Battery capacity', 
-        (buffer)=>{return buffer.readUInt16BE(10) / 100} )
-      this.addMetadatum('cycles', '', 'cycles',
-        (buffer)=>{return buffer.readUInt16BE(12)} )
+  async initSchema(){
+      super.initSchema()
+      this.addDefaultParam("batteryID")
+     
+      this.addDefaultPath('voltage','electrical.batteries.voltage')
+        .read=(buffer)=>{return buffer.readUInt16BE(4) / 100}
+
+      this.addDefaultPath('voltage','electrical.batteries.current')
+        .read=(buffer)=>{return buffer.readInt16BE(6) / 100} 
+      
+      this.addDefaultPath('remainingCapacity','electrical.batteries.capacity.remaining')
+        .read=(buffer)=>{return buffer.readUInt16BE(8) / 100} 
+      
+      this.addDefaultPath('capacity','electrical.batteries.capacity.actual')
+        .read=(buffer)=>{return buffer.readUInt16BE(10) / 100} 
+     
+      this.addDefaultPath('cycles','electrical.batteries.cycles' )
+        .read=(buffer)=>{return buffer.readUInt16BE(12)} 
+
       this.addMetadatum('protectionStatus', '', 'Protection Status',
-          (buffer)=>{return buffer.readUInt16BE(20)} )
-        
-      this.addMetadatum('SOC', 'ratio', 'State of Charge',
-        (buffer)=>{return buffer.readUInt8(23)/100} )
+        (buffer)=>{return buffer.readUInt16BE(20)} )
+        .default="electrical.batteries.{batteryID}.protectionStatus"
+         
+      this.addDefaultPath('SOC','electrical.batteries.capacity.stateOfCharge')
+        .read=(buffer)=>{return buffer.readUInt8(23)/100} 
       
       this.addMetadatum('FET', '', 'FET Control',
           (buffer)=>{return buffer.readUInt8(24)} )
+          .default="electrical.batteries.{batteryID}.FETControl"
   
       await this.deviceConnect()
       await this.initCharacteristics()
@@ -65,11 +74,12 @@ class JBDBMS extends BTSensor {
       for (let i=0; i<this.numberOfCells; i++){
         this.addMetadatum(`cell${i}Voltage`, 'V', `Cell ${i+1} voltage`,
           (buffer)=>{return buffer.readUInt16BE((4+(i*2)))/1000} )
+          .default=`electrical.batteries.{batteryID}.cell${i}.voltage`
         this.addMetadatum(`cell${i}Balance`, 'V', `Cell ${i+1} balance` )
+          .default=`electrical.batteries.{batteryID}.cell${i}.balance`
+        
       }
-
-
-    }
+  }
   hasGATT(){
     return true
   }

package/sensor_classes/KilovaultHLXPlus.js

@@ -60,35 +60,52 @@ class KilovaultHLXPlus extends BTSensor{
         // Nothing to do here.  HLX+ only reports via BLE notify, not BLE read
     }
 
-    async init(){
-        await super.init()
-
-        this.addMetadatum("voltage","V","Battery Voltage",
-            (buffer)=>{return Number(buffer.readInt16LE(0)) / 1000})
-        this.addMetadatum("current","A","Battery Current",
-            (buffer)=>{return buffer.readInt32LE(4) / 1000})
-        this.addMetadatum("energy","AHr","Battery Capacity",
-            (buffer)=>{return buffer.readInt32LE(8) / 1000})
-        this.addMetadatum("cycles","","Number of Charge Cycles",
-            (buffer)=>{return buffer.readInt16LE(12)})
-        this.addMetadatum("soc","ratio","Battery State of Charge",
-            (buffer)=>{return buffer.readInt16LE(14)})
-        this.addMetadatum("temperature","K","Battery Temperature",
-            (buffer)=>{return buffer.readInt16LE(16)/10 })
+    async initSchema(){
+        super.initSchema()
+        this.addDefaultParam("batteryID")
+
+        this.addDefaultPath("voltage","electrical.batteries.voltage")
+            .read=(buffer)=>{return Number(buffer.readInt16LE(0)) / 1000}
+       
+        this.addDefaultPath("current","electrical.batteries.current")
+            .read=(buffer)=>{return buffer.readInt32LE(4) / 1000}
+        
+        this.addDefaultPath("energy", "electrical.batteries.capacity.remaining")
+            .read=(buffer)=>{return buffer.readInt32LE(8) / 1000}
+        
+        this.addDefaultPath("cycles",'electrical.batteries.cycles')
+            .read=(buffer)=>{return buffer.readInt16LE(12)}
+
+        this.addDefaultPath("soc",'electrical.batteries.capacity,stateOfCharge')
+            .read=(buffer)=>{return buffer.readInt16LE(14)}
+        
+        this.addDefaultPath("temperature",'electrical.batteries.temperature')
+            .read=(buffer)=>{return buffer.readInt16LE(16)/10 }
 
         this.addMetadatum("status","","Battery Status",
             (buffer)=>{return buffer.readInt16LE(18) })
+            .default="electrical.batteries.{batteryID}.status"
+
         this.addMetadatum("AFEStatus","","Battery AFE Status",
             (buffer)=>{return buffer.readInt16LE(20) })
+            .default="electrical.batteries.{batteryID}.AFEStatus"
 
         this.addMetadatum("cell1_voltage","V","Cell 1 Voltage",
             (buffer)=>{return buffer.readInt16LE(22) / 1000})
+            .default="electrical.batteries.{batteryID}.cell1.voltage"
+
         this.addMetadatum("cell2_voltage","V","Cell 2 Voltage",
             (buffer)=>{return buffer.readInt16LE(24) / 1000})
+            .default="electrical.batteries.{batteryID}.cell2.voltage"
+
         this.addMetadatum("cell3_voltage","V","Cell 3 Voltage",
             (buffer)=>{return buffer.readInt16LE(26) / 1000})
+            .default="electrical.batteries.{batteryID}.cell3.voltage"
+
         this.addMetadatum("cell4_voltage","V","Cell 4 Voltage",
             (buffer)=>{return buffer.readInt16LE(28) / 1000})
+            .default="electrical.batteries.{batteryID}.cell4.voltage"
+
     }
 
     // Concatentate chunks received by notification into a complete message.

package/sensor_classes/LancolVoltageMeter.js

@@ -14,9 +14,10 @@ class LancolVoltageMeter extends BTSensor{
         
     }
 
-    async init(){
-        await super.init()
-        this.addMetadatum('voltage','V', 'battery voltage')
+    initSchema(){
+        super.initSchema()
+        this.addDefaultParam("batteryID")
+        this.addDefaultPath('voltage',"electrical.batteries.voltage")
     }
 
     getManufacturer(){

package/sensor_classes/MopekaTankSensor.js

@@ -276,7 +276,7 @@ class MopekaTankSensor extends BTSensor{
         this.addParameter("medium",
             {
                 title:"type of liquid in tank",
-                enum: Object.keys(Media)   
+                enum: Object.keys(Media)
             }
         )
         this.addParameter("tankHeight",
@@ -286,34 +286,43 @@ class MopekaTankSensor extends BTSensor{
                 unit:"mm"
             }
         )
+        this.addDefaultParam("id")
 
-        this.addMetadatum("battVolt","V","sensor battery in volts", 
-            ((buffer)=>{ 
+        this.addDefaultPath("battVolt","sensors.batteryVoltage") 
+            .read=((buffer)=>{ 
                 this.battVolt = (buffer.readUInt8(1)/32) 
                 return this.battVolt
             }).bind(this)
-        )
-        this.addMetadatum("battStrength","ratio","sensor battery strength", 
-            (buffer)=>{ return Math.max(0, Math.min(1, (((this.battVolt) - 2.2) / 0.65))) }
-        )
+        
+        this.addDefaultPath("battStrength", "sensors.batteryStrength") 
+            .read=(buffer)=>{ return Math.max(0, Math.min(1, (((this.battVolt) - 2.2) / 0.65))) }
+        
         this.addMetadatum("temp","K","temperature", 
             ((buffer)=>{ 
                 this.temp = parseFloat(((buffer.readUInt8(2)&0x7F)+233.15).toFixed(2))
                 return this.temp
-            }).bind(this)
+            })
         )
+        .default="tanks.{id}.temperature"
         this.addMetadatum("tankLevel","ratio","tank level", 
             (buffer)=>{ return (this._tankLevel(((buffer.readUInt16LE(3))&0x3FFF)))/this.getTankHeight()}
         )
+        .default="tanks.{id}.currentLevel"
+
         this.addMetadatum("readingQuality","","quality of read", 
             (buffer)=>{ return buffer.readUInt8(4)>>6}
         )
+        .default="sensors.{macAndName}.readingQuality"
+
         this.addMetadatum("accX","Mg","acceleration on X-axis", 
             (buffer)=>{ return buffer.readUInt8(8)}
         )
+        .default="sensors.{macAndName}.accelerationXAxis"
+
         this.addMetadatum("accY","Mg","acceleration on Y-axis", 
             (buffer)=>{ return buffer.readUInt8(9)}
         )        
+        .default="sensors.{macAndName}.accelerationYAxis"
     }
 
     propertiesChanged(props){
@@ -326,8 +335,8 @@ class MopekaTankSensor extends BTSensor{
         if (this.name)
             return this.name
 
-        const _name = MopekaDevices.get(this?.modelID??0x0).name
-        return _name?_name:MopekaDevices.get(0x0).name
+        const _name = MopekaDevice.get(this?.modelID??0x0).name
+        return _name?_name:MopekaDevice.get(0x0).name
         
     }
 }