Improvements to how ping’s work to improve performance and device re-…

…discovery
lprhodes · Jan 1, 2020 · b9e68a4 · b9e68a4
1 parent 7ce4537
commit b9e68a4
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 33 deletions.
diff --git a/accessories/outlet.js b/accessories/outlet.js
@@ -1,4 +1,3 @@
-const ping = require('ping');
 const ServiceManagerTypes = require('../helpers/serviceManagerTypes');
 
 const delayForDuration = require('../helpers/delayForDuration')
@@ -8,16 +7,19 @@ class OutletAccessory extends SwitchAccessory {
 
   pingCallback (active) {
     const { config, state, serviceManager } = this;
+    const newState = active ? true : false;
+
+    // Only update Homkit if the switch state haven changed.
+    if (previousState === newState) return
 
     if (config.pingIPAddressStateOnly) {
-      state.outletInUse = active ? true : false;
+      state.outletInUse = newState;
       serviceManager.refreshCharacteristicUI(Characteristic.OutletInUse)
 
       return
     }
 
-    const value = active ? true : false;
-    serviceManager.setCharacteristic(Characteristic.OutletInUse, value);
+    serviceManager.setCharacteristic(Characteristic.OutletInUse, newState);
   }
 
   setOutletInUse (value, callback) {

diff --git a/accessories/switch.js b/accessories/switch.js
@@ -14,7 +14,8 @@ class SwitchAccessory extends BroadlinkRMAccessory {
 
   setDefaults () {
     const { config } = this;
-    config.pingFrequency = config.pingFrequency || 1;
+    config.pingFrequency = config.pingFrequency || 2;
+    config.pingFrequency = Math.max(config.pingFrequency, 2);
 
     config.offDuration = config.offDuration || 60;
     config.onDuration = config.onDuration || 60;
@@ -69,17 +70,31 @@ class SwitchAccessory extends BroadlinkRMAccessory {
   }
 
   pingCallback (active) {
-    const { config, state, serviceManager } = this;
+    let { debug, config, log, name, state, serviceManager } = this;
+    debug = true
+
+    const previousState = state.switchState
+    const newState = active ? true : false;
+
+    // Only update Homkit if the switch state haven changed.
+    const hasStateChanged = (previousState === newState)
+    if (debug) log(`${name} pingCallback: state ${hasStateChanged ? 'not changed, ignoring' : 'changed'} (device ${newState ? 'active' : 'inactive'})`);
+
+    if (hasStateChanged) return
 
     if (config.pingIPAddressStateOnly) {
-      state.switchState = active ? true : false;
+      if (debug) log(`${name} pingCallback: UI updated only`);
+
+      state.switchState = newState
+
       serviceManager.refreshCharacteristicUI(Characteristic.On);
 
       return;
     }
 
-    const value = active ? true : false;
-    serviceManager.setCharacteristic(Characteristic.On, value);
+    if (debug) log(`${name} pingCallback: UI updated and command sent`);
+
+    serviceManager.setCharacteristic(Characteristic.On, newState);
   }
 
   async setSwitchState (hexData) {

diff --git a/helpers/getDevice.js b/helpers/getDevice.js
@@ -1,26 +1,28 @@
-const ping = require('ping');
 const broadlink = require('./broadlink')
 const delayForDuration = require('./delayForDuration')
 
-const pingFrequency = 5000;
+const ping = require('net-ping').createSession({
+  retries: 3,
+  timeout: 1000
+});
+
+const pingFrequency = 5000; // 5s
 
 const startPing = (device, log) => {
   device.state = 'unknown';
 
   setInterval(() => {
-    try {
-      ping.sys.probe(device.host.address, (active) => {
-        if (!active && device.state === 'active') {
-          log(`Broadlink RM device at ${device.host.address} (${device.host.macAddress || ''}) is no longer reachable.`);
+    ping.pingHost(device.host.address, (error, target) => {
+      if (error && device.state === 'active') {
+        log(`Broadlink RM device at ${device.host.address} (${device.host.macAddress || ''}) is no longer reachable.`);
 
-          device.state = 'inactive';
-        } else if (active && device.state !== 'active') {
-          if (device.state === 'inactive') log(`Broadlink RM device at ${device.host.address} (${device.host.macAddress || ''}) has been re-discovered.`);
+        device.state = 'inactive';
+      } else if (!error && device.state !== 'active') {
+        if (device.state === 'inactive') log(`Broadlink RM device at ${device.host.address} (${device.host.macAddress || ''}) has been re-discovered.`);
 
-          device.state = 'active';
-        }
-      })
-    } catch (err) {}
+        device.state = 'active';
+      }
+    })
   }, pingFrequency);
 }
 

diff --git a/helpers/ping.js b/helpers/ping.js
@@ -1,14 +1,13 @@
-const ping = require('ping');
+const ping = require('net-ping').createSession({
+  retries: 0,
+  timeout: 1000
+});
 
 const pingIPAddress = (ipAddress, interval, callback) => {
   setInterval(() => {
-    try {
-      ping.sys.probe(ipAddress, (isActive) => {
-        callback(isActive)
-      })
-    } catch (err) {
-      callback(false)
-    }
+    ping.pingHost(ipAddress, (error) => {
+      callback(!error)
+    })
   }, interval * 1000);
 }
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -24,11 +24,12 @@
     "url": "git@github.com:lprhodes/homebridge-broadlink-rm.git"
   },
   "dependencies": {
-    "chai": "^4.2.0",
     "broadlinkjs-rm": "^0.7.5",
+    "chai": "^4.2.0",
     "find-key": "^2.0.1",
     "github-version-checker": "^1.2.0",
     "homebridge-platform-helper": "1.2.0",
+    "net-ping": "^1.2.3",
     "ping": "^0.2.2",
     "uuid": "^3.3.3"
   },

diff --git a/test/helpers/fakePing.js b/test/helpers/fakePing.js
@@ -1,5 +1,3 @@
-const ping = require('ping');
-
 const pingIPAddress = function (ipAddress, interval, callback) {
   performPing(this.isActive, callback)