bt-sensors-plugin-sk 1.3.0 → 1.3.2

package/BTSensor.js

@@ -856,6 +856,10 @@ class BTSensor extends EventEmitter {
         return this.currentProperties?.RSSI??NaN
     }
 
+    isPaired(){
+        return this.currentProperties?.Paired??false
+    }
+
     getSignalStrength(){
         const rssi =  this.getRSSI()
         if (!rssi) 

package/README.md

@@ -1,6 +1,16 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org) 
 
 ## WHAT'S NEW  
+# Version 1.3.2
+
+- Victron Alarm Reason improvements
+- VictronOrionXS offReason text implementation
+- Shelly Blu H&T description changes 
+
+# Version 1.3.1
+
+- JBD Protection status
+- SensorPush devices (untested)
 
 # Version 1.3.0
 
@@ -112,7 +122,7 @@ It's pretty easy to write and deploy your own sensor class for any currently uns
 |[Jikong](https://jikongbms.com/)| https://jikongbms.com/product/ |
 |[Junctek](https://www.junteks.com)|[Junctek BMS](https://www.junteks.com/pages/product/index) |
 |[Remoran](https://remoran.eu)| [Remoran Wave.3](https://remoran.eu/wave.html)|
-|[AC DC Systems](https://marinedcac.com) | [Bank Manager] hybrid (Pb and Li) charger(https://marinedcac.com/pages/bankmanager)|
+|[AC DC Systems](https://marinedcac.com) | [Bank Manager](https://marinedcac.com/pages/bankmanager) hybrid (Pb and Li) charger|
 |[Ective](https://ective.de/)| Also Topband(?), Skanbatt and others |
 
 ### Environmental 
@@ -128,6 +138,7 @@ It's pretty easy to write and deploy your own sensor class for any currently uns
 |[Govee](http://www.govee.com)| Govee H50xx and H510x Temperature and humidity sensors |
 |[BTHome](https://bthome.io/)| NOTE: Framework for IOT sensor devices. |
 |[Inkbird](https://inkbird.com/)| TH-2 Temp and Humidity Sensor |
+|[SensorPush](https://www.sensorpush.com/)| Temperature, Humidity and Atmospheric Pressure sensor|
 
 
 ### Tanks 

package/index.js

@@ -110,7 +110,7 @@ class MissingSensor  {
 	on(){
 
 	}
-
+	stopNotifications(){}
 	isError(){
 		return true
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "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": {

package/sensor_classes/GobiusCTankMeter.js

@@ -348,7 +348,7 @@ class GobiusCTankMeter extends BTSensor{
     }
 
     async deactivateGATT(){
-        await this.stopNotifications(this.characteristic)
+        await this.stopGATTNotifications(this.characteristic)
         await super.deactivateGATT()
     }
    

package/sensor_classes/JBDBMS.js

@@ -62,15 +62,41 @@ class JBDBMS extends BTSensor {
         .read=(buffer)=>{return buffer.readUInt16BE(12)} 
 
       this.addMetadatum('protectionStatus', '', 'Protection Status',
-        (buffer)=>{return buffer.readUInt16BE(20)} )
+        (buffer)=>{
+          const bits = buffer.readUInt16BE(20).toString(2)
+          return {    
+		        singleCellOvervolt: bits[0]=='1',
+		        singleCellUndervolt: bits[1]=='1',
+		        packOvervolt: (bits[2]=='1'),
+		        packUndervolt: bits[3]=='1',
+		        chargeOvertemp:bits[4]=='1',
+		        chargeUndertemp:bits[5]=='1',
+		        dischargeOvertemp:bits[6]=='1',
+		        dischargeUndertemp:bits[7]=='1',
+		        chargeOvercurrent:bits[8]=='1',
+		        dischargeOvercurrent:bits[9]=='1',
+		        shortCircut:bits[10]=='1',
+		        frontEndDetectionICError:bits[11]=='1',
+		        softwareLockMOS:bits[12]=='1',
+          }  
+        })
         .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"
+
+
+      this.addMetadatum('FET', '', 'FET On/Off Status',
+          (buffer)=>{return buffer.readUInt8(24) !=0 } )
+          .default="electrical.batteries.{batteryID}.FETStatus"
+  
+      this.addMetadatum('FETCharging', '', 'FET Status Charging',
+          (buffer)=>{return (buffer.readUInt8(24) & 0x1) !=0  })
+          .default="electrical.batteries.{batteryID}.FETStatus.charging"
+
+      this.addMetadatum('FETDischarging', '', 'FET Status Discharging',
+          (buffer)=>{return (buffer.readUInt8(24) & 0x2) !=0 })
+          .default="electrical.batteries.{batteryID}.FETStatus.discharging"
   
         await this.deviceConnect() 
         const gattServer = await this.device.gatt()

package/sensor_classes/SensorPush.js

@@ -0,0 +1,123 @@
+const BTSensor = require("../BTSensor");
+class SensorPush extends BTSensor{
+    static Domain = BTSensor.SensorDomains.environmental
+        
+    static async identify(device){
+        
+        const name = await this.getDeviceProp(device,"Name")
+        const regex= /^SensorPush\s(HT|HTP)\s[0-9a-fA-F]{4}$/
+        if (name && name.match(regex))
+            return this 
+        else
+            return null
+    }
+    static ImageFile="SensorPush.webp"
+    static Manufacturer="Cousins & Sears - Creative Technologists - Brooklyn, NY USA"
+    static ServiceUUID = "EF090000-11D6-42BA-93B8-9DD7EC090AB0"
+    static Characteristics = 
+        {
+            tx:   "EF090003-11D6-42BA-93B8-9DD7EC090AA9",
+            adv:  "EF090005-11D6-42BA-93B8-9DD7EC090AA9",
+            batt: "EF090007-11D6-42BA-93B8-9DD7EC090AA9",
+            LED:  "EF09000C-11D6-42BA-93B8-9DD7EC090AA9",
+            temp: "EF090080-11D6-42BA-93B8-9DD7EC090AA9",
+            hum:  "EF090081-11D6-42BA-93B8-9DD7EC090AA9",
+            bar:  "EF090082-11D6-42BA-93B8-9DD7EC090AA9"
+        }
+    pollFreq=30
+    hasGATT(){
+        return true
+    }
+    usingGATT(){
+        return true
+    }
+    
+
+    async emitGATT(){
+        this.characteristics.temp.writeValue(0x01000000).then(async ()=>{
+            this.emitData("temp", await this.characteristics.temp.readValue())
+            this.emitData("hum", await this.characteristics.temp.readValue())
+        })
+        this.characteristics.bar.writeValue(0x01000000).then(async ()=>{
+            this.emitData("bar", await this.characteristics.bar.readValue())
+        })
+    }
+
+     initSchema(){
+        super.initSchema()
+        this.getGATTParams()["useGATT"].default=true
+        
+        this.addDefaultParam("zone")
+
+        this.addParameter(
+        "tx",
+            {
+                title:'transmission rate in db',
+                type: 'number',
+                enum: [-21, -18, -15, -12, -9, -6, -3, 0, 1, 2, 3, 4, 5],
+                default: -3,
+                isRequired: true
+            }
+        )
+        this.addParameter(
+        "adv",
+            {
+                title:'advertising interval in ms',
+                type: 'number',
+                default: 1285,
+                minimum: Math.round((32*625)/1000),
+                maximum: Math.round((32767*625)/1000),
+                isRequired: true
+            }
+      )
+
+       this.addParameter(
+        "LED",
+            {
+                type: 'number',
+                title:'LED flashes per second (0=off, 1-127, 128=once every second',
+                default: 0,
+                minimum: 0,
+                maximum: 128,
+                isRequired: true
+            }
+      )
+
+        this.addDefaultPath("batt","sensors.batteryVoltage")
+        .read=(buffer)=>{ return buffer.readUInt16LE()/100}
+
+        this.addDefaultPath("temp","environment.temperature") 
+        .read=(buffer)=>{ return buffer.readInt32E()/100}
+       
+        this.addDefaultPath("humidity","environment.humidity") 
+        .read=(buffer)=>{ return buffer.readInt32E()/10000}
+
+        this.addDefaultPath("pressure","environment.pressure") 
+        .read=(buffer)=>{ return buffer.readInt32E()/100}
+
+    }
+
+    async initGATTConnection(isReconnecting){ 
+        await super.initGATTConnection(isReconnecting)
+        const gattServer = await this.getGATTServer() 
+        const service = await gattServer.getPrimaryService(this.constructor.ServiceUUID) 
+        this.characteristics={}
+        for (const c in this.constructor.Characteristics) {
+            this.characteristics[c] = await service.getCharacteristic(this.constructor.Characteristics[c])
+        }
+        if (this.tx) this.characteristics.tx.writeValueWithoutResponse(this.tx)
+        if (this.LED) this.characteristics.LED.writeValueWithoutResponse(this.LED)
+        if (this.adv) this.characteristics.tx.writeValueWithoutResponse(Math.round((this.adv/625)*1000))
+    }
+    async initGATTNotifications() { 
+
+    }
+  
+    async deactivateGATT(){
+        for (const c in this.characteristics) {
+            await this.stopGATTNotifications(this.characteristics[c])
+        }
+        await super.deactivateGATT()
+    }
+}
+module.exports=SensorPush

package/sensor_classes/ShellySBHT003C.js

@@ -20,10 +20,10 @@ class ShellySBHT003C extends AbstractBTHomeSensor {
 
 	
 	getTextDescription(){
-		return `NOTE: Device must be paired with SignalK server machine to operate properly. For more information about the sensor go here: <a href=https://us.shelly.com/products/shelly-blu-h-t-black target="_blank">Shelly Blu H&T</a>.` 
+		return `NOTE: Device must be paired with SignalK server machine or you won't see updates (see: <a href=https://shelly-api-docs.shelly.cloud/docs-ble/common#pairing target="_blank">https://shelly-api-docs.shelly.cloud/docs-ble/common#pairing</a> ). For more information about the sensor go here: <a href=https://us.shelly.com/blogs/documentation/shelly-blu-h-t target="_blank">Shelly Blu H&T</a>.<br><br>Alternatively you can edit your /etc/bluetooth/main.conf file and set "TemporaryTimeout = 90" in the [General] section, then restart the bluetooth service.` 
 	}
 	
-	initSchema() {
+	initSchema() { 
 		super.initSchema()
 		this.addDefaultParam("zone")
 

package/sensor_classes/ShellySBMO003Z.js

@@ -20,11 +20,11 @@ class ShellySBMO003Z extends AbstractBTHomeSensor {
 	 * @type {string}
 	 */
 	static LOCAL_NAME="Shelly BLU Motion";
-	static ImageFile="ShellyBLUMotion.webp"
+	static ImageFile="ShellyBLUMotion.webp" 
    	
 	getTextDescription(){
-		return `NOTE: Device must be paired with SignalK server machine to operate properly. For more information about the sensor go here: <a href=https://us.shelly.com/products/shelly-blu-motion target="_blank">Shelly Blu Motion</a>.` 
-	}
+		return `${!this.isPaired()?"NOTE: Device must be paired with SignalK server machine to operate properly (see: <a href=https://shelly-api-docs.shelly.cloud/docs-ble/common#pairing target=\"_blank\">https://shelly-api-docs.shelly.cloud/docs-ble/common#pairing</a> ":"Device is paired."}).<br><br>For more information about the sensor click here: <a href=https://us.shelly.com/products/shelly-blu-motion target="_blank">Shelly Blu Motion</a>.` 
+	} 
 
 	initSchema() {
 		super.initSchema()
@@ -62,20 +62,6 @@ class ShellySBMO003Z extends AbstractBTHomeSensor {
 		.default="sensors.{macAndName}.button"
 
 
-/*
-		this.addMetadatum(
-			"packetID",
-			null,
-			"packetID from sensor",
-			this.parsePacketID.bind(this)
-		)
-		.default="sensors.{macAndName}.packetID"
-*/
-
-	}
-	getState() {
-	
-	return super.getState()
 	}
 }
 

package/sensor_classes/ShenzhenLiOnBMS.js

@@ -18,6 +18,14 @@ const ProtectionStatus = {
  0x4000: "Short Circuit Protection"
 }
 
+const BatteryState = {
+    0: "Discharging/Idle",
+    1: "Charging",
+    2: "Discharging",
+    4: "Charge Disabled"
+
+}
+
 class ShenzhenLiONBMS extends BTSensor{
     static Domain = BTSensor.SensorDomains.electrical
     static ImageFile = "LiTimeLiFePo4Battery.avif"
@@ -91,6 +99,9 @@ class ShenzhenLiONBMS extends BTSensor{
             this.addMetadatum(`cell${cellNum+1}Voltage`,'V', `cell #${cellNum+1} voltage`,
                 (buff)=>{return buff.readInt16LE(16+(cellNum*2)) /1000})
             .default=`electrical.batteries.{batteryID}.cells.${cellNum+1}.voltage`
+
+            this.addMetadatum(`cell${cellNum+1}Balancing`,'', `cell #${cellNum+1} balance state (true=balancing)`)
+            .default=`electrical.batteries.{batteryID}.cells.${cellNum+1}.balancing`
         }
 
         this.addDefaultPath('current','electrical.batteries.current')
@@ -119,19 +130,15 @@ class ShenzhenLiONBMS extends BTSensor{
             .default="electrical.batteries.{batteryID}.balanceMemoryActive"
 
         this.addMetadatum('protectionState','', 'protection state',
-                (buff)=>{return buff.slice(76,80).reverse().join("")})
+                (buff)=>{return ProtectionStatus[buff.readUInt16LE(76)]??"Normal"})
             .default="electrical.batteries.{batteryID}.protectionState"
 
         this.addMetadatum('failureState','', 'failure state',
                 (buff)=>{return buff.slice(80,84).reverse().join("").slice(-3)})
             .default="electrical.batteries.{batteryID}.failureState"
-        
-        this.addMetadatum('balanceState','', '1 = cell at offset is balancing',
-                (buff)=>{return buff.slice(84,88).reverse().join("")})
-            .default="electrical.batteries.{batteryID}.balanceState"
 
         this.addMetadatum('batteryState','', 'charge disabled = "0004", charging = "0001" (when charging active app will show estimated time untill fully charged), discharging/idle: "0000", unkown = "0002"',
-            (buff)=>{return buff.slice(88,90).reverse().join("")})
+            (buff)=>{return (BatteryState[buff.readUInt16LE(88)])??"Unknown"})
         .default="electrical.batteries.{batteryID}.batteryState"
 
         this.addMetadatum('dischargeCount','', 'discharge count',
@@ -148,6 +155,16 @@ class ShenzhenLiONBMS extends BTSensor{
         this.getJSONSchema().properties.params.required=["batteryID", "numberOfCells" ]
     }
 
+    emitValuesFrom(buffer){
+        super.emitValuesFrom(buffer)
+        const balanceState= buffer.slice(84,88).reverse().join("")
+
+        for(let cellNum=0; cellNum < this?.numberOfCells??4; cellNum++) {
+            this.emit(`cell${cellNum+1}Balancing`, balanceState[cellNum]==='1')
+        }
+
+    }
+
     async initGATTConnection(isReconnecting){ 
 
         await super.initGATTConnection(isReconnecting)