bt-sensors-plugin-sk 1.2.6-beta → 1.2.6-beta-1

package/.vscode/settings.json

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

package/README.md

@@ -2,9 +2,15 @@
 
 ## WHAT'S NEW  
 
+# Version 1.2.6-beta-1
+
+- UI improvements for selecting Sensor Class (if available, paths appear immediately upon selection)
+- EcoWorthy Batteries/BMS (need testers)
+
 # Version 1.2.6-beta
 
-- Mopeka examples not defaults in config
+
+- Mopeka examples not defaults in config for underused paths
 - Fix so no plugin restart required after selecting sensor class for an unidentified device
 - FeasyCom BP108B support -- iBeacon/Eddystone protocols
 - Ective, Topband, Skanbatt etc LiFePo4 BMS support (ective.de)

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/classLoader.js

@@ -2,22 +2,22 @@ const fs = require('fs')
 const path = require('path')
 const semver = require('semver')
 
-    function loadClasses (dir, ext='.js')
+     function loadClasses (dir, ext='.js')
         {
             const classMap = new Map()
             const classFiles = fs.readdirSync(dir)
             .filter(file => file.endsWith(ext));
         
-            classFiles.forEach(file => {
+            classFiles.forEach( (file) => {
                 const filePath = path.join(dir, file);
-                const cls = require(filePath);
+                const cls = require (filePath)
                 classMap.set(cls.name, cls);
             })
             return classMap
         }
 
-      function loadClassMap(app) {
-        const _classMap = loadClasses(path.join(__dirname, 'sensor_classes'))
+       function loadClassMap(app) {
+        const _classMap =  loadClasses(path.join(__dirname, 'sensor_classes'))
         const classMap = new Map([..._classMap].filter(([k, v]) => !k.startsWith("_") ))
         const libPath = app.config.appPath +(
             semver.gt(app.config.version,"2.13.5")?"dist":"lib"
@@ -26,7 +26,7 @@ const semver = require('semver')
         const { default:defaultExport} = modulesjs
             const modules = defaultExport.modulesWithKeyword(app.config, "signalk-bt-sensor-class")
             modules.forEach((module)=>{
-                module.metadata.classFiles.forEach((classFile)=>{
+                module.metadata.classFiles.forEach(  (classFile)=>{
                     try{
                         const cls = require(module.location+module.module+"/"+classFile);
                         classMap.set(cls.name, cls);

package/development/FakeBTDevice.js

@@ -0,0 +1,57 @@
+import { EventEmitter } from "events";
+export class FakeGATTServer{
+  constructor(services){
+    this.services=services
+  }
+  getPrimaryService (uuid){
+    return this.services.find((service)=>{return service.uuid==uuid})
+  }
+}
+
+export class FakeGATTService{
+  constructor(uuid, characteristics=[]){
+    this.uuid=uuid
+    this.characteristics=characteristics
+  }
+  getCharacteristic (uuid){
+    return this.characteristics.find((characteristic)=>{return characteristic.uuid==uuid})
+  }
+}
+
+export class FakeGATTCharacteristic extends EventEmitter{
+  constructor(uuid, values=[], interval=1000){
+    super()
+    this.uuid=uuid
+    this.valueIndex=0
+    this.values=values
+    this.interval = interval
+  }
+  startNotifications(){
+      this.intervalID=setInterval(()=>{
+      if (this.values.length>0){
+        this.emit("valuechanged",Buffer.from(this.values[this.valueIndex++],"hex") )
+        if (this.valueIndex>=this.values.length)
+          this.valueIndex=0
+      }
+    },this.interval)
+
+  }
+  stopNotifications(){
+    this.clearInterval(this.intervalID)
+  }
+}
+
+export class FakeDevice{
+  constructor(services=[]){
+    this.gattServer=new FakeGATTServer(services)
+  }
+  connect(){
+    return this
+  }
+  gatt(){
+    return this.gattServer
+  }
+  disconnect(){
+
+  }
+}

package/development/package.json

@@ -0,0 +1,5 @@
+{
+
+  "type": "module"
+
+}