RFC - connection aging (#292)

Show when Zigbee device was last seen

Author: chas-iot

manifest.json

@@ -20,7 +20,7 @@
       "scanChannels": 8190,
       "allowFTDISerial": false,
       "allowAMASerial": false,
-      "showBattery": false,
+      "showAging": false,
       "debug": ""
     },
     "schema": {
@@ -39,15 +39,15 @@
           "type": "boolean",
           "default": false
         },
-        "showBattery": {
-          "type": "boolean",
-          "title": "Show Battery Percentage",
-          "description": "experimental: Show the 'batteryPercentageRemaining' attribute as a property. Note that this attribute is reported from a power constrained device with possibly low quality consumer-grade batteries. Therefore, it may not represent what you expect. Particularly, it may drop in large increments and may suddenly go from, say, 50% to 1%. This attribute is reported very infrequently, maybe as little as once a day, so may take a while to appear after being enabled."
-        },
         "debug": {
           "type": "string",
           "default": ""
         },
+        "showAging": {
+          "type": "boolean",
+          "title": "Show Aging",
+          "description": "experimental - Creates an additional 'Last seen' property to show when each device was last active on the Zigbee network"
+        },
         "zigbee2mqtt": {
           "title": "Zigbee2Mqtt",
           "type": "object",

src/zb-adapter.js

@@ -472,6 +472,9 @@ class ZigbeeAdapter extends Adapter {
       // the ZHA protocol.
       const node = this.nodes[frame.remote64];
       if (node) {
+        if (typeof node.updateLastSeen === 'function') {
+          node.updateLastSeen();
+        }
         for (const property of node.properties.values()) {
           if (DEBUG_flow) {
             console.error(node.addr64, 'bind failed - setting fireAndForget to true');
@@ -506,6 +509,9 @@ class ZigbeeAdapter extends Adapter {
     }
     const node = this.findNodeFromRxFrame(frame);
     if (node) {
+      if (typeof node.updateLastSeen === 'function') {
+        node.updateLastSeen();
+      }
       node.handleZhaResponse(frame);
     } else {
       console.log('Node:', frame.remote64, frame.remote16, 'not found');
@@ -605,6 +611,11 @@ class ZigbeeAdapter extends Adapter {
     if (!node) {
       return;
     }
+
+    if (typeof node.updateLastSeen === 'function') {
+      node.updateLastSeen();
+    }
+
     if (this.scanning) {
       if (DEBUG_flow) {
         console.log('Ignoring Match Descriptor Request - scanning in progress');
@@ -731,6 +742,9 @@ class ZigbeeAdapter extends Adapter {
     this.activeEndpointResponseCount++;
     const node = this.nodes[frame.remote64];
     if (node) {
+      if (typeof node.updateLastSeen === 'function') {
+        node.updateLastSeen();
+      }
       for (const endpointNum of frame.activeEndpoints) {
         if (!(endpointNum in node.activeEndpoints)) {
           node.activeEndpoints[endpointNum] = {};
@@ -792,6 +806,10 @@ class ZigbeeAdapter extends Adapter {
     }
     const node = this.createNodeIfRequired(frame.remote64, frame.remote16);
 
+    if (node && typeof node.updateLastSeen === 'function') {
+      node.updateLastSeen();
+    }
+
     for (let i = 0; i < frame.numEntriesThisResponse; i++) {
       const neighborIndex = frame.startIndex + i;
       const neighbor = frame.neighbors[i];
@@ -943,6 +961,11 @@ class ZigbeeAdapter extends Adapter {
     if (!node) {
       return;
     }
+
+    if (typeof node.updateLastSeen === 'function') {
+      node.updateLastSeen();
+    }
+
     const endpoint = node.activeEndpoints[frame.endpoint];
     if (endpoint) {
       endpoint.queryingSimpleDescriptor = false;
@@ -1029,6 +1052,10 @@ class ZigbeeAdapter extends Adapter {
       return;
     }
 
+    if (typeof node.updateLastSeen === 'function') {
+      node.updateLastSeen();
+    }
+
     if (DEBUG_flow) {
       console.log('handleManagementLeaveResponse: Removing node:', node.addr64);
     }

src/zb-classifier.js

@@ -1196,7 +1196,6 @@ class ZigbeeClassifier {
           maximum: 100,
           multipleOf: 0.5,
           readOnly: true,
-          visible: !!node.driver.config.showBattery,
         },
         PROFILE_ID.ZHA, // profileId
         genPowerCfgEndpoint, // endpoint
@@ -1808,6 +1807,41 @@ class ZigbeeClassifier {
     }
   }
 
+  addLastSeenProperty(node) {
+    if (node.driver.config.showAging) {
+      const lastSeen = new ZigbeeProperty(
+        node,
+        'lastSeen', // name
+        {
+          type: 'string',
+          readOnly: true,
+          label: 'Last seen',
+        },
+        '', // profileId
+        '', // endPoint
+        '', // clusterId
+        '', // attr
+        null, // setAttrFromValue
+        null // parseValueFromAttr
+      );
+      node.properties.set('lastSeen', lastSeen);
+      lastSeen.value = '';
+      lastSeen.fireAndForget = true;
+
+      node.updateLastSeen = () => {
+        const d = new Date();
+        // there's no easy way to construct an ISO date with local timezone, so do it the hard way
+        /* eslint-disable max-len */
+        // prettier-ignore
+        const s =
+          `${d.getFullYear()}-${(`0${d.getMonth() + 1}`).slice(-2)}-${(`0${d.getDate()}`).slice(-2)}
+${(`0${d.getHours()}`).slice(-2)}:${(`0${d.getMinutes()}`).slice(-2)}:${(`0${d.getSeconds()}`).slice(-2)}`;
+        /* eslint-enable max-len */
+        lastSeen.setCachedValueAndNotify(s);
+      };
+    }
+  }
+
   addProperty(
     node,
     name,
@@ -2083,6 +2117,8 @@ class ZigbeeClassifier {
     if (genPowerCfgEndpoint) {
       this.addPowerCfgVoltageProperty(node, genPowerCfgEndpoint);
     }
+
+    this.addLastSeenProperty(node);
   }
 
   classify(node) {