bt-sensors-plugin-sk 1.1.1 → 1.2.0-beta.0.0.10

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.relativeHumidity')
+        .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/BlackListedDevice.js

@@ -15,6 +15,10 @@ class BLACKLISTED extends BTSensor {
         await super.init();
         this.currentProperties.Name = `Unsupported device from ${this.getManufacturer()}`;
     }
+
+    initListen(){
+        //do nothing
+    }
     reasonForBlacklisting() {
         switch (this.getManufacturerID()) {
             case 0x004c:

package/sensor_classes/DEVELOPMENT.md

@@ -1,4 +1,4 @@
-# BLUETOOTH SENSOR CLASS DEVELOPMENT (OUT OF DATE AS OF 1.1.0 release, NEW VERSION COMING IN 1.2.0)
+# BLUETOOTH SENSOR CLASS DEVELOPMENT (OUT OF DATE AS OF 1.1.0 Beta release NEW VERSION COMING SOON)
 
 The goal of this project is to support as many mariner-useful sensors as possible. If there's anything we can do to make sensor class development easier, please let us know.<br><br>
 
@@ -146,11 +146,6 @@ module.exports=ATC</pre>
 
 The big difference here is in the connect() method. All it does is wait on propertiesChanged and when that event occurs, the device object parses the buffer and emits the data. NOTE: Both classes have the same metadata, so the ATC class "borrows" the metadata from the LYWSD03MMC class.<br>
 
-## DEVICE MODULES
-
-To learn more about runtime loading of device modules, see (https://github.com/naugehyde/bt-sensors-plugin-sk/discussions/26) 
-
-
 ## LET US KNOW
 
 When you're done working on your class and satisified that it's functioning properly, commit and request a merge (more git talk).<br>

package/sensor_classes/GoveeH50xx.js

@@ -17,18 +17,18 @@ 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.addDefaultParam("zone")
+
+        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,14 +34,13 @@ class GoveeH510x extends BTSensor{
         
     }
 
-    async init(){
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata(){
-        this.addMetadatum('temp','K', 'temperature')
-        this.addMetadatum('battery','ratio', 'battery strength')
-        this.addMetadatum('humidity','ratio', 'humidity')
+    initSchema(){
+        super.initSchema()
+        this.addDefaultParam("zone")
+
+        this.addDefaultPath("temp","environment.temperature")
+        this.addDefaultPath("humidity", "environment.humidity")
+        this.addDefaultPath("battery","sensors.batteryStrength")        
     }
 
     emitValuesFrom(buffer){

package/sensor_classes/IBeacon.js

@@ -20,21 +20,17 @@ 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){
         super.propertiesChanged(props);
         const buff = this.getServiceData("0000356e-0000-1000-8000-00805f9b34fb");
-        if (!buff)
-            throw new Error("Unable to get service data for " + this.getDisplayName());
-        this.emitData("battery", buff);
+        if (buff) 
+            this.emitData("battery", buff);
     }
 
     getManufacturer(){

package/sensor_classes/Inkbird.js

@@ -13,12 +13,14 @@ class Inkbird extends BTSensor{
         
     }
 
-    async init(){
-        await super.init()
-        this.addMetadatum('temp','K', 'temperature')
-        this.addMetadatum('battery','ratio', 'battery strength')
+    initSchema() {
+        super.initSchema()
+        this.addDefaultParam("zone")
+
+        this.addDefaultPath('temp','environment.temperature')
+        this.addDefaultPath('battery', 'sensors.batteryStrength')
         if (this.getName() == 'sps'){
-            this.addMetadatum('humidity','ratio', 'humidity')
+            this.addDefaultPath('humidity','environment.humidity')
         }
     }
 
@@ -37,7 +39,7 @@ class Inkbird extends BTSensor{
                 throw new Error("Unable to get manufacturer data for "+this.getDisplayName())
             this.emit("temp", parseFloat((273.15+(key_i & 0x8000 ? key_i - 0x10000 : key_i)/100).toFixed(2))) ;
             this.emit('battery', data[5]/100)
-            if (this.getMetadata().has('humidity')){
+            if (this.getPath('humidity')) {
                 this.emit("humidity", data.readUInt16LE(0)/100);
             }
         }

package/sensor_classes/JBDBMS.js

@@ -28,28 +28,37 @@ 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.device.connect()
+      await this.deviceConnect()
       await this.initCharacteristics()
       const cellsAndTemps = await this.getNumberOfCellsAndTemps()
       this.numberOfCells=cellsAndTemps.cells
@@ -65,23 +74,22 @@ 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
   }
-  initCharacteristics(){ 
-    return new Promise((resolve,reject )=>{ this.device.connect().then(async ()=>{ 
+  async initCharacteristics(){ 
       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) }) }) 
+      return this
   }
 
   async initGATTNotifications(){
@@ -92,7 +100,7 @@ class JBDBMS extends BTSensor {
 
   emitGATT(){
     this.getAndEmitBatteryInfo()
-    setTimeout(()=>{this.getAndEmitCellVoltages()}, 5000)
+    setTimeout(()=>{this.getAndEmitCellVoltages()}, 10000)
   }
 
   async getNumberOfCellsAndTemps(){

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.
@@ -175,7 +192,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/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

@@ -257,7 +257,6 @@ class MopekaTankSensor extends BTSensor{
         await super.init()
         const md = this.valueIfVariant(this.getManufacturerData(this.constructor.manufacturerID))
         this.modelID = md[0]
-        this.initMetadata()
     } 
 
     getMedium(){
@@ -272,41 +271,58 @@ class MopekaTankSensor extends BTSensor{
         return rawLevel * (coefs[0] + (coefs[1] * (this.temp-233.15)) + (coefs[2] * ((this.temp-233.15)^2)))
     }
     
-    initMetadata(){
-        var md = this.addMetadatum("medium","","type of liquid in tank")
-        md.isParam=true
-        md.enum=Object.keys(Media)
+    initSchema(){
+        super.initSchema()
+        this.addParameter("medium",
+            {
+                title:"type of liquid in tank",
+                enum: Object.keys(Media)
+            }
+        )
+        this.addParameter("tankHeight",
+            {
+                title:"height of tank (in mm)",
+                type:"number",
+                unit:"mm"
+            }
+        )
+        this.addDefaultParam("id")
 
-        md = this.addMetadatum("tankHeight","mm","height of tank (in mm)")
-        md.isParam=true
-        
-        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){

package/sensor_classes/Renogy/RenogySensor.js

@@ -42,13 +42,22 @@ class RenogySensor extends BTSensor{
 
     async init(){
         await super.init()
-        var md = this.addMetadatum('refreshInterval','','refresh interval')
-        md.isParam = true
-
-        md = this.addMetadatum('deviceID', '', 'ID of device')
-        md.isParam = true
+        this.addParameter(
+            "refreshInterval",
+            {
+                title: 'refresh interval',
+                type: 'number'
+            }
+        )
+        this.addParameter(
+            "deviceID",
+            {
+                title: 'ID of device'
+            }
+        )
+      
 
-        await this.device.connect()
+        await this.deviceConnect()
         const rw = await this.constructor.getReadWriteCharacteristics(this.device)
 
         this.readChar = rw.read    

package/sensor_classes/RenogyBattery.js

@@ -22,25 +22,27 @@ class RenogyBattery extends RenogySensor {
     initMetadata(){
 
         this.addMetadatum('numberOfCells','', 'number of cells')
-        this.addMetadatum('current','A','current',
-             (buffer)=>{return buffer.readInt16BE(3)/100})
+        this.addDefaultPath('current','electrical.batteries.current')
+            .read=(buffer)=>{return buffer.readInt16BE(3)/100}
              
-        this.addMetadatum('voltage','V','voltage',
-            (buffer)=>{return buffer.readUInt16BE(5)/10})
+        this.addDefaultPath('voltage','electrical.batteries.voltage')
+            .read=(buffer)=>{return buffer.readUInt16BE(5)/10}
         
-        this.addMetadatum('remainingCharge', 'Ah', 'remaining charge',  //TODO: units 
-            (buffer)=>{return buffer.readUInt32BE(7)/1000})
-
-        this.addMetadatum('capacity','Ah', 'capacity',
-            (buffer)=>{return buffer.readUInt32BE(11)/1000})
+        this.addDefaultPath('remainingCharge', 'electrical.batteries.capacity.remaining') 
+            .read=(buffer)=>{return buffer.readUInt32BE(7)/1000}
+        
+        this.addDefaultPath('capacity', 'electrical.batteries.capacity.actual') 
+            .read=(buffer)=>{return buffer.readUInt32BE(11)/1000}
 
         for (let i = 0; i++ ; i < this.numberOfCells) {
             this.addMetadatum(`cellVoltage${i}`, 'V', `cell #${i} voltage`,
-                (buffer)=>{ return buffer.readUInt16(5+ i*2) }
-            )
+                (buffer)=>{ return buffer.readUInt16(5+ i*2) })
+            .default=`electrical.batteries.{batteryID}.cell${i}.voltage`
+
             this.addMetadatum(`cellTemp${i}`, 'K', `cell #${i} temperature`,
-                (buffer)=>{ return buffer.readUInt16(5+ i*2)+273.15 }
-            )
+                (buffer)=>{ return buffer.readUInt16(5+ i*2)+273.15 })
+                .default=`electrical.batteries.{batteryID}.cell${i}.temperature`
+
         }
     }
     async initGATTConnection() {

package/sensor_classes/RenogyRoverClient.js

@@ -10,13 +10,12 @@ class RenogyRoverClient extends RenogySensor {
 
     async init(){
         await super.init()
-        this.initMetadata()
         this.modelID=await this.retrieveModelID()
     }
 
-    initMetadata(){
+    initSchema(){
         //Buffer(73) [1, 3, 68, 32, 32, 82, 78, 71, 45, 67, 84, 82, 76, 45, 87, 78, 68, 51, 48, 7, 140, 0, 132, 0, 126, 0, 120, 0, 111, 0, 106, 100, 50, 0, 5, 0, 120, 0, 120, 0, 28, 0, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 15, 0, 5, 0, 5, 2, 148, 0, 5, 206, 143, 34, 228, buffer: ArrayBuffer(8192), byteLength: 73, byteOffset: 6144, length: 73, Symbol(Symbol.toStringTag): 'Uint8Array']
-
+        super.initSchema()
         this.addMetadatum('batteryType', '', "battery type")
         this.addMetadatum('batteryPercentage', 'ratio', "battery percentage",
              (buffer)=>{return buffer.readUInt16BE(3) })