homebridge-adt-pulse 2.1.0 → 2.1.3

package/README.md

@@ -66,16 +66,22 @@ If you have a sensor that is unsupported by this plugin, please [submit an issue
 Due to ADT Pulse limitations, accessories that are connected to the Z-Wave Platform cannot be supported. Consider using other Homebridge plugins.
 
 ## Configure 2-Factor Authentication
-With the recent updates, ADT Pulse now requires 2-factor authentication for your account. In the near future, this fingerprint will be required.
+With the recent updates, ADT Pulse now requires 2-factor authentication for your account. In the near future, this fingerprint will be required. Before you begin, make sure 2-Factor Authentication is already setup.
 
-1. Open a Chrome browser tab
+1. Open a Chrome browser tab (under Incognito mode)
 2. Open Developer Tools (using **View** ➜ **Developer** ➜ **Developer Tools** menu)
 3. Click on the **Network** tab (make sure **Preserve log** checkbox is checked)
-4. In the filter box, enter **signin.jsp**
+4. In the filter box, enter `signin.jsp?networkid=`
 5. Go to `https://portal.adtpulse.com` or `https://portal-ca.adtpulse.com` and login to your account
-6. Click on the network call (beginning with `signin.jsp`) appearing in the DevTools window
-7. In the **Headers** tab, under **Form Data**, copy the entire **fingerprint** (ending in `=`)
-8. Paste the copied text into the `fingerprint` field into your `config.json`
+6. Click **Request Code**, type in the requested code, and then click **Submit Code**
+7. Click **Trust this device** and name the device `Homebridge`
+8. Click **Save and Continue**
+9. Click **Sign Out** in the top right corner of the webpage
+10. Login to your account (once again)
+11. Click on the network call (beginning with `signin.jsp?networkid=`) appearing in the DevTools window. Select the last one.
+12. In the **Payload** tab, under **Form Data**, copy the entire **fingerprint** (after `fingerprint:`, do not include spaces)
+13. Paste the copied text into the `fingerprint` field into your `config.json`
+14. Close the Chrome window (DO NOT sign out)
 
 ## Force Arming (Arm Away/Stay/Night)
 Due to the nature of how HomeKit and ADT Pulse processes `setDeviceStatus` commands, this plugin will force arm when it detects active motion or open sensors.

package/api.js

@@ -419,19 +419,20 @@ Pulse.prototype.getDeviceStatus = function getDeviceStatus() {
  * - When Arming Night, armState will be set to "night+stay". It will be set to "night" after re-login.
  * - If alarm occurred, you must Clear Alarm before setting to Armed Away/Stay/Night.
  * - For ADT Pulse Canada, you must replace the "portal" sub-domain to "portal-ca" sub-domain.
+ * - "sat" code is now required for all set actions.
  *
  * Disarmed:
- * - Arm Away (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed&arm=away).
- * - Arm Stay (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed&arm=stay).
- * - Arm Night (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed&arm=night).
- * - Disarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed&arm=off).
- * - Clear Alarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed+with+alarm&arm=off).
+ * - Arm Away (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed&arm=away&sat=).
+ * - Arm Stay (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed&arm=stay&sat=).
+ * - Arm Night (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed&arm=night&sat=).
+ * - Disarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed&arm=off&sat=).
+ * - Clear Alarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=disarmed+with+alarm&arm=off&sat=).
  * Armed Away:
- * - Disarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=away&arm=off).
+ * - Disarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=away&arm=off&sat=).
  * Armed Stay:
- * - Disarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=stay&arm=off).
+ * - Disarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=stay&arm=off&sat=).
  * Armed Night:
- * - Disarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=night&arm=off).
+ * - Disarm (https://portal.adtpulse.com/myhome/quickcontrol/armDisarm.jsp?href=rest/adt/ui/client/security/setArmState&armstate=night&arm=off&sat=).
  *
  * @param {string} armState - Can be "disarmed", "disarmed+with+alarm", "away", "stay", or "night".
  * @param {string} arm      - Can be "off", "away", "stay", or "night".
@@ -444,26 +445,21 @@ Pulse.prototype.setDeviceStatus = function setDeviceStatus(armState, arm) {
   const deferred = Q.defer();
 
   this.hasInternetWrapper(deferred, () => {
-    const url = `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/quickcontrol/armDisarm.jsp`;
-    const arg = `?href=rest/adt/ui/client/security/setArmState&armstate=${armState}&arm=${arm}`;
+    const url1 = `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/summary/summary.jsp`;
 
     this.consoleLogger('ADT Pulse: Setting device status...', 'log');
 
     request.get(
-      url + arg,
-      this.generateRequestOptions({
-        headers: {
-          Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/summary/summary.jsp`,
-        },
-      }),
-      (error, response, body) => {
-        const regex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/quickcontrol\/armDisarm\.jsp)(.*)/);
-        const responsePath = _.get(response, 'request.uri.path');
+      url1,
+      this.generateRequestOptions(),
+      (error1, response1, body1) => {
+        const regex1 = new RegExp(/(\/myhome\/)([0-9.-]+)(\/summary\/summary\.jsp)(.*)/);
+        const responsePath1 = _.get(response1, 'request.uri.path');
 
-        this.consoleLogger(`ADT Pulse: Response path -> ${responsePath}`, 'log');
-        this.consoleLogger(`ADT Pulse: Response path matches -> ${regex.test(responsePath)}`, 'log');
+        this.consoleLogger(`ADT Pulse: Response path -> ${responsePath1}`, 'log');
+        this.consoleLogger(`ADT Pulse: Response path matches -> ${regex1.test(responsePath1)}`, 'log');
 
-        if (error || !regex.test(responsePath)) {
+        if (error1 || !regex1.test(responsePath1)) {
           authenticated = false;
 
           this.consoleLogger(`ADT Pulse: Set device status to ${arm} failed.`, 'error');
@@ -472,50 +468,99 @@ Pulse.prototype.setDeviceStatus = function setDeviceStatus(armState, arm) {
             action: 'SET_DEVICE_STATUS',
             success: false,
             info: {
-              error,
-              message: this.getErrorMessage(body),
+              error: error1,
+              message: this.getErrorMessage(body1),
             },
           });
         } else {
-          const $ = cheerio.load(body);
-          const onClick = $('input[id^="arm_button_"][value="Arm Anyway"]').attr('onclick');
-          const satCode = (onClick !== undefined) ? onClick.replace(/(.*)(\?sat=)([0-9a-z-]*)(&href=)(.*)/g, '$3') : undefined;
-
-          const forceUrl = `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/quickcontrol/serv/RunRRACommand`;
-          const forceArg = `?sat=${satCode}&href=rest/adt/ui/client/security/setForceArm&armstate=forcearm&arm=${arm}`;
-
-          // Check if system requires force arming.
-          if (['away', 'stay', 'night'].includes(arm) && onClick !== undefined && satCode !== undefined) {
-            this.consoleLogger('ADT Pulse: Some sensors are open or reporting motion. Arming Anyway...', 'warn');
-
-            request.get(
-              forceUrl + forceArg,
-              this.generateRequestOptions({
-                headers: {
-                  Accept: '*/*',
-                  Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/quickcontrol/armDisarm.jsp`,
-                },
-              }),
-              (forceError, forceResponse, forceBody) => {
-                const forceRegex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/quickcontrol\/serv\/RunRRACommand)(.*)/);
-                const forceResponsePath = _.get(forceResponse, 'request.uri.path');
-
-                this.consoleLogger(`ADT Pulse: Response path -> ${forceResponsePath}`, 'log');
-                this.consoleLogger(`ADT Pulse: Response path matches -> ${forceRegex.test(forceResponsePath)}`, 'log');
-
-                if (forceError || !forceRegex.test(forceResponsePath)) {
-                  authenticated = false;
-
-                  this.consoleLogger(`ADT Pulse: Set device status to ${arm} failed.`, 'error');
-
-                  deferred.reject({
-                    action: 'SET_DEVICE_STATUS',
-                    success: false,
-                    info: {
-                      error: forceError,
-                      message: this.getErrorMessage(forceBody),
+          const $2 = cheerio.load(body1);
+          const onClick2 = $2('input[id^="security_button_"]').attr('onclick');
+          const satCode2 = (onClick2 !== undefined) ? onClick2.replace(/(.*)(&sat=)([0-9a-z-]*)('\))/g, '$3') : undefined;
+          const url2 = `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/quickcontrol/armDisarm.jsp`;
+          const arg2 = `?href=rest/adt/ui/client/security/setArmState&armstate=${armState}&arm=${arm}&sat=${satCode2}`;
+
+          request.get(
+            url2 + arg2,
+            this.generateRequestOptions({
+              headers: {
+                Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/summary/summary.jsp`,
+              },
+            }),
+            (error2, response2, body2) => {
+              const regex2 = new RegExp(/(\/myhome\/)([0-9.-]+)(\/quickcontrol\/armDisarm\.jsp)(.*)/);
+              const responsePath2 = _.get(response2, 'request.uri.path');
+
+              this.consoleLogger(`ADT Pulse: Response path -> ${responsePath2}`, 'log');
+              this.consoleLogger(`ADT Pulse: Response path matches -> ${regex2.test(responsePath2)}`, 'log');
+
+              if (error2 || !regex2.test(responsePath2)) {
+                authenticated = false;
+
+                this.consoleLogger(`ADT Pulse: Set device status to ${arm} failed.`, 'error');
+
+                deferred.reject({
+                  action: 'SET_DEVICE_STATUS',
+                  success: false,
+                  info: {
+                    error: error2,
+                    message: this.getErrorMessage(body2),
+                  },
+                });
+              } else {
+                const $3 = cheerio.load(body2);
+                const onClick3 = $3('input[id^="arm_button_"][value="Arm Anyway"]').attr('onclick');
+                const satCode3 = (onClick3 !== undefined) ? onClick3.replace(/(.*)(\?sat=)([0-9a-z-]*)(&href=)(.*)/g, '$3') : undefined;
+
+                const url3 = `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/quickcontrol/serv/RunRRACommand`;
+                const arg3 = `?sat=${satCode3}&href=rest/adt/ui/client/security/setForceArm&armstate=forcearm&arm=${arm}`;
+
+                // Check if system requires force arming.
+                if (['away', 'stay', 'night'].includes(arm) && onClick3 !== undefined && satCode3 !== undefined) {
+                  this.consoleLogger('ADT Pulse: Some sensors are open or reporting motion. Arming Anyway...', 'warn');
+
+                  request.get(
+                    url3 + arg3,
+                    this.generateRequestOptions({
+                      headers: {
+                        Accept: '*/*',
+                        Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/quickcontrol/armDisarm.jsp`,
+                      },
+                    }),
+                    (forceError, forceResponse, forceBody) => {
+                      const forceRegex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/quickcontrol\/serv\/RunRRACommand)(.*)/);
+                      const forceResponsePath = _.get(forceResponse, 'request.uri.path');
+
+                      this.consoleLogger(`ADT Pulse: Response path -> ${forceResponsePath}`, 'log');
+                      this.consoleLogger(`ADT Pulse: Response path matches -> ${forceRegex.test(forceResponsePath)}`, 'log');
+
+                      if (forceError || !forceRegex.test(forceResponsePath)) {
+                        authenticated = false;
+
+                        this.consoleLogger(`ADT Pulse: Set device status to ${arm} failed.`, 'error');
+
+                        deferred.reject({
+                          action: 'SET_DEVICE_STATUS',
+                          success: false,
+                          info: {
+                            error: forceError,
+                            message: this.getErrorMessage(forceBody),
+                          },
+                        });
+                      } else {
+                        this.consoleLogger(`ADT Pulse: Set device status to ${arm} success.`, 'log');
+
+                        deferred.resolve({
+                          action: 'SET_DEVICE_STATUS',
+                          success: true,
+                          info: {
+                            forceArm: true,
+                            previousArm: armState,
+                            afterArm: arm,
+                          },
+                        });
+                      }
                     },
-                  });
+                  );
                 } else {
                   this.consoleLogger(`ADT Pulse: Set device status to ${arm} success.`, 'log');
 
@@ -523,27 +568,15 @@ Pulse.prototype.setDeviceStatus = function setDeviceStatus(armState, arm) {
                     action: 'SET_DEVICE_STATUS',
                     success: true,
                     info: {
-                      forceArm: true,
+                      forceArm: false,
                       previousArm: armState,
                       afterArm: arm,
                     },
                   });
                 }
-              },
-            );
-          } else {
-            this.consoleLogger(`ADT Pulse: Set device status to ${arm} success.`, 'log');
-
-            deferred.resolve({
-              action: 'SET_DEVICE_STATUS',
-              success: true,
-              info: {
-                forceArm: false,
-                previousArm: armState,
-                afterArm: arm,
-              },
-            });
-          }
+              }
+            },
+          );
         }
       },
     );

package/config.schema.json

@@ -37,7 +37,7 @@
                 "title": "MFA Fingerprint",
                 "type": "string",
                 "default": "",
-                "required": false,
+                "required": true,
                 "description": "MFA Fingerprint from browser registered with ADT Pulse"
             },
             "overrideSensors": {

package/index.js

@@ -5,7 +5,7 @@
  */
 const _ = require('lodash');
 
-const packageJson = require('./package');
+const packageJson = require('./package.json');
 const Pulse = require('./api');
 
 let Accessory;
@@ -847,7 +847,7 @@ ADTPulsePlatform.prototype.portalSync = function portalSync() {
       .login()
       .then((response) => {
         const version = _.get(response, 'info.version');
-        const supportedVersion = ['21.0.0-354', '22.0.0-233'];
+        const supportedVersion = ['22.0.0-233', '23.0.0-99'];
 
         if (version !== undefined && !supportedVersion.includes(version) && version !== this.sessionVersion) {
           this.logMessage(`Web Portal version ${version} detected. Test plugin to ensure system compatibility...`, 20);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-adt-pulse",
   "displayName": "Homebridge ADT Pulse",
-  "version": "2.1.0",
+  "version": "2.1.3",
   "description": "Homebridge security system platform for ADT Pulse",
   "main": "index.js",
   "private": false,
@@ -39,7 +39,7 @@
   "homepage": "https://github.com/mrjackyliang/homebridge-adt-pulse#readme",
   "engines": {
     "homebridge": ">=0.4.50",
-    "node": "16"
+    "node": ">=14.16.0"
   },
   "dependencies": {
     "cheerio": "1.0.0-rc.5",