bt-sensors-plugin-sk 1.2.4-3 → 1.2.4-4

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,26 +887,29 @@ 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 }}]}]
                 })
+            }
         })
 	}
 
 	 initPaths(deviceConfig, id){
-        const source = this.getName()
+        const source = `${this.getName()} (bt-sensors-plugin-sk)`
 		Object.keys(this.getPaths()).forEach((tag)=>{
             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)
 					}
                 })
 			}

package/README.md

@@ -1,6 +1,17 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org) 
+
+## IMPORTANT NOTE TO NEW USERS
+
+There's a known issue with saving the configuration after initial installation owing to current ServerAPI limitations.
+
+Your device config after you've saved it will appear to be "missing" after restarting. It's 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. 
+
 ## WHAT'S NEW  
 
+# Version 1.2.4-4
+
+Junctek support (tested)
+
 # Version 1.2.4-3
 
 - Mercury Smartcraft fixes (working now!)
@@ -163,6 +174,10 @@ Finally, restart SK. Plugin should appear in your server plugins list.<br>
 
 ## KNOWN ISSUES
 
+### Problems saving the configuration after installing plugin for first time  
+
+Your device config after you've saved it will appear to be "missing" after restarting. It's 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. 
+
 ### Connected Devices on Raspberry Pi platform (4/4b/5/CM400/CM500)
 
 Onboard Raspberry Pi WiFi can cause interference with the onboard Bluetooth resulting in lost connections to GATT connected devices (Renogy, JBD, etc. )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.2.4-3",
+  "version": "1.2.4-4",
   "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/public/index.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<style>
+  .line {
+    fill: none;
+    stroke: steelblue;
+    stroke-width: 20px;
+  }
+</style>
+
+<body>
+  <h1>Bluetooth Sensors for SignalK</h1>
+
+  <script>
+
+    var margin = { top: 20, right: 20, bottom: 30, left: 50 },
+      width = 960 - margin.left - margin.right,
+      height = 300 - margin.top - margin.bottom;
+  
+
+
+  </script>
+<script src="main.js"></script><script src="remoteEntry.js"></script></body>

package/sensor_classes/BTHome/AbstractBTHomeSensor.js

@@ -235,7 +235,7 @@ class AbstractBTHomeSensor extends BTSensor {
 	 * Extracts motion detection from the given BTHome data.
 	 *
 	 * @param btHomeData {BTHomeServiceData.BthomeServiceData} The BTHome data provided by the device.
-	 * @returns {Boolean|null} The device's button press state.
+   * @returns {Boolean|null} Wether the device has detected motion.
 	 */
 	parseMotion(btHomeData) {
 		const motion = this.getSensorDataByObjectId(
@@ -304,6 +304,31 @@ class AbstractBTHomeSensor extends BTSensor {
 		return null;
 	}
 
+  /**
+   * Parses the opening (window/door) state from BTHome service data.
+   * @param {BTHomeServiceData.BthomeServiceData} btHomeData - The parsed BTHome data object.
+   * @returns {string|null} "open", "closed", or null if not present.
+   */
+  parseWindowState(btHomeData) {
+    const state = this.getSensorDataByObjectId(btHomeData, BTHomeServiceData.BthomeObjectId.BINARY_WINDOW)?.window;
+    if (state.intValue === 1) return "open";
+    if (state.intValue === 0) return "closed";
+    return null;
+  }
+
+  /**
+   * Parses the rotation from BTHome service data.
+   * @param {BTHomeServiceData.BthomeServiceData} btHomeData - The parsed BTHome data object.
+   * @returns {number|null} rotation in degrees from the closed position, or null if not present.
+   */
+  parseRotation(btHomeData) {
+    // Use the correct object ID for window event (0x2D, which is 45 in decimal, which is already specified in BthomeObjectId).
+    const sensorRotation = this.getSensorDataByObjectId(btHomeData, BTHomeServiceData.BthomeObjectId.SENSOR_ROTATION_0_1)?.rotation;
+    if (sensorRotation) {
+      return Number.parseFloat(sensorRotation.toFixed(2));
+    }
+    return null;
+  }
 
 	propertiesChanged(props) {
 		super.propertiesChanged(props);

package/sensor_classes/Junctek.js

@@ -5,7 +5,7 @@ const BTSensor = require("../BTSensor");
 function bytesToBase10String(bytes){
         let s = ""
         for (let byte of bytes){
-            s+=byte.toString(16)
+            s+=byte.toString(16).padStart(2,'0')
         }
         return s
     }
@@ -22,6 +22,8 @@ class JunctekBMS extends BTSensor{
         return null
     }
 
+    chargeDirection = 1 
+
     hasGATT(){
         return true
     }
@@ -47,12 +49,14 @@ class JunctekBMS extends BTSensor{
         this.addDefaultPath("charge",'electrical.batteries.capacity.charge')
         this.addDefaultPath("temperature",'electrical.batteries.temperature')
         this.addDefaultPath("actualCapacity",'electrical.batteries.capacity.actual')
+        this.addMetadatum('timeToCharged','s', 'time in seconds to battery is fully charged')
+            .default='electrical.batteries.{batteryID}.timeToCharged'
         this.addMetadatum('impedance','mOhm', 'measured resistance')
             .default='electrical.batteries.{batteryID}.impedance'
     }
 
     emitFrom(buffer){
-        var value=[], chargeDirection = 1
+        let value=[], emitObject={}
         this.debug(buffer)
         for (let byte of buffer){
             if (byte==0xBB) {
@@ -65,45 +69,62 @@ class JunctekBMS extends BTSensor{
             
             if (isNaN(parseInt(byte.toString(16)))){ //not a base-10 number. seriously. that's how Junctek does this.
                 const v = parseInt(bytesToBase10String(value))
+                //if (byte!==0xd5)
+                //    this.debug(`0x${(byte).toString(16)}: ${(value).map((v)=>'0x'+v.toString(16))} (${v})`)
                 value=[]
                 switch (byte){
                 case 0xC0:
-                    this.emit("voltage",v/100)
+                    emitObject["voltage"]=v/100
                     break
                 
                 case 0xC1:
-                    this.emit("current",(v/100)*chargeDirection)
+                    emitObject["current"]=()=>{return (v/100)*this.chargeDirection}
                     break
 
                 case 0xD1:
-                    if (byte==0)
-                        chargeDirection=-1
+                    this.debug(v)
+                    if (v==0)
+                        this.chargeDirection=-1
+                    else 
+                        this.chargeDirection= 1
+                    this.debug(this.chargeDirection)
                     break
 
                 case 0xD2:
-                    this.emit("remaining",v*3.6)
+
+                    emitObject["remaining"]=v*3.6
                     break
 
                 case 0xD3:
-                    this.emit("discharge",v/100000)
+                    emitObject["discharge"]= v/100000
                     break
                 case 0xD4:
-                    this.emit("charge",v/100000)
+                    emitObject["charge"]=v/100000
                     break
                 case 0xD6:
-                    this.emit("timeRemaining",v*60)
+                    if (chargeDirection==-1){
+                        emitObject["timeToCharged"] = NaN
+                        emitObject["timeRemaining"] = v*60
+                    }
+                    else {
+                        emitObject["timeRemaining"] = NaN
+                        emitObject["timeToCharged"] = v*60
+                    }
                     break
                 case 0xD7:
-                    this.emit("impedance",v/100)
+                    emitObject["impedance"]=v/100
                     break
                 case 0xD8:
-                    this.emit("power",(v/100)*chargeDirection)
+                    emitObject["power"]=()=>{
+                        this.debug(this.chargeDirection)
+                        return (v/100)*this.chargeDirection
+                    }
                     break
                 case 0xD9:
-                    this.emit("temperature",v + 273.15) //assume C not F
+                    emitObject["temperature"]=v + 173.15 //assume C not F -- raw value is c - 100
                     break
                 case 0xB1:
-                    this.emit("capacityActual",v /10 )
+                    emitObject["capacityActual"]=v /10
                     break
             }
             }
@@ -111,12 +132,16 @@ class JunctekBMS extends BTSensor{
                 value.push(byte)
             }
         }
+        for (const [key, value] of Object.entries(emitObject)) {
+                this.emit(key,value instanceof Function?value():value)
+        }
+        emitObject = {}
     }
     emitGATT(){
-        this.battCharacteristic.readValue()
+        /*this.battCharacteristic.readValue()
         .then((buffer)=>{
             this.emitFrom(buffer)
-        })
+        })*/
     }
     initGATTConnection(){ 
         return new Promise((resolve,reject )=>{ this.deviceConnect().then(async ()=>{ 

package/sensor_classes/MercurySmartcraft.js

@@ -45,10 +45,10 @@ class MercurySmartcraft extends BTSensor{
             "id",
             {
                 "title": "Engine ID",
-                "examples": ["port","starboard","p0","p1"]
+                "examples": ["port","starboard","p0","p1"],
+                "isRequired": true
             }
         )
-        this._schema.properties.params.required=["id"]
 
         this.addMetadatum("rpm","Hz","engine revolutions per sec", 
             (buffer)=>{return buffer.readUInt16LE(bo)/60}

package/sensor_classes/MopekaTankSensor.js

@@ -280,17 +280,19 @@ class MopekaTankSensor extends BTSensor{
         this.addParameter("medium",
             {
                 title:"type of liquid in tank",
-                enum: Object.keys(Media)
+                enum: Object.keys(Media),
+                isRequired: true
             }
         )
         this.addParameter("tankHeight",
             {
                 title:"height of tank (in mm)",
                 type:"number",
-                unit:"mm"
+                unit:"mm",
+                isRequired: true
             }
         )
-        this.addDefaultParam("id")
+        this.addDefaultParam("id", true)
 
         this.addDefaultPath("battVolt","sensors.batteryVoltage") 
             .read=((buffer)=>{ 

package/sensor_classes/ShellySBDW002C.js

@@ -0,0 +1,51 @@
+const BTHomeServiceData = require("./BTHome/BTHomeServiceData");
+const AbstractBTHomeSensor = require("./BTHome/AbstractBTHomeSensor");
+
+/**
+ * Sensor class representing the Shelly BLU Door/Window.
+ * Specification on @see https://shelly-api-docs.shelly.cloud/docs-ble/Devices/dw
+ * This sensor is publishing data utilising the BTHome format and inherits from {@link AbstractBTHomeSensor}.
+ */
+class ShellySBDW002C extends AbstractBTHomeSensor {
+  static Domain = this.SensorDomains.environmental;
+
+  /**
+   * The shortened local name as advertised by the Shelly BLU H&T.
+   * @type {string}
+   */
+  static SHORTENED_LOCAL_NAME = "SBDW-002C";
+  static LOCAL_NAME = "Shelly BLU Door/Window";
+
+  getDescription() {
+    return `For more information about the sensor go here: <a href=https://us.shelly.com/products/shelly-blu-door-window-white target="_blank">Shelly Blu Door/Window</a>.`;
+  }
+
+  initSchema() {
+    super.initSchema();
+    this.addDefaultParam("zone", true).default = "cabin";
+
+    this.addParameter("opening", {
+      title: "Name of opening",
+      examples: ["companionWay", "porthole", "hatch"],
+      isRequired: true,
+      default: "companionWay",
+    });
+
+    this.addMetadatum("opening", "", "state of opening (door/window) as 'open' or 'closed'; null if not present. ", this.parseWindowState.bind(this)).default =
+      "environment.{zone}.{opening}.state";
+
+    // The second parameter is not the signalk path, but a JSON object in plugin_defaults.json; that provides the default signalk path
+    this.addDefaultPath("battery", "sensors.batteryStrength").read = this.parseBatteryLevel.bind(this);
+
+    this.addMetadatum("illuminance", "lx", "illuminance measured in lux, scaled 0.01", this.parseIlluminance.bind(this)).default =
+      "sensors.{macAndName}.illuminance";
+
+    this.addMetadatum("rotation", "deg", "rotation in degrees from the closed position; null if not present", this.parseRotation.bind(this)).default =
+      "sensors.{macAndName}.rotation";
+
+    this.addMetadatum("button", "", "button 'press' or 'hold_press'; null if not present", this.parseShellyButton.bind(this)).default =
+      "sensors.{macAndName}.button";
+  }
+}
+
+module.exports = ShellySBDW002C;

package/sensor_classes/ShellySBMO003Z.js

@@ -27,8 +27,7 @@ class ShellySBMO003Z extends AbstractBTHomeSensor {
 
 	initSchema() {
 		super.initSchema()
-		this.addDefaultParam("zone")
-
+		this.addDefaultParam("zone", true)
 
 		this.addMetadatum(
 			"motion",

package/sensor_classes/ShenzhenLiOnBMS.js

@@ -60,6 +60,7 @@ class ShenzhenLiONBMS extends BTSensor{
             {
                 title:"Number of cells",
                 type: "integer",
+                isRequired: true,
                 default: 4,
                 minimum: 1,
                 maximum: 16

package/sensor_classes/XiaomiMiBeacon.js

@@ -218,7 +218,8 @@ class XiaomiMiBeacon extends BTSensor{
         this.addParameter(
             "encryptionKey",
             {
-                title: "encryptionKey (AKA bindKey) for decryption"
+                title: "encryptionKey (AKA bindKey) for decryption",
+
             }
         )
         this.addDefaultPath('temp','environment.temperature')