bt-sensors-plugin-sk 1.3.4 → 1.3.5-1

package/BTSensor.js

@@ -87,7 +87,11 @@ class BTSensor extends EventEmitter {
         tanks: { name: "tanks", description: "Sensors that measure level in tanks (gas, propane, water etc.) "},
         beacons: { name: "beacons", description: "iBeacon/Eddystone sensor tags"}
     }
+    static batteryStrengthTag="batteryStrength"
+
     static Domain = this.SensorDomains.unknown   
+
+    _currentValues = {}
     /**
      * 
      * @param {module:node-ble/Device} device 
@@ -955,6 +959,19 @@ class BTSensor extends EventEmitter {
         throw new Error("Subclass must implement ::emitGATT function")
     }
 
+    getCurrentValue(tag){
+        return this._currentValues[tag]
+    }
+
+    setCurrentValue(tag,value){
+        this._currentValues[tag]=value
+    }
+
+    emit(tag, value){
+        super.emit(tag, value)
+        this.setCurrentValue(tag,value)
+    }
+
     emitData(tag, buffer, ...args){
         const md = this.getPath(tag)
         if (md && md.read)
@@ -1048,7 +1065,7 @@ class BTSensor extends EventEmitter {
                 this._app.handleMessage(id, 
                 {
                 updates: 
-                    [{ meta: [{path:  this.preparePath(path), value: { units: pathMeta?.unit }}]}]
+                    [{ meta: [{path:  this.preparePath(path), value: { units: pathMeta?.unit, zones:pathMeta?.zones} }]}] 
                 })
             }
         })
@@ -1062,11 +1079,7 @@ class BTSensor extends EventEmitter {
 			if (!(path === undefined)) {
                 let preparedPath =  this.preparePath(path)
                 this.on(tag, (val)=>{
-/*					if (pathMeta.notify){
-						this._app.notify(tag, val, id )
-					} else {*/
-						this.updatePath(preparedPath,val, id, source)
-					//}
+					this.updatePath(preparedPath,val, id, source)
                 })
 			}
 		})
@@ -1075,7 +1088,10 @@ class BTSensor extends EventEmitter {
 		this._app.handleMessage(id, {updates: [ { $source: source, values: [ { path: path, value: val }] } ] })
   	}  
     elapsedTimeSinceLastContact(){
-        return (Date.now()-this?._lastContact??Date.now())/1000
+        if (this.device instanceof OutOfRangeDevice)
+            return Infinity
+        else 
+            return (Date.now()-this?._lastContact??Date.now())/1000
     }
 
     prepareConfig(config){
@@ -1116,7 +1132,44 @@ class BTSensor extends EventEmitter {
     return resultString || str; // Return original string if no replacements were made
   }
 
+  notifyUnableToCommunicate(){
+    	this._app.handleMessage('bt-sensors-plugin-sk', 
+            {
+                updates: [{
+                    $source: this.getName(),
+                    timestamp: (new Date()).toISOString(),
+                    values: [{
+                            path: `notifications.sensors.${this.macAndName()}`,
+                            value: {
+                            state: "warn",
+                            message: "Unable to communicate with sensor",
+                            method: ["visual", "sound"]
+                        }
+                        }]
+                }]
+            }
+        
+        );
+  }
 
+  clearUnableToCommunicate(){
+    	this._app.handleMessage('bt-sensors-plugin-sk', 
+            {
+                updates: [{
+                    $source: this.getName(),
+                    timestamp: (new Date()).toISOString(),
+                    values: [{
+                        path: `notifications.sensors.${this.macAndName()}`,
+                        value: null
+                    }]
+                }]
+            }
+        
+        );
+  }
+  getBatteryStrength(){
+    return this.getCurrentValue(this.constructor.batteryStrengthTag)
+  }
 }
 
 module.exports = BTSensor   

package/README.md

@@ -2,6 +2,11 @@
 
 ## WHAT'S NEW  
 
+# Verstion 1.3.5 
+
+- Battery strength notification for supported sensors
+- Battery strength value/icon displayed on config page
+- MicrotikTag TG-BT5 environment sensor support 
 
 # Version 1.3.4 
 
@@ -157,6 +162,7 @@ It's pretty easy to write and deploy your own sensor class for any currently uns
 |[BTHome](https://bthome.io/)| NOTE: Framework for IOT sensor devices. |
 |[Inkbird](https://inkbird.com/)| TH-2 Temp and Humidity Sensor |
 |[SensorPush](https://www.sensorpush.com/)| Temperature, Humidity and Atmospheric Pressure sensor|
+|[MicrotikTag](https://mikrotik.com/products/group/iot-products)| TG-BT5 Temperature and Humidity and sensor|
 
 
 ### Tanks 

package/development/TestData/Jikong.json

@@ -0,0 +1,14 @@
+{
+"delay":100,
+"data":
+    {
+    "0x96": [
+"55 aa eb 90 10 e0 ac d0 00 00 28 a0 00 00 5a a0 00 00 42 e0 00 00 78 d0 00 00 50 00 00 00 79 d0 00 00 50 a0 00 00 7a d0 00 00 16 d0 00 00 ba 90 00 00 20 bf 20 00 30 00 00 00 3c 00 00 00 20 bf 20 00 2c 10 00 00 3c 00 00 00 1e 00 00 00 d0 70 00 00 bc 20 00 00 58 20 00 00 bc 20 00 00 58 20 00 00 9c ff ff ff 00 00 00 00 20 30 00 00 bc 20 00 00 40 00 00 00 10 00 00 00 10 00 00 00 10 00 00 00 f0 ba 40 00 50 ","00 00 00 5c d0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 10 00 00 00 00 00 00 00 20 a1 70 00 90 18 f6 00 18 fe ff ff ff 1f a9 6f e0 00 dd e2 00 7b"    ],
+    "0x97":[
+        "55 aa eb 90 00 3 c4 4a 4b 5f 42 32 41 38 53 32 30 50 00 0 00 0 00 00 00 31 31 2e 58 57 00 00 00 31 31 2e 32 36 31 00 00 68 96 c1 03 18 00 00 00 48 42 31 5f 42 34 00 00 00 00 00 00 00 00 00 00 31 32 33 34 00 00 00 00 00 00 00 00 00 00 00 00 32 33 30 38 31 34 00 00 33 30 32 32 38 34 34 32 36 37 00 30 30 30 30 00 49 6e 70 75 74 20 55 73 65 72 64 61 74 61 00 00 31 32 33 33 32 31 00 00 00 00",
+        "00 00 00 00 00 00 49 6e 70 75 74 20 55 73 65 72 64 61 74 61 00 00",
+        "7c f8 ff ff 1f 0d 00 00 00 00 00 00 90 0f 00 00 00 00 c0 d8 03 00 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00",
+        "00 00 00 00 00 00 00 00 00 fe 2f 00 00 00 00 00 00 00 00 00 00 bf"
+    ]
+    }
+}

package/diff.txt

@@ -1209,7 +1209,7 @@ index 0000000..473e8f1
 +        })*/
 +    }
 +    initGATTConnection(){ 
-+        return new Promise((resolve,reject )=>{ this.deviceConnect().then(async ()=>{ 
++        return new Promise((resolve,reject )=>{ this.).then(async ()=>{ 
 +            if (!this.gattServer) { 
 +                this.gattServer = await this.device.gatt() 
 +                this.battService = await this.gattServer.getPrimaryService("0000fff0-0000-1000-8000-00805f9b34fb") 

package/index.js

@@ -77,6 +77,9 @@ class MissingSensor  {
 	getRSSI(){
 		return NaN
 	}
+	getBatteryStrength(){
+		return NaN
+	}
 	getState(){
 		return "OUT_OF_RANGE"
 	}
@@ -386,6 +389,7 @@ module.exports =   function (app) {
 					 debugLog: sensor.getDebugLog(),
 					 RSSI: sensor.getRSSI(),
 					 signalStrength: sensor.getSignalStrength(),
+					 batteryStrength: sensor.getBatteryStrength(),
             		 connected: sensor.isConnected(),
             		 lastContactDelta: sensor.elapsedTimeSinceLastContact()
 			}
@@ -502,8 +506,10 @@ module.exports =   function (app) {
 					device.once("deviceFound",async (device)=>{
 						s.device=device
 						s.listen()
-						if (config.active)
+						if (config.active) {
+							s.clearUnableToCommunicate()
 							await s.activate(config, plugin)
+						}
 						else {
 							s.unsetError()
 							s.setState("DORMANT")
@@ -516,15 +522,18 @@ module.exports =   function (app) {
 				}
 				if (startNumber == starts ) {
 					const errorTxt = `Unable to communicate with device ${deviceNameAndAddress(config)} Reason: ${e?.message??e}`
-					if(s)
-					{
-						s.setError(errorTxt)
-					} else {
-						if (config.active)
+
+					if (config.active) {
+						if(s) {
+							s.setError(errorTxt)
+							s.notifyUnableToCommunicate()	
+						}
+						 else 
 							plugin.setError(errorTxt)
 					}
+					plugin.debug(errorTxt)
 					plugin.debug(e)
-
+					
 					reject( e?.message??e )
 				}	
 			})})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-sensors-plugin-sk",
-  "version": "1.3.4",
+  "version": "1.3.5-1",
   "description": "Bluetooth Sensors for Signalk - see https://www.npmjs.com/package/bt-sensors-plugin-sk#supported-sensors for a list of supported sensors",
   "main": "index.js",
   "dependencies": {
@@ -26,10 +26,10 @@
     "@fortawesome/react-fontawesome": "^0.2.2",
     "@material-ui/core": "^4.12.4",
     "@material-ui/icons": "^4.11.3",
+    "react-battery-gauge": "^1.0.7",
     "babel-loader": "^8.1.0",
     "chai": "^4.2.0",
     "css-loader": "^5.0.0",
-    "d3": "^6.2.0",
     "file-loader": "^6.1.1",
     "font-awesome": "^4.7.0",
     "mocha": "^8.0.1",

package/plugin_defaults.json

@@ -167,6 +167,19 @@
             "title": "Battery Strength",
             "unit":"ratio",
             "default":"sensors.{macAndName}.battery.strength",
+            "zones":[
+                { "upper": 0.5,
+                  "lower": 0.3,
+                  "state": "alert",
+                  "message": "Battery low - change soon"
+                },
+                {
+                  "upper": 0.3,
+                  "lower": 0,
+                  "state": "warn",
+                  "message": "Battery very low -  change now"
+                }      
+            ],
             "description":"Sensor battery strength" 
         },
     

package/public/143.js

@@ -0,0 +1 @@
+(self.webpackChunkbt_sensors_plugin_sk=self.webpackChunkbt_sensors_plugin_sk||[]).push([[143],{9337:()=>{},62995:(e,t,n)=>{"use strict";n.r(t),n.d(t,{BTConfig:()=>$,default:()=>D});var a=n(73490),s=n(74810),r=n(40334),o=n(86528),i=n.n(o),c=n(11363),l=n(97493),u=n(27606),m=n(82096),d=n(55877),f=n(3768),g=n(71431),h=n(39676),p=n(47041),E=n(86038),y=n(95027),w=n(26067),S=n(43540),b=n(38250),v=n(31008),A=n(20455),C=n(23399);const k=e=>console.log.bind(console,e);function $(e){const t=(0,m.A)((e=>({root:{"& > *":{margin:e.spacing(1)}}}))),[n,$]=(0,o.useState)({}),[D,_]=(0,o.useState)({}),[x,T]=(0,o.useState)({}),[N,O]=(0,o.useState)({"ui:options":{label:!1},paths:{enableMarkdownInDescription:!0},title:{"ui:widget":"hidden"}}),[j,M]=(0,o.useState)(),[U,R]=(0,o.useState)(!1),[B,J]=(0,o.useState)(!0),[L,I]=(0,o.useState)(new Map),[P,W]=(0,o.useState)({progress:0,maxTimeout:100,deviceCount:0,totalDevices:0}),[z,K]=(0,o.useState)("unknown"),[F,G]=(0,o.useState)(),[H,Y]=(0,o.useState)(!1),[q,Q]=(0,o.useState)(""),V=t();function X(e,t){const n=new Headers;return n.append("Content-Type","application/json"),fetch(`/plugins/bt-sensors-plugin-sk/${e}`,{credentials:"include",method:"POST",body:JSON.stringify(t),headers:n})}async function Z(e,t={}){let n;try{const a=Object.keys(t).length?"?"+new URLSearchParams(t).toString():"";n=await fetch(`/plugins/bt-sensors-plugin-sk/${e}${a}`,{credentials:"include",method:"GET"})}catch(e){n={status:500,statusText:e.toString()}}return n}function ee(e){return Object.keys(e.configCopy).length>0}function te(e){const t=ee(e);return i().createElement(A.A,{action:!0,onClick:()=>{e.config.mac_address=e.info.mac,T(e.schema),M(e.config)}},i().createElement("div",{class:"d-flex justify-content-between align-items-center",style:t?{fontWeight:"normal"}:{fontStyle:"italic"}},`${e._changesMade?"*":""}${e.info.name} MAC: ${e.info.mac} RSSI: ${n=e.info.RSSI,null==n?NaN:n} ${function(e){const t=e.info?.batteryStrength;return t?`BATT: ${100*t}%`:""}(e)}`,i().createElement("div",{class:"d-flex justify-content-between "},`${e.info.state} ${e.info.error?" (ERROR)":""}`,i().createElement("div",{class:"d-flex justify-content-between "},function(e){return e.info.connected?i().createElement(d.A,null):null==e.info.lastContactDelta||e.info.lastContactDelta>e.config.discoveryTimeout?i().createElement(f.A,null):e.info.signalStrength>80?i().createElement(g.A,null):e.info.signalStrength>60?i().createElement(h.A,null):e.info.signalStrength>40?i().createElement(p.A,null):e.info.signalStrength>20?i().createElement(E.A,null):i().createElement(y.A,null)}(e),function(e){const t=e.info.batteryStrength;return void 0===t?"":i().createElement(w.A,{size:22,orientation:"vertical",customization:{batteryBody:{fill:"silver",strokeColor:"silver",strokeWidth:2},batteryCap:{fill:"silver",strokeColor:"silver",cornerRadius:3,strokeWidth:0,capToBodyRatio:.4},readingText:{lightContrastColor:"purple",darkContrastColor:"yellow",lowBatteryColor:"red",fontFamily:"Arial",fontSize:16}},value:100*t})}(e)))));var n}function ne(e){window.open(e,"_blank","noreferrer")}return(0,o.useEffect)((()=>{let e=null;return Z("getPluginState").then((async t=>{if(404==t.status)throw K("unknown"),new Error("unable to get plugin state");const n=await t.json();e=new EventSource("/plugins/bt-sensors-plugin-sk/sse",{withCredentials:!0}),e.addEventListener("newsensor",(e=>{!function(e){let t=JSON.parse(e.data);console.log(`New sensor: ${t.info.mac}`),I((e=>(e.set(t.info.mac,t),new Map(e))))}(e)})),e.addEventListener("sensorchanged",(e=>{!function(e){console.log("sensorchanged");const t=JSON.parse(e.data);console.log(t),I((e=>{const n=e.get(t.mac);return n&&Object.assign(n.info,t),new Map(e)}))}(e)})),e.addEventListener("progress",(e=>{const t=JSON.parse(e.data);W(t)})),e.addEventListener("pluginstate",(e=>{const t=JSON.parse(e.data);K(t.state)})),K(n.state),(async()=>{const e=await async function(){const e=await Z("getSensors");if(200!=e.status)throw new Error(`Unable get sensor data: ${e.statusText} (${e.status}) `);return await e.json()}();I(new Map(e.map((e=>[e.info.mac,e]))))})()})).catch((e=>{G(e.message)})),()=>{console.log("Closing connection to SSE"),e.close()}}),[]),(0,o.useEffect)((()=>{if(!U)return;if(!j||!L)return;const e=L.get(j.mac_address);e&&x&&j&&Object.hasOwn(j,"params")&&"UNKNOWN"==e.info.class&&j.params.sensorClass&&"UNKNOWN"!=j.params.sensorClass&&(J(!1),Q(`Please wait. Fetching schema for ${j.params.sensorClass}...`),async function(e,t){const n=await Z("getSensorInfo",{mac_address:e,class:t});if(200!=n.status)throw new Error(`Unable get sensor info: ${n.statusText} (${n.status}) `);return await n.json()}(j.mac_address,j.params.sensorClass).then((e=>{T(e.schema)})).catch((e=>{alert(e.message)})).finally((()=>{Q(""),J(!0),R(!1)})))}),[U]),(0,o.useEffect)((()=>{Y(""!=q)}),[q]),(0,o.useEffect)((()=>{"started"==z?(async function(){const e=await Z("getBaseData");if(200!=e.status)throw new Error(`Unable to get base data: ${e.statusText} (${e.status}) `);const t=await e.json();return t.schema.htmlDescription=i().createElement("div",null,(0,r.Ay)(t.schema.htmlDescription),i().createElement("p",null)),t}().then((e=>{$(e.schema),_(e.data)})).catch((e=>{G(e.message)})),async function(){const e=await Z("getProgress");if(200!=e.status)throw new Error(`Unable to get progress: ${e.statusText} (${e.status}) `);return await e.json()}().then((e=>{W(e)})).catch((e=>{G(e.message)}))):($({}),_({}))}),[z]),"stopped"==z||"unknown"==z?i().createElement("h3",null,"Enable plugin to see configuration"):i().createElement("div",null,i().createElement(c.A,{anchorOrigin:{horizontal:"center",vertical:"bottom"},onClose:()=>Y(!1),open:H,message:q,key:"snackbar"}),i().createElement("div",{className:V.root},i().createElement(l.A,{variant:"contained",onClick:()=>{ne("https://github.com/naugehyde/bt-sensors-plugin-sk/tree/1.2.0-beta#configuration")}},"Documentation"),i().createElement(l.A,{variant:"contained",onClick:()=>{ne("https://github.com/naugehyde/bt-sensors-plugin-sk/issues/new/choose")}},"Report Issue"),i().createElement(l.A,{variant:"contained",onClick:()=>{ne("https://discord.com/channels/1170433917761892493/1295425963466952725")}},"Discord Thread"),i().createElement("p",null),i().createElement("p",null)),i().createElement("hr",{style:{width:"100%",height:"1px",color:"gray","background-color":"gray","text-align":"left","margin-left":0}}),F?i().createElement("h2",{style:{color:"red"}},F):"",i().createElement(a.Ay,{schema:n,validator:s.Ay,uiSchema:{"ui:field":"LayoutGridField","ui:layoutGrid":{"ui:row":[{"ui:row":{className:"row",children:[{"ui:columns":{className:"col-xs-4",children:["adapter","transport","duplicateData","discoveryTimeout","discoveryInterval"]}}]}}]}},onChange:e=>_(e.formData),onSubmit:({formData:e},t)=>{var n;n=e,I(new Map),X("updateBaseData",n).then((e=>{200!=e.status&&G(`Unable to update base data: ${e.statusText} (${e.status})`)})),T({})},onError:k("errors"),formData:D}),i().createElement("hr",{style:{width:"100%",height:"1px",color:"gray","background-color":"gray","text-align":"left","margin-left":0}}),i().createElement("p",null),i().createElement("p",null),P.deviceCount<P.totalDevices?i().createElement(C.A,{max:P.maxTimeout,now:P.progress}):"",i().createElement("p",null),i().createElement(b.A,{defaultActiveKey:"_configured",id:"domain-tabs",className:"mb-3"},function(){const e=[...new Set([...L.entries()].map((e=>e[1].info.domain)))].sort(),t=Array.from(L.entries()).filter((e=>ee(e[1])));let n={};return n._configured=0==t.length?"Select a device from its domain tab (Electrical etc.) and configure it.":t.map((e=>te(L.get(e[0])))),e.forEach((e=>{var t;n[e]=(t=e,Array.from(L.entries()).filter((e=>e[1].info.domain===t))).map((e=>te(L.get(e[0]))))})),Object.keys(n).map((e=>function(e,t){let n=e.slice("_"===e.charAt(0)?1:0);return i().createElement(v.A,{eventKey:e,title:`${n.charAt(0).toUpperCase()}${n.slice(1)}${"string"==typeof t?"":" ("+t.length+")"}`},i().createElement(S.A,{style:{maxHeight:"300px",overflowY:"auto"}},t))}(e,n[e])))}()),i().createElement("div",{style:{paddingLeft:10,paddingTop:10,display:0==Object.keys(x).length?"none":""}},i().createElement(u.A,{container:!0,direction:"column",style:{spacing:5}},i().createElement(u.A,{item:!0},i().createElement("h2",null,x?.title),i().createElement("p",null)),i().createElement(u.A,{item:!0},(0,r.Ay)(x?.htmlDescription))),i().createElement("fieldset",{disabled:!B},i().createElement(a.Ay,{schema:x,validator:s.Ay,uiSchema:N,onChange:(e,t)=>{const n=L.get(e.formData.mac_address);n&&(n._changesMade=!0,n.config=e.formData,M(e.formData)),"root_params_sensorClass"==t&&R(!0)},onSubmit:({formData:e},t)=>{var n;X("updateSensorData",n=e).then((e=>{if(200!=e.status)throw new Error(e.statusText);I((e=>(e.delete(n.mac_address),new Map(e)))),T({})})),alert("Changes saved")},onError:k("errors"),formData:j},i().createElement("div",{className:V.root},i().createElement(l.A,{type:"submit",color:"primary",variant:"contained"},"Save"),i().createElement(l.A,{variant:"contained",onClick:()=>{var e;e=j.mac_address,L.get(e)._changesMade=!1,L.get(e).config=JSON.parse(JSON.stringify(L.get(e).configCopy)),M(L.get(e).config)}},"Undo"),i().createElement(l.A,{variant:"contained",color:"secondary",onClick:e=>function(e){const t=L.get(e);(!ee(t)||window.confirm(`Delete configuration for ${t.info.name}?`))&&function(e){try{X("removeSensorData",{mac_address:e}).then((e=>{if(200!=e.status)throw new Error(e.statusText)})),I((t=>(t.delete(e),new Map(t)))),T({})}catch{}}(e)}(j.mac_address)},"Delete"))))))}const D=$}}]);