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

package/sensor_classes/Victron/VictronConstants.js

@@ -1,24 +1,8 @@
-module.exports = { 
+const Images = require('./VictronImages.js')
+
+ const VC=
+ {
 
-  /*Device State?
-  0x00: Off
-0x01: Low Power Mode,
-0x02: Fault,
-0x03: Bulk,
-0x04: Absorption,
-0x05: Float,
-0x06: Storage,
-0x07: Equalize,
-0x08: Passthru,
-0x09: Inverting,
-0x0A: Assisting,
-0x0B: Power Supply Mode,
-0x0C-0xFA: Reserved,
-0xFB: Test,
-0xFC: Hub-1,
-0xFD-0xFE: Reserved,
-0xFF: Not Available
-  */
     OperationMode: new Map([
     [0, 'OFF'],
     [1, 'LOW_POWER'],
@@ -73,9 +57,9 @@ module.exports = {
     [8, 'WATER_HEATER']
   ]),
   MODEL_ID_MAP :{
-    0x203: "BMV-700",
-    0x204: "BMV-702",
-    0x205: "BMV-700H",
+    0x203: {name: "BMV-700",image: Images.bmv},
+    0x204: {name: "BMV-702",image: Images.bmv},
+    0x205: {name: "BMV-700H",image: Images.bmv},
     0x0300: "BlueSolar MPPT 70|15",
     0xA040: "BlueSolar MPPT 75|50",
     0xA041: "BlueSolar MPPT 150|35",
@@ -207,12 +191,12 @@ module.exports = {
     0xA346: "Phoenix Smart IP43 Charger 24|16 (1+1)",
     0xA347: "Phoenix Smart IP43 Charger 24|16 (3)",
     0xA350: "Phoenix Smart IP43 Charger 12|50 (1+1) 120-240V A350",
-    0xA381: "BMV-712 Smart",
-    0xA382: "BMV-710H Smart",
-    0xA383: "BMV-712 Smart Rev2",
-    0xA389: "SmartShunt 500A/50mV",
-    0xA38A: "SmartShunt 1000A/50mV",
-    0xA38B: "SmartShunt 2000A/50mV",
+    0xA381: {name: "BMV-712 Smart", image: Images.bmv},
+    0xA382: {name: "BMV-710H Smart", image: Images.bmv},
+    0xA383: {name: "BMV-712 Smart Rev2", image: Images.bmv},
+    0xA389: {name:"SmartShunt 500A/50mV",image: Images.shunt},
+    0xA38A: {name:"SmartShunt 1000A/50mV",image: Images.shunt},
+    0xA38B: {name:"SmartShunt 2000A/50mV",image: Images.shunt},
     0xA3A4: "Smart Battery Sense",
     0xA3A5: "Smart Battery Sense",
     0xA3B0: "Smart Battery Protect",
@@ -239,7 +223,7 @@ module.exports = {
     0xA3E6: "Lynx Smart BMS 1000",
     0x2780: "Victron Multiplus II 12/3000/120-50 2x120V",
     0xC00A: "Cerbo GX",
-    0xC030: "SmartShunt IP65 500A/50mV",
+    0xC030: {name:"SmartShunt IP65 500A/50mV",image: Images.shunt},
     0xeba0: "Smart Lithium Battery",
     
 },
@@ -249,6 +233,7 @@ AuxMode:{
     TEMPERATURE: 2,
     DISABLED: 3
  },
+ 
 ChargerError:new Map()
     .set(0,"NO_ERROR")
     .set(1,"TEMPERATURE_BATTERY_HIGH")
@@ -330,6 +315,6 @@ OffReasons : new Map([
     [0x00000080, 'ENGINE_SHUTDOWN'],
     [0x00000081, 'ENGINE_SHUTDOWN_AND_INPUT_VOLTAGE_LOCKOUT'],
     [0x00000100, 'ANALYSING_INPUT_VOLTAGE']
-  ]),
-  
+  ])
 }
+module.exports = VC

package/sensor_classes/Victron/VictronImages.js

@@ -0,0 +1,8 @@
+   Images= {
+    generic: "victron-min-1.jpg ",
+    shunt: "Victron-SmartShunt.jpg",
+    bmv: "BMV-712-Smart-Front.webp",
+    smartSolar: "smartsolarMPPT7515.png"
+  }
+  module.exports=Images
+  

package/sensor_classes/Victron/VictronSensor.js

@@ -1,6 +1,8 @@
+const  VC = require( './VictronConstants.js');
+const Images = require('./VictronImages.js')
+
 const BTSensor = require("../../BTSensor.js");
 const crypto = require('node:crypto');
-const VC = require('./VictronConstants.js');
 function sleep(x) {
     return new Promise((resolve) => {
       setTimeout(() => {
@@ -59,12 +61,21 @@ function sleep(x) {
             }
         )
         this.model_id=this.getManufacturerData(0x2e1)?.readUInt16LE(2)??"Unknown"
+        this._schema.title = this.getName()
     }
     alarmReason(alarmValue){
         return this.constructor.AlarmReason[alarmValue]
     }
     getModelName(){
-        return VC?.MODEL_ID_MAP[this.model_id]??this.constructor.name+" (Model ID:"+this.model_id+")"
+        const m = VC.MODEL_ID_MAP[this.model_id]
+        if(m) {
+            if(typeof m == 'string' || m instanceof String ) {
+                return m
+            } else {
+                return m.name
+            }
+        }
+        return this.constructor.name+" (Model ID:"+this.model_id+")"
     }
 
     decrypt(data){
@@ -110,7 +121,20 @@ function sleep(x) {
         throw new Error( "GATT Connection unimplemented for "+this.getDisplayName())
     }
 
-   
+   getImage(){
+        const m = VC.MODEL_ID_MAP[this.model_id]
+        if (m && m.image)
+            return m.image
+        else
+            return Images.generic
+   }
+
+   getDescription(){
+    //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" object-fit="cover" ></img>`
+
+
+    return `<img src="../bt-sensors-plugin-sk/images/${this.getImage()}" height="300" object-fit="cover" ></img>`
+   }
 
 }
 module.exports=VictronSensor

package/sensor_classes/VictronBatteryMonitor.js

@@ -195,6 +195,10 @@ class VictronBatteryMonitor extends VictronSensor{
         return "To use the GATT connection the SignalK server computer and the Smart Shunt must first be paired."
     }
 
+    getDescription(){
+        return super.getDescription()
+    }
+
     async stopListening(){
         super.stopListening()
         for (var c of this.characteristics){

package/sensor_classes/VictronSolarCharger.js

@@ -39,5 +39,6 @@ class VictronSolarCharger extends VictronSensor{
             .default="electrical.solar.{id}.loadCurrent" 
   
     }
+
 }
 module.exports=VictronSolarCharger 

package/sensor_classes/XiaomiMiBeacon.js

@@ -97,6 +97,11 @@ class XiaomiMiBeacon extends BTSensor{
         this.emit("humidity", buffer.readUInt8(2)/100)
         this.emitData("voltage",buffer,3);
     }
+
+    getDescription(){
+        return `<div><p><img src="../bt-sensors-plugin-sk/images/LYWSD03MMC-Device.jpg" alt=LYWSD03MMC image" style="float: left; margin-right: 10px;" /> The LYWSD03MMC temperature and humidity sensor is an inexpensive environmental sensor from Xiaomi Inc. <p> WARNING: If you use the GATT connection, you won't need an encrypytion//bind key to get your data but the energy cost of maintaining a GATT connection is high and will drain your battery in about 2 weeks of persistent use. Instead follow the instructions <a href=https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor/?tab=readme-ov-file#linux--home-assistant-in-ssh--web-terminal target="_blank">here</a> to get your device's encryption key.<div>`
+    }
+    
     getManufacturer(){
         return "Xiaomi Inc."
     }

package/src/components/PluginConfigurationPanel.js

@@ -1,9 +1,12 @@
 import Form from '@rjsf/core' ;
 import validator from '@rjsf/validator-ajv8';
-import React from 'react'
+import React from "react";
+import ReactHtmlParser from 'react-html-parser';
+
 import {useEffect, useState} from 'react'
 
-import {Button, Grid} from '@material-ui/core';
+import {Button, Grid } from '@material-ui/core';
+import { makeStyles } from '@material-ui/core/styles';
 
 import { SignalCellular0Bar, SignalCellular1Bar, SignalCellular2Bar, SignalCellular3Bar, SignalCellular4Bar, SignalCellularConnectedNoInternet0Bar    } from '@material-ui/icons';
 
@@ -12,30 +15,62 @@ const log = (type) => console.log.bind(console, type);
 import ListGroup from 'react-bootstrap/ListGroup';
 import Tabs from 'react-bootstrap/Tabs';
 import Tab from 'react-bootstrap/Tab';
+
 import { ListGroupItem } from 'react-bootstrap';
 
 import ProgressBar from 'react-bootstrap/ProgressBar';
 
-
 var _sensorMap, _sensorDomains={}, _sensorList={}
 
-export default (props) => {
+export default function BTConfig (props)  {
 
-  const hideSubmit= {
-    'ui:submitButtonOptions': {
-      props: {
-        disabled: false,
-        className: 'btn btn-info',
-      },
-      norender: true,
-      submitText: 'Submit',
-    },
+   const _uiSchema= {
+    "ui:options": {label: false},
+    'title': { 'ui:widget': 'hidden' }
+  }
+
+  const baseUISchema = 
+  {
+  "ui:field": "LayoutGridField",
+  "ui:layoutGrid": {
+      "ui:row":[
+      {
+        "ui:row": {
+          "className": "row",
+          "children": [
+            {
+              "ui:columns": {
+                "className": "col-xs-4",
+                "children": [
+                  "adapter",
+                  "transport",
+                  "duplicateData",
+                  "discoveryTimeout",
+                  "discoveryInterval"
+                ]
+              }
+            }
+          ]
+        }
+      }
+      ]
+    }
   }
+
+const useStyles = makeStyles((theme) => ({
+  root: {
+    '& > *': {
+      margin: theme.spacing(1),
+    },
+  },
+}));
+
   const [baseSchema, setBaseSchema] = useState({})
+
   const [baseData, setBaseData] = useState({})
 
   const [schema, setSchema] = useState({}) 
-  const [ uiSchema, setUISchema] = useState(hideSubmit )
+  const [ uiSchema, setUISchema] = useState(_uiSchema )
   const [sensorList, setSensorList] = useState([])
 
   const [sensorData, setSensorData] = useState()
@@ -49,11 +84,12 @@ export default (props) => {
  
   const [pluginState, setPluginState ] = useState("unknown")
   const [error, setError ] = useState()
+  const classes = useStyles();
 
-
+ 
   function sendJSONData(cmd, data){
 
-    console.log(`sending ${cmd}`)
+    console.log(`sending ${cmd}`) 
     console.log(data)
     const headers = new Headers();
     headers.append("Content-Type", "application/json");
@@ -67,11 +103,19 @@ export default (props) => {
 
   async function fetchJSONData(path){
     console.log(`fetching ${path}`)
-     
-    return fetch(`/plugins/bt-sensors-plugin-sk/${path}`, {
-      credentials: 'include'
-    })
-
+    var result
+    try {
+      result = fetch(`/plugins/bt-sensors-plugin-sk/${path}`, {
+        credentials: 'include'
+      })
+    } catch (e) {
+      result=
+        {
+          status: 500,
+          statusText: e.toString()
+        }
+    }
+    return result
   }
 
   async function getSensors(){
@@ -82,6 +126,9 @@ export default (props) => {
     }
     const json = await response.json()
     console.log(json)
+    //for (let i=0;i<json.length;i++){
+    //  json[i].schema.htmlDescription=<div>{ReactHtmlParser(json[i].schema.htmlDescription)}<p></p></div>
+    //}
     return json
 
   }
@@ -100,17 +147,18 @@ export default (props) => {
     console.log("getBaseData")
     const response = await fetchJSONData("getBaseData")
     if (response.status!=200){
-      throw new Error(`Unable get base data: ${response.statusText} (${response.status}) `)
+      throw new Error(`Unable to get base data: ${response.statusText} (${response.status}) `)
     }
     const json = await response.json()
     console.log(json)
+    json.schema.htmlDescription=<div>{ReactHtmlParser(json.schema.htmlDescription)}<p></p></div>
     return json
   }
   async function getProgress(){
     console.log("getProgress")
     const response = await fetchJSONData("getProgress")
     if (response.status!=200){
-      throw new Error(`Unable get progres: ${response.statusText} (${response.status}) `)
+      throw new Error(`Unable to get progress: ${response.statusText} (${response.status}) `)
     }
     const json = await response.json()
     console.log(json)
@@ -163,14 +211,13 @@ export default (props) => {
     sendJSONData("updateBaseData", data).then( (response )=>{
       if (response.status != 200) {
         setError(new Error(`Unable to update base data: ${response.statusText} (${response.status})`))
-      } else {
+      } /*else {
         getProgress().then((json)=>{
           setProgress(json)
         }).catch((e)=>{
           setError(e)
         })
-        refreshSensors()
-      }
+      }*/
       })
   }
     
@@ -221,6 +268,7 @@ export default (props) => {
         
         if (_sensorMap.has(json.mac)) {      
           let sensor = _sensorMap.get(json.mac)
+
           Object.assign(sensor.info, json )
           setSensorMap(new Map ( _sensorMap ))
         }
@@ -372,66 +420,72 @@ useEffect(()=>{
     
     return Object.keys(_sensorList).map((domain)=> {return getTab(domain)})
   }
+    // <div style={{paddingBottom: 20}} class="d-flex flex-wrap justify-content-start align-items-start">
+    //    <div class="d-flex flex-column" >
+
   function getTab(key){
     var title = key.slice(key.charAt(0)==="_"?1:0)
     
     return <Tab eventKey={key} title={title.charAt(0).toUpperCase()+title.slice(1)    }>
         
-    <div style={{paddingBottom: 20}} class="d-flex flex-wrap justify-content-start align-items-start">
     <ListGroup style={{  maxHeight: '300px', overflowY: 'auto' }}>
       {getSensorList(key)}
     </ListGroup>
+    
 
-    <div style= {{ paddingLeft: 10, paddingTop: 10, display: (Object.keys(schema).length==0)? "none" :""  }} >
+    </Tab>
+  }
 
-    <Form
-      schema={schema}
-      validator={validator}
-      uiSchema={uiSchema}
-      onChange={(e) => {
-          const s = sensorMap.get(e.formData.mac_address)
-          s._changesMade=true
-          setSensorData(e.formData)
-        }
-      }
-      onSubmit={({ formData }, e) => {
-        console.log(formData) 
-        updateSensorData(formData)
-        setSchema({})
-        alert("Changes saved")
-      }}
-      onError={log('errors')}
-      formData={sensorData}>
-      <div>
-      <Grid direction="row" style={{spacing:5}}>
-      <Button type='submit' color="primary" variant="contained">Save</Button>
-      <Button variant="contained" onClick={()=>{undoChanges(sensorData.mac_address)}}>Undo</Button>
-      <Button variant="contained" color="secondary" onClick={(e)=>confirmDelete(sensorData.mac_address)}>Delete</Button>
+ 
+  function openInNewTab (url)  {
+    window.open(url, "_blank", "noreferrer");
+  }
 
+  function CustomFieldTemplate(props) {
+  const { id, classNames, style, label, help, required, description, errors, children } = props;
+  return (
+    <div className={classNames} style={style}>
+      <Grid container xs={12} direction="row" spacing="1">
+        <Grid item xs={1} sm container direction="column">
+        <Grid item ><label htmlFor={id}>{label}{required ? '*' : null}</label></Grid>
+        <Grid item> {description}</Grid>
+        </Grid>
+        <Grid item>{children}</Grid>
       </Grid>
-      </div>
-    </Form>
-
+      {errors}
+      {help}
     </div>
-    </div>
-    </Tab>
-  }
+  );
+}
 
   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>)
+    return (<h3>Enable plugin to see configuration</h3>)
   else
   return(
 
     <div>
+       <div className={classes.root}>
+          
+          <Button  variant="contained" onClick={()=>{openInNewTab("https://github.com/naugehyde/bt-sensors-plugin-sk/tree/1.2.0-beta#configuration")}}>Documentation</Button>
+          <Button variant="contained"  onClick={()=>{openInNewTab("https://github.com/naugehyde/bt-sensors-plugin-sk/issues/new/choose")}}>Report Issue</Button>
+          <Button variant="contained"  onClick={()=>{openInNewTab("https://discord.com/channels/1170433917761892493/1295425963466952725" )}}>Discord Thread</Button>
+          <p></p>
+          <p></p>
+      </div>
+      <hr style={{"width":"100%","height":"1px","color":"gray","background-color":"gray","text-align":"left","margin-left":0}}></hr>
+
       {error?<h2 style="color: red;">{error}</h2>:""}
       <Form 
         schema={baseSchema}
         validator={validator}
+        uiSchema={baseUISchema}
         onChange={(e) => setBaseData(e.formData)}
         onSubmit={ ({ formData }, e) => { updateBaseData(formData); setSchema({}) } }
+
         onError={log('errors')}
         formData={baseData}
       />
+    <hr style={{"width":"100%","height":"1px","color":"gray","background-color":"gray","text-align":"left","margin-left":0}}></hr>
       <p></p>
       <p></p>
       { (progress.deviceCount<progress.totalDevices)?
@@ -439,16 +493,47 @@ useEffect(()=>{
                      now={progress.progress} 
         />:""
       }
-      <h2>{`${sensorMap.size>0?"Bluetooth Devices - Select to configure" :""}`}</h2>
-      <h2>{`${sensorMap.size>0?"(* = sensor has unsaved changes)" :""}`}</h2>
       <p></p>
       <Tabs
       defaultActiveKey="_configured"
       id="domain-tabs"
       className="mb-3"
+      onClick={()=>{setSchema({})}}
       >
       {getTabs()}
       </Tabs>
+      <div style= {{ paddingLeft: 10, paddingTop: 10, display: (Object.keys(schema).length==0)? "none" :""  }}>
+      <Grid container direction="column" style={{spacing:5}}>
+      <Grid item><h2>{schema?.title}</h2><p></p></Grid>
+      <Grid item>{ReactHtmlParser(schema?.htmlDescription)}</Grid>
+      </Grid>
+    
+    <Form
+      schema={schema}
+      validator={validator}
+      uiSchema={uiSchema}
+      onChange={(e) => {
+          const s = sensorMap.get(e.formData.mac_address)
+          s._changesMade=true
+          setSensorData(e.formData)
+        }
+      }
+      onSubmit={({ formData }, e) => {
+        updateSensorData(formData)
+        setSchema({})
+        alert("Changes saved")
+      }}
+      onError={log('errors')}
+      formData={sensorData}>
+      <div className={classes.root}>
+        <Button type='submit' color="primary" variant="contained">Save</Button>
+        <Button variant="contained" onClick={()=>{undoChanges(sensorData.mac_address)}}>Undo</Button>
+        <Button variant="contained" color="secondary" onClick={(e)=>confirmDelete(sensorData.mac_address)}>Delete</Button>
+      </div>  
+    </Form>
+
+   
+    </div>
     </div>
   )
     

package/webpack.config.js

@@ -4,7 +4,7 @@ const path = require('path');
 const { ModuleFederationPlugin } = require('webpack').container;
 const { WatchIgnorePlugin } = require('webpack')
 
-require('@signalk/server-admin-ui-dependencies')
+//require('@signalk/server-admin-ui-dependencies')
 
 const packageJson = require('./package')