bt-sensors-plugin-sk 1.2.4-3 → 1.2.5-1

package/BTSensor.js

@@ -74,7 +74,7 @@ function preparePath(obj, str) {
             evalResult= evalResult.call(obj)
         }
 
-        resultString += evalResult !== undefined ? evalResult : `${keyToAccess}_value_undefined`;
+        resultString += evalResult !== undefined ? evalResult.replace(/\s+/g,'_') : `${keyToAccess}_value_undefined`;
       } catch (error) {
         console.error(`Error accessing key '${keyToAccess}':`, error);
         resultString += fullMatch; // Keep the original curly braces on error
@@ -405,6 +405,12 @@ class BTSensor extends EventEmitter {
         if (!param.type)
             param.type="string"
 
+        if (param.isRequired) {
+            if (!Object.hasOwn(this._schema.properties.params, "required"))
+                this._schema.properties.params.required=[tag]
+            else
+                this._schema.properties.params.required.push(tag)
+        }
         this._schema.properties.params.properties[tag]=param
         return this._schema.properties.params.properties[tag]
     }
@@ -413,6 +419,13 @@ class BTSensor extends EventEmitter {
         if (!path.type)
             path.type="string"
 
+        if (path.isRequired) {
+            if (!Object.hasOwn(this._schema.properties.paths, "required"))
+                this._schema.properties.paths.required=[tag]
+            else
+                this._schema.properties.paths.required.push(tag)
+        }
+
         if (!path.pattern)
             path.pattern=//"^(?:[^{}\\s]*\\{[a-zA-Z0-9]+\\}[^{}\\s]*|[^{}\\s]*)$"
                 "^((\\{[a-zA-Z0-9]+\\}|[a-zA-Z0-9]+))(\\.(\\{[a-zA-Z0-9]+\\}|[a-zA-Z0-9]+))*$"
@@ -424,7 +437,13 @@ class BTSensor extends EventEmitter {
 
         if (!param.type)
             param.type="string"
-        
+
+        if (param.isRequired) {
+            if (!Object.hasOwn(this._schema.properties.gattParams, "required"))
+                this._schema.properties.gattParams.required=[tag]
+            else
+                this._schema.properties.gattParams.required.push(tag)
+        }
         return this._schema.properties.gattParams.properties[tag]=param
     }
 
@@ -433,8 +452,10 @@ class BTSensor extends EventEmitter {
         return this.addPath(tag,Object.assign({}, path))
     }
 
-    addDefaultParam(tag){        
-        return this.addParameter(tag,Object.assign({}, BTSensor.DEFAULTS.params[tag]))
+    addDefaultParam(tag,required=false){        
+        const param = Object.assign({}, BTSensor.DEFAULTS.params[tag])
+        param.isRequired=required
+        return this.addParameter(tag,param)
     }
 
     getJSONSchema(){
@@ -866,12 +887,14 @@ class BTSensor extends EventEmitter {
 		Object.keys(this.getPaths()).forEach((tag)=>{
             const pathMeta=this.getPath(tag)
             const path = config.paths[tag]
-            if (!(path===undefined))
+            if (!(path===undefined)) {
+                const preparedPath  =
                 this.app.handleMessage(id, 
                 {
                 updates: 
-                    [{ meta: [{path: preparePath(this, path), value: { units: pathMeta?.unit }}]}]
+                    [{ meta: [{path:  preparePath(this, path), value: { units: pathMeta?.unit }}]}]
                 })
+            }
         })
 	}
 
@@ -881,11 +904,12 @@ class BTSensor extends EventEmitter {
             const pathMeta=this.getPath(tag)
 			const path = deviceConfig.paths[tag];
 			if (!(path === undefined)) {
+                let preparedPath =  preparePath(this, path)
                 this.on(tag, (val)=>{
 					if (pathMeta.notify){
 						this.app.notify(tag, val, id )
 					} else {
-						this.updatePath(preparePath(this,path),val, id, source)
+						this.updatePath(preparedPath,val, id, source)
 					}
                 })
 			}
@@ -898,6 +922,9 @@ class BTSensor extends EventEmitter {
         return (Date.now()-this?._lastContact??Date.now())/1000
     }
 
+    prepareConfig(config){
+        config.params.sensorClass=this.constructor.name
+    }
 
 }
 

package/README.md

@@ -1,6 +1,23 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org) 
+
 ## WHAT'S NEW  
 
+# Version 1.2.5-1
+
+- Reverted change from 1.2.5 to path's source field 
+- Victron Sensor model ID and name improvements to constistency for VE Smart Networking enabled devices
+- Improved initial startup responsiveness 
+
+# Version 1.2.5
+
+- On initial startup, plugin saves default configuration. Fixing the "missing" configured devices after restart.
+- Mopeka Tank Sensor configuration fix
+- Added number of found devices in a domain in the configuration screen's domain tab
+
+# Version 1.2.4-4
+
+Junctek support (tested)
+
 # Version 1.2.4-3
 
 - Mercury Smartcraft fixes (working now!)
@@ -185,6 +202,11 @@ Poorly shielded USB 3.0 and HDMI (5ghz) can interfere with BT transmission (2.4g
 - There's no way that I know of to remove a SK Path without restarting the server. So if any active paths are changed by the plugin, you'll still see them hanging around in the data browser growing stale until you restart the server.
 - RPi 3/4/5/CM400s when running an Access Point on the on board Wifi can cause a problem connecting to devices through the onboard BT. The only known fix is to disable the onboard Bluetooth and use a USB BT adapter. Alternatively, you can use a USB WiFi adapter. NOTE: This only applies to _connected_ devices like Renogy devices, LiTime batteries etc. 
 
+### Problems saving the configuration after installing plugin for first time (fixed as of Version 1.2.5)  
+
+Device config after being saved will appear to be "missing" after restarting. The config is in fact saved in the plugin config directory. All you have to do is Submit the main configuration then enable and optionally disable Debug. This, believe it or not, ensures that the config is marked as enabled. You should see your data now and upon restart. 
+
+
 ## CONFIGURATION
 
 After installing and restarting Signalk you should see a "BT Sensors Plugin" option in the Signalk->Server->Plugin Config page.<br><br>

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
+}