bt-sensors-plugin-sk 1.1.0-beta.2.2.0.1 → 1.1.0-beta.2.2.1.1

package/BTSensor.js

@@ -227,7 +227,7 @@ class BTSensor extends EventEmitter {
         const _propsProxy = await this._getPropsProxy(device)
         try{
             const rawProps = await _propsProxy.Get(device.helper.iface,prop)
-            return rawProps?.value
+            return rawProps?.value 
         }
         catch(e){
             return null //Property $prop (probably) doesn't exist in $device
@@ -258,7 +258,7 @@ class BTSensor extends EventEmitter {
         if (!md) return null 
         const keys = Object.keys(md)
         if (keys && keys.length>0){
-            return parseInt(keys[0])
+            return parseInt(keys[keys.length-1])
         }
         return null
     }

package/README.md

@@ -1,8 +1,16 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org)
 
+## BETA 2.2.1
+
+### What's New
+
+GoveeH50xx sensor support. Selectable bluetooth adapter on config screen (in case you have more than bluetooth adapter on your server).
+
+
 ## BETA 2.2.0
 
 ### What's New
+
 Support for Aranet4 environment sensor and Renogy Rover/Wanderer Controllers. Untested support for Renogy Battery and Inverter clients. If you have a Renogy Battery or Inverter with bluetooth support, please give it a try and let me know how it goes. 
 
 ### RENOGY NOTES 
@@ -30,7 +38,7 @@ Signalk users with a Linux boat-puter (Windows and MacOS are NOT currently suppo
 
 ## REQUIREMENTS
 
-* A Linux Signalk boat-puter with System-D (NOTE: Most Linux installations support System-D)
+* A Linux Signalk boat-puter with bluetooth-DBUS support 
 * A Bluetooth adapter
 * [Bluez](https://www.bluez.org) installed
 (Go here for [Snap installation instructions](https://snapcraft.io/bluez))
@@ -57,6 +65,7 @@ If you want to install directly from source (this is mostly of interest to custo
   git clone https://github.com/naugehyde/bt-sensors-plugin-sk
   cd bt-sensors-plugin-sk
   git switch '1.1.0'
+  git pull
   npm i
   [sudo] npm link
   cd [signalk_home] 

package/index.js

@@ -176,8 +176,11 @@ module.exports =  function (app) {
 		"2) You will have to wait until the scanner has found your device before seeing your device's config fields and saving the configuration. \n"+
 		"3) To refresh the list of available devices and their configurations, just open and close the config screen by clicking on the arrow symbol in the config's top bar. \n"+
 		"4) If you submit and get errors it may be because the configured devices have not yet all been discovered.",
-		required:["discoveryTimeout", "discoveryInterval"],
+		required:["adapter","discoveryTimeout", "discoveryInterval"],
 		properties: {
+			adapter: {title: "Bluetooth adapter",
+				type: "string", default: "hci0"},
+
 			discoveryTimeout: {title: "Default device discovery timeout (in seconds)", 
 				type: "integer", default: 30,
 				minimum: 10,
@@ -422,13 +425,32 @@ module.exports =  function (app) {
 		sensorMap.clear()
 		deviceConfigs=options?.peripherals??[]
 
+		
+
 		if (plugin.stopped) {
 			await sleep(5000) //Make sure plugin.stop() completes first			
 						  //plugin.start is called asynchronously for some reason
 						  //and does not wait for plugin.stop to complete
 			plugin.stopped=false
 		}
-		adapter = await bluetooth.getAdapter(app.settings?.btAdapter??adapterID)
+		var adapterID=options.adapter
+
+		if (!adapterID || adapterID==="")
+			adapterID = "hci0"
+
+		app.debug(`Connecting to bluetooth adapter ${adapterID}`);
+
+		const activeAdapters = await bluetooth.activeAdapters()
+		plugin.schema.properties.adapter.enum=[]
+		plugin.schema.properties.adapter.enumNames=[]
+		for (a of activeAdapters){
+			plugin.schema.properties.adapter.enum.push(a.adapter)
+			plugin.schema.properties.adapter.enumNames.push(`${a.adapter} @ ${ await a.getAddress()} (${await a.getName()})`)
+		}
+
+		plugin.uiSchema.adapter={'ui:disabled': (activeAdapters.length==1)}
+
+		adapter = await bluetooth.getAdapter(adapterID)
 		await startScanner()
 		if (starts>0){
 			app.debug(`Plugin ${packageInfo.version} restarting...`);

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.1.0-beta.2.2.0.1",
+  "version": "1.1.0-beta.2.2.1.1",
   "description": "Bluetooth Sensors for Signalk -- support for Victron devices, RuuviTag, Xiaomi, ATC and Inkbird, Ultrasonic wind meters, Mopeka tank readers, Renogy Battery and Solar Controllers (new), Aranet4 environment sensors, and Govee GVH51xx temp sensors",
   "main": "index.js",
   "dependencies": {
     "dbus-next": "^0.10.2",
-    "node-ble": "^1.9.0",
+    "node-ble": "^1.12.0",
     "int24":"^0.0.1"
   },
   "scripts": {

package/sensor_classes/ATC.js

@@ -51,6 +51,8 @@ class ATC extends BTSensor{
     }
     propertiesChanged(props){
         super.propertiesChanged(props)    
+        if (!props.hasOwnProperty("ServiceData")) return
+
         const buff = this.getServiceData("0000181a-0000-1000-8000-00805f9b34fb")
         if (!buff)
             throw new Error("Unable to get service data for "+this.getDisplayName())

package/sensor_classes/Aranet2.js

@@ -34,7 +34,9 @@ class Aranet2 extends AranetSensor{
         
     }
     propertiesChanged(props){
-        super.propertiesChanged(props)    
+        super.propertiesChanged(props)
+        if (!props.hasOwnProperty("ManufacturerData")) return
+
         const buff = this.getManufacturerData(0x0702)
         this.emitData("temp", buff)
         this.emitData("humidity", buff)

package/sensor_classes/Aranet4.js

@@ -39,6 +39,8 @@ class Aranet4 extends AranetSensor{
     }
     propertiesChanged(props){
         super.propertiesChanged(props)    
+        if (!props.hasOwnProperty("ManufacturerData")) return
+
         const buff = this.getManufacturerData(0x0702)
         this.emitData("co2", buff)
         this.emitData("temp", buff)

package/sensor_classes/BlackListedDevice.js

@@ -2,10 +2,13 @@ const BTSensor = require("../BTSensor");
 class BLACKLISTED extends BTSensor{
     static isSystem = true
     static async identify(device){
-        if (await this.getManufacturerID(device)===0x004C)   //apple devices use 
-            return this                                     //randomised macs and clog up our list
-        else
-            return null
+        const md = await this.getDeviceProp(device,'ManufacturerData')
+        if (md){
+            const keys = Object.keys(md)
+            if (keys.length==1 && keys[0]==0x004C)
+                return this
+        }
+        return null
     }
     async init(){
         await super.init()
@@ -13,7 +16,7 @@ class BLACKLISTED extends BTSensor{
     }
     reasonForBlacklisting() {
         switch ( this.getManufacturerID()){
-            case (0x004C): return "Randomized MAC address"
+            case (0x004C): return "Randomized MAC address (Apple)"
             case (0x02e1): return "Device is using VE.Smart" //NOTE: Victron/VictronSensor class 
                                                              //determines if a device is using VE.Smart
                                                              //in identify(). If so, identify() returns

package/sensor_classes/GoveeH50xx.js

@@ -0,0 +1,47 @@
+const BTSensor = require("../BTSensor");
+
+class GoveeH50xx extends  BTSensor {
+
+    static async  identify(device){
+        const regex = /^Govee_H50[0-9]{2}_[a-f,A-F,0-9]{4}$/
+        //this.getManufacturer()
+        const name = await this.getDeviceProp(device,"Name")
+        const uuids = await this.getDeviceProp(device,'UUIDs')
+ 
+        if (name && name.match(regex) && 
+            uuids && uuids.length > 0 && 
+            uuids[0] == '0000ec88-0000-1000-8000-00805f9b34fb')
+            return this
+        else
+            return null
+        t
+    }
+
+    async init(){
+        await super.init()
+        this.initMetadata()
+    }
+    initMetadata(){
+        this.addMetadatum('temp','K', 'temperature', 
+            (buffer)=>{return 273.15+(buffer.readUInt16LE(1)/100) 
+        })
+        this.addMetadatum('humidity','ratio', 'humidity', 
+            (buffer)=>{return buffer.readUInt16LE(3)/10000    
+        })
+        this.addMetadatum('battery','ratio', 'battery strength', (buffer)=>{return buffer.readUInt8(5)/100})
+    }
+
+    getManufacturer(){
+        return "Govee"
+    }
+    async propertiesChanged(props){
+        super.propertiesChanged(props)    
+        if (!props.hasOwnProperty("ManufacturerData")) return
+
+        const buffer = this.getManufacturerData(0xec88)
+        if (buffer) {
+            this.emitValuesFrom(buffer)
+        }      
+   }                         
+}
+module.exports=GoveeH50xx

package/sensor_classes/{GoveeTH.js → GoveeH510x.js}

@@ -18,10 +18,10 @@ function decodeTempHumid(tempHumidBytes) {
       return {t: tempAsFloat, h: humid};
     }
   }
-class GoveeTH extends BTSensor{
+class GoveeH510x extends BTSensor{
 
     static async  identify(device){
-        const regex = /^GVH5[0-9]{3}_[a-f,A-F,0-9]{4}$/
+        const regex = /^GVH510[0-9]_[a-f,A-F,0-9]{4}$/
         const name = await this.getDeviceProp(device,"Name")
         const uuids = await this.getDeviceProp(device,'UUIDs')
 
@@ -56,12 +56,12 @@ class GoveeTH extends BTSensor{
     }
     async propertiesChanged(props){
         super.propertiesChanged(props)    
-        if (props.ManufacturerData) {
-            const buffer = this.getManufacturerData(0x0001)
-            if (buffer) {
-               this.emitValuesFrom(buffer)
-            }      
-        }
+        if (!props.hasOwnProperty("ManufacturerData")) return
+
+        const buffer = this.getManufacturerData(0x0001)
+        if (buffer) {
+            this.emitValuesFrom(buffer)
+        }      
    }                         
 }
-module.exports=GoveeTH
+module.exports=GoveeH510x

package/sensor_classes/Inkbird.js

@@ -27,6 +27,7 @@ class Inkbird extends BTSensor{
     }
     async propertiesChanged(props){
         super.propertiesChanged(props)    
+        
         if (props.ManufacturerData) {
             const keys = Object.keys(this.currentProperties.ManufacturerData) 
             const key = keys[keys.length-1]

package/sensor_classes/SwitchBotTH.js

@@ -0,0 +1,81 @@
+const BTSensor = require("../BTSensor");
+
+class SwitchBotTH extends  BTSensor {
+    static async test(){
+
+        const p = {[this.ID.toString()]: [0xd8, 0x35, 0x34, 0x38, 0x4f, 0x70, 0x07, 0x02, 0x04, 0x96, 0x2c, 0x00]}
+        this.getDeviceProp=async ()=>{
+            return p
+        }
+        const c = await this.identify()
+        const sb = new c()
+        sb.initMetadata()
+        sb.currentProperties={}
+        sb.on("temp", (t)=>console.log(t))
+        sb.on("humidity", (h)=>console.log(h))
+        sb.on("battery", (b)=>console.log(b))
+
+        sb.propertiesChanged( {ManufacturerData: p})
+        
+        sb.propertiesChanged( {ServiceData: {[this.batteryService]:[0x77,0x00,0x64]}})
+
+    
+    }
+    static ID = 0x0969
+    static batteryService = "0000fd3d-0000-1000-8000-00805f9b34fb"
+    static async  identify(device){
+        const md = await this.getDeviceProp(device,'ManufacturerData')
+        if (!md) return null 
+        const keys = Object.keys(md)
+        if (keys && keys.length>0){
+            const id = keys[keys.length-1]
+            if (parseInt(id)==this.ID && md[id].length==12)
+                return this
+        } 
+        return null
+        
+    }
+
+    async init(){
+        await super.init()
+        this.initMetadata()
+    }
+    initMetadata(){
+        this.addMetadatum('temp','K', 'temperature', 
+            (buffer)=>{
+                return (27315+(((buffer[8] & 0x0F)/10 + (buffer[9] & 0x7F)) * (((buffer[9] & 0x80)>0)?100:-100)))/100
+            })
+        this.addMetadatum('humidity','ratio', 'humidity', 
+        
+            (buffer)=>{return (buffer[10] & 0x7F)/100    
+        })
+        
+        this.addMetadatum("battery", "ratio", "battery strength",
+            (buffer)=>{return buffer[2]/100}
+         )
+    }
+
+    getManufacturer(){
+        return "Wonder Labs"
+    }
+    getName() {
+        "SwitchBotTH"
+    }
+    async propertiesChanged(props){
+        super.propertiesChanged(props)    
+        if (props.ManufacturerData) {
+            const buffer = this.getManufacturerData(this.constructor.ID)
+            if (buffer) {
+                this.emitData("temp", buffer)
+                this.emitData("humidity", buffer)
+            }      
+        }
+        if (props.ServiceData) {
+            const buffer = this.getServiceData(this.constructor.batteryService)
+            if (buffer){
+                this.emitData("battery", buffer)
+            }
+        }
+   }                         
+}
+module.exports=SwitchBotTH

package/sensor_classes/UltrasonicWindMeter.js

@@ -19,12 +19,12 @@ class UltrasonicWindMeter extends BTSensor{
         )
         this.awsCharacteristic.readValue()
         .then((buffer)=>
-            this.emit("aws", buffer)
+            this.emitData("aws", buffer)
             
         )
         this.awaCharacteristic.readValue()
         .then((buffer)=>
-            this.emit("awa", buffer)   
+            this.emitData("awa", buffer)   
         )
 
     }

package/sensor_classes/Victron/VictronSensor.js

@@ -88,7 +88,7 @@ function sleep(x) {
     propertiesChanged(props){
         super.propertiesChanged(props)
         if (this.usingGATT()) return
-        
+        if (!props.hasOwnProperty("ManufacturerData")) return
         try{
             const md = this.getManufacturerData(0x2e1)
             if (md && md.length && md[0]==0x10){

package/sensor_classes/XiaomiMiBeacon.js

@@ -1,7 +1,7 @@
-const { throws } = require("assert");
 const BTSensor = require("../BTSensor");
 
 const crypto = require('crypto');
+const util = require('util');
 const { isGeneratorFunction } = require("util/types");
 
 const DEVICE_TYPES = new Map([
@@ -96,7 +96,7 @@ class XiaomiMiBeacon extends BTSensor{
     
     emitValues(buffer){
         this.emitData("temp", buffer, 0)
-        this.emitData("humidity", buffer,2)
+        this.emit("humidity", buffer.readUInt8(2)/100)
         this.emitData("voltage",buffer,3);
     }
     getManufacturer(){
@@ -164,6 +164,8 @@ class XiaomiMiBeacon extends BTSensor{
     propertiesChanged(props){
         super.propertiesChanged(props)
         if (this.usingGATT()) return
+        if (!props.hasOwnProperty("ServiceData")) return
+        
         const data = this.getServiceData(this.constructor.SERVICE_MIBEACON)
         var dec
         if (!this.encryptionKey){
@@ -180,14 +182,22 @@ class XiaomiMiBeacon extends BTSensor{
             throw new Error(`${this.getNameAndAddress()} received empty decrypted packet. Check that the bind/encryption key in config is correct.`)
 
         switch(dec[0]){
+        case 0x0D:
+            this.emitData("temp",dec,3)  
+            this.emitData("humidity",dec,5)      
+            break    
+
+        case 0x0A:
+            this.emitData("batteryStrength",dec,3)
+            break
         case 0x04:    
-            this.emit("temp",(dec.readInt16LE(3)/10)+273.15)  
+            this.emitData("temp",dec,3)  
             break        
         case 0x06:
-            this.emit("humidity",(dec.readInt16LE(3)/1000))          
+            this.emitData("humidity",dec,3)          
             break
         default:
-            throw new Error(`${this.getNameAndAddress()} unable to parse decrypted service data (${dec})`)
+            throw new Error(`${this.getNameAndAddress()} unable to parse decrypted service data (${util.inspect(dec)})`)
             
         }
     }
@@ -197,8 +207,11 @@ class XiaomiMiBeacon extends BTSensor{
         const md = this.addMetadatum("encryptionKey", "", "encryptionKey (AKA bindKey) for decryption")
         md.isParam=true
         this.addMetadatum('temp','K', 'temperature',
-            (buff,offset)=>{return ((buff.readInt16LE(offset))/100) + 273.1})
+            (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)})