bt-sensors-plugin-sk 1.2.5-1 → 1.2.6-beta

package/sensor_classes/MopekaTankSensor.js

@@ -1,204 +1,4 @@
-/*
-"""Parser for Gmopeka_iot BLE advertisements.
 
-Thanks to https://github.com/spbrogan/mopeka_pro_check for
-help decoding the advertisements.
-
-MIT License applies.
-"""
-
-from __future__ import annotations
-
-import logging
-from dataclasses import dataclass
-from bluetooth_data_tools import short_address
-from bluetooth_sensor_state_data import BluetoothData
-from home_assistant_bluetooth import BluetoothServiceInfo
-from sensor_state_data import (
-    BinarySensorDeviceClass,
-    SensorDeviceClass,
-    SensorLibrary,
-    Units,
-)
-
-from .models import MediumType
-
-_LOGGER = logging.getLogger(__name__)
-
-
-# converting sensor value to height
-MOPEKA_TANK_LEVEL_COEFFICIENTS = {
-    MediumType.PROPANE: (0.573045, -0.002822, -0.00000535),
-    MediumType.AIR: (0.153096, 0.000327, -0.000000294),
-    MediumType.FRESH_WATER: (0.600592, 0.003124, -0.00001368),
-    MediumType.WASTE_WATER: (0.600592, 0.003124, -0.00001368),
-    MediumType.LIVE_WELL: (0.600592, 0.003124, -0.00001368),
-    MediumType.BLACK_WATER: (0.600592, 0.003124, -0.00001368),
-    MediumType.RAW_WATER: (0.600592, 0.003124, -0.00001368),
-    MediumType.GASOLINE: (0.7373417462, -0.001978229885, 0.00000202162),
-    MediumType.DIESEL: (0.7373417462, -0.001978229885, 0.00000202162),
-    MediumType.LNG: (0.7373417462, -0.001978229885, 0.00000202162),
-    MediumType.OIL: (0.7373417462, -0.001978229885, 0.00000202162),
-    MediumType.HYDRAULIC_OIL: (0.7373417462, -0.001978229885, 0.00000202162),
-}
-
-MOPEKA_MANUFACTURER = 89
-MOKPEKA_PRO_SERVICE_UUID = "0000fee5-0000-1000-8000-00805f9b34fb"
-
-
-@dataclass
-class MopekaDevice:
-    model: str
-    name: str
-    adv_length: int
-
-
-DEVICE_TYPES = {
-    0x3: MopekaDevice("M1017", "Pro Check", 10),
-    0x4: MopekaDevice("Pro-200", "Pro-200", 10),
-    0x5: MopekaDevice("Pro H20", "Pro Check H2O", 10),
-    0x6: MopekaDevice("M1017", "Lippert BottleCheck", 10),
-    0x8: MopekaDevice("M1015", "Pro Plus", 10),
-    0x9: MopekaDevice("M1015", "Pro Plus with Cellular", 10),
-    0xA: MopekaDevice("TD40/TD200", "TD40/TD200", 10),
-    0xB: MopekaDevice("TD40/TD200", "TD40/TD200 with Cellular", 10),
-    0xC: MopekaDevice("M1017", "Pro Check Universal", 10),
-}
-
-
-def hex(data: bytes) -> str:
-    """Return a string object containing two hexadecimal digits for each byte in the instance."""
-    return "b'{}'".format("".join(f"\\x{b:02x}" for b in data))  # noqa: E231
-
-
-def battery_to_voltage(battery: int) -> float:
-    """Convert battery value to voltage"""
-    return battery / 32.0
-
-
-def battery_to_percentage(battery: int) -> float:
-    """Convert battery value to percentage."""
-    return round(max(0, min(100, (((battery / 32.0) - 2.2) / 0.65) * 100)), 1)
-
-
-def temp_to_celsius(temp: int) -> int:
-    """Convert temperature value to celsius."""
-    return temp - 40
-
-
-def tank_level_to_mm(tank_level: int) -> int:
-    """Convert tank level value to mm."""
-    return tank_level * 10
-
-
-def tank_level_and_temp_to_mm(
-    tank_level: int, temp: int, medium: MediumType = MediumType.PROPANE
-) -> int:
-    """Get the tank level in mm for a given fluid type."""
-    coefs = MOPEKA_TANK_LEVEL_COEFFICIENTS[medium]
-    return int(tank_level * (coefs[0] + (coefs[1] * temp) + (coefs[2] * (temp**2))))
-
-
-class MopekaIOTBluetoothDeviceData(BluetoothData):
-    """Data for Mopeka IOT BLE sensors."""
-
-    def __init__(self, medium_type: MediumType = MediumType.PROPANE) -> None:
-        super().__init__()
-        self._medium_type = medium_type
-
-    def _start_update(self, service_info: BluetoothServiceInfo) -> None:
-        """Update from BLE advertisement data."""
-        _LOGGER.debug(
-            "Parsing Mopeka IOT BLE advertisement data: %s, MediumType is: %s",
-            service_info,
-            self._medium_type,
-        )
-        manufacturer_data = service_info.manufacturer_data
-        service_uuids = service_info.service_uuids
-        address = service_info.address
-        if (
-            MOPEKA_MANUFACTURER not in manufacturer_data
-            or MOKPEKA_PRO_SERVICE_UUID not in service_uuids
-        ):
-            _LOGGER.debug("Not a Mopeka IOT BLE advertisement: %s", service_info)
-            return
-        data = manufacturer_data[MOPEKA_MANUFACTURER]
-        model_num = data[0]
-        if not (device_type := DEVICE_TYPES.get(model_num)):
-            _LOGGER.debug("Unsupported Mopeka IOT BLE advertisement: %s", service_info)
-            return
-        adv_length = device_type.adv_length
-        if len(data) != adv_length:
-            return
-
-        self.set_device_manufacturer("Mopeka IOT")
-        self.set_device_type(device_type.model)
-        self.set_device_name(f"{device_type.name} {short_address(address)}")
-        battery = data[1]
-        battery_voltage = battery_to_voltage(battery)
-        battery_percentage = battery_to_percentage(battery)
-        button_pressed = bool(data[2] & 0x80 > 0)
-        temp = data[2] & 0x7F
-        temp_celsius = temp_to_celsius(temp)
-        tank_level = ((int(data[4]) << 8) + data[3]) & 0x3FFF
-        tank_level_mm = tank_level_and_temp_to_mm(tank_level, temp, self._medium_type)
-        reading_quality = data[4] >> 6
-        accelerometer_x = data[8]
-        accelerometer_y = data[9]
-
-        self.update_predefined_sensor(SensorLibrary.TEMPERATURE__CELSIUS, temp_celsius)
-        self.update_predefined_sensor(
-            SensorLibrary.BATTERY__PERCENTAGE, battery_percentage
-        )
-        self.update_predefined_sensor(
-            SensorLibrary.VOLTAGE__ELECTRIC_POTENTIAL_VOLT,
-            battery_voltage,
-            name="Battery Voltage",
-            key="battery_voltage",
-        )
-        self.update_predefined_binary_sensor(
-            BinarySensorDeviceClass.OCCUPANCY,
-            button_pressed,
-            key="button_pressed",
-            name="Button pressed",
-        )
-        self.update_sensor(
-            "tank_level",
-            Units.LENGTH_MILLIMETERS,
-            tank_level_mm if reading_quality >= 1 else None,
-            SensorDeviceClass.DISTANCE,
-            "Tank Level",
-        )
-        self.update_sensor(
-            "accelerometer_x",
-            None,
-            accelerometer_x,
-            None,
-            "Position X",
-        )
-        self.update_sensor(
-            "accelerometer_y",
-            None,
-            accelerometer_y,
-            None,
-            "Position Y",
-        )
-        self.update_sensor(
-            "reading_quality_raw",
-            None,
-            reading_quality,
-            None,
-            "Reading quality raw",
-        )
-        self.update_sensor(
-            "reading_quality",
-            Units.PERCENTAGE,
-            round(reading_quality / 3 * 100),
-            None,
-            "Reading quality",
-        )
-        # Reading stars = (3-reading_quality) * "★" + (reading_quality * "⭐")
-*/
 
 class MopekaDevice{
     
@@ -246,6 +46,9 @@ class MopekaTankSensor extends BTSensor{
     static serviceID16 = 0xFEE5
 
     static manufacturerID = 0x0059
+    static Manufacturer = "Mopeka Products LLC"
+
+    static ImageFile="MopekaTankSensor.jpg"
     static async identify(device){
         if (await this.getManufacturerID(device)==this.manufacturerID ){
             const uuids = await this.getDeviceProp(device, 'UUIDs')

package/sensor_classes/RemoranWave3.js

@@ -33,11 +33,13 @@ const states= ["Charging Needed", "Charging", "Floating", "Idle"]
 const BTSensor = require("../BTSensor");
  class RemoranWave3 extends BTSensor{
     static Domain = BTSensor.SensorDomains.electrical
+    static ImageFile = "RemoranWave3.jpeg"
     serviceUUID = "81d08df0-c0f8-422a-9d9d-e4379bb1ea3b"
     info1CharUUID = "62c91222-fafe-4f6e-95f0-afc02bd19f2e"
     info2CharUUID = "f5d12d34-4390-486c-b906-24ea8906af71"
     eventUUID =  "f12a8e25-59f7-42f2-b7ae-ba96fb25c13c"
 
+
      static async identify(device){
          
          const name = await this.getDeviceProp(device,"Name")

package/sensor_classes/Renogy/RenogySensor.js

@@ -13,6 +13,7 @@ class RenogySensor extends BTSensor{
     static WRITE_CHAR_UUID  = "0000ffd1-0000-1000-8000-00805f9b34fb"
     static READ_FUNC = 3
     static WRITE_FUNC = 6
+    static Manufacturer = "Renogy USA"
     constructor(device,config,gattConfig){
         super(device,config,gattConfig)
     }

package/sensor_classes/RenogyBattery.js

@@ -5,13 +5,12 @@
 const RenogySensor = require("./Renogy/RenogySensor.js");
 class RenogyBattery extends RenogySensor {
     
-    
+    static ImageFile="RenogySmartLiFePo4Battery.webp"
   
     async init(){
-        await super.init()
         this.numberOfCells = await this.retrieveNumberOfCells()
         this.deviceID = await this.retrieveDeviceID()
-        this.initMetadata()
+        await super.init()
     }
 
     async getAllEmitterFunctions(){
@@ -19,7 +18,7 @@ class RenogyBattery extends RenogySensor {
                 this.getAndEmitCellTemperatures.bind(this), 
                 this.getAndEmitCellVoltages.bind(this)]
     }
-    initMetadata(){
+    initSchema(){
 
         this.addMetadatum('numberOfCells','', 'number of cells')
         this.addDefaultPath('current','electrical.batteries.current')

package/sensor_classes/RenogyInverter.js

@@ -6,13 +6,10 @@ const RenogySensor = require("./Renogy/RenogySensor.js");
 const RC=require("./Renogy/RenogyConstants.js")
 class RenogyInverter extends RenogySensor {
 
-    
-    async init(){
-        await super.init()
-        this.initMetadata()
-    }
+    static ImageFile = "RenogyInverter.jpg"
 
-    initMetadata(){
+    initSchema(){
+        super.initSchema()
         this.addMetadatum('batteryType', '', "battery type")
     
         this.addMetadatum('ueiVoltage','V','UEI Voltage',

package/sensor_classes/RenogyRoverClient.js

@@ -6,6 +6,9 @@ const RenogySensor = require("./Renogy/RenogySensor.js");
 const RC=require("./Renogy/RenogyConstants.js")
 
 class RenogyRoverClient extends RenogySensor {
+
+    static ImageFile = "RenogyRoverClient.jpg"
+
 /*
           "batteryType": "electrical.charger.battery.type",
           "batteryPercentage": "electrical.charger.battery.charge",

package/sensor_classes/RuuviTag.js

@@ -2,6 +2,7 @@ const BTSensor = require("../BTSensor");
 class RuuviTag extends BTSensor{
     static manufacturerID = 0x0499
     static Domain = BTSensor.SensorDomains.environmental
+    static ImageFile = "RuuviTag.jpg"
     static  async identify(device){
         if (await this.getManufacturerID(device)==this.manufacturerID)
             return this
@@ -14,9 +15,11 @@ class RuuviTag extends BTSensor{
         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]()
+        if (md) {
+            this.mode = md[0]
+            if (this['_initModeV'+this.mode])
+                this['_initModeV'+this.mode]()
+        }
         else    
             throw new Error("Unrecognized Ruuvitag data mode "+md[0])
 

package/sensor_classes/ShellySBDW002C.js

@@ -16,7 +16,9 @@ class ShellySBDW002C extends AbstractBTHomeSensor {
   static SHORTENED_LOCAL_NAME = "SBDW-002C";
   static LOCAL_NAME = "Shelly BLU Door/Window";
 
-  getDescription() {
+  static ImageFile="ShellyBluDoorWindow.webp"
+
+  getTextDescription() {
     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>.`;
   }
 

package/sensor_classes/ShellySBHT003C.js

@@ -15,6 +15,13 @@ class ShellySBHT003C extends AbstractBTHomeSensor {
 	 */
 	static SHORTENED_LOCAL_NAME = "SBHT-003C";
 	static LOCAL_NAME = "TBD"
+
+	static ImageFile="ShellyBLUHT.webp"
+
+	
+	getTextDescription(){
+		return `NOTE: Device must be paired with SignalK server machine to operate properly. For more information about the sensor go here: <a href=https://us.shelly.com/products/shelly-blu-h-t-black target="_blank">Shelly Blu H&T</a>.` 
+	}
 	
 	initSchema() {
 		super.initSchema()

package/sensor_classes/ShellySBMO003Z.js

@@ -20,8 +20,9 @@ class ShellySBMO003Z extends AbstractBTHomeSensor {
 	 * @type {string}
 	 */
 	static LOCAL_NAME="Shelly BLU Motion";
-
-	getDescription(){
+	static ImageFile="ShellyBLUMotion.webp"
+   	
+	getTextDescription(){
 		return `NOTE: Device must be paired with SignalK server machine to operate properly. For more information about the sensor go here: <a href=https://us.shelly.com/products/shelly-blu-motion target="_blank">Shelly Blu Motion</a>.` 
 	}
 

package/sensor_classes/ShenzhenLiOnBMS.js

@@ -20,6 +20,7 @@ const ProtectionStatus = {
 
 class ShenzhenLiONBMS extends BTSensor{
     static Domain = BTSensor.SensorDomains.electrical
+    static ImageFile = "LiTimeLiFePo4Battery.avif"
     static Commands = {
         product_registration: new Uint8Array([0x00, 0x00, 0x04, 0x01, 0x01, 0x55, 0xAA, 0x05]),
         disconnect_registration: new Uint8Array([0x00, 0x00, 0x04, 0x01, 0x02, 0x55, 0xAA, 0x06]),
@@ -34,6 +35,9 @@ class ShenzhenLiONBMS extends BTSensor{
     static async identify(device){
         return null
     }
+    static DisplayName(){
+        "Shenzhen LiTime BMS Batteries: Redodo, Litime, PowerQueen and others"
+    }
     async sendCommand(cmd){
         await this.txCharacteristic.writeValueWithResponse( Buffer.from(cmd))
     }

package/sensor_classes/SwitchBotMeterPlus.js

@@ -1,7 +1,7 @@
 const BTSensor = require("../BTSensor");
 class SwitchBotMeterPlus extends BTSensor{
     static Domain = BTSensor.SensorDomains.environmental
-		
+    static ImageFile = "SwitchBotMeterPlus.webp"
     constructor(device, config={}){
         super(device,config)
         if (config.parser){

package/sensor_classes/SwitchBotTH.js

@@ -2,7 +2,8 @@ const BTSensor = require("../BTSensor");
 
 class SwitchBotTH extends  BTSensor {
     static Domain = BTSensor.SensorDomains.environmental
-		
+    static ImageFile = "SwitchBotTH.webp"
+    		
     static async test(){
 
         const p = {[this.ID.toString()]: [0xd8, 0x35, 0x34, 0x38, 0x4f, 0x70, 0x07, 0x02, 0x04, 0x96, 0x2c, 0x00]}

package/sensor_classes/UNKNOWN.js

@@ -13,7 +13,8 @@ class UNKNOWN extends BTSensor{
             "sensorClass",
             {
                 title: "Sensor Class",
-                enum:Array.from(this.constructor.classMap.keys())
+                enum: Array.from(this.constructor.classMap.keys()),
+                enumNames: (Array.from(this.constructor.classMap.values()).map((cls)=>{return cls.DisplayName()}))
             }
         )
         this.listen()

package/sensor_classes/UltrasonicWindMeter.js

@@ -11,6 +11,9 @@ class UltrasonicWindMeter extends BTSensor{
         else
             return null
     }
+    static ImageFile="Ultrasonic.jpg"
+    static Manufacturer="Calypso Instruments EMEA, S.L."
+    
     hasGATT(){
         return true
     }

package/sensor_classes/Victron/VictronConstants.js

@@ -110,6 +110,8 @@ const Images = require('./VictronImages.js')
     0xA06F: "BlueSolar MPPT 150|45 rev2",
     0xA070: "BlueSolar MPPT 150|60 rev2",
     0xA071: "BlueSolar MPPT 150|70 rev2",
+    0xA0EB: "Smart Lithium Battery 12.8v 200AH",
+    0xA0EA: "Smart Lithium Battery 25.6v 200AH",
     0xA0F0: "Smart Lithium Battery 4 cells 12v 330AH",
     0xA0EE: "Smart Lithium Battery",
     0xA102: "SmartSolar MPPT VE.Can 150/70",

package/sensor_classes/Victron/VictronIdentifier.js

@@ -0,0 +1,24 @@
+
+class VictronIdentifier{
+    static identify( md ){
+        if (md.length>=5 && md[0]==0x10){
+            switch (md[4]) {
+                case 0x1: return require("../VictronSolarCharger")
+                case 0x2: return require("../VictronBatteryMonitor")
+                case 0x3: return require("../VictronInverter")
+                case 0x4: return require("../VictronDCDCConverter")
+                case 0x5: return require("../VictronSmartLithium")
+                case 0x6: return require("../VictronInverterRS")
+                case 0x7: return require("../VictronGXDevice")
+                case 0x8: return require("../VictronACCharger")
+                case 0x9: return require("../VictronSmartBatteryProtect")
+                case 0xA: return require("../VictronLynxSmartBMS")
+                case 0xC: return require("../VictronVEBus")
+                case 0xD: return require("../VictronDCEnergyMeter");
+                case 0xF: return require("../VictronOrionXS")
+                default: return null
+            }
+        }
+    }
+}
+module.exports=VictronIdentifier

package/sensor_classes/Victron/VictronSensor.js

@@ -3,71 +3,62 @@ const Images = require('./VictronImages.js')
 
 const BTSensor = require("../../BTSensor.js");
 const crypto = require('node:crypto');
-function sleep(x) {
-    return new Promise((resolve) => {
-      setTimeout(() => {
-        resolve(x);
-      }, x);
-    });
-  }
+const VictronIdentifier = require('./VictronIdentifier.js');
+
   class VictronSensor extends BTSensor{
     static Domain = BTSensor.SensorDomains.electrical
-
+    static ManufacturerID = 0x2e1
     constructor(device,config,gattConfig){
         super(device,config,gattConfig)
         
-        if(device.modelID)
-            this.modelID=device.modelID
-        
+        if (device.modelID)
+            this.modelID=device.modelID        
     }
+
     
-    static getModelID(md) {
-        return md[0x2e1]?.value.readUInt16LE(2)??-1
-    }
-    static async identifyMode(device, mode){
-            
-        var md = await this.getDeviceProp(device,'ManufacturerData')
-        if (md==undefined || !Object.hasOwn(md,0x2e1)) 
-            return null
-        else {
-            
-            if (md[0x2e1].value[0]==0x10) {
-                if (md[0x2e1].value[4]==mode) {
-                    device.modelID=this.getModelID(md)
-                    return this
-                }
-                else 
-                    return null
-            }
+    static async getDataPacket(device, md){
+        if (md && md[this.ManufacturerID]?.value[0]==0x10)
+            return md[this.ManufacturerID].value
+
+        device.helper._prepare()
 
-            var hasDataPacket=false
-            device.helper._prepare()
+        return new Promise((resolve, reject) => {
             device.helper.on("PropertiesChanged",
-                 (props)=> {
-                    if (Object.hasOwn(props,'ManufacturerData')){
-                        md = props['ManufacturerData'].value
-                        hasDataPacket=md[0x2e1].value[0]==0x10
+            (props)=> {
+                if (Object.hasOwn(props,'ManufacturerData')){
+                    const md = props['ManufacturerData'].value
+                    if(md[this.ManufacturerID].value[0]==0x10) {
+                        device.helper.removeListeners()
+                        resolve(md[this.ManufacturerID].value)
                     }
+                }
             })        
-            while (!hasDataPacket) {
-                await sleep(500)
-            }
-            device.helper.removeListeners()
-            if (md[0x2e1].value[4]==mode) {
-                device.modelID=this.getModelID(md)
-                return this
-            }
-            else
-                return null
-        } 
+        })
+    }
+    
+    static getModelID(md) {
+        return md[this.ManufacturerID]?.value.readUInt16LE(2)??-1
     }
 
-    async init(){
+    static async identify(device){
+
+        var md = await this.getDeviceProp(device,'ManufacturerData')
+        if (md==undefined || !Object.hasOwn(md,this.ManufacturerID)) 
+            return null
+        const data=await this.getDataPacket(device,md)
+        if (data) {
+            device.modelID=this.getModelID(md)
+            return VictronIdentifier.identify(data)
+        } 
+        return null
+    }
+   async init(){
         await super.init()
         this.addParameter(
             "encryptionKey",
             {
-                title:"Encryption Key"
+                title:"Encryption Key",
+                isRequired: true
             }
         )
     }
@@ -109,7 +100,7 @@ function sleep(x) {
     }
     getModelID(){
         if (!this.modelID ||this.modelID==-1)
-            this.modelID=this.getManufacturerData(0x2e1)?.readUInt16LE(2)??-1
+            this.modelID=this.getManufacturerData(this.constructor.ManufacturerID)?.readUInt16LE(2)??-1
 
         return this.modelID
     }
@@ -122,7 +113,7 @@ function sleep(x) {
         if (this.usingGATT()) return
         if (!props.hasOwnProperty("ManufacturerData")) return
         try{
-            const md = this.getManufacturerData(0x2e1)
+            const md = this.getManufacturerData(this.constructor.ManufacturerID)
             if (md && md.length && md[0]==0x10){
                 const decData=this.decrypt(md)
                 this.emitValuesFrom(decData)
@@ -145,13 +136,11 @@ function sleep(x) {
             return Images.generic
    }
 
-   getDescription(){
+   getTextDescription(){
     //return `<img src="https://www.victronenergy.com/_next/image?url=https%3A%2F%2Fwww.victronenergy.com%2Fupload%2Fproducts%2FSmartShunt%2520500_nw.png&w=1080&q=70"" height="150" align=”top” ></img>`
 
 
-    return `<img src="../bt-sensors-plugin-sk/images/${this.getImage()}" width="200" style="float: left; 
-  margin: 20px;" ></img> 
-    To get the encryption key for your device, follow the instructions <a href=https://communityarchive.victronenergy.com/questions/187303/victron-bluetooth-advertising-protocol.html target="_victron_encrypt">here</a>`
+    return `To get the encryption key for your device, follow the instructions <a href=https://communityarchive.victronenergy.com/questions/187303/victron-bluetooth-advertising-protocol.html target="_victron_encrypt">here</a>`
    }
 
    prepareConfig(config){

package/sensor_classes/VictronACCharger.js

@@ -23,12 +23,7 @@ const VC = require("./Victron/VictronConstants.js")
 const BitReader = require("./_BitReader")
 
 class VictronACCharger extends VictronSensor{
-
-    static async identify(device){
-        return await this.identifyMode(device, 0x08)
-    }   
-
-
+    static ImageFile = "VictronBlueSmartACCharger.jpg"
     initSchema(){
         super.initSchema()
         this.addDefaultParam("id")