bt-sensors-plugin-sk 1.3.7 → 1.3.8-beta2

package/.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

package/BTSensor.js

@@ -105,7 +105,7 @@ class BTSensor extends EventEmitter {
 
         Object.assign(this,config)
         Object.assign(this,gattConfig)
-    
+
         this._state = "UNKNOWN"
     }
     /**
@@ -155,7 +155,7 @@ class BTSensor extends EventEmitter {
     static _test(data, key, config={}){
         var b = Buffer.from(data.replaceAll(" ",""),"hex")
         const d = new this(null,config)
-        d.initMetadata() 
+        d.initSchema() 
         Object.keys(d.getPaths()).forEach((tag)=>{
                 d.on(tag,(v)=>console.log(`${tag}=${v}`))
         })
@@ -328,7 +328,7 @@ class BTSensor extends EventEmitter {
                         type: "integer", 
                         minimum: 0,
                         maximum: 600,
-                        default: 2*(this?.discoveryTimeout??30) },
+                        default: 2*(this?.discoveryTimeout??30) }
                     }
                 },
                 paths:{
@@ -346,12 +346,19 @@ class BTSensor extends EventEmitter {
 				title:`GATT Specific device parameters`,
 				description: this.getGATTDescription(),
 				type:"object",
+                required:[],
 				properties:{
                     useGATT: {title: "Use GATT connection", type: "boolean", default: true },
                     pollFreq: { type: "number", title: "Polling frequency in seconds"}
                 }
 			}
-		}
+		} else{
+            this._schema.properties.params.properties.minUpdateInterval=                        
+                {title: "Minimum update interval in milliseconds (0 to disable rate limiting).", 
+                type: "integer", 
+                minimum: 0,
+                default: 0 }
+        }
 
 
         //create the 'name' parameter
@@ -581,7 +588,7 @@ class BTSensor extends EventEmitter {
     isError(){
         return this._error
     }
-    deviceConnect(isReconnecting=false, autoReconnect=false) {
+    deviceConnect(isReconnecting=false, autoReconnect=false, timeout=30000) {
      
         return connectQueue.enqueue( async ()=>{
             this.debug(`Connecting... ${this.getName()}`)
@@ -596,10 +603,27 @@ class BTSensor extends EventEmitter {
                     this.setConnected(true)
                 })    
             }
-            await this.device.helper.callMethod('Connect')
+            const connectTimeoutID = setTimeout(
+                ()=>{
+                    const e = `Connect timed out. Unable to connect after ${timeout}ms.`
+                    this.setError(e)
+                    throw new Error(e)
+                }
+                ,timeout
+            ) 
+            try {
+                await this.device.helper.callMethod('Connect')
+            } catch (e) {
+                this.debug(e)
+                throw new Error(e.message)
+            }
+            finally {
+                clearTimeout(connectTimeoutID)
+            }
             this.setConnected(true)
-
+            this._lastContact = Date.now()
             this.debug(`Connected to ${this.getName()}`)
+            
             if (!isReconnecting) {
               this.device.helper.on(
                     "PropertiesChanged",
@@ -728,13 +752,20 @@ class BTSensor extends EventEmitter {
      * DBUS connection stays alive, doesn't tax resources and doesn't spit out spurious errors.
      */
     initPropertiesChanged(){
-
+        let lastPropsChanged = -1
         this._propertiesChanged.bind(this)
         this.device.helper._prepare()
         this.device.helper.on("PropertiesChanged",
             ((props)=> {
+                if ( this.minUpdateInterval && 
+                     lastPropsChanged>0 && 
+                     (Date.now() - lastPropsChanged) < this.minUpdateInterval) {
+                        this.debug(`Ignoring properties changed. Last update was ${Date.now() - lastPropsChanged} ms ago.`)
+                    return
+                }
                 try{
                     this._propertiesChanged(props)
+                    lastPropsChanged = Date.now()
                 }
                 catch(error){
                     this.debug(`Error occured on ${this.getNameAndAddress()}: ${error?.message??error}`)
@@ -851,7 +882,7 @@ class BTSensor extends EventEmitter {
     }
 
     getManufacturerData(key=null){
-        if (this.currentProperties.ManufacturerData)
+        if (this.currentProperties?.ManufacturerData)
             if (key)
                 return this.valueIfVariant (this.currentProperties.ManufacturerData[key])
             else
@@ -951,8 +982,8 @@ class BTSensor extends EventEmitter {
             this.currentProperties.ManufacturerData=this.valueIfVariant(props.ManufacturerData)
         if (this.isActive())
             this.propertiesChanged(props)
-
     }
+    
     propertiesChanged(props){
         //implemented by subclass
     }
@@ -973,7 +1004,7 @@ class BTSensor extends EventEmitter {
         this._currentValues[tag]=value
     }
 
-    emit(tag, value){
+    _emit(tag, value){
         super.emit(tag, value)
         if (this.usingGATT()) //update last contact time only for GATT devices 
                               //which do not receive propertyChanged events when connected

package/README.md

@@ -1,6 +1,20 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org) 
 
 ## WHAT'S NEW  
+# Version 1.3.8-beta2
+
+- SensorPush fixes
+
+# Version 1.3.8-beta1
+
+## New sensors
+
+- MicrotikTag 
+- SensorPush 
+
+## New features
+
+- Rate limiter
 
 # Version 1.3.7
 

package/bt-sensors-plugin-sk copy.json

@@ -0,0 +1,170 @@
+{
+  "configuration": {
+    "discoveryInterval": 10,
+    "peripherals": [
+      {
+        "active": true,
+        "discoveryTimeout": 30,
+        "params": {
+          "name": "ATC_9FF77E",
+          "zone": "inside.cabin",
+          "parser": "ATC-LE",
+          "sensorClass": "ATC"
+        },
+        "paths": {
+          "RSSI": "sensors.{macAndName}.RSSI",
+          "batteryStrength": "sensors.{macAndName}.battery.strength",
+          "voltage": "sensors.{macAndName}.battery.voltage",
+          "temp": "environment.{zone}.temperature",
+          "humidity": "environment.{zone}.humidity"
+        },
+        "mac_address": "A4:C1:38:9F:F7:7E"
+      },
+      {
+        "active": true,
+        "discoveryTimeout": 30,
+        "params": {
+          "name": "tps",
+          "zone": "inside.refrigerator",
+          "sensorClass": "Inkbird"
+        },
+        "paths": {
+          "RSSI": "sensors.{macAndName}.RSSI",
+          "temp": "environment.{zone}.temperature",
+          "battery": "sensors.{macAndName}.battery.strength"
+        },
+        "mac_address": "49:22:05:17:2B:AE"
+      },
+      {
+        "active": true,
+        "discoveryTimeout": 30,
+        "params": {
+          "name": "Ruuvi BC7E",
+          "zone": "inside.navdesk",
+          "sensorClass": "RuuviTag"
+        },
+        "paths": {
+          "RSSI": "sensors.{macAndName}.RSSI",
+          "temp": "environment.{zone}.temperature",
+          "humidity": "environment.{zone}.humidity",
+          "pressure": "environment.{zone}.pressure",
+          "accX": "sensors.{macAndName}.accX",
+          "accY": "sensors.{macAndName}.accY",
+          "accZ": "sensors.{macAndName}.accZ",
+          "battV": "sensors.{macAndName}.battery.voltage",
+          "mc": "sensors.{macAndName}.movementCounter",
+          "msc": "sensors.{macAndName}.measurementSequenceCounter"
+        },
+        "mac_address": "F9:B0:6E:63:BC:7E"
+      },
+      {
+        "active": true,
+        "discoveryTimeout": 30,
+        "params": {
+          "name": "SBMO-003Z-db1b",
+          "zone": "inside",
+          "sensorClass": "ShellySBMO003Z"
+        },
+        "paths": {
+          "RSSI": "sensors.{macAndName}.RSSI",
+          "motion": "environment.{zone}.motion",
+          "illuminance": "environment.{zone}.illuminance",
+          "battery": "sensors.{macAndName}.battery.strength",
+          "button": "sensors.{macAndName}.button"
+        },
+        "mac_address": "E8:E0:7E:97:DB:1B"
+      },
+      {
+        "active": true,
+        "discoveryTimeout": 30,
+        "params": {
+          "name": "LYWSD03MMC",
+          "zone": "inside.vberth",
+          "encryptionKey": "3985f4ebc032f276cc316f1f6ecea085",
+          "sensorClass": "XiaomiMiBeacon"
+        },
+        "paths": {
+          "RSSI": "sensors.{macAndName}.RSSI",
+          "temp": "environment.{zone}.temperature",
+          "humidity": "environment.{zone}.humidity",
+          "batteryStrength": "sensors.{macAndName}.battery.strength",
+          "voltage": "sensors.{macAndName}.battery.voltage"
+        },
+        "gattParams": {
+          "useGATT": false
+        },
+        "mac_address": "A4:C1:38:3E:7E:94"
+      },
+      {
+        "active": true,
+        "discoveryTimeout": 30,
+        "params": {
+          "name": "SmartShunt HQ2204C2GHD",
+          "batteryID": "house",
+          "encryptionKey": "8cce8529307cf9dd0c85611c4fef42d9",
+          "sensorClass": "VictronBatteryMonitor"
+        },
+        "paths": {
+          "RSSI": "sensors.{macAndName}.RSSI",
+          "current": "electrical.batteries.{batteryID}.current",
+          "power": "electrical.batteries.{batteryID}.power",
+          "voltage": "electrical.batteries.{batteryID}.voltage",
+          "alarm": "electrical.batteries.{batteryID}.alarm",
+          "consumed": "electrical.batteries.{batteryID}.capacity.ampHoursConsumed",
+          "soc": "electrical.batteries.{batteryID}.capacity.stateOfCharge",
+          "ttg": "electrical.batteries.{batteryID}.capacity.timeRemaining",
+          "starterVoltage": "electrical.batteries.secondary.voltage"
+        },
+        "gattParams": {
+          "useGATT": false
+        },
+        "mac_address": "D4:50:46:39:38:C5"
+      },
+      {
+        "active": true,
+        "discoveryTimeout": 90,
+        "params": {
+          "name": "aft propane tank",
+          "medium": "PROPANE",
+          "tankHeight": "325",
+          "id": "propane",
+          "sensorClass": "MopekaTankSensor"
+        },
+        "paths": {
+          "RSSI": "sensors.{macAndName}.RSSI",
+          "battVolt": "sensors.{macAndName}.battery.voltage",
+          "battStrength": "sensors.{macAndName}.battery.strength",
+          "temp": "tanks.{id}.temperature",
+          "tankLevel": "tanks.{id}.currentLevel",
+          "readingQuality": "sensors.{macAndName}.readingQuality",
+          "accX": "sensors.{macAndName}.accelerationXAxis",
+          "accY": "sensors.{macAndName}.accelerationYAxis"
+        },
+        "mac_address": "D4:40:59:BE:2A:8C"
+      },
+      {
+        "active": true,
+        "discoveryTimeout": 30,
+        "params": {
+          "name": "SBHT-003C",
+          "zone": "outside.deck",
+          "sensorClass": "ShellySBHT003C"
+        },
+        "paths": {
+          "RSSI": "sensors.{macAndName}.RSSI",
+          "battery": "sensors.{macAndName}.battery.strength",
+          "temp": "environment.{zone}.temperature",
+          "humidity": "environment.{zone}.humidity",
+          "button": "sensors.{macAndName}.button"
+        },
+        "mac_address": "7C:C6:B6:AF:49:5F"
+      }
+    ],
+    "adapter": "hci0",
+    "transport": "le",
+    "duplicateData": false,
+    "discoveryTimeout": 30
+  },
+  "enabled": true,
+  "enableDebug": false
+}

package/bt-sensors-plugin-sk.json.bak

@@ -0,0 +1,121 @@
+{
+  "configuration": {
+    "discoveryTimeout": 30,
+    "discoveryInterval": 0,
+    "peripherals": [
+      {
+        "active": true,
+        "mac_address": "D4:50:46:39:38:C5",
+        "discoveryTimeout": 30,
+        "params": {
+          "name": "Victron Smart Shunt",
+          "encryptionKey": "8cce8529307cf9dd0c85611c4fef42d9"
+        },
+        "paths": {
+          "RSSI": "sensors.smartshunt.rssi",
+          "current": "electrical.battery.house.current",
+          "power": "electrical.battery.house.power",
+          "voltage": "electrical.battery.house.voltage",
+          "alarm": "electrical.battery.house.alarm",
+          "consumed": "electrical.battery.house.consumedAh",
+          "soc": "electrical.battery.house.soc",
+          "ttg": "electrical.battery.house.ttg",
+          "starterVoltage": "electrical.battery.starter.voltage",
+          "__state__": "sensors.smartshunt.state"
+        },
+        "gattParams": {
+          "useGATT": false
+        }
+      },
+      {
+        "active": true,
+        "mac_address": "F9:B0:6E:63:BC:7E",
+        "discoveryTimeout": 30,
+        "params": {
+          "name": "Ruuvi sensor for cabin"
+        },
+        "paths": {
+          "RSSI": "sensors.ruuviBC7E.rssi",
+          "temp": "environment.cabin.temperature",
+          "humidity": "environment.cabin.humidity",
+          "pressure": "environment.cabin.pressure",
+          "battV": "sensors.ruuviBC7E.voltage",
+          "mc": "sensors.ruuviBC7E.movementCounter",
+          "battery": "sensors.temperature.reefer.batterystrength",
+          "__state__": "sensors.ruuviBC7E.state"
+        }
+      },
+      {
+        "active": true,
+        "mac_address": "49:22:05:17:2B:AE",
+        "discoveryTimeout": 120,
+        "params": {
+          "name": "Inkbird temperature sensor"
+        },
+        "paths": {
+          "RSSI": "sensors.inkbird-th2.rssi",
+          "temp": "environment.refrigerator.temperature",
+          "battery": "sensors.inkbird-th2.battery",
+          "__state__": "sensors.inkbird-th2.state"
+        }
+      },
+      {
+        "active": true,
+        "mac_address": "A4:C1:38:9F:F7:7E",
+        "discoveryTimeout": 300,
+        "params": {
+          "name": "ATC Temp/Humidity sensor for Deck",
+          "parser": "ATC-LE"
+        },
+        "paths": {
+          "RSSI": "sensors.ATC_9FF77E.rssi",
+          "temp": "environment.deck.temperature",
+          "humidity": "environment.deck.humidity",
+          "voltage": "sensors.ATC_9FF77E.voltage",
+          "batteryStrength": "sensors.ATC_9FF77E.batteryStrength",
+          "__state__": "sensors.ATC_9FF77E.state"
+        }
+      },
+      {
+        "active": true,
+        "mac_address": "D4:40:59:BE:2A:8C",
+        "discoveryTimeout": 30,
+        "params": {
+          "medium": "PROPANE",
+          "tankHeight": "304.8",
+          "name": "Galley propane level"
+        },
+        "paths": {
+          "RSSI": "sensors.mopeka-59be8c.rssi",
+          "battVolt": "sensors.mopeka-59be8c.battery.voltage",
+          "battStrength": "sensors.mopeka-59be8c.battery.strength",
+          "temp": "sensors.mopeka-59be8c.temperature",
+          "tankLevel": "sensors.mopeka-59be8c.tankLevel",
+          "readingQuality": "sensors.mopeka-59be8c.quality",
+          "__state__": "sensors.mopeka-59be8c.state"
+        }
+      },
+      {
+        "active": true,
+        "mac_address": "A4:C1:38:3E:7E:94",
+        "discoveryTimeout": 30,
+        "params": {
+          "encryptionKey": "3985f4ebc032f276cc316f1f6ecea085",
+          "__state__": "sensors.xiaomi.state"
+        },
+        "paths": {
+          "RSSI": "sensors.xiaomi.rssi",
+          "temp": "sensors.xiaomi.temp",
+          "humidity": "sensors.xiaomi.humidity",
+          "voltage": "sensors.xiaomi.voltage",
+          "__state__": "sensors.xiaomi.state"
+        },
+        "gattParams": {
+          "useGATT": false
+        }
+      }
+    ]
+  },
+  "enabled": true,
+  "enableDebug": true
+}

package/development/TestData/Jikong.json

@@ -0,0 +1,14 @@
+{
+"delay":100,
+"data":
+    {
+    "0x96": [
+"55 aa eb 90 10 e0 ac d0 00 00 28 a0 00 00 5a a0 00 00 42 e0 00 00 78 d0 00 00 50 00 00 00 79 d0 00 00 50 a0 00 00 7a d0 00 00 16 d0 00 00 ba 90 00 00 20 bf 20 00 30 00 00 00 3c 00 00 00 20 bf 20 00 2c 10 00 00 3c 00 00 00 1e 00 00 00 d0 70 00 00 bc 20 00 00 58 20 00 00 bc 20 00 00 58 20 00 00 9c ff ff ff 00 00 00 00 20 30 00 00 bc 20 00 00 40 00 00 00 10 00 00 00 10 00 00 00 10 00 00 00 f0 ba 40 00 50 ","00 00 00 5c d0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 10 00 00 00 00 00 00 00 20 a1 70 00 90 18 f6 00 18 fe ff ff ff 1f a9 6f e0 00 dd e2 00 7b"    ],
+    "0x97":[
+        "55 aa eb 90 00 3 c4 4a 4b 5f 42 32 41 38 53 32 30 50 00 0 00 0 00 00 00 31 31 2e 58 57 00 00 00 31 31 2e 32 36 31 00 00 68 96 c1 03 18 00 00 00 48 42 31 5f 42 34 00 00 00 00 00 00 00 00 00 00 31 32 33 34 00 00 00 00 00 00 00 00 00 00 00 00 32 33 30 38 31 34 00 00 33 30 32 32 38 34 34 32 36 37 00 30 30 30 30 00 49 6e 70 75 74 20 55 73 65 72 64 61 74 61 00 00 31 32 33 33 32 31 00 00 00 00",
+        "00 00 00 00 00 00 49 6e 70 75 74 20 55 73 65 72 64 61 74 61 00 00",
+        "7c f8 ff ff 1f 0d 00 00 00 00 00 00 90 0f 00 00 00 00 c0 d8 03 00 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00",
+        "00 00 00 00 00 00 00 00 00 fe 2f 00 00 00 00 00 00 00 00 00 00 bf"
+    ]
+    }
+}