bt-sensors-plugin-sk 1.1.0-beta.2.1.4.1 → 1.1.0-beta.2.1.4.4

package/index.js

@@ -3,7 +3,7 @@ const util = require('util')
 const path = require('path')
 const {createBluetooth} = require('node-ble')
 const {bluetooth, destroy} = createBluetooth()
-
+const packageInfo = require("./package.json")
 const BTSensor = require('./BTSensor.js')
 const BLACKLISTED = require('./sensor_classes/BlackListedDevice.js')
 
@@ -152,7 +152,7 @@ module.exports =  function (app) {
 		classMap = utilities_sk.loadClasses(path.join(__dirname, 'sensor_classes'))
 	}
 
-	app.debug('Loading plugin')
+	app.debug(`Loading plugin ${packageInfo.version}`)
 	
 	plugin.schema = {			
 		type: "object",
@@ -414,7 +414,7 @@ module.exports =  function (app) {
 			if (plugin.schema.properties.peripherals.items.dependencies)
 				plugin.schema.properties.peripherals.items.dependencies.mac_address.oneOf=[]
 		} else {
-			app.debug('Plugin build 2024.10.08 started');
+			app.debug('Plugin build Beta 2.4.1.2 started');
 			
 		}
 		starts++

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.1.0-beta.2.1.4.1",
+  "version": "1.1.0-beta.2.1.4.4",
   "description": "Bluetooth Sensors for Signalk -- support for Victron devices, RuuviTag, Xiaomi, ATC and Inkbird, Ultrasonic, Mopeka tank reader and preliminary support for Govee GVH51xx temp sensors",
   "main": "index.js",
   "dependencies": {

package/sensor_classes/GoveeTH.js

@@ -36,6 +36,7 @@ class GoveeTH extends BTSensor{
 
     async init(){
         await super.init()
+        this.initMetadata()
     }
     initMetadata(){
         this.addMetadatum('temp','K', 'temperature')
@@ -63,4 +64,4 @@ class GoveeTH extends BTSensor{
         }
    }                         
 }
-module.exports=GoveeTH
+module.exports=GoveeTH

package/sensor_classes/MopekaTankSensor.js

@@ -258,23 +258,28 @@ class MopekaTankSensor extends BTSensor{
         const md = this.valueIfVariant(this.getManufacturerData(this.constructor.manufacturerID))
         this.modelID = md[0]
         this.initMetadata()
-
     } 
 
     getMedium(){
         return Media[this?.medium??'PROPANE']
     }
+    getTankHeight(){
+        return this?.tankHeight??304.8 //Assume a foot
+    }
 
     _tankLevel( rawLevel ){
         const coefs= this.getMedium().coefficients
-        return rawLevel * (coefs[0] + (coefs[1] * this.temp) + (coefs[2] * (this.temp^2)))
+        return rawLevel * (coefs[0] + (coefs[1] * (this.temp-233.15)) + (coefs[2] * ((this.temp-233.15)^2)))
     }
     
     initMetadata(){
-        const md = this.addMetadatum("medium","","type of liquid in tank")
+        var md = this.addMetadatum("medium","","type of liquid in tank")
         md.isParam=true
         md.enum=Object.keys(Media)
 
+        md = this.addMetadatum("tankHeight","mm","height of tank (in mm)")
+        md.isParam=true
+        
         this.addMetadatum("battVolt","V","sensor battery in volts", 
             ((buffer)=>{ 
                 this.battVolt = (buffer.readUInt8(1)/32) 
@@ -290,8 +295,8 @@ class MopekaTankSensor extends BTSensor{
                 return this.temp
             }).bind(this)
         )
-        this.addMetadatum("tankLevel","m","tank level", 
-            (buffer)=>{ return this._tankLevel(((buffer.readUInt16LE(3))&0x3FFF)*10)/1000}
+        this.addMetadatum("tankLevel","ratio","tank level", 
+            (buffer)=>{ return (this._tankLevel(((buffer.readUInt16LE(3))&0x3FFF)))/this.getTankHeight()}
         )
         this.addMetadatum("readingQuality","","quality of read", 
             (buffer)=>{ return buffer.readUInt8(4)>>6}
@@ -309,6 +314,7 @@ class MopekaTankSensor extends BTSensor{
         if (props.ManufacturerData)
             this.emitValuesFrom( this.getManufacturerData(this.constructor.manufacturerID) )
     }
+
     getName(){
         if (this.name)
             return this.name

package/sensor_classes/Renogy/RenogySensor.js

@@ -0,0 +1,107 @@
+const BTSensor = require("../../BTSensor.js");
+const VC = require('./RenogyConstants.js');
+function sleep(x) {
+    return new Promise((resolve) => {
+      setTimeout(() => {
+        resolve(x);
+      }, x);
+    });
+  }
+  class RenogySensor extends BTSensor{
+
+    constructor(device,config,gattConfig){
+        super(device,config,gattConfig)
+        this.encryptionKey = config?.encryptionKey
+    }
+    
+    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
+            }
+
+            var hasDataPacket=false
+            device.helper._prepare()
+            device.helper.on("PropertiesChanged",
+                 (props)=> {
+                    if (Object.hasOwn(props,'ManufacturerData')){
+                        md = props['ManufacturerData'].value
+                        hasDataPacket=md[0x2e1].value[0]==0x10
+                    }
+            })        
+            while (!hasDataPacket) {
+                await sleep(500)
+            }
+            device.helper.removeListeners()
+            if (md[0x2e1].value[4]==mode)
+                return this
+            else
+                return null
+        } 
+    }
+
+    async init(){
+        await super.init()
+    }
+    alarmReason(alarmValue){
+        return this.constructor.AlarmReason[alarmValue]
+    }
+    getModelName(){
+        return VC?.MODEL_ID_MAP[this.model_id]??this.constructor.name+" (Model ID:"+this.model_id+")"
+    }
+
+    decrypt(data){
+        if (!this.encryptionKey)
+            throw Error("Unable to decrypt: no encryption key set")
+
+        const encMethod = 'aes-128-ctr';
+        const iv = data.readUInt16LE(5); 
+        const key = Buffer.from(this.encryptionKey,'hex')
+        const ivBuffer = Buffer.alloc(16); // 128 bits = 16 bytes
+        
+        ivBuffer.writeUInt16LE(iv)
+        
+        var encData = Buffer.from([...data.slice(8)])
+        
+        const decipher = crypto.createDecipheriv(encMethod, key, ivBuffer)
+        
+        const decData=decipher.update(encData)
+
+        return Buffer.from(decData)
+        
+    }
+    getName(){
+        return `Victron ${this.getModelName()}`
+    }
+    propertiesChanged(props){
+        super.propertiesChanged(props)
+        if (this.usingGATT()) return
+        
+        try{
+            const md = this.getManufacturerData(0x2e1)
+            if (md && md.length && md[0]==0x10){
+                const decData=this.decrypt(md)
+                this.emitValuesFrom(decData)
+            }
+        }
+        catch (error) {
+            throw new Error(`Unable to read data from ${ this.getDisplayName()}: ${error}` )
+        }
+    }
+
+    initGATTConnection(){
+        throw new Error( "GATT Connection unimplemented for "+this.getDisplayName())
+    }
+
+   
+
+}
+module.exports=RenogySensor

package/sensor_classes/Victron/VictronSensor.js

@@ -1,11 +1,6 @@
 const BTSensor = require("../../BTSensor.js");
 const crypto = require('node:crypto');
-const int24 = require('int24')
-const util = require('util')
 const VC = require('./VictronConstants.js');
-const BLACKLISTED = require("../BlackListedDevice.js");
-const { resolve } = require("node:path");
-const { setMaxIdleHTTPParsers } = require("node:http");
 function sleep(x) {
     return new Promise((resolve) => {
       setTimeout(() => {
@@ -20,7 +15,6 @@ function sleep(x) {
         this.encryptionKey = config?.encryptionKey
     }
     
-    
     static async identifyMode(device, mode){
             
         var md = await this.getDeviceProp(device,'ManufacturerData')
@@ -54,15 +48,10 @@ function sleep(x) {
                 return null
         } 
     }
-    
-
 
     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")
+        const md =this.addMetadatum('encryptionKey','', "Encryption Key")
         md.isParam = true
         this.model_id=this.getManufacturerData(0x2e1).readUInt16LE(2)
     }

package/sensor_classes/VictronACCharger.js

@@ -35,7 +35,7 @@ class VictronACCharger extends VictronSensor{
     initMetadata(){
         this.addMetadatum('state','', 'device state', 
             (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
-        this.addMetadatum('error','', 'error code', 
+        this.addMetadatum('chargerError','', 'charger error code', 
             (buff)=>{return VC.ChargerError.get(buff.readUInt8(1))})
  
         this.addMetadatum('batt1','V', 'battery 1 voltage')
@@ -70,4 +70,4 @@ class VictronACCharger extends VictronSensor{
         this.emit("acCurr", this.NaNif(br.read_unsigned_int(9),0x1FF)/10)
     }
 }
-module.exports=VictronACCharger
+module.exports=VictronACCharger

package/sensor_classes/VictronSmartLithium.js

@@ -16,10 +16,19 @@ Start Bit	Nr of Bits	Meaning	Units	Range	NA Value	Remark
 152	7	Battery temperature	1°C	-40..86 °C	0x7F	VE_REG_BAT_TEMPERATURE Temperature = Record value - 40
 159	1	Unused				
 VE_REG_BATTERY_CELL_VOLTAGE 0x00 ( 0) when cell voltage < 2.61V 0x01 ( 1) when cell voltage == 2.61V 0x7D (125) when cell voltage == 3.85V 0x7E (126) when cell voltage > 3.85 0x7F (127) when cell voltage is not available / unknown
-*/const VictronSensor = require ("./Victron/VictronSensor") 
+*/
+
+const VictronSensor = require ("./Victron/VictronSensor") 
 const VC = require("./Victron/VictronConstants")
 const BitReader = require("./_BitReader")
 
+const BALANCERSTATUS = {
+    0:"Unknown",
+    1:"Balanced",
+    2:"Balancing",
+    3:"Cell imbalance",
+    0xF:"Not applicable"
+}
 function _toCellVoltage(val){    
     return val==0x7F?NaN:2.6+(val/100)
 }
@@ -51,15 +60,15 @@ class VictronSmartLithium extends VictronSensor{
         this.addMetadatum('batteryVoltage','V', 'battery voltage', 
             (buff)=>{return this.NaNif((buff.readUInt16LE(13)&0xFFF),0xFFF)/100})
         this.addMetadatum('balancerStatus','', 'balancer status', //TODO
-            (buff)=>{return this.NaNif((buff.readUInt8(14)>>4),0xF)})
+            (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})          
     }
     emitValuesFrom(buffer){
         super.emitValuesFrom(buffer)
         const br = new BitReader(buffer.subarray(6,13))
-        for (let i = 1; i<8; i++)
+        for (let i = 0; i<8; i++)
             this.emit(`cell${i+1}Voltage`,_toCellVoltage(br.read_unsigned_int(7)))
     }
 }
-module.exports=VictronSmartLithium
+module.exports=VictronSmartLithium