bt-sensors-plugin-sk 1.2.2 → 1.2.3

package/BTSensor.js

@@ -465,13 +465,26 @@ class BTSensor extends EventEmitter {
         throw new Error("::initGATTNotifications() should be implemented by the BTSensor subclass")
     }
 
-    deviceConnect() {
+    deviceConnect(reconnect=false) {
 
      
         return connectQueue.enqueue( async ()=>{
             this.debug(`Connecting... ${this.getName()}`)
-            await this.device.connect()
+            await this.device.helper.callMethod('Connect')
+
             this.debug(`Connected to ${this.getName()}`)
+            if (!reconnect) {
+                this.device.helper.on('PropertiesChanged',  (propertiesChanged) => {
+                    if ('Connected' in propertiesChanged) {
+                        const { value } = propertiesChanged.Connected
+                        if (value) {
+                            this.device.emit('connect', { connected: true })
+                        } else {
+                            this.device.emit('disconnect', { connected: false })
+                        }
+                    }
+                })
+            }
 
             try {
 

package/README.md

@@ -1,4 +1,10 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org) 
+# Version 1.2.3
+
+## WHAT'S NEW SINCE VERSION 1.2.2
+
+Bug fixes Remoran Wave.3, JunctekBMS, and ShenzhenLiOn
+
 # Version 1.2.2
 
 ## WHAT'S NEW SINCE VERSION 1.2.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.2.2",
-  "description": "Bluetooth Sensors for Signalk - see https://www.npmjs.com/package/bt-sensors-plugin-sk for a list of supported classes",
+  "version": "1.2.3",
+  "description": "Bluetooth Sensors for Signalk - see https://www.npmjs.com/package/bt-sensors-plugin-sk#supported-sensors for a list of supported sensors",
   "main": "index.js",
   "dependencies": {
     "@rjsf/bootstrap-4": "^5.24.11",

package/sensor_classes/JBDBMS.js

@@ -52,10 +52,10 @@ class JBDBMS extends BTSensor {
         (buffer)=>{return buffer.readInt16BE(6) / 100} 
       
       this.addDefaultPath('remainingCapacity','electrical.batteries.capacity.remaining')
-        .read=(buffer)=>{return buffer.readUInt16BE(8) / 100} 
+        .read=(buffer)=>{return (buffer.readUInt16BE(8) / 100)*3600} 
       
       this.addDefaultPath('capacity','electrical.batteries.capacity.actual')
-        .read=(buffer)=>{return buffer.readUInt16BE(10) / 100} 
+        .read=(buffer)=>{return (buffer.readUInt16BE(10) / 100)*3600} 
      
       this.addDefaultPath('cycles','electrical.batteries.cycles' )
         .read=(buffer)=>{return buffer.readUInt16BE(12)} 
@@ -139,7 +139,7 @@ class JBDBMS extends BTSensor {
         let datasize = -1
         const timer = setTimeout(() => {
           clearTimeout(timer)
-          reject(new Error(`Response timed out from JBDBMS device ${this.getName()}. `));
+          reject(new Error(`Response timed out (+30s) from JBDBMS device ${this.getName()}. `));
         }, 30000);
 
         const valChanged = async (buffer) => {
@@ -147,13 +147,12 @@ class JBDBMS extends BTSensor {
             if (buffer[0]!==0xDD || buffer.length < 5 || buffer[1] !== command)
                 reject(`Invalid buffer from ${this.getName()}, not processing.`)
             else 
-                datasize=buffer[2]
+                datasize=buffer[3]
           }
           buffer.copy(result,offset)
-          if (buffer[buffer.length-1]==0x77 && offset+buffer.length-6==datasize){
+          if (buffer[buffer.length-1]==0x77 && offset+buffer.length-7==datasize){
             
             result = Uint8Array.prototype.slice.call(result, 0, offset+buffer.length)
-            this.debug(result)
             this.rxChar.removeAllListeners()
             clearTimeout(timer)
             if (!checkSum(result)) 
@@ -196,6 +195,20 @@ async getAndEmitCellVoltages(){
 }
 
 initGATTInterval(){
+  this.device.on("disconnect", ()=>{
+      if (this.isActive()) {
+      this.debug(`Device disconnected. Attempting to reconnect to ${this.getName()}`)  
+          try {        
+          this.deviceConnect(true).then(()=>{
+            this.debug(`Device reconnected -- ${this.getName()}`)  
+          })
+          }
+          catch (e) {
+                  this.debug(`Error while reconnecting to ${this.getName()}`)
+          }
+      }
+  })     
+  this.emitGATT()
   this.initGATTNotifications()
 }
 

package/sensor_classes/Junctek.js

@@ -69,10 +69,10 @@ class JunctekBMS extends BTSensor{
                 const v = parseInt(bytesToBase10String(value))
                 switch (byte){
                 case 0xC0:{
-                    emitData("voltage",v/100)
+                    emit("voltage",v/100)
                 }
                 case 0xC1:{
-                    emitData("current",(v/100)*chargeDirection)
+                    emit("current",(v/100)*chargeDirection)
                 }
 
                 case 0xD1:{
@@ -81,29 +81,29 @@ class JunctekBMS extends BTSensor{
                 }
 
                 case 0xD2:{
-                    emitData("remainingAh",v/1000)
+                    emit("remainingAh",v/1000)
                 }
 
                 case 0xD3:{
-                    emitData("discharge",v/100000)
+                    emit("discharge",v/100000)
                 }
                 case 0xD4:{
-                    emitData("charge",v/100000)
+                    emit("charge",v/100000)
                 }
                 case 0xD6:{
-                    emitData("timeRemaining",v*60)
+                    emit("timeRemaining",v*60)
                 }
                 case 0xD7:{
-                    emitData("impedance",v/100)
+                    emit("impedance",v/100)
                 }
                 case 0xD8:{
-                    emitData("power",(v/100)*chargeDirection)
+                    emit("power",(v/100)*chargeDirection)
                 }
                 case 0xD9:{
-                    emitData("temperature",v + 173.15) //assume C not F
+                    emit("temperature",v + 173.15) //assume C not F
                 }
                 case 0xB1:{
-                    emitData("capacityActual",v /10 )
+                    emit("capacityActual",v /10 )
                 }
             }
             }

package/sensor_classes/RemoranWave3.js

@@ -33,10 +33,10 @@ const states= ["Charging Needed", "Charging", "Floating", "Idle"]
 const BTSensor = require("../BTSensor");
  class RemoranWave3 extends BTSensor{
     static Domain = BTSensor.SensorDomains.electrical
-    serviceUUID = "81D08DF0-C0F8-422A-9D9D-E4379BB1EA3B"
-    info1CharUUID = "62C91222-FAFE-4F6E-95F0-AFC02BD19F2E"
+    serviceUUID = "81d08df0-c0f8-422a-9d9d-e4379bb1ea3b"
+    info1CharUUID = "62c91222-fafe-4f6e-95f0-afc02bd19f2e"
     info2CharUUID = "f5d12d34-4390-486c-b906-24ea8906af71"
-    eventUuid =  "f12a8e25-59f7-42f2-b7ae-ba96fb25c13c"
+    eventUUID =  "f12a8e25-59f7-42f2-b7ae-ba96fb25c13c"
 
      static async identify(device){
          
@@ -53,57 +53,68 @@ const BTSensor = require("../BTSensor");
          return true
      }
     emitInfo1Data(buffer){
+        this.debug(`emitting info 1 data`)
         if (buffer.length < 20) {
             app.debug(`Bad buffer size ${buffer.length}. Buffer size must be 20 bytes or more.`)
             return
         }
-        emitData("versionNumber", buffer.readUInt8(0))
+        this.emit("versionNumber", buffer.readUInt8(0))
         const errors = buffer.readUInt8(2)
         const errorState = []
         for (var i = 0; i < 8; ++i) {
             var c = 1 << i;
-            r & c && errorState.push(errors[i])
+            errors & c && errorState.push(errors[i])
         }
-        emitData("errors", errorState)
-        emitData("state",  states[buffer.readUInt8(3)])
-        emitData("rpm", buffer.readUInt32LE(4))
-        emitData( "voltage" , buffer.readFloatLE(8))
-        emitData("current",  buffer.readFloatLE(12))
-        emitData( "power", buffer.readFloatLE(16))
+        this.emit("errors", errorState)
+        this.emit("state",  states[buffer.readUInt8(3)])
+        this.emit("rpm", buffer.readUInt32LE(4))
+        this.emit( "voltage" , buffer.readFloatLE(8))
+        this.emit("current",  buffer.readFloatLE(12))
+        this.emit( "power", buffer.readFloatLE(16))
                 
         if (buffer.length > 23) {
-            emitData( "temp", buffer.readFloatLE(20).toFixed(1))
-            emitData( "uptime", buffer.readUInt32(24))
+            this.emit( "temp", ((buffer.readFloatLE(20))+273.15))
+            this.emit( "uptime", buffer.readUInt32LE(24))
             if (versionNumber>1 && buffer.size > 31) {
-                emitData("energy", buffer.readFloatLE(32).toFixed(1))
+                this.emit("energy", buffer.readFloatLE(32))
             }
         }
     
     }
     emitInfo2Data(buffer){
+        this.debug(`emitting info 2 data`)
+
         if (buffer.size < 12) {
             app.debug(`Bad buffer size ${buffer.length}. Buffer size must be 12 bytes or more.`)
             return
          }
-        emitData("versionNumber", buffer.getUint8(0))
-        emitData("temp",  buffer.readFloat32LE(4))
-        emitData("uptime", buffer.readUInt32(8))
-        emitData("lastBootTime", arduinoDateDecode(buffer.getUInt32LE(12)))
-        emitData("energy",   buffer.readFloat32LE(16))
+        this.emit("versionNumber", buffer.readUInt8(0))
+        this.emit("temp",  ((buffer.readFloatLE(4))+273.15))
+        this.emit("uptime", buffer.readUInt32LE(8))
+        this.emit("lastBootTime", arduinoDateDecode(buffer.readUInt32LE(12)))
+        this.emit("energy",   buffer.readFloatLE(16))
     }
     emitEventData(buffer){
-        if (buffer.size < 14) {
+                this.debug(`emitting event data`)
+        if (buffer.length < 14) {
+            this.debug(buffer)
             app.debug(`Bad buffer size ${buffer.length}. Buffer size must be 14 bytes or more.`)
             return
          }
-        this.emitData("event", 
+        const eventType = buffer.readUInt16LE(8)
+        var eventDesc = eventType.toString()
+        if (Object.hasOwn(eventTypes,eventType))
+            eventDesc = eventTypes[eventType]
+
+
+        this.emit("event", 
             {
                 firstDate: arduinoDateDecode(buffer.readUInt32LE(0)),
                 lastDate: arduinoDateDecode(buffer.readUInt32LE(4)),
-                eventType: buffer.readUInt16LE(8),
+                eventType: eventType,
                 count: buffer.readUInt16LE(10),
                 index: buffer.readUInt16LE(12),
-                eventDesc: eventTypes[i]
+                eventDesc: eventDesc
             }
         )
     }
@@ -174,10 +185,10 @@ const BTSensor = require("../BTSensor");
                  this.gattServer = await this.device.gatt() 
                  this.service = await this.gattServer.getPrimaryService(this.serviceUUID) 
                  this.info1Characteristic = await this.service.getCharacteristic(this.info1CharUUID)
-                 this.info2Characteristic = await this.service.getPrimaryService(this.info2CharUUID) 
+                 this.info2Characteristic = await this.service.getCharacteristic(this.info2CharUUID) 
                  this.eventCharacteristic = await this.service.getCharacteristic(this.eventUUID)
                  resolve(this)
-            }}) .catch((e)=>{ reject(e.message) }) }) 
+            }}) .catch((e)=>{ this.debug(e); reject(e.message) }) }) 
      }
      
      initGATTNotifications() { 
@@ -205,9 +216,9 @@ const BTSensor = require("../BTSensor");
     }
      async stopListening(){
         super.stopListening()
-        await stopNotifations(this.info1Characteristic)
-        await stopNotifations(this.info2Characteristic)
-        await stopNotifations(this.eventCharacteristic)
+        await this.stopNotifications(this?.info1Characteristic)
+        await this.stopNotifications(this?.info2Characteristic)
+        await this.stopNotifications(this?.eventCharacteristic)
         if (await this.device.isConnected()){
             await this.device.disconnect()
         }

package/sensor_classes/Renogy/RenogyConstants.js

@@ -13,7 +13,8 @@ CHARGING_STATE:
     3: 'Equalizing',
     4: 'Boost',
     5: 'Floating',
-    6: 'Current limiting'
+    6: 'Current limiting',
+    8: 'Not charging'
 },
 
 LOAD_STATE: {

package/sensor_classes/Renogy/RenogySensor.js

@@ -57,9 +57,6 @@ class RenogySensor extends BTSensor{
         ) 
     }
 
-    emitGATT(){
-    }
-
     getModelName(){
         return this?.modelID??`${this.constructor.name} Unknown model` 
     }
@@ -86,7 +83,6 @@ class RenogySensor extends BTSensor{
     }
 
     initGATTInterval(){
-        this.emitGATT()
         this.intervalID = setInterval(()=>{
             this.emitGATT()
         }, 1000*(this?.pollFreq??60) )

package/sensor_classes/RenogyRoverClient.js

@@ -6,53 +6,113 @@ const RenogySensor = require("./Renogy/RenogySensor.js");
 const RC=require("./Renogy/RenogyConstants.js")
 
 class RenogyRoverClient extends RenogySensor {
-
+/*
+          "batteryType": "electrical.charger.battery.type",
+          "batteryPercentage": "electrical.charger.battery.charge",
+          "batteryVoltage": "electrical.charger.battery.voltage",
+          "batteryCurrent": "electrical.charger.battery.current",
+          "controllerTemperature": "electrical.charger.temperature",
+          "batteryTemperature": "electrical.charger.battery.temperature",
+          "loadVoltage": "electrical.charger.load.voltage",
+          "loadCurrent": "electrical.charger.load.current",
+          "loadPower": "electrical.charger.load.power",
+          "pvVoltage": "electrical.charger.solar.voltage",
+          "pvCurrent": "electrical.charger.solar.current",
+          "pvPower": "electrical.charger.solar.power",
+          "maxChargingPowerToday": "electrical.charger.today.max",
+          "maxDischargingPowerToday": "electrical.charger.discharging.maximum",
+          "chargingAmpHoursToday": "electrical.charger.charged.today",
+          "powerGenerationToday": "electrical.charger.power.today",
+          "powerGenerationTotal": "electrical.charger.power.total",
+          "loadStatus": "electrical.charger.load.status",
+          "chargingStatus": "electrical.charger.status"
+*/
 
     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")
+            .default="electrical.chargers.{id}.battery.type"
         this.addMetadatum('batteryPercentage', 'ratio', "battery percentage",
              (buffer)=>{return buffer.readUInt16BE(3) })
+            .default="electrical.chargers.{id}.battery.soc"
+
         this.addMetadatum('batteryVoltage', 'V', "battery voltage",
             (buffer)=>{return buffer.readUInt16BE((5))/10})
+        .default="electrical.chargers.{id}.battery.voltage"
+
         this.addMetadatum('batteryCurrent', 'A', 'battery current',
             (buffer)=>{return buffer.readUInt16BE((7))/100})
+        .default="electrical.chargers.{id}.battery.current"
+
         this.addMetadatum('controllerTemperature', 'K', 'controller temperature',
             (buffer)=>{return buffer.readInt8((9))+273.15})
+        .default="electrical.chargers.{id}.controller.temperature"
+
         this.addMetadatum('batteryTemperature', 'K', 'battery temperature',
             (buffer)=>{return buffer.readInt8((10))+273.15})
+        .default="electrical.chargers.{id}.battery.temperature"
+
         this.addMetadatum('loadVoltage', 'V', 'load voltage',
             (buffer)=>{return buffer.readUInt16BE((11))/10})
+        .default="electrical.chargers.{id}.load.voltage"
+
         this.addMetadatum('loadCurrent',  'A', 'load current',
             (buffer)=>{return buffer.readUInt16BE((13))/100})
+        .default="electrical.chargers.{id}.load.current"
         this.addMetadatum('loadPower', 'W', 'load power',
             (buffer)=>{return buffer.readUInt16BE((15))})
+        .default="electrical.chargers.{id}.load.power"
         this.addMetadatum('pvVoltage', 'V', 'pv voltage',
             (buffer)=>{return buffer.readUInt16BE((17))/10})
+        .default="electrical.chargers.{id}.solar.voltage"
         this.addMetadatum('pvCurrent', 'A', 'pv current',
             (buffer)=>{return buffer.readUInt16BE((19))/100})
+        .default="electrical.chargers.{id}.solar.current"
         this.addMetadatum('pvPower', 'W', 'pv power',
             (buffer)=>{return buffer.readUInt16BE(21)})
+        .default="electrical.chargers.{id}.solar.power"
         this.addMetadatum('maxChargingPowerToday', 'W', 'max charging power today',
             (buffer)=>{return buffer.readUInt16BE(33)})
+        .default="electrical.chargers.{id}.charge.max.today"
         this.addMetadatum('maxDischargingPowerToday', 'W', 'max discharging power today',
             (buffer)=>{return buffer.readUInt16BE(35)})
+        .default="electrical.chargers.{id}.discharge.max.today"
         this.addMetadatum('chargingAmpHoursToday', 'Ah', 'charging amp hours today',
             (buffer)=>{return buffer.readUInt16BE(37)})
+        .default="electrical.chargers.{id}.charge.ampHours.today"
+
         this.addMetadatum('dischargingAmpHoursToday', 'Ah', 'discharging amp hours today',
             (buffer)=>{return buffer.readUInt16BE(39)})
+        .default="electrical.chargers.{id}.discharge.ampHours.today"
+
         this.addMetadatum('powerGenerationToday', 'W', 'power generation today',
             (buffer)=>{return buffer.readUInt16BE(41)})
+        .default="electrical.chargers.{id}.power.generated.today"
+
         this.addMetadatum('powerConsumptionToday', 'W', 'power consumption today',
             (buffer)=>{return buffer.readUInt16BE(43)})
+        .default="electrical.chargers.{id}.power.consumed.today"
+
         this.addMetadatum('powerGenerationTotal', 'W', 'power generation total',
             (buffer)=>{return buffer.readUInt32BE(59)})
+         .default="electrical.chargers.{id}.power.generated.total"
+
         this.addMetadatum('loadStatus', '',  'load status',
             (buffer)=>{return RC.LOAD_STATE[buffer.readUInt8(67)>>7]})
+         .default="electrical.chargers.{id}.load.status"
 
         this.addMetadatum('chargingStatus', '', 'charging status',
-            (buffer)=>{return RC.CHARGING_STATE[buffer.readUInt8(68)]})
+            (buffer)=>{
+                const cs = buffer.readUInt8(68)
+                if (Object.hasOwn(RC.CHARGING_STATE,cs))
+                    return RC.CHARGING_STATE[cs]
+                else
+                    return null
+            })
+
+         .default="electrical.chargers.{id}.charge.status"
+
     }
     
     retrieveDeviceID(){