bt-sensors-plugin-sk 1.2.0-beta.0.0.1.test → 1.2.0-beta.0.0.10

package/sensor_classes/VictronSolarCharger.js

@@ -6,25 +6,38 @@ class VictronSolarCharger extends VictronSensor{
         return await this.identifyMode(device, 0x01)
     }   
 
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata() { 
-    this.addMetadatum('chargeState','', 'charge state', 
+    initSchema() {
+        super.initSchema()
+        this.addDefaultParam("id")
+    
+        this.addMetadatum('chargeState','', 'charge state', 
         (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
-    this.addMetadatum('chargerError','', 'charger error',
-        (buff)=>{return VC.ChargerError.get(buff.readUInt8(1))})
-    this.addMetadatum('voltage','V', 'charger battery voltage', 
-        (buff)=>{return this.NaNif(buff.readInt16LE(2),0x7FFF)/100})
-    this.addMetadatum('current','A','charger battery current', 
-        (buff)=>{return this.NaNif(buff.readInt16LE(4),0x7FFF)/10})
-    this.addMetadatum('yield','Wh', 'yield today in Watt-hours', 
-        (buff)=>{return this.NaNif(buff.readUInt16LE(6),0xFFFF)*10})
-    this.addMetadatum('solarPower','W', 'solar power', 
-        (buff)=>{return this.NaNif(buff.readUInt16LE(8),0xFFFF)})    
-    this.addMetadatum('externalDeviceLoad','A', 'external device load', 
-        (buff)=>{return this.NaNif(buff.readUInt16LE(10)&0x1FF,0x1FF)/10})    
+        .default="electrical.solar.{id}.state"
+    
+        this.addMetadatum('chargerError','', 'charger error',
+            (buff)=>{return VC.ChargerError.get(buff.readUInt8(1))})
+            .default="electrical.solar.{id}.error"
+
+        this.addMetadatum('voltage','V', 'charger battery voltage', 
+            (buff)=>{return this.NaNif(buff.readInt16LE(2),0x7FFF)/100})
+            .default="electrical.solar.{id}.dc.voltage"
+
+        this.addMetadatum('current','A','charger battery current', 
+            (buff)=>{return this.NaNif(buff.readInt16LE(4),0x7FFF)/10})
+            .default="electrical.solar.{id}.dc.current"
+
+        this.addMetadatum('yield','Wh', 'yield today in Watt-hours', 
+            (buff)=>{return this.NaNif(buff.readUInt16LE(6),0xFFFF)*10})
+            .default="electrical.solar.{id}.yieldToday"
+
+        this.addMetadatum('solarPower','W', 'solar power', 
+            (buff)=>{return this.NaNif(buff.readUInt16LE(8),0xFFFF)})   
+            .default="electrical.solar.{id}.panelPower" 
+       
+        this.addMetadatum('externalDeviceLoad','A', 'external device load', 
+            (buff)=>{return this.NaNif(buff.readUInt16LE(10)&0x1FF,0x1FF)/10})
+            .default="electrical.solar.{id}.loadCurrent" 
+  
     }
 }
 module.exports=VictronSolarCharger 

package/sensor_classes/VictronVEBus.js

@@ -9,11 +9,8 @@ class VictronVEBus extends VictronSensor{
         return await this.identifyMode(device, 0x0C)
     }   
 
-    async init() {
-        await super.init()
-        this.initMetadata()
-    }
-    initMetadata(){
+    initSchema(){
+        super.initSchema()
         this.addMetadatum('chargeState','', 'charge state', 
             (buff)=>{return VC.OperationMode.get(buff.readUInt8(0))})
             

package/sensor_classes/XiaomiMiBeacon.js

@@ -90,8 +90,6 @@ class XiaomiMiBeacon extends BTSensor{
                 return null
         }
     }
-
-    GATTwarning = "WARNING: Xiaomi GATT connections are known to be unreliable on Debian distributions with Bluez 5.55 and up (earlier BlueZ versions are untested). Using GATT on the Xiaomi may put the system Bluetooth stack into an inconsistent state disrupting and disabling other plugin Bluetooth connections. If by some chance you're successful using GATT with the Xiaomi, let the plugin developer know your configuration. Refer to the plugin documentation for getting the Xiamoi bindKey for non-GATT connections and more information on Xiaomi GATT issues."
     
     emitValues(buffer){
         this.emitData("temp", buffer, 0)
@@ -102,15 +100,12 @@ class XiaomiMiBeacon extends BTSensor{
         return "Xiaomi Inc."
     }
     getGATTDescription() {
-        return this.GATTwarning
+        return ""
     }
+
     initGATTConnection(){
-        if (!this?.gattWarningDelivered) {
-            this.debug(this.GATTwarning.toUpperCase())
-            this.gattWarningDelivered=true
-        }
         return new Promise((resolve,reject )=>{
-            this.device.connect().then(async ()=>{
+            this.deviceConnect().then(async ()=>{
                 if (!this.gattServer) {
                     this.gattServer = await this.device.gatt()
                     this.gattService = await this.gattServer.getPrimaryService("ebe0ccb0-7a0a-4b0c-8a1a-6ff2997da3a6")
@@ -202,30 +197,36 @@ class XiaomiMiBeacon extends BTSensor{
     }
     
     async init(){
+
         await super.init()
         const data = this.getServiceData(this.constructor.SERVICE_MIBEACON)
         const frameControl = data[0] + (data[1] << 8)
         this.deviceID = data[2] + (data[3] << 8)
         this.isEncrypted = (frameControl >> 3) & 1
         this.encryptionVersion = frameControl >> 12 
+    }   
+    initSchema(){
+        super.initSchema()
+        this.addDefaultParam("zone")
+
         this.addParameter(
             "encryptionKey",
             {
                 title: "encryptionKey (AKA bindKey) for decryption"
             }
         )
-        this.addMetadatum('temp','K', 'temperature',
-            (buff,offset)=>{return ((buff.readInt16LE(offset))/10) + 273.15})
-        this.addMetadatum('humidity','ratio', 'humidity',
-            (buff,offset)=>{return buff.readInt16LE(offset)/1000})
+        this.addDefaultPath('temp','environment.temperature')
+        .read=(buff,offset)=>{return ((buff.readInt16LE(offset))/10) + 273.15}
 
-        this.addMetadatum('batteryStrength', 'ratio',  'sensor battery strength',
-            (buff,offset)=>{return ((buff.readUInt8(offset))/100)})
-        this.addMetadatum('voltage', 'V',  'sensor battery voltage',
-            (buff,offset)=>{return ((buff.readUInt16LE(offset))/1000)})
-
-
-    }   
+        this.addDefaultPath('humidity','environment.humidity')
+        .read=(buff,offset)=>{return buff.readInt16LE(offset)/1000}        
+            
+        this.addDefaultPath("batteryStrength", "sensors.batteryStrength")
+        .read= (buff,offset)=>{return ((buff.readUInt8(offset))/100)}
+       
+        this.addDefaultPath("voltage", "sensors.batteryVoltage")
+        .read=(buff,offset)=>{return ((buff.readUInt16LE(offset))/1000)}
+    }
 
     getName(){
         const dt = DEVICE_TYPES.get(this.deviceID)

package/src/components/PluginConfigurationPanel.js

@@ -5,8 +5,7 @@ import {useEffect, useState} from 'react'
 
 import {Button, Grid} from '@material-ui/core';
 
-
-import {  SignalCellular0Bar, SignalCellular1Bar, SignalCellular2Bar, SignalCellular3Bar, SignalCellular4Bar, SignalCellularConnectedNoInternet0Bar    } from '@material-ui/icons';
+import { SignalCellular0Bar, SignalCellular1Bar, SignalCellular2Bar, SignalCellular3Bar, SignalCellular4Bar, SignalCellularConnectedNoInternet0Bar    } from '@material-ui/icons';
 
 const log = (type) => console.log.bind(console, type);
 
@@ -66,16 +65,16 @@ export default (props) => {
 
   async function fetchJSONData(path){
     console.log(`fetching ${path}`)
-
+     
     return fetch(`/plugins/bt-sensors-plugin-sk/${path}`, {
       credentials: 'include'
     })
 
   }
 
-  async function getSensorData(){
-  
-    const response = await fetchJSONData("sensors")
+  async function getSensors(){
+    console.log("getSensors")
+    const response = await fetchJSONData("getSensors")
     if (response.status!=200){
       throw new Error(`Unable get sensor data: ${response.statusText} (${response.status}) `)
     }
@@ -86,8 +85,8 @@ export default (props) => {
   }
 
   async function getBaseData(){
-    
-    const response = await fetchJSONData("base")
+    console.log("getBaseData")
+    const response = await fetchJSONData("getBaseData")
     if (response.status!=200){
       throw new Error(`Unable get base data: ${response.statusText} (${response.status}) `)
     }
@@ -96,8 +95,8 @@ export default (props) => {
     return json
   }
   async function getProgress(){
-    
-    const response = await fetchJSONData("progress")
+    console.log("getProgress")
+    const response = await fetchJSONData("getProgress")
     if (response.status!=200){
       throw new Error(`Unable get progres: ${response.statusText} (${response.status}) `)
     }
@@ -107,21 +106,26 @@ export default (props) => {
   }
 
   function updateSensorData(data){
-    sendJSONData("sendSensorData", data).then((response)=>{ 
+    console.log("updateSensorData")
+    sendJSONData("updateSensorData", data).then((response)=>{ 
       if (response.status != 200) {
         throw new Error(response.statusText)
       }
-      debugger
+      sensorMap.get(data.mac_address)._changesMade=false
       sensorMap.get(data.mac_address).config = data
       
     })
-  }
+  } 
 
   function undoChanges(mac) {
+    console.log("undoChanges")
+    sensorMap.get(mac)._changesMade = false
     setSensorData( sensorMap.get(mac).config )
   }
 
   function removeSensorData(mac){
+    console.log("removeSensorData")
+
     try{ 
     
       sendJSONData("removeSensorData", {mac_address:mac} ).then((response)=>{
@@ -142,7 +146,9 @@ export default (props) => {
 
 
   function updateBaseData(data){
-    sendJSONData("sendBaseData", data).then( (response )=>{
+    console.log("updateBaseData")
+
+    sendJSONData("updateBaseData", data).then( (response )=>{
       if (response.status != 200) {
         setError(new Error(`Unable to update base data: ${response.statusText} (${response.status})`))
       } else {
@@ -160,7 +166,7 @@ export default (props) => {
   function refreshSensors(){
     console.log('refreshing sensor map')
 
-    getSensorData().then((sensors)=>{
+    getSensors().then((sensors)=>{
       setSensorMap (new Map(sensors.map((sensor)=>[sensor.info.mac,sensor])));    
     })
     .catch((e)=>{
@@ -170,14 +176,19 @@ export default (props) => {
 
 
   useEffect(()=>{
-
-    fetchJSONData("sendPluginState").then( async (response)=> {
+    console.log("useEffect([])")
+    fetchJSONData("getPluginState").then( async (response)=> {
+      if (response.status==404) {
+        setPluginState("unknown")
+        throw new Error("unable to get plugin state")
+      }
       const json = await response.json()
       setPluginState(json.state)
       console.log("Setting up eventsource")
       const eventSource = new EventSource("/plugins/bt-sensors-plugin-sk/sse")
       
       eventSource.addEventListener("newsensor", (event) => {
+        console.log("newsensor")
         let json = JSON.parse(event.data)
         
         if (!_sensorMap.has(json.info.mac)) {
@@ -187,7 +198,9 @@ export default (props) => {
       });
 
       eventSource.addEventListener("sensorchanged", (event) => {
-        let json = JSON.parse(event.data)        
+        let json = JSON.parse(event.data)      
+        console.log("sensorchanged")
+        console.log(json)
         
         if (_sensorMap.has(json.mac)) {      
           let sensor = _sensorMap.get(json.mac)
@@ -196,12 +209,14 @@ export default (props) => {
         }
       });
       eventSource.addEventListener("progress", (event) => {
+        console.log("progress")
         const json = JSON.parse(event.data)  
         setProgress(json)
         console.log(json)
       });
 
       eventSource.addEventListener("pluginstate", (event) => {
+        console.log("pluginstate")
         const json = JSON.parse(event.data)  
         setPluginState(json.state)
       });
@@ -215,6 +230,7 @@ export default (props) => {
 },[])
 
 useEffect(()=>{
+  console.log("useEffect([pluginState])")
   if (pluginState=="started"){
     refreshSensors()
     
@@ -239,9 +255,7 @@ useEffect(()=>{
 
 },[pluginState])
 
-useEffect(()=>{
-  console.log(error)
-},[error])
+
 
 function confirmDelete(mac){
   const result = window.confirm(`Delete configuration for ${mac}?`)
@@ -269,6 +283,8 @@ function signalStrengthIcon(sensor){
 
 }
 useEffect(()=>{
+  console.log("useEffect([sensorMap])")
+
     _sensorMap = sensorMap
     
     setSensorList(
@@ -289,7 +305,7 @@ useEffect(()=>{
         }
         }> 
         <div  class="d-flex justify-content-between align-items-center" style={hasConfig?{fontWeight:"normal"}:{fontStyle:"italic"}}>
-        {`${sensor.info.name} MAC: ${sensor.info.mac} RSSI: ${ifNullNaN(sensor.info.RSSI)}`  }
+        {`${sensor._changesMade?"*":""}${sensor.info.name} MAC: ${sensor.info.mac} RSSI: ${ifNullNaN(sensor.info.RSSI)}`  }
         <div class="d-flex justify-content-between ">
           {
             signalStrengthIcon(sensor)
@@ -308,12 +324,13 @@ useEffect(()=>{
   }
 
   
-  if (pluginState=="stopped")
-    return (<h1  >Enable plugin to see configuration</h1>)
+  if (pluginState=="stopped" || pluginState=="unknown")
+    return (<h1  >Enable plugin to see configuration (if plugin is Enabled and you're seeing this message, restart SignalK)</h1>)
   else
   return(
+
     <div>
-      {error?<h2 style="color: red;">{error.message}</h2>:""}
+      {error?<h2 style="color: red;">{error}</h2>:""}
       <Form 
         schema={baseSchema}
         validator={validator}
@@ -329,7 +346,8 @@ useEffect(()=>{
                      now={progress.progress} 
         />:""
       }
-      <h2>{`${sensorMap.size>0?" Bluetooth Devices click to configure":""}`}</h2>
+      <h2>{`${sensorMap.size>0?"Bluetooth Devices - Select to configure" :""}`}</h2>
+      <h2>{`${sensorMap.size>0?"(* = sensor has unsaved changes)" :""}`}</h2>
       <p></p>
       <div style={{paddingBottom: 20}} class="d-flex flex-wrap justify-content-start align-items-start">
       <ListGroup style={{  maxHeight: '300px', overflowY: 'auto' }}>
@@ -340,7 +358,14 @@ useEffect(()=>{
         schema={schema}
         validator={validator}
         uiSchema={uiSchema}
-        onChange={(e) => setSensorData(e.formData)}
+        onChange={(e) => {
+            const s = sensorMap.get(e.formData.mac_address)
+            s._changesMade=true
+            //s.config = e.formData; 
+
+            setSensorData(e.formData)
+          }
+        }
         onSubmit={({ formData }, e) => {
           console.log(formData) 
           updateSensorData(formData)

package/testqueue.js

@@ -0,0 +1,64 @@
+
+
+import {createBluetooth} from 'node-ble'
+
+import {AutoQueue} from "./Queue.js"
+import  {Variant}  from 'dbus-next'
+
+const {bluetooth, destroy} = createBluetooth()
+const connectQueue = new AutoQueue()
+const adapter = await bluetooth.getAdapter("hci0")
+await adapter.startDiscovery()
+
+function deviceConnect(mac) {
+
+        /* CAUTION: HACK AHEAD 
+
+        Bluez for some cockamamie reason (It's 2025 for chrissake. 
+        BLUETOOTH ISN'T JUST FOR DESKTOPS ANYMORE, BLUEZ DEVS!)
+        SUSPENDS scanning while connected to a device.
+
+        The next line of code gives the scanner a kick in the arse, 
+        starting it up again so, I dunno, another device might be able 
+        to connect and sensor classes could maybe get beacon updates.
+
+        You know, the little things.
+      */
+    adapter.waitDevice(mac,(30000)).then((device) =>{
+
+        return connectQueue.enqueue( async ()=>{
+            console.log("Connecting to "+mac)
+            try {await device.connect()} catch {(e)=>console.log(e)}
+            try {
+                console.log("Connected to "+mac)
+                console.log("Stopping discovery for "+mac)
+            
+                await adapter.helper.callMethod('StopDiscovery')
+                console.log("Discovery stopped for "+mac)
+                await adapter.helper.callMethod('SetDiscoveryFilter', {
+                    Transport: new Variant('s', "le")
+                })
+                console.log("Starting discovery for "+mac)
+                await adapter.helper.callMethod('StartDiscovery')   
+                console.log("Discovery started for "+mac)
+                
+            } catch (e){
+                //probably ignorable error. probably.
+                console.log(e)
+            }
+        })
+    })
+    /* END HACK*/
+}
+ setInterval( ()=>{
+    deviceConnect("D1:06:00:C6:16:4A")
+ }, 5000)
+ setInterval( ()=>{
+  
+ for (const mac of (["D1:06:01:46:49:39","A4:C1:38:3E:7E:94"])){
+    try { deviceConnect(mac) } catch { (e)=>console.log(e) }
+ }
+}, 10000)
+
+
+