bt-sensors-plugin-sk 1.2.5 → 1.2.6-beta

package/sensor_classes/Victron/VictronSensor.js

@@ -3,71 +3,71 @@ const Images = require('./VictronImages.js')
 
 const BTSensor = require("../../BTSensor.js");
 const crypto = require('node:crypto');
-function sleep(x) {
-    return new Promise((resolve) => {
-      setTimeout(() => {
-        resolve(x);
-      }, x);
-    });
-  }
+const VictronIdentifier = require('./VictronIdentifier.js');
+
   class VictronSensor extends BTSensor{
     static Domain = BTSensor.SensorDomains.electrical
-
+    static ManufacturerID = 0x2e1
     constructor(device,config,gattConfig){
         super(device,config,gattConfig)
-        this.encryptionKey = config?.encryptionKey
+        
+        if (device.modelID)
+            this.modelID=device.modelID        
     }
+
     
-    static async identifyMode(device, mode){
-            
-        var md = await this.getDeviceProp(device,'ManufacturerData')
-        if (md==undefined || !Object.hasOwn(md,0x2e1)) 
-            return null
-        else {
-            
-            if (md[0x2e1].value[0]==0x10) {
-                if (md[0x2e1].value[4]==mode)
-                    return this
-                else 
-                    return null
-            }
+    static async getDataPacket(device, md){
+        if (md && md[this.ManufacturerID]?.value[0]==0x10)
+            return md[this.ManufacturerID].value
+
+        device.helper._prepare()
 
-            var hasDataPacket=false
-            device.helper._prepare()
+        return new Promise((resolve, reject) => {
             device.helper.on("PropertiesChanged",
-                 (props)=> {
-                    if (Object.hasOwn(props,'ManufacturerData')){
-                        md = props['ManufacturerData'].value
-                        hasDataPacket=md[0x2e1].value[0]==0x10
+            (props)=> {
+                if (Object.hasOwn(props,'ManufacturerData')){
+                    const md = props['ManufacturerData'].value
+                    if(md[this.ManufacturerID].value[0]==0x10) {
+                        device.helper.removeListeners()
+                        resolve(md[this.ManufacturerID].value)
                     }
+                }
             })        
-            while (!hasDataPacket) {
-                await sleep(500)
-            }
-            device.helper.removeListeners()
-            if (md[0x2e1].value[4]==mode)
-                return this
-            else
-                return null
-        } 
+        })
+    }
+    
+    static getModelID(md) {
+        return md[this.ManufacturerID]?.value.readUInt16LE(2)??-1
     }
 
-    async init(){
+    static async identify(device){
+
+        var md = await this.getDeviceProp(device,'ManufacturerData')
+        if (md==undefined || !Object.hasOwn(md,this.ManufacturerID)) 
+            return null
+        const data=await this.getDataPacket(device,md)
+        if (data) {
+            device.modelID=this.getModelID(md)
+            return VictronIdentifier.identify(data)
+        } 
+        return null
+    }
+   async init(){
         await super.init()
         this.addParameter(
             "encryptionKey",
             {
-                title:"Encryption Key"
+                title:"Encryption Key",
+                isRequired: true
             }
         )
-        this.model_id=this.getManufacturerData(0x2e1)?.readUInt16LE(2)??"Unknown"
-        this._schema.title = this.getName()
     }
     alarmReason(alarmValue){
         return this.constructor.AlarmReason[alarmValue]
     }
     getModelName(){
-        const m = VC.MODEL_ID_MAP[this.model_id]
+        const mID = this.getModelID()
+        const m = VC.MODEL_ID_MAP[mID]
         if(m) {
             if(typeof m == 'string' || m instanceof String ) {
                 return m
@@ -75,7 +75,7 @@ function sleep(x) {
                 return m.name
             }
         }
-        return this.constructor.name+" (Model ID:"+this.model_id+")"
+        return this.constructor.name+` (Model ID: ${mID==-1?"Unknown":mID})`
     }
 
     decrypt(data){
@@ -98,6 +98,13 @@ function sleep(x) {
         return Buffer.from(decData)
         
     }
+    getModelID(){
+        if (!this.modelID ||this.modelID==-1)
+            this.modelID=this.getManufacturerData(this.constructor.ManufacturerID)?.readUInt16LE(2)??-1
+
+        return this.modelID
+    }
+
     getName(){
         return `Victron ${this.getModelName()}`
     }
@@ -106,7 +113,7 @@ function sleep(x) {
         if (this.usingGATT()) return
         if (!props.hasOwnProperty("ManufacturerData")) return
         try{
-            const md = this.getManufacturerData(0x2e1)
+            const md = this.getManufacturerData(this.constructor.ManufacturerID)
             if (md && md.length && md[0]==0x10){
                 const decData=this.decrypt(md)
                 this.emitValuesFrom(decData)
@@ -122,21 +129,24 @@ function sleep(x) {
     }
 
    getImage(){
-        const m = VC.MODEL_ID_MAP[this.model_id]
+        const m = VC.MODEL_ID_MAP[this.getModelID()]
         if (m && m.image)
             return m.image
         else
             return Images.generic
    }
 
-   getDescription(){
+   getTextDescription(){
     //return `<img src="https://www.victronenergy.com/_next/image?url=https%3A%2F%2Fwww.victronenergy.com%2Fupload%2Fproducts%2FSmartShunt%2520500_nw.png&w=1080&q=70"" height="150" align=”top” ></img>`
 
 
-    return `<img src="../bt-sensors-plugin-sk/images/${this.getImage()}" width="200" style="float: left; 
-  margin: 20px;" ></img> 
-    To get the encryption key for your device, follow the instructions <a href=https://communityarchive.victronenergy.com/questions/187303/victron-bluetooth-advertising-protocol.html target="_victron_encrypt">here</a>`
+    return `To get the encryption key for your device, follow the instructions <a href=https://communityarchive.victronenergy.com/questions/187303/victron-bluetooth-advertising-protocol.html target="_victron_encrypt">here</a>`
    }
 
+   prepareConfig(config){
+        super.prepareConfig(config)
+        config.params.modelID=this.getModelID()
+    }
+
 }
 module.exports=VictronSensor

package/sensor_classes/VictronACCharger.js

@@ -23,12 +23,7 @@ const VC = require("./Victron/VictronConstants.js")
 const BitReader = require("./_BitReader")
 
 class VictronACCharger extends VictronSensor{
-
-    static async identify(device){
-        return await this.identifyMode(device, 0x08)
-    }   
-
-
+    static ImageFile = "VictronBlueSmartACCharger.jpg"
     initSchema(){
         super.initSchema()
         this.addDefaultParam("id")

package/sensor_classes/VictronBatteryMonitor.js

@@ -7,18 +7,18 @@ const VC=require("./Victron/VictronConstants.js")
 const int24 = require('int24')
 class VictronBatteryMonitor extends VictronSensor{
 
-
-    static async identify(device){
-        return await this.identifyMode(device, 0x02)
-    }
-    static _test(data, key){
-        var b = Buffer.from(data.replaceAll(" ",""),"hex")
+        static _test(data, key){
+        var b
+        if (data instanceof String)
+            b = Buffer.from(data.replaceAll(" ",""),"hex")
+        else
+            b = data
         const d = new this()
 
         if (key) {
-            d.encryptionKey = key
-        
-        }
+            d.encryptionKey = key       
+        } else
+            d.auxMode=b.readInt8(8)&0x3
         d.currentProperties = {}
         d.currentProperties.ManufacturerData={}
         d.currentProperties.ManufacturerData[0x02e1]=b
@@ -28,18 +28,21 @@ class VictronBatteryMonitor extends VictronSensor{
         Object.keys(d.getPaths()).forEach((tag)=>{
                 d.on(tag,(v)=>console.log(`${tag}=${v}`))
         })
-        b = d.decrypt(b)
+        if (key)
+            b = d.decrypt(b)
+        else
+
         console.log(b)
         d.emitValuesFrom(b)
         d.removeAllListeners()
     
     }
+    static ImageFile = "VictronSmartShunt.jpg"
 
     characteristics=[]
 
-
-    initSchema(){
-        super.initSchema()
+    async initSchema(){
+        await super.initSchema()
         this.addDefaultParam("batteryID").default="house"
         //"default": "electrical.batteries.{batteryID}.voltage"
 
@@ -73,26 +76,31 @@ class VictronBatteryMonitor extends VictronSensor{
         
         this.addDefaultPath( 'ttg',"electrical.batteries.capacity.timeRemaining") 
             .read=(buff,offset=0)=>{return this.NaNif(buff.readUInt16LE(offset),0xFFFF)*60}
-        this.getPath("ttg").gatt='65970ffe-4bda-4c1e-af4b-551c4cf74769'
+        this.getPath("ttg").gatt='65970ffe-4bda-4c1e-af4b-551c4cf74769';
+
         this.auxMode=VC.AuxMode.STARTER_VOLTAGE
-        try {
-        if (this.encryptionKey){
-            const decData = this.decrypt(this.getManufacturerData(0x02e1))
-            if (decData)
-                this.auxMode=decData.readInt8(8)&0x3   
-        }
-        } catch(e){ 
-            this.debug(`Unable to determine device AuxMode. ${e.message}`)
-            this.debug(e)
-            this.auxMode=VC.AuxMode.DISABLED
-        }   
 
+        if (!this.auxMode){
+            const md=await this.constructor.getDataPacket(this.device, this.getManufacturerData(this.constructor.ManufacturerID))
+            try {
+                if (this.encryptionKey){
+                    const decData = this.decrypt(md)
+                    if (decData)
+                        this.auxMode=decData.readInt8(8)&0x3   
+            }
+            } catch(e){ 
+                this.debug(`Unable to determine device AuxMode. ${e.message}`)
+                this.debug(e)
+                this.auxMode=VC.AuxMode.DISABLED
+            }
+        }
+    
         switch(this.auxMode){
             case VC.AuxMode.STARTER_VOLTAGE:
                 this.addMetadatum('starterVoltage','V', 'starter battery voltage', 
                     (buff,offset=0)=>{return buff.readInt16LE(offset)/100},
                     '6597ed7d-4bda-4c1e-af4b-551c4cf74769')
-                    .default="electrical.batteries.secondary.voltage"
+                    .default="electrical.batteries.starter.voltage"
                     break;
             case VC.AuxMode.MIDPOINT_VOLTAGE:
                 this.addMetadatum('midpointVoltage','V', 'midpoint battery voltage', 
@@ -110,9 +118,11 @@ class VictronBatteryMonitor extends VictronSensor{
             default:
                 break
         }
+                
     }
     
     emitValuesFrom(decData){
+        
         this.emitData("ttg",decData,0)
         this.emitData("voltage",decData,2);
         const alarm = this.getPath("alarm").read(decData,4)
@@ -211,5 +221,6 @@ class VictronBatteryMonitor extends VictronSensor{
             this.debug(`Disconnected from ${ this.getName()}`)
         }
     }
+    
 }
 module.exports=VictronBatteryMonitor

package/sensor_classes/VictronDCDCConverter.js

@@ -3,10 +3,7 @@ const VC=require("./Victron/VictronConstants.js")
 
 class VictronDCDCConverter extends VictronSensor{
     
-    static async identify(device){
-        return await this.identifyMode(device,0x04)
-    }
-   
+    static ImageFile="VictronOrionTrIsolated.webp"
    
     initSchema(){
         super.initSchema()

package/sensor_classes/VictronDCEnergyMeter.js

@@ -5,10 +5,7 @@ const int24 = require("int24");
 const _BitReader = require("./_BitReader.js");
 class VictronDCEnergyMeter extends VictronSensor{
     
-    static async identify(device){
-        return await this.identifyMode(device, 0x0D)
-    }
-    async init(){
+     async init(){
         await super.init()
         try {
         if (this.encryptionKey){

package/sensor_classes/VictronGXDevice.js

@@ -22,10 +22,7 @@ Alarms
 TBD
 117 43 Unuse
 */
-    static async identify(device){
-        return await this.identifyMode(device, 0x07)
-    }   
-
+    static ImageFile = "VictronCerboGX.webp"
     initSchema(){
         super.initSchema()
         this.addMetadatum('voltage','V', 'channel #1 voltage', 

package/sensor_classes/VictronInverter.js

@@ -3,9 +3,8 @@ const VC=require("./Victron/VictronConstants.js")
 const BitReader = require('./_BitReader')
 
 class VictronInverter extends VictronSensor{
-    static async identify(device){
-        return await this.identifyMode(device, 0x03)
-    }
+  
+    static ImageFile="VictronPhoenixSmart1600.webp"
 
     initSchema(){
         super.initSchema()

package/sensor_classes/VictronInverterRS.js

@@ -5,10 +5,8 @@ function toBinaryString(buff){
     return [...buff].map((b) => b.toString(2).padStart(8, "0")).join("");
     }
 class VictronInverterRS extends VictronSensor{
-    static async identify(device){
-        return await this.identifyMode(device, 0x06)
-    }
-    
+
+    static ImageFile = "VictronInverterRS.webp"
 
      initSchema() {
         super.initSchema()

package/sensor_classes/VictronLynxSmartBMS.js

@@ -18,10 +18,7 @@ const VC = require("./Victron/VictronConstants.js")
 const BitReader = require("./_BitReader")
 class VictronLynxSmartBMS extends VictronSensor{
 
-    static async identify(device){
-        return await this.identifyMode(device, 0x0A)
-    }   
-
+    static ImageFile="VictronLynxSmartBMS"
     initSchema(){
         super.initSchema()
         this.addDefaultParam("batteryID")

package/sensor_classes/VictronOrionXS.js

@@ -5,9 +5,7 @@ const VictronSensor = require ("./Victron/VictronSensor.js")
 const VC = require("./Victron/VictronConstants.js")
 class VictronOrionXS extends VictronSensor{
 
-    static async identify(device){
-        return await this.identifyMode(device, 0x0F)
-    }   
+    static ImageFile="VictronOrionTrIsolated.webp"
      initSchema() {
         super.initSchema()
         this.addDefaultParam("id")

package/sensor_classes/VictronSmartBatteryProtect.js

@@ -19,10 +19,7 @@ const VictronSensor = require ("./Victron/VictronSensor.js")
 const VC = require("./Victron/VictronConstants.js")
 class VictronSmartBatteryProtect extends VictronSensor{
 
-    static async identify(device){
-        return await this.identifyMode(device, 0x09)
-    }   
-
+    static ImageFile="VictronSmartBatteryProte.jpg"
 
     initSchema(){
         super.initSchema()

package/sensor_classes/VictronSmartLithium.js

@@ -34,10 +34,7 @@ function _toCellVoltage(val){
 }
 class VictronSmartLithium extends VictronSensor{
 
-    static async identify(device){
-        return await this.identifyMode(device, 0x05)
-    }   
-
+    static ImageFile="VictronSmartLithiumBattery.jpg"
     initSchema(){
         super.initSchema()
         this.addDefaultParam("batteryID")

package/sensor_classes/VictronSolarCharger.js

@@ -2,9 +2,7 @@ const VictronSensor = require ("./Victron/VictronSensor.js")
 const VC = require("./Victron/VictronConstants.js")
 class VictronSolarCharger extends VictronSensor{
 
-    static async identify(device){
-        return await this.identifyMode(device, 0x01)
-    }   
+    static ImageFile="VictronSmartSolarMPPT.webp"
 
     initSchema() {
         super.initSchema()

package/sensor_classes/VictronVEBus.js

@@ -5,10 +5,7 @@ AC_IN_STATE=["AC in 1","AC in 2","NOT CONNECTED", "NA"]
 ALARM_STATE=["None","warning", "alarm","NA"]
 class VictronVEBus extends VictronSensor{
 
-    static async identify(device){
-        return await this.identifyMode(device, 0x0C)
-    }   
-
+    static ImageFile="VictronVEBus.webp"
     initSchema(){
         super.initSchema()
         this.addMetadatum('chargeState','', 'charge state', 

package/sensor_classes/XiaomiMiBeacon.js

@@ -72,7 +72,7 @@ const DEVICE_TYPES = new Map([
 
 class XiaomiMiBeacon extends BTSensor{
     static Domain = BTSensor.SensorDomains.environmental
-		
+	static ImageFile = "LYWSD03MMC-Device.jpg"
     constructor(device, config, gattConfig){
         super(device, config, gattConfig)
         this.encryptionKey = config?.encryptionKey
@@ -91,7 +91,8 @@ class XiaomiMiBeacon extends BTSensor{
                 return null
         }
     }
-    
+    static ImageFile="LYWSD03MMC-Device.jpg"
+
     emitValues(buffer){
         this.emitData("temp", buffer, 0)
         this.emit("humidity", buffer.readUInt8(2)/100)
@@ -206,6 +207,8 @@ class XiaomiMiBeacon extends BTSensor{
 
         await super.init()
         const data = this.getServiceData(this.constructor.SERVICE_MIBEACON)
+        if (!data || data.length<4)
+            throw new Error(`Service Data ${this.constructor.SERVICE_MIBEACON} not available for ${this.getName()}`)
         const frameControl = data[0] + (data[1] << 8)
         this.deviceID = data[2] + (data[3] << 8)
         this.isEncrypted = (frameControl >> 3) & 1

package/sensor_classes/iBeaconSensor.js

@@ -0,0 +1,40 @@
+
+const BTSensor = require("../BTSensor");
+const iBeacon = require("./Beacon/iBeacon")
+
+class iBeaconSensor extends BTSensor {
+
+    static async identify (device){
+      return null
+    }
+    static IsRoaming = true;
+    static Domain = BTSensor.SensorDomains.beacons
+    static ImageFile = "iBeacon.jpg"
+    
+
+    beacon=new iBeacon(this)
+
+    initSchema(){
+        super.initSchema()
+        this.beacon.initSchema()
+    }
+
+    initListen(){
+      super.initListen()
+      this.beacon.initListen()
+    }
+    elapsedTimeSinceLastContact(){
+      return this.beacon.elapsedTimeSinceLastContact(super.elapsedTimeSinceLastContact())
+    }
+
+    propertiesChanged(props){
+      super.propertiesChanged(props);
+      this.beacon.propertiesChanged(props) 
+    }
+
+    getTextDescription(){
+        return `${this.getName()} iBeacon device`
+    }
+  }
+
+module.exports = iBeaconSensor;