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

package/sensor_classes/VictronGXDevice.js

@@ -26,11 +26,8 @@ TBD
         return await this.identifyMode(device, 0x07)
     }   
 
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata(){
+    initSchema(){
+        super.initSchema()
         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,23 +7,27 @@ class VictronInverter extends VictronSensor{
         return await this.identifyMode(device, 0x03)
     }
 
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata(){
+    initSchema(){
+        super.initSchema()
+        this.addDefaultParam("id")
+
         this.addMetadatum('deviceState','', 'inverter device state', 
             (buff)=>{return VC.OperationMode.get(buff.readIntU8(0))})
+            .default="electrical.inverters.{id}.state"
+
         const md = this.addMetadatum('alarmReason','', 'reason for alarm',
             (buff)=>{return buff.readIntU16LE(1)})
-        md.notify=true
-
-        this.addMetadatum('batteryVoltage','V', 'battery voltage', 
-            (buff)=>{return this.NaNif(buff.readInt16LE(3),0x7FFF)/100})
-        this.addMetadatum('acPower','W', 'AC power (in watts: Apparent Power * Power Factor)', 
-            (buff)=>{return this.NaNif( buff.readUInt16LE(5), 0xFFFF )*this.powerFactor})
-        this.addMetadatum('acVoltage','V','AC Voltage')
-        this.addMetadatum('acCurrent','A', 'AC Current')
+        .default="electrical.inverters.{id}.alarm"
+
+        this.addDefaultPath('dcVoltage','electrical.inverters.dc.voltage') 
+            .read=(buff)=>{return this.NaNif(buff.readInt16LE(3),0x7FFF)/100}
+
+        this.addDefaultPath('acPower','electrical.inverters.ac.power') 
+            .read=(buff)=>{return this.NaNif( buff.readUInt16LE(5), 0xFFFF )*this.powerFactor}
+        
+        this.addDefaultPath('acVoltage','electrical.inverters.ac.voltage') 
+
+        this.addDefaultPath('acCurrent','electrical.inverters.ac.current') 
                 
     }
     powerFactor = .8 //parameterize anon
@@ -33,9 +37,9 @@ class VictronInverter extends VictronSensor{
         const br = new BitReader(decData.subarray(5))
         this.emit('acVoltage',
             this.NaNif(br.read_unsigned_int(15),0x7FFF)/100)
-        this.addMetadatum('acCurrent',
+        this.emit('acCurrent',
             this.NaNif(br.read_unsigned_int(11),0x7FF)/10)
-        const alarm = this.getMetadatum("alarmReason").read(decData)
+        const alarm = this.getPath("alarmReason").read(decData)
         if (alarm>0){
             this.emit(
                 `ALARM #${alarm} from ${this.getDisplayName()})`, 

package/sensor_classes/VictronInverterRS.js

@@ -10,28 +10,39 @@ class VictronInverterRS extends VictronSensor{
     }
     
 
-    async init() {
-        await super.init()
-        
+     initSchema() {
+        super.initSchema()
+        this.addDefaultParam("id")
         this.addMetadatum('deviceState','', 'inverter device state', 
-                (buff)=>{return VC.OperationMode.get(buff.readIntU8(0))})
+            (buff)=>{return VC.OperationMode.get(buff.readIntU8(0))})
+            .default='electrical.inverters.{id}.state'    
+
         const md = this.addMetadatum('chargerError','', 'charger error',
-                (buff)=>{return VC.ChargerError(buff.readIntU8(1))})
-        md.notify=true
+            (buff)=>{return VC.ChargerError(buff.readIntU8(1))})
+            md.default='electrical.inverters.{id}.error'
+            md.notify=true
 
         this.addMetadatum('batteryVoltage','V', 'battery voltage', 
             (buff)=>{return this.NaNif(buff.readInt16LE(2),0x7FFF)/100})
+            .default='electrical.inverters.{id}.battery.voltage'
+        .
         this.addMetadatum('pvPower','W', 'PV power', 
             (buff)=>{return this.NaNif(buff.readUInt16LE(4), 0xffff)})
+            .default='electrical.inverters.{id}.power'
+        
         this.addMetadatum('yieldToday','W', 'yield yoday in watts', 
             (buff)=>{return this.NaNif(buff.readUInt16LE(6), 0xffff)*10})
+            .default='electrical.inverters.{id}.yieldToday'
+ 
         this.addMetadatum('acOutPower','W', 'AC out power in watts', 
-            (buff)=>{this.NaNif(buff.readInt16LE(8), 0x7fff)})                
+            (buff)=>{this.NaNif(buff.readInt16LE(8), 0x7fff)}) 
+            .default='electrical.inverters.{id}.ac.power'
+              
     }
 
     emitValuesFrom(decData){
         super.emitValuesFrom(decData)
-        const error = this.getMetadatum("chargerError").read(decData)
+        const error = this.getPath("chargerError").read(decData)
         if (error>0){
             this.emit(
                 `Charger Error #${error} from ${this.getDisplayName()})`, 

package/sensor_classes/VictronLynxSmartBMS.js

@@ -22,26 +22,28 @@ class VictronLynxSmartBMS extends VictronSensor{
         return await this.identifyMode(device, 0x0A)
     }   
 
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata(){
+    initSchema(){
+        super.initSchema()
         this.addMetadatum('error','', 'error code', 
             (buff)=>{return buff.readUInt8(0)})
  
-        this.addMetadatum('ttg','s', 'time to go (in seconds)',
-            (buff)=>{return this.NaNif(buff.readUInt16LE(1),0xFFFF)*60})
-        this.addMetadatum('voltage','V', 'channel 1 voltage',
-            (buff)=>{return this.NaNif(buff.readInt16LE(3),0x7FFF)/100})
-        this.addMetadatum('current','A','channel 1 current', 
-            (buff)=>{return this.NaNif(buff.readInt16LE(5),0x7FFF)/10})
+        this.addDefaultPath('ttg','electrical.batteries.capacity.timeRemaining')
+            .read=(buff)=>{return this.NaNif(buff.readUInt16LE(1),0xFFFF)*60}
+        this.addDefaultPath('voltage','electrical.batteries.voltage')
+            .read=(buff)=>{return this.NaNif(buff.readInt16LE(3),0x7FFF)/100}
+        this.addDefaultPath('current','electrical.batteries.current') 
+            .read=(buff)=>{return this.NaNif(buff.readInt16LE(5),0x7FFF)/10}
+        
         this.addMetadatum('ioStatus','','IO Status', //TODO
             (buff)=>{return buff.readUInt16LE(7)})
+
         this.addMetadatum('warningsAndAlarms','','warnings and alarms')
-        this.addMetadatum('soc','','state of charge')
+
+        this.addDefaultPath('soc','electrical.batteries.capacity.stateOfCharge')
         this.addMetadatum('consumedAh','Ah','amp-hours consumed')
-        this.addMetadatum('temp', 'K', 'battery temperature')
+        .default="electrical.batteries.{batteryID}.capacity.ampHoursConsumed"
+        
+        this.addDefaultPath('temp', 'electrical.batteries.temperature')
     }
     emitValuesFrom(buffer){
         super.emitValuesFrom(buffer)

package/sensor_classes/VictronOrionXS.js

@@ -8,22 +8,35 @@ class VictronOrionXS extends VictronSensor{
     static async identify(device){
         return await this.identifyMode(device, 0x0F)
     }   
-    async init() {
-        await super.init()
+     initSchema() {
+        super.initSchema()
+        this.addDefaultParam("id")
         this.addMetadatum('deviceState','', 'device state', 
             (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
+            .default="electrical.chargers.{id}.state"
+
         this.addMetadatum('chargerError','', 'charger error',
             (buff)=>{return VC.ChargerError.get(buff.readUInt8(1))})
+            .default="electrical.chargers.{id}.error"
+
         this.addMetadatum('outputVoltage','V', 'output voltage', 
             (buff)=>{return this.NaNif(buff.readInt16LE(2),0x7FF)/100})
+            .default="electrical.chargers.{id}.output.voltage"
+            
+        
         this.addMetadatum('current','A','output current', 
             (buff)=>{return this.NaNif(buff.readUInt16LE(4),0xFFFF)/10})
+            .default="electrical.chargers.{id}.output.current"
         this.addMetadatum('inputVoltage','V', 'input voltage', 
             (buff)=>{return this.NaNif(buff.readInt16LE(6),0x07FF)/100})
+            .default="electrical.chargers.{id}.input.voltage"
         this.addMetadatum('inputCurrent','A','input current', 
             (buff)=>{return this.NaNif(buff.readUInt16LE(8),0xFFFF)/10})
+            .default="electrical.chargers.{id}.input.current"
         this.addMetadatum('deviceOffReason','', 'device off reason', 
-            (buff)=>{return VC.OffReasons(buff.readUInt32BE(10))})            }
+            (buff)=>{return VC.OffReasons(buff.readUInt32BE(10))})
+            .default="electrical.chargers.{id}.offReason"    
+        }
 
 }
 module.exports=VictronOrionXS

package/sensor_classes/VictronSmartBatteryProtect.js

@@ -23,13 +23,12 @@ class VictronSmartBatteryProtect extends VictronSensor{
         return await this.identifyMode(device, 0x09)
     }   
 
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata(){
+
+    initSchema(){
+        super.initSchema()
+        this.addDefaultParam("id")
         this.addMetadatum('deviceState','', 'device state', 
-                        (buff)=>{return VC.OperationMode.get(buff.readUInt8(1))})
+            (buff)=>{return VC.OperationMode.get(buff.readUInt8(1))})
         this.addMetadatum('outputStatus','', 'output status', //TODO
             (buff)=>{return (buff.readUInt8(2))})
 

package/sensor_classes/VictronSmartLithium.js

@@ -38,31 +38,31 @@ class VictronSmartLithium extends VictronSensor{
         return await this.identifyMode(device, 0x05)
     }   
 
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata(){
+    initSchema(){
+        super.initSchema()
+        this.addDefaultParam("batteryID")
 
         this.addMetadatum('bmsFlags','', 'BMS Flags', 
                         (buff)=>{return buff.readUInt32LE(0)})
+        .default="electrical.batteries.{batteryID}.flags"
 
         this.addMetadatum('smartLithiumErrors','', 'Smart Lithium Errors Flags',
             (buff)=>{return buff.readUInt16LE(4)})
-        this.addMetadatum('cell1Voltage','V', 'cell #1 voltage')
-        this.addMetadatum('cell2Voltage','V', 'cell #2 voltage')
-        this.addMetadatum('cell3Voltage','V', 'cell #3 voltage')
-        this.addMetadatum('cell4Voltage','V', 'cell #4 voltage')
-        this.addMetadatum('cell5Voltage','V', 'cell #5 voltage')
-        this.addMetadatum('cell6Voltage','V', 'cell #6 voltage')
-        this.addMetadatum('cell7Voltage','V', 'cell #7 voltage')
-        this.addMetadatum('cell8Voltage','V', 'cell #8 voltage')
-        this.addMetadatum('batteryVoltage','V', 'battery voltage', 
-            (buff)=>{return this.NaNif((buff.readUInt16LE(13)&0xFFF),0xFFF)/100})
-        this.addMetadatum('balancerStatus','', 'balancer status', //TODO
+            .default="electrical.batteries.{batteryID}.errors"
+
+        for (let i=0;i++;i<8){
+            this.addMetadatum(`cell${i+1}Voltage`,'V', `cell ${i+1} voltage`)
+            .default=`electrical.batteries.{batteryID}.cell${i+1}.voltage`
+        }
+        this.addDefaultPath('batteryVoltage','electrical.batteries.voltage')
+            .read=(buff)=>{return this.NaNif((buff.readUInt16LE(13)&0xFFF),0xFFF)/100}
+
+        this.addMetadatum('balancerStatus','', 'balancer status', 
             (buff)=>{return BALANCERSTATUS[this.NaNif((buff.readUInt8(14)>>4),0xF)]})
-        this.addMetadatum('batteryTemp','K', 'battery temperature', 
-            (buff)=>{return this.NaNif((buff.readUInt8(15)&0x7F),0x7F)+233.15})          
+            .default=`electrical.batteries.{batteryID}.balancerStatus`
+
+        this.addDefaultPath('batteryTemp','electrical.batteries.temperature') 
+            .read=(buff)=>{return this.NaNif((buff.readUInt8(15)&0x7F),0x7F)+233.15}          
     }
     emitValuesFrom(buffer){
         super.emitValuesFrom(buffer)

package/sensor_classes/VictronSolarCharger.js

@@ -6,25 +6,38 @@ class VictronSolarCharger extends VictronSensor{
         return await this.identifyMode(device, 0x01)
     }   
 
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata() { 
-    this.addMetadatum('chargeState','', 'charge state', 
+    initSchema() {
+        super.initSchema()
+        this.addDefaultParam("id")
+    
+        this.addMetadatum('chargeState','', 'charge state', 
         (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
-    this.addMetadatum('chargerError','', 'charger error',
-        (buff)=>{return VC.ChargerError.get(buff.readUInt8(1))})
-    this.addMetadatum('voltage','V', 'charger battery voltage', 
-        (buff)=>{return this.NaNif(buff.readInt16LE(2),0x7FFF)/100})
-    this.addMetadatum('current','A','charger battery current', 
-        (buff)=>{return this.NaNif(buff.readInt16LE(4),0x7FFF)/10})
-    this.addMetadatum('yield','Wh', 'yield today in Watt-hours', 
-        (buff)=>{return this.NaNif(buff.readUInt16LE(6),0xFFFF)*10})
-    this.addMetadatum('solarPower','W', 'solar power', 
-        (buff)=>{return this.NaNif(buff.readUInt16LE(8),0xFFFF)})    
-    this.addMetadatum('externalDeviceLoad','A', 'external device load', 
-        (buff)=>{return this.NaNif(buff.readUInt16LE(10)&0x1FF,0x1FF)/10})    
+        .default="electrical.solar.{id}.state"
+    
+        this.addMetadatum('chargerError','', 'charger error',
+            (buff)=>{return VC.ChargerError.get(buff.readUInt8(1))})
+            .default="electrical.solar.{id}.error"
+
+        this.addMetadatum('voltage','V', 'charger battery voltage', 
+            (buff)=>{return this.NaNif(buff.readInt16LE(2),0x7FFF)/100})
+            .default="electrical.solar.{id}.dc.voltage"
+
+        this.addMetadatum('current','A','charger battery current', 
+            (buff)=>{return this.NaNif(buff.readInt16LE(4),0x7FFF)/10})
+            .default="electrical.solar.{id}.dc.current"
+
+        this.addMetadatum('yield','Wh', 'yield today in Watt-hours', 
+            (buff)=>{return this.NaNif(buff.readUInt16LE(6),0xFFFF)*10})
+            .default="electrical.solar.{id}.yieldToday"
+
+        this.addMetadatum('solarPower','W', 'solar power', 
+            (buff)=>{return this.NaNif(buff.readUInt16LE(8),0xFFFF)})   
+            .default="electrical.solar.{id}.panelPower" 
+       
+        this.addMetadatum('externalDeviceLoad','A', 'external device load', 
+            (buff)=>{return this.NaNif(buff.readUInt16LE(10)&0x1FF,0x1FF)/10})
+            .default="electrical.solar.{id}.loadCurrent" 
+  
     }
 }
 module.exports=VictronSolarCharger 

package/sensor_classes/VictronVEBus.js

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

package/sensor_classes/XiaomiMiBeacon.js

@@ -90,8 +90,6 @@ class XiaomiMiBeacon extends BTSensor{
                 return null
         }
     }
-
-    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){
         this.emitData("temp", buffer, 0)
@@ -102,15 +100,12 @@ class XiaomiMiBeacon extends BTSensor{
         return "Xiaomi Inc."
     }
     getGATTDescription() {
-        return this.GATTwarning
+        return ""
     }
+
     initGATTConnection(){
-        if (!this?.gattWarningDelivered) {
-            this.debug(this.GATTwarning.toUpperCase())
-            this.gattWarningDelivered=true
-        }
         return new Promise((resolve,reject )=>{
-            this.device.connect().then(async ()=>{
+            this.deviceConnect().then(async ()=>{
                 if (!this.gattServer) {
                     this.gattServer = await this.device.gatt()
                     this.gattService = await this.gattServer.getPrimaryService("ebe0ccb0-7a0a-4b0c-8a1a-6ff2997da3a6")
@@ -202,29 +197,44 @@ 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))/10) + 273.15})
-        this.addMetadatum('humidity','ratio', 'humidity',
-            (buff,offset)=>{return buff.readInt16LE(offset)/1000})
-
-        this.addMetadatum('batteryStrength', 'ratio',  'sensor battery strength',
-            (buff,offset)=>{return ((buff.readUInt8(offset))/100)})
-        this.addMetadatum('voltage', 'V',  'sensor battery voltage',
-            (buff,offset)=>{return ((buff.readUInt16LE(offset))/1000)})
 
+        await super.init()
         const data = this.getServiceData(this.constructor.SERVICE_MIBEACON)
         const frameControl = data[0] + (data[1] << 8)
         this.deviceID = data[2] + (data[3] << 8)
         this.isEncrypted = (frameControl >> 3) & 1
         this.encryptionVersion = frameControl >> 12 
     }   
+    initSchema(){
+        super.initSchema()
+        this.addDefaultParam("zone")
+
+        this.addParameter(
+            "encryptionKey",
+            {
+                title: "encryptionKey (AKA bindKey) for decryption"
+            }
+        )
+        this.addDefaultPath('temp','environment.temperature')
+        .read=(buff,offset)=>{return ((buff.readInt16LE(offset))/10) + 273.15}
+
+        this.addDefaultPath('humidity','environment.humidity')
+        .read=(buff,offset)=>{return buff.readInt16LE(offset)/1000}        
+            
+        this.addDefaultPath("batteryStrength", "sensors.batteryStrength")
+        .read= (buff,offset)=>{return ((buff.readUInt8(offset))/100)}
+       
+        this.addDefaultPath("voltage", "sensors.batteryVoltage")
+        .read=(buff,offset)=>{return ((buff.readUInt16LE(offset))/1000)}
+    }
 
     getName(){
         const dt = DEVICE_TYPES.get(this.deviceID)
-        return this?.name??`${dt.name} ${dt.model}`
+        if (!dt) 
+            return super.getName()
+        else
+            return this?.name??`${dt.name} ${dt.model}`
+
     }
 
     async disconnectGATTCharacteristic(){