bt-sensors-plugin-sk 1.2.0-beta.0.0.5 → 1.2.0-beta.0.0.7

package/BTSensor.js

@@ -101,6 +101,7 @@ function preparePath(obj, str) {
 
 class BTSensor extends EventEmitter {
     //static metadata=new Map()
+ 
     static DEFAULTS = require('./plugin_defaults.json');
     
     /**
@@ -320,7 +321,7 @@ class BTSensor extends EventEmitter {
 
         //create the 'location' parameter
 
-        this.addDefaultParam("location")
+        //this.addDefaultParam("location")
 
         //create the 'RSSI' parameter 
         this.addDefaultPath("RSSI","sensors.RSSI")

package/README.md

@@ -1,8 +1,21 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org)
 
-## Beta 1.0.0
+## What's New
 
-Dynamic configuration added (no more screen refreshing necessary).
+## 1.2.0-beta-0.0.7
+
+Added zone config param for environmental sensors. Removed location parameter. 
+
+## 1.2.0-beta-0.0.6
+Default values for paths for most sensor classes. 
+
+## 1.2.0-beta-0.0.5
+
+Added workaround to support multiple simultaneous GATT connections. Owing to problematic behavior in Bluez where making a GATT connection halted the scanner which made additional updates and connections impossible, added a scanner restart after making each GATT connection. 
+
+## 1.2.0-beta-0.0.1
+
+Dynamic configuration added. List updates when new devices are found by scanner. (No more screen refreshing necessary).
 
 ## WHAT IT IS
 
@@ -33,13 +46,13 @@ Signalk users with a Linux boat-puter (Windows and MacOS are NOT currently suppo
 NOTE: If you're running the 1.0.3 release, you will have to reconfigure your devices.<br>
 
 ### Signalk Appstore
-The plugin is currently available in the Signalk Appstore. <br>
+The beta plugin is not currently available in the Signalk Appstore. <br>
 
 ### NPM
 
 Go to you signalk home (usually ~/.signalk) and run:
 
-npm i bt-sensors-plugin-sk@1.1.0-beta.2.1
+npm i bt-sensors-plugin-sk@1.2.0-beta.0.0.7
 
 ### Linux
 
@@ -48,7 +61,7 @@ If you want to install directly from source (this is mostly of interest to custo
 <pre>  cd ~/[some_dir]
   git clone https://github.com/naugehyde/bt-sensors-plugin-sk
   cd bt-sensors-plugin-sk
-  git switch '1.1.0'
+  git switch '1.2.0-beta'
   git pull
   npm i
   [sudo] npm link
@@ -68,16 +81,11 @@ After installing and restarting Signalk you should see a "BT Sensors Plugin" opt
 
 On initial configuration, wait for your Bluetooth adapter to scan devices. The plugin will scan for new devices at whatever you set the "scan for new devices interval" value to. <br><br>
 
-> TIP: Close and re-open the config screen to refresh the screen. The config screen isn't as <i>reactive</i> as it oughtta be.<br><br>
-
-Then press the + button to add a sensor. Your screen should look something like this:<br><br>
-<img width="1122" alt="Screenshot 2024-10-13 at 6 52 52 PM" src="https://github.com/user-attachments/assets/0487b8d0-4bc0-4358-85c6-a507bc3c97d2">
-
 <br><br>
 
-Select the sensor you want Signalk to listen to from the drop down.<br>
+Select the sensor you want Signalk to listen to from the list.<br>
 
-If you don't see your device and you know that it's on and nearby to the server, it may not be currently supported. But fear not, you can add custom sensor classes yourself. (Check out [the development section](#development).). <br><br>
+If you don't see your device and you know that it's on and nearby to the server, it may not be currently supported (It could also be out of range.) But fear not, you can add custom sensor classes yourself. (Check out [the development section](#development).). <br><br>
 
 Now it's a simple matter of associating the data emitted by the sensor with the Signalk path you want it to update. (Also, you can name your sensor so when it appears in logs its easy to recognize.) <br><br>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.2.0-beta.0.0.5",
+  "version": "1.2.0-beta.0.0.7",
   "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, Aranet4 environment sensors, SwitchBot temp and humidity sensors, KilovaultHLXPlus smart batteries, and Govee GVH51xx temp sensors",
   "main": "index.js",
   "dependencies": {

package/sensor_classes/ATC.js

@@ -33,6 +33,8 @@ class ATC extends BTSensor{
     }
     initSchema(){
         super.initSchema()
+        this.addDefaultParam("zone")
+
         this.addDefaultPath('batteryStrength','sensors.batteryStrength')
         .read=(buff)=>{return ((buff.readUInt8(12))/100)}
 

package/sensor_classes/GoveeH510x.js

@@ -36,6 +36,8 @@ class GoveeH510x extends BTSensor{
 
     initSchema(){
         super.initSchema()
+        this.addDefaultParam("zone")
+
         this.addDefaultPath("temp","environment.temperature")
         this.addDefaultPath("humidity", "environment.humidity")
         this.addDefaultPath("battery","sensors.batteryStrength")        

package/sensor_classes/Inkbird.js

@@ -15,6 +15,8 @@ class Inkbird extends BTSensor{
 
     initSchema() {
         super.initSchema()
+        this.addDefaultParam("zone")
+
         this.addDefaultPath('temp','environment.temperature')
         this.addDefaultPath('battery', 'sensors.batteryStrength')
         if (this.getName() == 'sps'){

package/sensor_classes/MopekaTankSensor.js

@@ -276,7 +276,7 @@ class MopekaTankSensor extends BTSensor{
         this.addParameter("medium",
             {
                 title:"type of liquid in tank",
-                enum: Object.keys(Media)   
+                enum: Object.keys(Media)
             }
         )
         this.addParameter("tankHeight",
@@ -286,34 +286,43 @@ class MopekaTankSensor extends BTSensor{
                 unit:"mm"
             }
         )
+        this.addDefaultParam("id")
 
-        this.addMetadatum("battVolt","V","sensor battery in volts", 
-            ((buffer)=>{ 
+        this.addDefaultPath("battVolt","sensors.batteryVoltage") 
+            .read=((buffer)=>{ 
                 this.battVolt = (buffer.readUInt8(1)/32) 
                 return this.battVolt
             }).bind(this)
-        )
-        this.addMetadatum("battStrength","ratio","sensor battery strength", 
-            (buffer)=>{ return Math.max(0, Math.min(1, (((this.battVolt) - 2.2) / 0.65))) }
-        )
+        
+        this.addDefaultPath("battStrength", "sensors.batteryStrength") 
+            .read=(buffer)=>{ return Math.max(0, Math.min(1, (((this.battVolt) - 2.2) / 0.65))) }
+        
         this.addMetadatum("temp","K","temperature", 
             ((buffer)=>{ 
                 this.temp = parseFloat(((buffer.readUInt8(2)&0x7F)+233.15).toFixed(2))
                 return this.temp
-            }).bind(this)
+            })
         )
+        .default="tanks.{id}.temperature"
         this.addMetadatum("tankLevel","ratio","tank level", 
             (buffer)=>{ return (this._tankLevel(((buffer.readUInt16LE(3))&0x3FFF)))/this.getTankHeight()}
         )
+        .default="tanks.{id}.currentLevel"
+
         this.addMetadatum("readingQuality","","quality of read", 
             (buffer)=>{ return buffer.readUInt8(4)>>6}
         )
+        .default="sensors.{macAndName}.readingQuality"
+
         this.addMetadatum("accX","Mg","acceleration on X-axis", 
             (buffer)=>{ return buffer.readUInt8(8)}
         )
+        .default="sensors.{macAndName}.accelerationXAxis"
+
         this.addMetadatum("accY","Mg","acceleration on Y-axis", 
             (buffer)=>{ return buffer.readUInt8(9)}
         )        
+        .default="sensors.{macAndName}.accelerationYAxis"
     }
 
     propertiesChanged(props){
@@ -326,8 +335,8 @@ class MopekaTankSensor extends BTSensor{
         if (this.name)
             return this.name
 
-        const _name = MopekaDevices.get(this?.modelID??0x0).name
-        return _name?_name:MopekaDevices.get(0x0).name
+        const _name = MopekaDevice.get(this?.modelID??0x0).name
+        return _name?_name:MopekaDevice.get(0x0).name
         
     }
 }

package/sensor_classes/RuuviTag.js

@@ -10,13 +10,14 @@ class RuuviTag extends BTSensor{
         
     initSchema(){
         super.initSchema()
+        this.addDefaultParam("zone")
+
         const md = this.valueIfVariant(this.getManufacturerData(this.constructor.manufacturerID))
         this.mode = md[0]
         if (this['_initModeV'+this.mode])
             this['_initModeV'+this.mode]()
         else    
             throw new Error("Unrecognized Ruuvitag data mode "+md[0])
-        this.addDefaultParam("zone")
 
     } 
 

package/sensor_classes/ShellySBHT003C.js

@@ -80,6 +80,8 @@ class ShellySBHT003C extends AbstractBTHomeSensor {
 
 	initSchema() {
 		super.initSchema()
+		this.addDefaultParam("zone")
+
 		this.addDefaultPath(
 			"battery",
 			"sensors.batteryStrength")

package/sensor_classes/SwitchBotMeterPlus.js

@@ -37,6 +37,8 @@ class SwitchBotMeterPlus extends BTSensor{
 // Refer https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md#(new)-broadcast-message 
  
         super.initSchema()
+        this.addDefaultParam("zone")
+
         this.addDefaultPath('temp', 'environment.temperature')
         .read= (buffer)=>{return (( ( ( (buffer[4] & 0x7f) + ((buffer[3] & 0x0f)/10) ) * ( (buffer[4] & 0x80)>0 ? 1 : -1 ) ) - ( (buffer[5] & 0x80)>0 ? 32 : 0) ) / ( (buffer[5] & 0x80)>0 ? 1.8 : 1) ) + 273.15 }
         this.addDefaultPath('humidity', 'environment.humidity')

package/sensor_classes/SwitchBotTH.js

@@ -39,6 +39,8 @@ class SwitchBotTH extends  BTSensor {
 
     initSchema(){
         super.initSchema()
+        this.addDefaultParam("zone")
+
         this.addDefaultPath('temp', 'environment.temperature') 
         .read=(buffer)=>{
                 return (27315+(((buffer[8] & 0x0F)/10 + (buffer[9] & 0x7F)) * (((buffer[9] & 0x80)>0)?100:-100)))/100

package/sensor_classes/UltrasonicWindMeter.js

@@ -27,16 +27,20 @@ class UltrasonicWindMeter extends BTSensor{
         )
 
     }
-    async init(){
-        await super.init()
-        this.addMetadatum("batt","ratio","Battery strength",
-            (buffer)=>{return (buffer.readUInt8())/100})
+     initSchema(){
+        super.initSchema()
+        this.addDefaultPath("batt",'sensors.batteryStrength')
+            .read=(buffer)=>{return (buffer.readUInt8())/100}
+
         this.addMetadatum("awa","rad","Apparent Wind Angle",
             (buffer)=>{return ((buffer.readInt16LE())/100)*(Math.PI/180)}
         )
+        .default='environment.wind.angleApparent'
+
         this.addMetadatum("aws","m/s","Apparent Wind Speed",
         (buffer)=>{return (buffer.readInt16LE()/100)*.514444} //convert knots to m/s
         )
+        .default='environment.wind.speedApparent'
     }
 
     initGATTConnection(){ 

package/sensor_classes/VictronACCharger.js

@@ -31,28 +31,39 @@ class VictronACCharger extends VictronSensor{
 
     initSchema(){
         super.initSchema()
+        this.addDefaultParam("id")
 
         this.addMetadatum('state','', 'device state', 
             (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
-
+            .default= "electrical.chargers.{id}.state"
         this.addMetadatum('chargerError','', 'charger error code', 
             (buff)=>{return VC.ChargerError.get(buff.readUInt8(1))})
- 
+            .default= "electrical.chargers.{id}.error"
+
         this.addMetadatum('batt1','V', 'battery 1 voltage')
+        .default= "electrical.chargers.{id}.battery1.voltage"
 
         this.addMetadatum('curr1','A', 'battery 1 current')
+        .default= "electrical.chargers.{id}.battery1.current"
 
         this.addMetadatum('batt2','V', 'battery 2 voltage')
+        .default= "electrical.chargers.{id}.battery2.voltage"
 
         this.addMetadatum('curr2','A', 'battery 2 current')
+        .default= "electrical.chargers.{id}.battery2.current"
 
         this.addMetadatum('batt3','V', 'battery 3 voltage')
+        .default= "electrical.chargers.{id}.battery3.voltage"
 
         this.addMetadatum('curr3','A', 'battery 3 current')
-    
-        this.addMetadatum('temp', 'K', 'battery temperature')
+        .default= "electrical.chargers.{id}.battery3.current"
+
+        this.addMetadatum('temp', 'K', 'charger temperature')
+        .default= "electrical.chargers.{id}.temperature"
 
         this.addMetadatum('acCurr','A', 'AC current')
+        .default= "electrical.chargers.{id}.ac.current"
+
     }
     emitValuesFrom(buffer){
         super.emitValuesFrom(buffer)

package/sensor_classes/VictronInverterRS.js

@@ -11,22 +11,33 @@ class VictronInverterRS extends VictronSensor{
     
 
      initSchema() {
-         super.initSchema()
-        
+        super.initSchema()
+        this.addDefaultParam("id")
         this.addMetadatum('deviceState','', 'inverter device state', 
-                (buff)=>{return VC.OperationMode.get(buff.readIntU8(0))})
+            (buff)=>{return VC.OperationMode.get(buff.readIntU8(0))})
+            .default='electrical.inverters.{id}.state'    
+
         const md = this.addMetadatum('chargerError','', 'charger error',
-                (buff)=>{return VC.ChargerError(buff.readIntU8(1))})
-        md.notify=true
+            (buff)=>{return VC.ChargerError(buff.readIntU8(1))})
+            .default='electrical.inverters.{id}.error'
+            md.notify=true
 
         this.addMetadatum('batteryVoltage','V', 'battery voltage', 
             (buff)=>{return this.NaNif(buff.readInt16LE(2),0x7FFF)/100})
+            .default='electrical.inverters.{id}.battery.voltage'
+        
         this.addMetadatum('pvPower','W', 'PV power', 
             (buff)=>{return this.NaNif(buff.readUInt16LE(4), 0xffff)})
+            .default='electrical.inverters.{id}.power'
+        
         this.addMetadatum('yieldToday','W', 'yield yoday in watts', 
             (buff)=>{return this.NaNif(buff.readUInt16LE(6), 0xffff)*10})
+            .default='electrical.inverters.{id}.yieldToday'
+ 
         this.addMetadatum('acOutPower','W', 'AC out power in watts', 
-            (buff)=>{this.NaNif(buff.readInt16LE(8), 0x7fff)})                
+            (buff)=>{this.NaNif(buff.readInt16LE(8), 0x7fff)}) 
+            .default='electrical.inverters.{id}.ac.power'
+              
     }
 
     emitValuesFrom(decData){

package/sensor_classes/VictronLynxSmartBMS.js

@@ -22,24 +22,28 @@ class VictronLynxSmartBMS extends VictronSensor{
         return await this.identifyMode(device, 0x0A)
     }   
 
- 
     initSchema(){
         super.initSchema()
         this.addMetadatum('error','', 'error code', 
             (buff)=>{return buff.readUInt8(0)})
  
-        this.addMetadatum('ttg','s', 'time to go (in seconds)',
-            (buff)=>{return this.NaNif(buff.readUInt16LE(1),0xFFFF)*60})
-        this.addMetadatum('voltage','V', 'channel 1 voltage',
-            (buff)=>{return this.NaNif(buff.readInt16LE(3),0x7FFF)/100})
-        this.addMetadatum('current','A','channel 1 current', 
-            (buff)=>{return this.NaNif(buff.readInt16LE(5),0x7FFF)/10})
+        this.addDefaultPath('ttg','electrical.batteries.capacity.timeRemaining')
+            .read=(buff)=>{return this.NaNif(buff.readUInt16LE(1),0xFFFF)*60}
+        this.addDefaultPath('voltage','electrical.batteries.voltage')
+            .read=(buff)=>{return this.NaNif(buff.readInt16LE(3),0x7FFF)/100}
+        this.addDefaultPath('current','electrical.batteries.current') 
+            .read=(buff)=>{return this.NaNif(buff.readInt16LE(5),0x7FFF)/10}
+        
         this.addMetadatum('ioStatus','','IO Status', //TODO
             (buff)=>{return buff.readUInt16LE(7)})
+
         this.addMetadatum('warningsAndAlarms','','warnings and alarms')
-        this.addMetadatum('soc','','state of charge')
+
+        this.addDefaultPath('soc','electrical.batteries.capacity.stateOfCharge')
         this.addMetadatum('consumedAh','Ah','amp-hours consumed')
-        this.addMetadatum('temp', 'K', 'battery temperature')
+        .default="electrical.batteries.{batteryID}.capacity.ampHoursConsumed"
+        
+        this.addDefaultPath('temp', 'electrical.batteries.temperature')
     }
     emitValuesFrom(buffer){
         super.emitValuesFrom(buffer)

package/sensor_classes/VictronOrionXS.js

@@ -10,20 +10,32 @@ class VictronOrionXS extends VictronSensor{
     }   
      initSchema() {
         super.initSchema()
+        this.addDefaultParam("id")
         this.addMetadatum('deviceState','', 'device state', 
             (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
+            .default="electrical.chargers.{id}.state"
+
         this.addMetadatum('chargerError','', 'charger error',
             (buff)=>{return VC.ChargerError.get(buff.readUInt8(1))})
+            .default="electrical.chargers.{id}.error"
+
         this.addMetadatum('outputVoltage','V', 'output voltage', 
             (buff)=>{return this.NaNif(buff.readInt16LE(2),0x7FF)/100})
+            .default="electrical.chargers.{id}.output.voltage"
+            
+        
         this.addMetadatum('current','A','output current', 
             (buff)=>{return this.NaNif(buff.readUInt16LE(4),0xFFFF)/10})
+            .default="electrical.chargers.{id}.output.current"
         this.addMetadatum('inputVoltage','V', 'input voltage', 
             (buff)=>{return this.NaNif(buff.readInt16LE(6),0x07FF)/100})
+            .default="electrical.chargers.{id}.input.voltage"
         this.addMetadatum('inputCurrent','A','input current', 
             (buff)=>{return this.NaNif(buff.readUInt16LE(8),0xFFFF)/10})
+            .default="electrical.chargers.{id}.input.current"
         this.addMetadatum('deviceOffReason','', 'device off reason', 
-            (buff)=>{return VC.OffReasons(buff.readUInt32BE(10))})    
+            (buff)=>{return VC.OffReasons(buff.readUInt32BE(10))})
+            .default="electrical.chargers.{id}.offReason"    
         }
 
 }

package/sensor_classes/XiaomiMiBeacon.js

@@ -207,6 +207,8 @@ class XiaomiMiBeacon extends BTSensor{
     }   
     initSchema(){
         super.initSchema()
+        this.addDefaultParam("zone")
+
         this.addParameter(
             "encryptionKey",
             {