bt-sensors-plugin-sk 1.2.0-beta.0.1.6 → 1.2.0

package/BTSensor.js

@@ -286,6 +286,8 @@ class BTSensor extends EventEmitter {
 
     async initSchema(){
         this._schema = {
+            type: "object",
+            title: this.getName(),
             properties:{
                 active: {title: "Active", type: "boolean", default: true },
                 discoveryTimeout: {title: "Device discovery timeout (in seconds)", 
@@ -295,13 +297,12 @@ class BTSensor extends EventEmitter {
             
                 params:{
                     title:`Device parameters`,
-                    description: this.getDescription(),
                     type:"object",
                     properties:{}
                 },
                 paths:{
                     title:"Signalk Paths",
-                    description: `Signalk paths to be updated when ${this.getName()}'s values change`,
+                    description: `Signalk paths to be updated when the device's values change`,
                     type:"object",
                     properties:{}
                 }
@@ -354,7 +355,7 @@ class BTSensor extends EventEmitter {
         }
         if (this.usingGATT()){
             try {
-            this.activateGATT()
+                this.activateGATT()
             } catch (e) {
                 this.debug(`GATT services unavailable for ${this.getName()}. Reason: ${e}`)
                 this._state="ERROR"
@@ -368,7 +369,7 @@ class BTSensor extends EventEmitter {
 
     activateGATT(){
         this.initGATTConnection().then(async ()=>{
-            this.emitGATT()
+            await this.emitGATT()
             if (this.pollFreq)
                 this.initGATTInterval()
             else 
@@ -497,9 +498,7 @@ class BTSensor extends EventEmitter {
                 console.log(e)
             }
               /* END HACK*/
-              this.device.on("disconnect", ()=>{
-                this.debug(`${this.macAndName()} disconnected`)
-            })        
+                 
         })
 
 }
@@ -516,8 +515,8 @@ class BTSensor extends EventEmitter {
         this.device.disconnect().then(()=>{
             this.initPropertiesChanged()
             this.intervalID = setInterval( () => {
-                this.initGATTConnection().then(()=>{
-                    this.emitGATT()
+                this.initGATTConnection().then(async ()=>{
+                    await this.emitGATT()
                     this.device.disconnect()
                         .then(()=>
                             this.initPropertiesChanged()
@@ -585,9 +584,21 @@ class BTSensor extends EventEmitter {
         return this.currentProperties.Address
     }
 
-    getDescription(){
+    getImage(){
+        return "bluetooth-logo.png" 
+    }
+    getImageHTML(){
+        return `<img src="../bt-sensors-plugin-sk/images/${this.getImage()}" height="150" object-fit="cover" ></img>`
+    }
+
+    getTextDescription(){
         return `${this.getName()} from ${this.getManufacturer()}`
     }
+
+    getDescription(){
+        return `<div>${this.getImageHTML()} ${this.getTextDescription()} </div>`
+
+    }
     getName(){
         const name = this?.name??this.currentProperties.Name
         return name?name:"Unknown"
@@ -733,7 +744,7 @@ class BTSensor extends EventEmitter {
    * 
    */
 
-    emitGATT(){
+    async emitGATT(){
         throw new Error("Subclass must implement ::emitGATT function")
     }
 
@@ -752,6 +763,27 @@ class BTSensor extends EventEmitter {
         )
     }
 
+  /**
+   * ::reactivate()
+   */
+ 
+    async reactivate(){
+        await this.stopListening()
+        this.listen()
+        this.currentProperties = await this.constructor.getDeviceProps(this.device)
+        if (this.usingGATT()){
+            try {
+                this.activateGATT()
+            } catch (e) {
+                this.debug(`GATT services unavailable for ${this.getName()}. Reason: ${e}`)
+                this._state="ERROR"
+                return
+            }
+        }
+        this._state="ACTIVE"
+        this._propertiesChanged(this.currentProperties)
+    }
+
   /**
    *  Listen to sensor.
    *  ::listen() sets up listeners for property changes thru ::propertiesChanged(props)
@@ -839,6 +871,8 @@ class BTSensor extends EventEmitter {
     elapsedTimeSinceLastContact(){
         return (Date.now()-this?._lastContact??Date.now())/1000
     }
+
+
 }
 
 module.exports = BTSensor   

package/README.md

@@ -1,106 +1,107 @@
-# Bluetooth Sensors for [Signal K](http://www.signalk.org)
+# Bluetooth Sensors for [Signal K](http://www.signalk.org) 
+# Version 1.2.0 
 
-## What's New
-
-## 1.2.0-beta-0.1.5/6
-
-Renogy and JBDBMS fixes
-
-## 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
-
-## 1.2.0-beta-0.1.2.a
-
-Module load fix
-
-## 1.2.0-beta-0.1.2
-
-SSE deregister fix (long story)
-
-## 1.2.0-beta-0.1.1
-
-Gobius fix for inclination path, id parameter.
-
-## 1.2.0-beta-0.1.0
-
-Sensors on config page appear under tabs indicating their domain (Environmental, Electrical etc.)
-
-Gobius C tank meter support added.
+## WHAT IT IS
 
-## 1.2.0-beta-0.0.10
+BT Sensors Plugin for Signalk is a lightweight BLE (Bluetooth Low Energy) framework for listening and connecting to Bluetooth sensors on your boat. After discovery and configuration the plugin sends deltas to Signalk paths with values your sensor reports. <br>
 
-Better handling of plugin config screen when Disabled
+It runs on any 2.0 or greater SignalK installation but on Linux only. It's been tested on Desktop and headless RPis, OpenPlotter, and Cerbo GX/Ekrano.
 
-## 1.2.0-beta-0.0.9
+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>
 
-Fixes to config page RSSI update.
+The reported temperature can then be displayed on a Signalk app like Kip, WilhelmSK or, with appropriate mapping to NMEA-2000, a NMEA 2000 Multi-function display. 
 
-## 1.2.0-beta-0.0.8
+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).
 
-Improved handling of changed state on config page.
+## WHAT'S NEW SINCE VERSION 1.1.x
 
-Several small fixes to various sensor classes.
+- Dynamic configuration screen. The Device list automatically updates when new devices are found by the BT scanner. (No more annoying screen refresh necessary!). 
 
-## 1.2.0-beta-0.0.7
+- Sensors appear under tabs indicating their domain (Environmental, Electrical etc.)
 
-Added zone config param for environmental sensors. Removed location parameter. 
+- Support added for [Shelly Blu Motion sensor ](https://us.shelly.com/products/shelly-blu-motion), Gobius C tank meter and LiTime/Rebodo Smart Batteries.
 
-## 1.2.0-beta-0.0.6
-Default values for paths for most sensor classes. 
+- Default values for paths for most sensor classes. 
 
-## 1.2.0-beta-0.0.5
+- Support for multiple simultaneous GATT connections. 
 
-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. 
+## SUPPORTED SENSORS
 
-## 1.2.0-beta-0.0.1
+### NOTE 
 
-Dynamic configuration added. List updates when new devices are found by scanner. (No more screen refreshing necessary).
+- Not all listed devices and variants have been thoroughly tested. If you encounter any issues, please report on github.  
+- Some supported devices cannot be automatically identified -- at least not reliably. You'll need to select the sensor class configuration variable manually.
+- Not all supported devices are enumerated under their manufacturer. Some device models that are not known to this  developer may share a protocol with another brand/model and in fact be supported. Please raise an issue on github if you discover a supported device that's not listed or implied below. 
 
-## WHAT IT IS
+### Electrical 
+| Manufacturer | Devices |
+|--------------|---------|
+|[Victron](https://www.victronenergy.com/)|All documented (as of May 2025) devices that support instant readout (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) See: https://www.victronenergy.com/panel-systems-remote-monitoring/victronconnect|  
+|[Renogy](https://www.renogy.com/)| Renogy Smart Batteries, Inverters and Rover Client |
+|[JBD/Jibada](https://www.jbdbms.com/)| Smart BMS devices see: https://www.jbdbms.com/collections/smart-bms |
+|Xiaoxiang| Rebranded JBD/Jibada |
+|[LiTime](https://www.litime.com/)| LifePo4 Smart Batteries |
+|Redodo| Rebranded LiTime |
+|Kilovault| [Kilovault HLX+ smart batteries ](https://sunwatts.com/content/manual/KiloVault_HLX_PLUS_Datasheet_06252021%20%281%29.pdf?srsltid=AfmBOooY-cGnC_Qm6V1T9Vg5oZzBCJurS0AOGoWqWeyy-dwz2vA-l1Jb) (Note: Kilovault appears to be out of business as of March 2024) |
+|[Lancol](www.Lancol.com)| [Micro 10C 12V Car Battery Monitor](https://www.lancol.com/product/12v-bluetooth-4-0-battery-tester-micro-10-c/)|
 
-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, and Inkbird thermometers.
+### Environmental 
+| Manufacturer |  Devices | 
+|--------------|----------|
+|[Ruuvi](https://ruuvi.com/)| Ruuvi Tag and Ruuvi Tag Pro|
+|[Switch Bot](https://www.switch-bot.com/)| Meter Plus and TH devices |
+|[Xiaomi](https://www.mi.com/global/)|  LYWSD03MMC (and variants) Temp and Humidity Sensor |
+|[ATC](https://github.com/atc1441/ATC_MiThermometer)| Custom firmware for LYWSD03MMC |
+|[Shelly](https://www.shelly.com/)| Shelly SBHT003C Temperature and Humidity Sensor and Shelly SBMO003Z Motion Sensor |
+|[Calypso Instruments](https://calypsoinstruments.com)| [Wireless Wind Meters](https://calypsoinstruments.com/sailing)  |
+|[Aranet](https://www.aranet.com)| Aranet 2 Temp and Humidity Sensor. Aranet 4 Temp/Humidity/Co2 Sensor. |
+|[Govee](http://www.govee.com)| Govee H50xx and H510x Temperature and humidity sensors |
+|[BTHome](https://bthome.io/)| NOTE: Framework for IOT sensor devices. |
+|[Inkbird](https://inkbird.com/)| TH-2 Temp and Humidity Sensor |
 
-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>
 
-The reported temperature can then be displayed on a Signalk app like Kip, WilhelmSK or, with appropiate mapping to NMEA-2000, a NMEA 2000 Multi-function display. 
+### Tanks 
+| Manufacturer |  Devices | 
+|--------------|----------|
+| [Gobius](https://gobiusc.com/) | Gobius-C Tank level sensor|
+| [Mopeka](https://www.mopeka.com) | [Mopeka Pro Chek](https://mopeka.com/product-category/recreational-sensors-rv-bbq-etc/) ultrasonic tank level sensor  |
 
-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).
 
-## WHO IS IT FOR
+## WHO IT'S 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.
 
 ## REQUIREMENTS
 
-* A Linux Signalk boat-puter with bluetooth-DBUS support 
-* A Bluetooth adapter
+* A Linux Signalk boat-puter with bluetooth-DBUS support
+* A Bluetooth adapter, either built-in or a USB external adapter
 * [Bluez](https://www.bluez.org) installed
 (Go here for [Snap installation instructions](https://snapcraft.io/bluez))
 * [Node-ble](https://www.npmjs.com/package/node-ble) (installs with the plugin)
 
 ## INSTALLATION
 
-NOTE: If you're running the 1.0.3 release, you will have to reconfigure your devices.<br>
-
 ### Signalk Appstore
-The beta plugin is not currently available in the Signalk Appstore. <br>
+The plugin is available in the Signalk Appstore. Yay. <br>
+
+### Signal K Server in Docker
+
+If you are running SK Server in a Docker container you'll need to mount the dbus system from the host and run as privileged. <br><br>
+
+Add the following lines `docker-compose.yml`:
+
+```
+    volumes:
+      - /var/run/dbus:/var/run/dbus
+    privileged: true
+```
 
-### NPM
+### NPM Installation
 
 Go to you signalk home (usually ~/.signalk) and run:
 
-npm i bt-sensors-plugin-sk@1.2.0-beta.0.0.7
+npm i bt-sensors-plugin-sk@latest
 
 ### Linux
 
@@ -109,7 +110,6 @@ 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
@@ -125,33 +125,49 @@ Finally, restart SK. Plugin should appear in your server plugins list.<br>
 
 After installing and restarting Signalk you should see a "BT Sensors Plugin" option in the Signalk->Server->Plugin Config page.<br><br>
 
-<img width="1130" alt="Screenshot 2024-10-13 at 6 50 09 PM" src="https://github.com/user-attachments/assets/4180504e-1ca8-48af-babf-899486fb0a24"><br><br>
+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. (NOTE: You only need to scan for new devices during configuration. Once your config is set, set the new devices interval to 0.) <br><br>
 
-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>
+<img width="1182" alt="Screenshot 2025-06-12 at 9 33 57 AM" src="https://github.com/user-attachments/assets/f0e1d644-3090-4f13-820e-748e9c83bc82" />
+<br><br>
+
+Select the sensor you want Signalk to listen to from the categorized list.<br>
+
+<img width="1115" alt="Screenshot 2025-06-12 at 9 34 16 AM" src="https://github.com/user-attachments/assets/70baf082-c181-4482-bde4-1e65c07702de" />
+
+NOTE: Devices that are not configured appear in *italics*. Configured devices with unsaved changes are asterisked.
+
+The selected device's configuration will appear below the list of found devices.
 
+<img width="1095" alt="Screenshot 2025-06-12 at 9 34 48 AM" src="https://github.com/user-attachments/assets/48670df2-7f85-4ca1-9ea2-c1cf49087858" />
+
+If you see your device in the UNKNOWN tab it may not be currently supported. But fear not, you can add custom sensor classes yourself. (Check out the [development README](./sensor_classes/DEVELOPMENT.md).) 
+
+If your device appears as UNKNOWN and is a supported sensor it's likely that it can't be automatically identified by the plugin. Select the senor and then select the appropriate Sensor Class from the dropdown list. After saving, you should see your sensor in the tab under its type (Electrical, etc). You'll be able to edit the paths for the sensor now. 
 <br><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 (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>
 
-<img width="1125" alt="Screenshot 2024-10-13 at 9 30 53 PM" src="https://github.com/user-attachments/assets/5284539e-d5ee-488f-bbab-901258eb1c0b">
+<img width="1087" alt="Screenshot 2025-06-12 at 9 35 01 AM" src="https://github.com/user-attachments/assets/6deee310-57ec-4df6-979a-6ca16699392d" />
+
+Most devices will have default paths that should align with the SignalK spec. If the sensor is missing defaults or the defaults are not consistent with the SK spec, create an issue or open a pull request and add your own to the sensor's `initSchema()` method. 
+
+Be sure to Save your device configuration by selecting **Save**. 
 
-The plugin doesn't need for Signalk to restart after submitting your config but restart if that makes you more comfortable. <br><br>
+<img width="325" alt="Screenshot 2025-06-12 at 9 35 16 AM" src="https://github.com/user-attachments/assets/951f41ce-2363-4527-9d9b-d5aa9aca7e14" />
 
-### ADVERTISED DATA
+To delete the configuration, select **Delete**. To undo any changes, select **Undo**.
 
-Most supported Bluetooth sensors broadcast (or advertise) their device's data without an explicit connection. Some devices broadcast their data encrypted. Supported devices with encrypted advertised data will allow you to input the encryption key as a config parameter. NOTE: the encryption key is currently stored on the server in plain text. 
+Your device will restart its connection automatically after saving.
 
-### GATT CONNECTIONS
+You may see embedded in a default path values like `{zone}`. This is a parameter variable you can set in the config whose value can cascade through the configuration of your paths.
 
-If you see something like this on your device config:
+<img width="309" alt="Screenshot 2025-06-12 at 9 37 15 AM" src="https://github.com/user-attachments/assets/3b02e819-4408-4b37-a257-cda8f4a035c5" /><img width="192" alt="Screenshot 2025-06-12 at 9 37 28 AM" src="https://github.com/user-attachments/assets/1cf13934-4c09-47b3-8eef-d215fcd93374" />  
 
-<img width="727" alt="Screenshot 2024-10-13 at 9 42 26 PM" src="https://github.com/user-attachments/assets/65fe1aa7-99a5-41ac-85dc-cfde00e95932">
+Any member variable of the sensor class can be used as a parameter variable. Equally, any unary function that returns a string can be used as a parameter variable (`{macAndName}`, for example). Use with caution.
 
-You have the option of making a GATT Connection to your device. A GATT Connection is energy-inefficient but serves data from your device in more or less real-time. To learn more about GATT check out: https://learn.adafruit.com/introduction-to-bluetooth-low-energy/gatt
+<br><br>
 
 ## NOW WHAT?
 
@@ -161,7 +177,97 @@ You should see data appear in your data browser. Here's a screenshot of Signalk
 
 You can now take the data and display it using Kip, WilhelmSK or route it to NMEA-2K and display it on a N2K MFD, or use it to create and respond to alerts in Node-Red. Isn't life grand?
 
+## NOTES ON WORKING WITH BLUETOOTH DEVICES
+
+This project got started when I wanted to monitor the temperature in my boat's refrigerator. The thought of spending > $100 US and straining my back muscles so I could run NMEA wires under my cabin sole or behind my water heater got me thinking "Wireless, that sounds like a good idea."
+
+A year or so later, I have wireless Bluetooth sensors reporting not only on my refrigerator temperature but on the temperature and humidity in the vberth, on the deck and at the nav table. I'm getting wireless electrical data from my house and starter battery banks as well as on the levels of my propane tank. When there's motion detected on my boat, I get an email and a text telling me so. All wirelessly. All on inexpensive devices powered by inexpensice batteries that last sometimes for years and can be purchased at my local CVS (a US mega-pharmacy).
+ 
+Bluetooth LE (Low Energy) sensors are very inexpensive (especially compared to marine vendor options), widely available, and depending on the brand, very durable (even in marine environments).
+
+Some things I've learned that may be of use.
+
+### The Interference is Real
+
+Bluetooth LE runs at 2.4 GHZ. This is an, uh, oversubscribed part of the EM spectrum. If you're not careful with  the placement and shielding of your 2.4Ghz devices, you will encounter interference and signal/connection dropoff. 
+
+HDMI and USB 3.0, both of which operate at approximately twice the frequency of BT-LE can cause as much signal interference as a 2.4Ghz device. One plugin user noticed that when he turned on the HDMI monitor to his RPI, the plugin would lose a connection to some of his devices. 
+
+### It's Not as Simple as You Think
+
+There are two ways that Bluetooth devices emit their data. One, the old-fashioned way is through a full-fledged connection. Generally, that's a GATT (for Generic ATTribute Profile) connection. The other, which makes sense for IOT devices like most sensors, is by squeezing data into the device's Advertisement protocol.
+
+GATT connections require a lot of power and drain batteries pretty quickly, hence the Advertisement protocol hack that IOT devices use. 
+
+It's also a pain in the butt to maintain a GATT connection. AND you can only have so many per client device (seven, usually). 
+
+Victron, for example, started off its instant readout program with GATT connections (the battery power didn't matter as their devices are all powered by wire) but eventually gave up and went to an encrypted Advertising protocol which allowed them in the Connect App and their Cerbo devices to monitor multiple devices without a connection.
+
+Not all BMS manufacturers are as wise. Many of the inexpensive BMSes developed in China (several of which the plugin supports) use GATT connections. GATT connections are perfectly adequate if all you're doing is connecting through an app, checking your starter battery voltage, for instance, then closing the app. It's another thing when you've got a client like Signal K which is listening for changes to the starter battery voltage at all times.
+
+All of which is to say, be aware that if your device uses a GATT connection, it may suffer from connection loss.
+
+If your device is connection-y and frequently drops its connection and there's not a lot of obvious interference, please fill out an issue on github.
+
+### RPI 3/4/4b/5 Bluetooth Sucks
+
+The Raspberry Pi's native BT radio strength is weak. Unless all your sensors are within direct line of sight and less than 20 or so feet from your RPI you'll get inconsistent results. 
+
+Get yourself a BT 5.3 USB adapter. They're inexpensive (around $20 US). I have a [Tp-link UB500-Plus](https://www.tp-link.com/us/home-networking/usb-adapter/ub500-plus/) on my boat. *chef's kiss*
+
+
+### Bluetooth on Linux ain't Great
+
+Linux, IMHO, is a server OS first, a desktop OS second. Unfortunately, a lot of Linux developers have dreams of killing OSx and Windows and saving the world with open source (a noble but foolosh conceit). As a result, things like the Bluetooth stack on Linux skew toward desktop-friendly devices like headphones, keyboards, mice and the like. 
+
+The use pattern for a connected bluetooth peripheral is: start the scanner for one-time discovery and pairing which is followed by regular connection and usage (with no scanning necessary).
+
+For most Advertisement-oriented devices, the use pattern is turn scanner on and listen for changes to Advertised values. As most sensors are Advertisement-oriented, the plug-in keeps the Bluetooth scanner on at all times. 
+
+If a process on the server turns off the scanner, the plugin will, at least for Advertisement-oriented devices, appear to have stopped. Connected devices will continue to run normally, however.
+
+Because Desktop installations are oriented toward connected peripherals, the Bluetooth manager on Rasberry Pi's may turn off the scanner when it's closed by a user. So keep that in mind. 
+
+Disable/enable the plugin or submit your changes to restart the scanner if it stops.
+
+#### D-BUS
+Linux uses D-Bus, a path-oriented data store for getting and setting system info. 
+
+Bluez, the Debian standard for interacting with BT devices is D-Bus oriented. This plug-in relies on D-Bus for its BT data. 
+
+D-Bus keeps a reference to scanned BT devices for a default of 30s. If a device is not paired, D-Bus tosses that reference out and waits for another Advertisement from the device before adding the device back into its database. 
+
+As a result, some devices with Advertisement periods of less than the default Bluez stay alive parameter (30s) appear to be permanently unavailable.
+
+The simplest solution is pair any device that fails to show up in the scan. See [pairing guide](./pairing.md) for more info on how to pair a device to your Signal K server. 
+
+Future versions of the plugin will allow you to pair from the configuration interface (assuming it's possible and I have the time.)
+
+
+## THANKS
+
+Many thanks to all those who contributed to the project either with code or testing or just letting me sit on a dock near their boat and connect to their devices.
+
+- Michael aboard the A Bientot
+- Kevin on the Luna Miel
+- Jason on the Apres Ski
+- Teppo
+- Ilya
+- Guthip
+- Peter
+- Greg
+- Bram
+- Karl
+- Mat in NZ
+- Kees
+- Scarns
+- John W.
+- Sebastian
+- Arjen
+- SDLee
+- Jordan
 
+It takes a village. Or more appropriately, an armada. Okay, regatta. But you get the idea.
   
   
  

package/index.js

@@ -88,7 +88,7 @@ class MissingSensor  {
 
 }
 module.exports =   function (app) {
-	var deviceConfigs
+	var deviceConfigs=[]
 	var starts=0
 	
 	var plugin = {};
@@ -100,6 +100,9 @@ module.exports =   function (app) {
 	
 	plugin.schema = {			
 		type: "object",
+		htmlDescription: 
+`<h2><a href="https://github.com/naugehyde/bt-sensors-plugin-sk/tree/1.2.0-beta#configuration" target="_blank">Plugin Documenation</a><p/><a href="https://github.com/naugehyde/bt-sensors-plugin-sk/issues/new/choose" target="_blank">Report an issue</a><p/><a href="https://discord.com/channels/1170433917761892493/1295425963466952725" target="_blank">Discord thread</a></h2>
+ `,
 		required:["adapter","discoveryTimeout", "discoveryInterval"],
 		properties: {
 			adapter: {title: "Bluetooth adapter",
@@ -130,21 +133,6 @@ module.exports =   function (app) {
 	const classMap = loadClassMap(app)
 	const sensorMap=new Map()
 
-	
-/*	plugin.registerWithRouter = function(router) {
-		router.get('/sendPluginState', async (req, res) => {
-		
-			res.status(200).json({
-				"state":(plugin.started?"started":"stopped")
-			})
-		});
-		router.get("/sse", async (req, res) => {
-			const session = await createSession(req, res);
-			channel.register(session)
-	   });
-	
-	}*/
-
 	plugin.start = async function (options, restartPlugin) {
 		plugin.started=true
 		var adapterID=options.adapter
@@ -288,9 +276,11 @@ module.exports =   function (app) {
 
 		function sensorToJSON(sensor){
 			const config = getDeviceConfig(sensor.getMacAddress())
+			const schema = sensor.getJSONSchema()
+			schema.htmlDescription = sensor.getDescription()
 			return {
 					info: getSensorInfo(sensor),
-					schema: sensor.getJSONSchema(),
+					schema: schema,
 					config: config?config:{}
 				}
 		}
@@ -330,8 +320,7 @@ module.exports =   function (app) {
 		
 		function addSensorToList(sensor){
 			app.debug(`adding sensor to list ${sensor.getMacAddress()}`)
-			if (sensorMap.has(sensor.getMacAddress()) )
-				debugger 
+
 			sensorMap.set(sensor.getMacAddress(),sensor)
 			channel.broadcast(sensorToJSON(sensor),"newsensor");
 		}
@@ -350,8 +339,9 @@ module.exports =   function (app) {
 					return
 				}
 				s = await instantiateSensor(device,config) 
-				//app.debug(`Instantiated ${config.mac_address}`)
-				
+				if (!s) 
+					reject("Unable to create sensor")
+				else
 				if (s instanceof BLACKLISTED)
 					reject ( `Device is blacklisted (${s.reasonForBlacklisting()}).`)
 				else{
@@ -384,45 +374,47 @@ module.exports =   function (app) {
 		}
 		function getDeviceConfig(mac){
 			return deviceConfigs.find((p)=>p.mac_address==mac) 
-		}	
-		async function instantiateSensor(device,config){
-			try{
+		}
+		async function getClassFor(device,config){
+			
+			if (config.params?.sensorClass){
+				const c = classMap.get(config.params.sensorClass)
+				if (c==null)
+					throw new Error ("Cannot find class "+config.params.sensorClass)
+				return c
+			}			
 			for (var [clsName, cls] of classMap) {
 				if (clsName.startsWith("_")) continue
 				const c = await cls.identify(device)
 				if (c) {
-					c.debug=app.debug
-					const sensor = new c(device,config?.params, config?.gattParams)
-					sensor.debug=app.debug
-					sensor.app=app
-					  sensor._adapter=adapter //HACK!
-
-					await sensor.init()
-					//app.debug(`instantiated ${await BTSensor.getDeviceProp(device,"Address")}`)
-					
-					return sensor
+					if (Object.hasOwn(config, "params")) {
+						config.params.sensorClass=clsName
+					}
+					return c
 				}
-			}} catch(error){
+			}
+			return classMap.get('UNKNOWN')
+		}
+				
+		async function instantiateSensor(device,config){
+			try{
+				const c = await getClassFor(device,config)
+				c.debug=app.debug
+				const sensor = new c(device, config?.params, config?.gattParams)
+				sensor.debug=app.debug
+				sensor.app=app
+				sensor._adapter=adapter //HACK!
+				await sensor.init()				
+				return sensor
+			}
+			catch(error){
 				const msg = `Unable to instantiate ${await BTSensor.getDeviceProp(device,"Address")}: ${error.message} `
 				app.debug(msg)
 				app.debug(error)
 				app.setPluginError(msg)
+				return null
 			}
-			//if we're here ain't got no class for the device
-			var sensor 
-			if (config.params?.sensorClass){
-				var c = classMap.get(config.params.sensorClass)
-			} else{
-				c = classMap.get('UNKNOWN')
-			}
-			c.debug=app.debug
-			sensor = new c(device,config?.params, config?.gattParams)
-			sensor.debug=app.debug
-			sensor.app=app
-			sensor._adapter=adapter //HACK!
-
-			await sensor.init()
-			return sensor
+
 		}	
 		
 		function initConfiguredDevice(deviceConfig){
@@ -479,7 +471,7 @@ module.exports =   function (app) {
 
 						if (!deviceConfig) {
 							deviceConfig = {mac_address: mac, 
-											discoveryTimeout: discoveryTimeout*1000, 
+											discoveryTimeout: discoveryTimeout, 
 											active: false, unconfigured: true}
 							initConfiguredDevice(deviceConfig) 
 						}