bt-sensors-plugin-sk 1.1.0-beta.2.2.1.5 → 1.1.0-beta.2.2.3

package/README.md

@@ -1,5 +1,17 @@
 # Bluetooth Sensors for [Signal K](http://www.signalk.org)
 
+## BETA 2.2.3
+### What's New
+Support for [JBD/Jiabaida/Xiaoxiang Battery management systems](https://jiabaida-bms.com/), IBeacon and clone devices courtesy of [Arjen R](https://github.com/ArjenR). 
+
+### What's New for Developers
+Runtime loading of external device modules. See (https://github.com/naugehyde/bt-sensors-plugin-sk/discussions/26) 
+## BETA 2.2.2
+### What's New
+Support for Lancol Battery Meters, Kilovault HLX+ smart batteries courtesy of [sdlee1963](https://github.com/sdlee1963) and baseline  support for BTHome devices as well as support for the ShellySBHT003C enviromental sensor courtesy of [Sebastian Haas](https://github.com/sebastianhaas) 
+
+Fixed incorrect reporting of Victron Battery Monitor -> aux temperature values. 
+
 ## BETA 2.2.1
 
 ### What's New
@@ -24,7 +36,7 @@ On the plugin config page, You will need to select the device from the Device dr
 
 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),  Xiaomi devices, [ATC devices](https://github.com/atc1441/ATC_MiThermometer), RuuviTags 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>
 

package/index.js

@@ -10,7 +10,7 @@ const BTSensor = require('./BTSensor.js')
 const BLACKLISTED = require('./sensor_classes/BlackListedDevice.js')
 
 class MissingSensor  {
-	
+
 
 	constructor(config){
 		this.Metadatum = BTSensor.Metadatum
@@ -53,8 +53,10 @@ class MissingSensor  {
 	stopListening(){}
 	listen(){}
 }
-module.exports =  function (app) {
-	const adapterID = 'hci0'
+module.exports =   function (app) {
+	var adapterID = 'hci0'
+	
+
 	var deviceConfigs
 	var starts=0
 	var classMap
@@ -66,6 +68,8 @@ module.exports =  function (app) {
 	plugin.name = 'BT Sensors plugin';
 	plugin.description = 'Plugin to communicate with and update paths to BLE Sensors in Signalk';
 
+
+	
 	//Try and load utilities-sk NOTE: should be installed from App Store-- 
 	//But there's a fail safe because I'm a reasonable man.
 
@@ -162,10 +166,19 @@ module.exports =  function (app) {
   	}  
 
 	function loadClassMap() {
-		const _classMap = utilities_sk.loadClasses(path.join(__dirname, 'sensor_classes'))
-		classMap = new Map([..._classMap].filter(([k, v]) => !k.startsWith("_") ))
-		classMap.get('UNKNOWN').classMap=new Map([...classMap].filter(([k, v]) => !v.isSystem )) // share the classMap with Unknown for configuration purposes
-
+		import(app.config.appPath+"/lib/modules.js").then( (modulesjs)=>{
+			const _classMap = utilities_sk.loadClasses(path.join(__dirname, 'sensor_classes'))
+			classMap = new Map([..._classMap].filter(([k, v]) => !k.startsWith("_") ))
+			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
+		})
 	}
 
 	app.debug(`Loading plugin ${packageInfo.version}`)
@@ -338,20 +351,28 @@ module.exports =  function (app) {
 	async function startScanner() {
 		
 		app.debug("Starting scan...");
-		try{ await adapter.stopDiscovery() } catch(error){}
-		try{ await adapter.startDiscovery() } catch(error){}
+		//Use adapter.helper directly to get around Adapter::startDiscovery()
+		//filter options which can cause issues with Device::Connect() 
+		//turning off Discovery
+		try{ await adapter.helper.callMethod('StartDiscovery') } catch (error){	
+			app.debug(error)
+		}
+		
 	}
 
 	const sensorMap=new Map()
-	var adapter
 	
 	plugin.started=false
 
 	loadClassMap()
 	var discoveryIntervalID
-
+	var adapter 
+	var adapterPower
 	plugin.start = async function (options, restartPlugin) {
-
+		plugin.started=true
+		
+		var adapterID=options.adapter
+		
 		function getDeviceConfig(mac){
 			return deviceConfigs.find((p)=>p.mac_address==mac) 
 		}	
@@ -381,7 +402,8 @@ module.exports =  function (app) {
 					const msg =`Sensor at ${deviceConfig.mac_address} unavailable. Reason: ${error}`
 					app.debug(msg)
 					app.debug(error)
-					app.setPluginError(msg)
+					if (deviceConfig.active) 
+						app.setPluginError(msg)
 					deviceConfig.sensor=new MissingSensor(deviceConfig)
 					addSensorToList(deviceConfig.sensor) //add sensor to list with known options
 				
@@ -420,25 +442,63 @@ module.exports =  function (app) {
 			discoveryIntervalID = setInterval( findDevices, discoveryInterval*1000, discoveryTimeout)
 		}
 	
-		plugin.started=true
+	
+		if (!adapterID || adapterID=="")
+			adapterID = "hci0"
+		//Check if Adapter has changed since last start()
+		if (adapter) {
+			const n = await adapter.getName()
+			if (n!=adapterID) {
+				adapter.helper.removeAllListeners()
+				adapter=null
+			}
+		}
+		//Connect to adapter
+
+		if (!adapter){
+			app.debug(`Connecting to bluetooth adapter ${adapterID}`);
+
+			adapter = await bluetooth.getAdapter(adapterID)
+
+			//Set up DBUS listener to monitor Powered status of current adapter
+
+			await adapter.helper._prepare()
+			adapter.helper._propsProxy.on('PropertiesChanged', async (iface,changedProps,invalidated) => {
+				if (Object.hasOwn(changedProps,"Powered")){
+					if (changedProps.Powered.value==false) {
+						if (plugin.started){ //only call stop() if plugin is started
+							app.setPluginStatus(`Bluetooth Adapter ${adapterID} turned off. Plugin disabled.`)
+							await plugin.stop()
+							adapterPower=false 
+						}
+					} else { 				
+						if (!adapterPower)	{ //only call start() once
+							adapterPower=true
+							await plugin.start(options,restartPlugin)
+						}
+					}
+				}
+			})
+			if (!await adapter.isPowered()) {
+				app.debug(`Bluetooth Adapter ${adapterID} not powered on.`)
+				app.setPluginError(`Bluetooth Adapter ${adapterID} not powered on.`)
+				adapterPower=false
+				await plugin.stop()
+				return
+			}
+		}
+		adapterPower=true
+	
 		plugin.uiSchema.peripherals['ui:disabled']=false
 		sensorMap.clear()
 		deviceConfigs=options?.peripherals??[]
 
-		
-
 		if (plugin.stopped) {
 			await sleep(5000) //Make sure plugin.stop() completes first			
 						  //plugin.start is called asynchronously for some reason
 						  //and does not wait for plugin.stop to complete
 			plugin.stopped=false
 		}
-		var adapterID=options.adapter
-
-		if (!adapterID || adapterID==="")
-			adapterID = "hci0"
-
-		app.debug(`Connecting to bluetooth adapter ${adapterID}`);
 
 		const activeAdapters = await bluetooth.activeAdapters()
 		plugin.schema.properties.adapter.enum=[]
@@ -450,7 +510,7 @@ module.exports =  function (app) {
 
 		plugin.uiSchema.adapter={'ui:disabled': (activeAdapters.length==1)}
 
-		adapter = await bluetooth.getAdapter(adapterID)
+		
 		await startScanner()
 		if (starts>0){
 			app.debug(`Plugin ${packageInfo.version} restarting...`);
@@ -479,6 +539,7 @@ module.exports =  function (app) {
 	plugin.stop =  async function () {
 		app.debug("Stopping plugin")
 		plugin.stopped=true
+		plugin.started=false
 		plugin.uiSchema.peripherals['ui:disabled']=true
 		if ((sensorMap)){
 			plugin.schema.properties.peripherals.items.properties.mac_address.enum=[]

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.1.0-beta.2.2.1.5",
+  "version": "1.1.0-beta.2.2.3",
   "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": {
     "dbus-next": "^0.10.2",
-    "node-ble": "^1.12.0",
-    "int24":"^0.0.1"
+    "node-ble": "^1.13.0",
+    "int24":"^0.0.1",
+    "kaitai-struct": "^0.10.0"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/sensor_classes/BTHome/AbstractBTHomeSensor.js

@@ -0,0 +1,199 @@
+const BTSensor = require("../../BTSensor");
+const BTHomeServiceData = require("./BTHomeServiceData");
+const KaitaiStream = require("kaitai-struct/KaitaiStream");
+
+/**
+ * Base class for sensors publishing BTHome data.
+ *
+ * BTHome is an open standard for broadcasting sensor data and button presses over Bluetooth LE.
+ *
+ * @abstract
+ * @see https://bthome.io/
+ */
+class AbstractBTHomeSensor extends BTSensor {
+	/**
+	 * Offset from Celsius to Kelvin, used to convert between these units.
+	 * 273.15 degrees Kelvin correspond to 0 degrees Celsius.
+	 */
+	static KELVIN_OFFSET = 273.15;
+
+	/**
+	 * BTHome Service identifier
+	 *
+	 * @type {string} The Service UUID
+	 * @see https://bthome.io/images/License_Statement_-_BTHOME.pdf
+	 */
+	static BTHOME_SERVICE_ID = "0000fcd2-0000-1000-8000-00805f9b34fb";
+
+	/**
+	 * Returns measurement data for the given object ID from the given BTHomeData.
+	 *
+	 * @param btHomeData {BTHomeServiceData.BthomeServiceData}
+	 * @param objectId {number}
+	 * @return {any|null} Returns the measurement data for the given object ID, or `null`, if the BTHomeData does not
+	 * contain the measurement.
+	 */
+	static getSensorDataByObjectId(btHomeData, objectId) {
+		return btHomeData.measurement.find((m) => m.objectId === objectId)?.data;
+	}
+
+	/**
+	 * Returns whether the specified device's advertisement contains BTHome service data or not.
+	 *
+	 * This method should be included in the {@link BTSensor#identify} method of inheriting sensor classes.
+	 *
+	 * @example
+	 * static async identify(device) {
+	 *   if (await this.hasBtHomeServiceData(device)) {
+	 *     // Additional checks to distinguish from other BTHome devices
+	 *     return YourSensorClass;
+	 *   }
+	 *   return null;
+	 * }
+	 * @see BTSensor#identify
+	 * @param device The Bluetooth device to check for BTHome data.
+	 * @returns {Promise<boolean>} Returns `true`, if the device exposes BTHome service data, or `false`,
+	 * if not.
+	 */
+	static async hasBtHomeServiceData(device) {
+		const serviceData = await AbstractBTHomeSensor.getDeviceProp(
+			device,
+			"ServiceData",
+		);
+		if (serviceData) {
+			if (AbstractBTHomeSensor.BTHOME_SERVICE_ID in serviceData) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * Returns whether the specified device has a given name.
+	 *
+	 * This method can be included in the {@link BTSensor#identify} method of inheriting sensor classes.
+	 *
+	 * @example
+	 * static async identify(device) {
+	 *   if (await this.hasName(device)) {
+	 *     // Additional checks, if required
+	 *     return YourSensorClass;
+	 *   }
+	 *   return null;
+	 * }
+	 * @see BTSensor#identify
+	 * @param device The Bluetooth device to check the name.
+	 * @param name {string} The name to be checked for.
+	 * @returns {Promise<boolean>} Returns `true`, if the device exposes BTHome service data, or `false`,
+	 * if not.
+	 */
+	static async hasName(device, name) {
+		const deviceName = await AbstractBTHomeSensor.getDeviceProp(device, "Name");
+		if (deviceName) {
+			if (deviceName === name) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * Extracts battery level from the given BTHome data.
+	 *
+	 * @param btHomeData {BTHomeServiceData.BthomeServiceData} The BTHome data provided by the device.
+	 * @returns {number|null} The device's battery level as ratio (0‒1).
+	 */
+	static parseBatteryLevel(btHomeData) {
+		const batteryLevel = AbstractBTHomeSensor.getSensorDataByObjectId(
+			btHomeData,
+			BTHomeServiceData.BthomeObjectId.SENSOR_BATTERY,
+		)?.battery;
+		if (batteryLevel) {
+			return Number.parseFloat((batteryLevel / 100.0).toFixed(2));
+		}
+		return null;
+	}
+
+	/**
+	 * Extracts temperature from the given BTHome data and converts it to Kelvin for Signal-K.
+	 *
+	 * @param btHomeData {BTHomeServiceData.BthomeServiceData} The BTHome data provided by the device.
+	 * @returns {number|null} The temperature in Kelvin.
+	 */
+	static parseTemperature(btHomeData) {
+		const tempCelsius = AbstractBTHomeSensor.getSensorDataByObjectId(
+			btHomeData,
+			BTHomeServiceData.BthomeObjectId.SENSOR_TEMPERATURE_0_1,
+		)?.temperature;
+		if (tempCelsius) {
+			return Number.parseFloat(
+				(AbstractBTHomeSensor.KELVIN_OFFSET + tempCelsius).toFixed(2),
+			);
+		}
+		return null;
+	}
+
+	/**
+	 * Extracts humidity from the given BTHome data.
+	 *
+	 * @param btHomeData {BTHomeServiceData.BthomeServiceData} The BTHome data provided by the device.
+	 * @returns {number|null} The relative humidity as ratio (0‒1).
+	 */
+	static parseHumidity(btHomeData) {
+		const humidity = AbstractBTHomeSensor.getSensorDataByObjectId(
+			btHomeData,
+			BTHomeServiceData.BthomeObjectId.SENSOR_HUMIDITY,
+		)?.humidity;
+		if (humidity) {
+			return Number.parseFloat((humidity / 100.0).toFixed(2));
+		}
+		return null;
+	}
+
+	/**
+	 * Extracts button press event from the given BTHome data.
+	 *
+	 * @param btHomeData {BTHomeServiceData.BthomeServiceData} The BTHome data provided by the device.
+	 * @returns {BTHomeServiceData.ButtonEventType|null} The device's button press state.
+	 */
+	static parseButton(btHomeData) {
+		const buttonEvent = AbstractBTHomeSensor.getSensorDataByObjectId(
+			btHomeData,
+			BTHomeServiceData.BthomeObjectId.EVENT_BUTTON,
+		)?.event;
+		if (buttonEvent) {
+			return buttonEvent;
+		}
+		return null;
+	}
+
+	propertiesChanged(props) {
+		super.propertiesChanged(props);
+
+		// Make sure the advertisement contains service data, which is not the case for, e.g., RSSI events
+		if (!Object.hasOwn(props, "ServiceData")) {
+			return;
+		}
+
+		// Retrieve BTHome data
+		const buffer = this.getServiceData(AbstractBTHomeSensor.BTHOME_SERVICE_ID);
+		if (!buffer) {
+			this.debug(
+				`ServiceData does not contain BTHome service, which is unexpected for ${this.getDisplayName()}`,
+			);
+			return;
+		}
+
+		try {
+			// Parse ServiceData according to the BTHome v2 format (https://bthome.io/format/) and emit sensor data
+			const btHomeData = new BTHomeServiceData(new KaitaiStream(buffer));
+			this.emitValuesFrom(btHomeData);
+		} catch (e) {
+			throw new Error(
+				`Unable to parse BTHome data for ${this.getDisplayName()}`,
+			);
+		}
+	}
+}
+
+module.exports = AbstractBTHomeSensor;