bt-sensors-plugin-sk 1.1.1 → 1.2.0-beta.0.0.10

package/README.md

@@ -1,19 +1,41 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org)
 
-## RELEASE 1.1.1
+## What's New
 
-## WHAT'S NEW
+## 1.2.0-beta-0.0.10
 
-Fix for Govee devices (and potentially others) being misidentified and instantiated as IBeacon devices. 
+Better handling of plugin config screen when Disabled
 
-NOTE: new IBeacon devices will appear as Unknown devices and will need to be explicity classified as "IBeacon" by the user by selecting IBeacon from the Sensor Class dropdown.
+## 1.2.0-beta-0.0.9
+
+Fixes to config page RSSI update.
+
+## 1.2.0-beta-0.0.8
+
+Improved handling of changed state on config page.
+
+Several small fixes to various sensor classes.
+
+## 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
 
 BT Sensors Plugin for Signalk is a lightweight BLE (Bluetooth Low Energy) framework for listening and connecting to Bluetooth sensors on your boat and sending deltas to Signalk paths with the values the sensors reports. <br>
 
-The Plugin currently supports every documented Victron device (AC Charger, Battery Monitor, DC-DC Converter, DC Energy Meter, GX Device, Inverter, Inverter RS, Lynx Smart BMS, Orion XS, Smart Battery Protect, Smart Lithium and VE Bus),  [Lancol Battery Meters ](https://www.lancol.com/product/12v-bluetooth-4-0-battery-tester-micro-10-c/), [Kilovault HLX+ smart batteries ](https://sunwatts.com/content/manual/KiloVault_HLX_PLUS_Datasheet_06252021%20%281%29.pdf?srsltid=AfmBOooY-cGnC_Qm6V1T9Vg5oZzBCJurS0AOGoWqWeyy-dwz2vA-l1Jb), Xiaomi devices, [ATC devices](https://github.com/atc1441/ATC_MiThermometer), RuuviTags, Renogy BMS, Ultrasonic Wind Meters, SwitchBotTH and Meterplus, Aranet 2/4 environmental sensors, Govee 50/51xx sensors, ShellySBHT003C enviromental sensor,
-[JBD/Jiabaida/Xiaoxiang Battery management systems](https://jiabaida-bms.com/), IBeacon and clone devices, and Inkbird thermometers.
+The Plugin currently supports every documented Victron device (AC Charger, Battery Monitor, DC-DC Converter, DC Energy Meter, GX Device, Inverter, Inverter RS, Lynx Smart BMS, Orion XS, Smart Battery Protect, Smart Lithium and VE Bus),  [Lancol Battery Meters ](https://www.lancol.com/product/12v-bluetooth-4-0-battery-tester-micro-10-c/), [Kilovault HLX+ smart batteries ](https://sunwatts.com/content/manual/KiloVault_HLX_PLUS_Datasheet_06252021%20%281%29.pdf?srsltid=AfmBOooY-cGnC_Qm6V1T9Vg5oZzBCJurS0AOGoWqWeyy-dwz2vA-l1Jb), Xiaomi devices, [ATC devices](https://github.com/atc1441/ATC_MiThermometer), RuuviTags, Renogy BMS, Ultrasonic Wind Meters, SwitchBotTH and Meterplus, Aranet 2/4 environmental sensors, Govee 50/51xx sensors, and Inkbird thermometers.
 
 A typical use case is a Bluetooth thermometer like the Xiaomi LYWSD03MMC, an inexpensive Bluetooth thermometer that runs on a 3V watch battery that can report the current temperature and humidity in your refrigerator or cabin or wherever you want to stick it (no judgement.) <br>
 
@@ -21,12 +43,6 @@ The reported temperature can then be displayed on a Signalk app like Kip, Wilhel
 
 It's pretty easy to write and deploy your own sensor class for any currently unsupported sensor. More on that in [the development README](./sensor_classes/DEVELOPMENT.md).
 
-### RENOGY NOTES 
-
-The class of Renogy Devices cannot be reliably identified from their Bluetooth advertisements. <br>
-
-On the plugin config page, You will need to select the device from the Device dropdown, then select the appropriate class from the Class dropdown. After that, you will need to hit the Submit button. On restart of the plugin, the plugin should recognize the device. If you've selected the appropriate class (RenogyRoverClient for example), you should see configs for paths. <br>
-
 ## WHO IS IT FOR
 
 Signalk users with a Linux boat-puter (Windows and MacOS are NOT currently supported) and Bluetooth sensors they'd like to integrate into their Signalk datastream.
@@ -41,15 +57,16 @@ Signalk users with a Linux boat-puter (Windows and MacOS are NOT currently suppo
 
 ## INSTALLATION
 
-### Signalk Appstore
+NOTE: If you're running the 1.0.3 release, you will have to reconfigure your devices.<br>
 
-The plugin is currently available in the Signalk Appstore. <br>
+### Signalk Appstore
+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
+npm i bt-sensors-plugin-sk@1.2.0-beta.0.0.7
 
 ### Linux
 
@@ -58,6 +75,8 @@ 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.2.0-beta'
+  git pull
   npm i
   [sudo] npm link
   cd [signalk_home] 
@@ -76,16 +95,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/classLoader.js

@@ -0,0 +1,38 @@
+const fs = require('fs')
+const path = require('path')
+const semver = require('semver')
+
+    function loadClasses (dir, ext='.js')
+        {
+            const classMap = new Map()
+            const classFiles = fs.readdirSync(dir)
+            .filter(file => file.endsWith(ext));
+        
+            classFiles.forEach(file => {
+                const filePath = path.join(dir, file);
+                const cls = require(filePath);
+                classMap.set(cls.name, cls);
+            })
+            return classMap
+        }
+
+      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"
+        )
+        import(libPath+"/modules.js").then( (modulesjs)=>{
+        const { default:defaultExport} = modulesjs
+            const modules = defaultExport.modulesWithKeyword(app.config, "signalk-bt-sensor-class")
+            modules.forEach((module)=>{
+                module.metadata.classFiles.forEach((classFile)=>{
+                    const cls = require(module.location+module.module+"/"+classFile);
+                    classMap.set(cls.name, cls);
+                })
+            })
+            classMap.get('UNKNOWN').classMap=new Map([...classMap].sort().filter(([k, v]) => !v.isSystem )) // share the classMap with Unknown for configuration purposes
+        })
+        return classMap
+    }
+    module.exports=loadClassMap