bt-sensors-plugin-sk 1.2.0-beta.0.1.3 → 1.2.0-beta.0.1.4

package/README.md

@@ -2,11 +2,15 @@
 
 ## What's New
 
+
+## 1.2.0-beta-0.1.4
+
+Added support for paired Shelly devices.
+
 ## 1.2.0-beta-0.1.3
 
 Added support for [Shelly Blu Motion sensor ](https://us.shelly.com/products/shelly-blu-motion)
 
-
 ## 1.2.0-beta-0.1.2.b
 
 Module load unfix

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.2.0-beta.0.1.3",
+  "version": "1.2.0-beta.0.1.4",
   "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/BTHome/AbstractBTHomeSensor.js

@@ -49,10 +49,16 @@ class AbstractBTHomeSensor extends BTSensor {
 	static async identify(device) {
 		if (
 			(await this.hasBtHomeServiceData(device)) &&
-			(await this.hasName(
+			((await this.hasName(
 				device,
 				this.SHORTENED_LOCAL_NAME,
-			))
+			)) || (await this.hasNameAndAddress(
+				device,
+				this.SHORTENED_LOCAL_NAME,
+			)) || (await this.hasName(
+				device,
+				this.LOCAL_NAME,
+			)))
 		) {
 			return this;
 		}
@@ -111,6 +117,7 @@ class AbstractBTHomeSensor extends BTSensor {
 	 */
 	static async hasName(device, name) {
 		const deviceName = await this.getDeviceProp(device, "Name");
+		
 		if (deviceName) {
 			if (deviceName === name) {
 				return true;
@@ -118,7 +125,36 @@ class AbstractBTHomeSensor extends BTSensor {
 		}
 		return false;
 	}
-/**
+
+		/**
+	 * Returns whether the specified device has a given name plus the last two bytes of its address. 
+	 *
+	 * This method can be included in the {@link BTSensor#identify} method of inheriting sensor classes.
+	 *
+	 * @example
+	 * static async identify(device) {
+	 *   if (await this.hasNameAndAddress(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 hasNameAndAddress(device, name) {
+		let deviceName = await this.getDeviceProp(device, "Name");
+		const address = (await this.getDeviceProp(device, "Address")).split(":")
+		if (deviceName) {
+			if (`${name}-${address[4]}${address[5]}`.localeCompare(deviceName, undefined,  { sensitivity: 'base' } )==0)
+				return true;
+		}
+		return false;
+	}
+	/**
 	 * Returns measurement data for the given object ID from the given BTHomeData.
 	 *
 	 * @param btHomeData {BTHomeServiceData.BthomeServiceData}
@@ -159,7 +195,7 @@ class AbstractBTHomeSensor extends BTSensor {
 		)?.temperature;
 		if (tempCelsius) {
 			return Number.parseFloat(
-				(this.KELVIN_OFFSET + tempCelsius).toFixed(2),
+				(this.constructor.KELVIN_OFFSET + tempCelsius).toFixed(2),
 			);
 		}
 		return null;
@@ -204,11 +240,23 @@ class AbstractBTHomeSensor extends BTSensor {
 	parseMotion(btHomeData) {
 		const motion = this.getSensorDataByObjectId(
 			btHomeData,
-			BTHomeServiceData.BthomeObjectId.BINARY_MOTION,
+			BTHomeServiceData.BthomeObjectId.BINARY_MOTION
 		)?.motion;
 		return motion.intValue==1
 	}
 	
+	/**
+	 * Extracts packet ID from the given BTHome data.
+	 *
+	 * @param btHomeData {BTHomeServiceData.BthomeServiceData} The BTHome data provided by the device.
+	 * @returns {Number|null} The packet ID.
+	 */
+	parsePacketID(btHomeData) {
+		return this.getSensorDataByObjectId(
+			btHomeData,
+			BTHomeServiceData.BthomeObjectId.MISC_PACKET_ID,
+		).packetId
+	}
 
 	/**
 	 * Extracts button press event from the given BTHome data.

package/sensor_classes/ShellySBHT003C.js

@@ -14,7 +14,7 @@ class ShellySBHT003C extends AbstractBTHomeSensor {
 	 * @type {string}
 	 */
 	static SHORTENED_LOCAL_NAME = "SBHT-003C";
-
+	static LOCAL_NAME = "TBD"
 	
 	initSchema() {
 		super.initSchema()

package/sensor_classes/ShellySBMO003Z.js

@@ -2,7 +2,7 @@ const BTHomeServiceData = require("./BTHome/BTHomeServiceData");
 const AbstractBTHomeSensor = require("./BTHome/AbstractBTHomeSensor");
 
 /**
- * Sensor class representing the Shelly BLU H&T.
+ * Sensor class representing the Shelly BLU Motion.
  *
  * This sensor is publishing data utilising the BTHome format and inherits from {@link AbstractBTHomeSensor}.
  */
@@ -10,11 +10,16 @@ class ShellySBMO003Z extends AbstractBTHomeSensor {
 	static Domain = this.SensorDomains.environmental
 		
 	/**
-	 * The shortened local name as advertised by the Shelly BLU H&T.
+	 * The shortened local name as advertised by the Shelly BLU Motion.
 	 * @type {string}
 	 */
 	static SHORTENED_LOCAL_NAME = "SBMO-003Z";
 
+		/**
+	 * The local name as advertised by the Shelly BLU Motion after pairing .
+	 * @type {string}
+	 */
+	static LOCAL_NAME="Shelly BLU Motion";
 
 	initSchema() {
 		super.initSchema()
@@ -52,6 +57,16 @@ class ShellySBMO003Z extends AbstractBTHomeSensor {
 		)
 		.default="sensors.{macAndName}.button"
 
+/*
+		this.addMetadatum(
+			"packetID",
+			null,
+			"packetID from sensor",
+			this.parsePacketID.bind(this)
+		)
+		.default="sensors.{macAndName}.packetID"
+*/
+
 	}
 }