homebridge-adt-pulse 2.2.0 → 3.0.0-beta.1

package/api.js

@@ -1,878 +0,0 @@
-/**
- * ADT Pulse.
- *
- * A JavaScript library / Node module for ADT Pulse.
- *
- * @author Kevin Hickey <kevin@kevinmhickey.com>
- * @author Jacky Liang
- *
- * @since 1.0.0
- */
-const cheerio = require('cheerio');
-const hasInternet = require('internet-available');
-const Q = require('q');
-const request = require('request');
-const _ = require('lodash');
-
-/**
- * Browser session cookies.
- *
- * @since 1.0.0
- */
-let jar;
-
-/**
- * Set country sub-domain.
- *
- * @since 1.0.0
- */
-let countrySubDomain = '';
-
-/**
- * Track login, login statuses, portal versions.
- *
- * @since 1.0.0
- */
-let authenticated = false;
-let lastKnownVersion = '';
-let lastKnownSiteId = '';
-
-/**
- * ADT Pulse constructor.
- *
- * @param {object} options - The configuration.
- *
- * @constructor
- *
- * @since 1.0.0
- */
-function Pulse(options) {
-  this.username = _.get(options, 'username', '');
-  this.password = _.get(options, 'password', '');
-  this.fingerprint = _.get(options, 'fingerprint', '');
-  this.overrideSensors = _.get(options, 'overrideSensors', []);
-  this.country = _.get(options, 'country', '');
-  this.debug = _.get(options, 'debug', false);
-
-  // Configure country sub-domain.
-  switch (this.country) {
-    case 'ca':
-      countrySubDomain = 'portal-ca';
-      break;
-    case 'us':
-    default:
-      countrySubDomain = 'portal';
-      break;
-  }
-}
-
-/**
- * ADT Pulse login.
- *
- * @returns {Q.Promise<object>}
- *
- * @since 1.0.0
- */
-Pulse.prototype.login = function login() {
-  const deferred = Q.defer();
-  const that = this;
-
-  this.hasInternetWrapper(deferred, () => {
-    if (authenticated) {
-      deferred.resolve({
-        action: 'LOGIN',
-        success: true,
-        info: {
-          version: lastKnownVersion,
-          siteId: lastKnownSiteId,
-        },
-      });
-    } else {
-      this.consoleLogger('ADT Pulse: Logging in...', 'log');
-
-      // Request a new cookie session.
-      jar = request.jar();
-
-      request.get(
-        `https://${countrySubDomain}.adtpulse.com`,
-        this.generateRequestOptions(),
-        (error, response, body) => {
-          const regex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/access\/signin\.jsp)/);
-          const responsePath = _.get(response, 'request.uri.path');
-
-          this.consoleLogger(`ADT Pulse: Response path -> ${responsePath}`, 'log');
-          this.consoleLogger(`ADT Pulse: Response path matches -> ${regex.test(responsePath)}`, 'log');
-
-          if (error || !regex.test(responsePath)) {
-            authenticated = false;
-
-            this.consoleLogger('ADT Pulse: Login failed.', 'error');
-
-            deferred.reject({
-              action: 'LOGIN',
-              success: false,
-              info: {
-                error,
-                message: this.getErrorMessage(body),
-              },
-            });
-          } else {
-            authenticated = false;
-
-            const version = responsePath.replace(regex, '$2');
-
-            // Saves last known version for reuse later.
-            lastKnownVersion = version;
-
-            this.consoleLogger(`ADT Pulse: Web portal version -> ${version}`, 'log');
-
-            request.post(
-              `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/access/signin.jsp`,
-              this.generateRequestOptions({
-                followAllRedirects: true,
-                headers: {
-                  Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/access/signin.jsp`,
-                },
-                form: {
-                  usernameForm: that.username,
-                  passwordForm: that.password,
-                  fingerprint: that.fingerprint,
-                },
-              }),
-              (postError, postResponse, postBody) => {
-                const postRegex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/summary\/summary\.jsp)/);
-                const postResponsePath = _.get(postResponse, 'request.uri.path');
-
-                this.consoleLogger(`ADT Pulse: Response path -> ${postResponsePath}`, 'log');
-                this.consoleLogger(`ADT Pulse: Response path matches -> ${postRegex.test(postResponsePath)}`, 'log');
-
-                if (postError || !postRegex.test(postResponsePath)) {
-                  authenticated = false;
-
-                  this.consoleLogger('ADT Pulse: Login failed.', 'error');
-
-                  deferred.reject({
-                    action: 'LOGIN',
-                    success: false,
-                    info: {
-                      error: postError,
-                      message: this.getErrorMessage(postBody),
-                    },
-                  });
-                } else {
-                  authenticated = true;
-
-                  const $ = cheerio.load(postBody);
-                  const signoutLink = $('#p_signout1').attr('href');
-                  const siteId = (signoutLink !== undefined) ? signoutLink.replace(/(.*)(networkid=)(.*)(&)(.*)/g, '$3') : undefined;
-
-                  // Saves last known site ID for reuse later.
-                  lastKnownSiteId = siteId;
-
-                  this.consoleLogger(`ADT Pulse: Site ID -> ${siteId}`, 'log');
-                  this.consoleLogger('ADT Pulse: Login success.', 'log');
-
-                  deferred.resolve({
-                    action: 'LOGIN',
-                    success: true,
-                    info: {
-                      version: lastKnownVersion,
-                      siteId: lastKnownSiteId,
-                    },
-                  });
-                }
-              },
-            );
-          }
-        },
-      );
-    }
-  });
-
-  return deferred.promise;
-};
-
-/**
- * ADT Pulse logout.
- *
- * @returns {Q.Promise<object>}
- *
- * @since 1.0.0
- */
-Pulse.prototype.logout = function logout() {
-  const deferred = Q.defer();
-
-  this.hasInternetWrapper(deferred, () => {
-    if (!authenticated) {
-      deferred.resolve({
-        action: 'LOGOUT',
-        success: true,
-        info: null,
-      });
-    } else {
-      this.consoleLogger('ADT Pulse: Logging out...', 'log');
-
-      request.get(
-        `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/access/signout.jsp?networkid=${lastKnownSiteId}&partner=adt`,
-        this.generateRequestOptions({
-          headers: {
-            Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/summary/summary.jsp`,
-          },
-        }),
-        (error, response, body) => {
-          const regex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/access\/signin\.jsp)(.*)/);
-          const responsePath = _.get(response, 'request.uri.path');
-
-          this.consoleLogger(`ADT Pulse: Response path -> ${responsePath}`, 'log');
-          this.consoleLogger(`ADT Pulse: Response path matches -> ${regex.test(responsePath)}`, 'log');
-
-          if (error || !regex.test(responsePath)) {
-            authenticated = true;
-
-            this.consoleLogger('ADT Pulse: Logout failed.', 'error');
-
-            deferred.reject({
-              action: 'LOGOUT',
-              success: false,
-              info: {
-                error,
-                message: this.getErrorMessage(body),
-              },
-            });
-          } else {
-            authenticated = false;
-
-            this.consoleLogger('ADT Pulse: Logout success.', 'log');
-
-            deferred.resolve({
-              action: 'LOGOUT',
-              success: true,
-              info: null,
-            });
-          }
-        },
-      );
-    }
-  });
-
-  return deferred.promise;
-};
-
-/**
- * ADT Pulse get device information.
- *
- * @returns {Q.Promise<object>}
- *
- * @since 1.0.0
- */
-Pulse.prototype.getDeviceInformation = function getDeviceInformation() {
-  const deferred = Q.defer();
-
-  this.hasInternetWrapper(deferred, () => {
-    this.consoleLogger('ADT Pulse: Getting device information...', 'log');
-
-    request.get(
-      `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/system/device.jsp?id=1`,
-      this.generateRequestOptions({
-        headers: {
-          Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/system/system.jsp`,
-        },
-      }),
-      (error, response, body) => {
-        const regex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/system\/device\.jsp)(.*)/);
-        const responsePath = _.get(response, 'request.uri.path');
-
-        this.consoleLogger(`ADT Pulse: Response path -> ${responsePath}`, 'log');
-        this.consoleLogger(`ADT Pulse: Response path matches -> ${regex.test(responsePath)}`, 'log');
-
-        if (error || !regex.test(responsePath)) {
-          authenticated = false;
-
-          this.consoleLogger('ADT Pulse: Get device information failed.', 'error');
-
-          deferred.reject({
-            action: 'GET_DEVICE_INFO',
-            success: false,
-            info: {
-              error,
-              message: this.getErrorMessage(body),
-            },
-          });
-        } else {
-          const $ = cheerio.load(body);
-          const deviceName = $('td.InputFieldDescriptionL:contains("Name")').next().text().trim();
-          const deviceMake = $('td.InputFieldDescriptionL:contains("Manufacturer")').next().text().trim();
-          const deviceType = $('td.InputFieldDescriptionL:contains("Type")').next().text().trim();
-
-          this.consoleLogger('ADT Pulse: Get device information success.', 'log');
-
-          deferred.resolve({
-            action: 'GET_DEVICE_INFO',
-            success: true,
-            info: {
-              name: deviceName,
-              make: deviceMake,
-              type: deviceType,
-            },
-          });
-        }
-      },
-    );
-  });
-
-  return deferred.promise;
-};
-
-/**
- * ADT Pulse get device status.
- *
- * @returns {Q.Promise<object>}
- *
- * @since 1.0.0
- */
-Pulse.prototype.getDeviceStatus = function getDeviceStatus() {
-  const deferred = Q.defer();
-
-  this.hasInternetWrapper(deferred, () => {
-    this.consoleLogger('ADT Pulse: Getting device status...', 'log');
-
-    request.get(
-      `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/ajax/orb.jsp`,
-      this.generateRequestOptions({
-        headers: {
-          Accept: '*/*',
-          Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/summary/summary.jsp`,
-        },
-      }),
-      (error, response, body) => {
-        const regex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/ajax\/orb\.jsp)/);
-        const responsePath = _.get(response, 'request.uri.path');
-
-        this.consoleLogger(`ADT Pulse: Response path -> ${responsePath}`, 'log');
-        this.consoleLogger(`ADT Pulse: Response path matches -> ${regex.test(responsePath)}`, 'log');
-
-        if (error || !regex.test(responsePath) || body.indexOf('<html') > -1) {
-          authenticated = false;
-
-          this.consoleLogger('ADT Pulse: Get device status failed.', 'error');
-
-          deferred.reject({
-            action: 'GET_DEVICE_STATUS',
-            success: false,
-            info: {
-              error,
-              message: this.getErrorMessage(body),
-            },
-          });
-        } else {
-          const $ = cheerio.load(body);
-          const textSummary = $('#divOrbTextSummary span').text();
-          const theState = textSummary.replace(/([A-Z a-z ]+)(\.[  ]?)([A-Z a-z 0-9]*)(\.?)(.*)/g, '$1');
-          const theStatus = textSummary.replace(/([A-Z a-z ]+)(\.[  ]?)([A-Z a-z 0-9]*)(\.?)(.*)/g, '$3');
-
-          this.consoleLogger('ADT Pulse: Get device status success.', 'log');
-
-          /**
-           * These are the possible states and statuses.
-           *
-           * State:
-           *   "Disarmed"
-           *   "Armed Away"
-           *   "Armed Stay"
-           *   "Armed Night"
-           *   "Status Unavailable"
-           * Status:
-           *   "All Quiet"
-           *   "1 Sensor Open" or "x Sensors Open"
-           *   "Sensor Bypassed" or "Sensors Bypassed"
-           *   "Sensor Tripped" or "Sensors Tripped"
-           *   "Motion"
-           *   "Uncleared Alarm"
-           *   "Carbon Monoxide Alarm"
-           *   "FIRE ALARM"
-           *   "BURGLARY ALARM"
-           *   "Sensor Problem"
-           *   ""
-           */
-          deferred.resolve({
-            action: 'GET_DEVICE_STATUS',
-            success: true,
-            info: {
-              summary: textSummary,
-              state: theState,
-              status: theStatus,
-            },
-          });
-        }
-      },
-    );
-  });
-
-  return deferred.promise;
-};
-
-/**
- * ADT Pulse set device status.
- *
- * Notes:
- * - When Disarming, armState will be set to "disarmed". It will be set to "off" after re-login.
- * - 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&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&sat=).
- * Armed Stay:
- * - 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&sat=).
- *
- * @param {string} armState - Can be "disarmed", "disarmed+with+alarm", "away", "stay", or "night".
- * @param {string} arm      - Can be "off", "away", "stay", or "night".
- *
- * @returns {Q.Promise<object>}
- *
- * @since 1.0.0
- */
-Pulse.prototype.setDeviceStatus = function setDeviceStatus(armState, arm) {
-  const deferred = Q.defer();
-
-  this.hasInternetWrapper(deferred, () => {
-    const url1 = `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/summary/summary.jsp`;
-
-    this.consoleLogger('ADT Pulse: Setting device status...', 'log');
-
-    request.get(
-      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 -> ${responsePath1}`, 'log');
-        this.consoleLogger(`ADT Pulse: Response path matches -> ${regex1.test(responsePath1)}`, 'log');
-
-        if (error1 || !regex1.test(responsePath1)) {
-          authenticated = false;
-
-          this.consoleLogger(`ADT Pulse: Set device status to ${arm} failed.`, 'error');
-
-          deferred.reject({
-            action: 'SET_DEVICE_STATUS',
-            success: false,
-            info: {
-              error: error1,
-              message: this.getErrorMessage(body1),
-            },
-          });
-        } else {
-          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');
-
-                  deferred.resolve({
-                    action: 'SET_DEVICE_STATUS',
-                    success: true,
-                    info: {
-                      forceArm: false,
-                      previousArm: armState,
-                      afterArm: arm,
-                    },
-                  });
-                }
-              }
-            },
-          );
-        }
-      },
-    );
-  });
-
-  return deferred.promise;
-};
-
-/**
- * ADT Pulse get zone status.
- *
- * @returns {Q.Promise<object>}
- *
- * @since 1.0.0
- */
-Pulse.prototype.getZoneStatus = function getZoneStatus() {
-  const deferred = Q.defer();
-
-  this.hasInternetWrapper(deferred, () => {
-    this.consoleLogger('ADT Pulse: Getting zone status...', 'log');
-
-    request.get(
-      `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/ajax/orb.jsp`,
-      this.generateRequestOptions({
-        headers: {
-          Accept: '*/*',
-          Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/summary/summary.jsp`,
-        },
-      }),
-      (error, response, body) => {
-        const regex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/ajax\/orb\.jsp)/);
-        const responsePath = _.get(response, 'request.uri.path');
-
-        this.consoleLogger(`ADT Pulse: Response path -> ${responsePath}`, 'log');
-        this.consoleLogger(`ADT Pulse: Response path matches -> ${regex.test(responsePath)}`, 'log');
-
-        if (error || !regex.test(responsePath) || body.indexOf('<html') > -1) {
-          authenticated = false;
-
-          this.consoleLogger('ADT Pulse: Get zone status failed.', 'error');
-
-          deferred.reject({
-            action: 'GET_ZONE_STATUS',
-            success: false,
-            info: {
-              error,
-              message: this.getErrorMessage(body),
-            },
-          });
-        } else {
-          const $ = cheerio.load(body);
-          const sensors = $('#orbSensorsList table tr.p_listRow').toArray();
-
-          const output = _.map(sensors, (sensor) => {
-            const theSensor = cheerio.load([].concat(sensor));
-            const theName = theSensor('a.p_deviceNameText').html();
-            const theZone = theSensor('span.p_grayNormalText').html();
-            const theState = theSensor('span.devStatIcon canvas').attr('icon');
-
-            const theZoneNumber = (theZone) ? theZone.replace(/(Zone)(&#xA0;|&nbsp;)([0-9]{1,2})/, '$3') : 0;
-
-            let theTag;
-
-            if (typeof theName === 'string' && theState !== 'devStatUnknown') {
-              const theNameLowercase = theName.toLowerCase();
-              const theOverrideSensor = _.find(this.overrideSensors, (overrideSensor) => overrideSensor.name.toLowerCase() === theNameLowercase);
-
-              if (theOverrideSensor !== undefined) {
-                const theOverrideSensorType = _.get(theOverrideSensor, 'type');
-                const allowedSensorTypes = ['sensor,glass', 'sensor,motion', 'sensor,co', 'sensor,fire', 'sensor,doorWindow'];
-
-                this.consoleLogger(`ADT Pulse: ${theName} sensor type is manually overridden to "${theOverrideSensorType}".`, 'warn');
-
-                theTag = (allowedSensorTypes.includes(theOverrideSensorType)) ? theOverrideSensorType : undefined;
-              } else if (theNameLowercase.match(/^(.*)(glass)(.*)$/g) !== null) {
-                theTag = 'sensor,glass';
-              } else if (theNameLowercase.match(/^(.*)(motion)(.*)$/g) !== null) {
-                theTag = 'sensor,motion';
-              } else if (theNameLowercase.match(/^(.*)(gas)(.*)$/g) !== null) {
-                theTag = 'sensor,co';
-              } else if (theNameLowercase.match(/^(.*)(smoke|heat)(.*)$/g) !== null) {
-                theTag = 'sensor,fire';
-              } else if (theNameLowercase.match(/^(.*)(door|window|dr|win|slider)(.*)$/g) !== null) {
-                theTag = 'sensor,doorWindow';
-              }
-            }
-
-            /**
-             * Expected output.
-             *
-             * id:    sensor-[integer]
-             * name:  device name
-             * tags:  sensor,[doorWindow,motion,glass,co,fire]
-             * state: devStatOK (device okay)
-             *        devStatLowBatt (device low battery)
-             *        devStatOpen (door/window opened)
-             *        devStatMotion (detected motion)
-             *        devStatTamper (glass broken or device tamper)
-             *        devStatAlarm (detected CO/Smoke)
-             *        devStatUnknown (device offline)
-             */
-            return {
-              id: `sensor-${theZoneNumber}`,
-              name: theName || '',
-              tags: theTag || 'sensor',
-              state: theState || 'devStatUnknown',
-            };
-          });
-
-          this.consoleLogger('ADT Pulse: Get zone status success.', 'log');
-
-          deferred.resolve({
-            action: 'GET_ZONE_STATUS',
-            success: true,
-            info: output,
-          });
-        }
-      },
-    );
-  });
-
-  return deferred.promise;
-};
-
-/**
- * ADT Pulse sync protocol.
- *
- * @returns {Q.Promise<object>}
- *
- * @since 1.0.0
- */
-Pulse.prototype.performPortalSync = function performPortalSync() {
-  const deferred = Q.defer();
-
-  this.hasInternetWrapper(deferred, () => {
-    this.consoleLogger('ADT Pulse: Performing portal sync...', 'log');
-
-    request.get(
-      `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/Ajax/SyncCheckServ?t=${Date.now()}`,
-      this.generateRequestOptions({
-        headers: {
-          Accept: '*/*',
-          Referer: `https://${countrySubDomain}.adtpulse.com/myhome/${lastKnownVersion}/summary/summary.jsp`,
-        },
-      }),
-      (error, response, body) => {
-        const regex = new RegExp(/(\/myhome\/)([0-9.-]+)(\/Ajax\/SyncCheckServ)(.*)/);
-        const responsePath = _.get(response, 'request.uri.path');
-
-        this.consoleLogger(`ADT Pulse: Response path -> ${responsePath}`, 'log');
-        this.consoleLogger(`ADT Pulse: Response path matches -> ${regex.test(responsePath)}`, 'log');
-
-        if (error || !regex.test(responsePath) || body.indexOf('<html') > -1) {
-          authenticated = false;
-
-          this.consoleLogger('ADT Pulse: Portal sync failed.', 'error');
-
-          deferred.reject({
-            action: 'SYNC',
-            success: false,
-            info: {
-              error,
-              message: this.getErrorMessage(body),
-            },
-          });
-        } else {
-          this.consoleLogger('ADT Pulse: Portal sync success.', 'log');
-
-          /**
-           * May return sync codes like this:
-           *   1-0-0
-           *   2-0-0
-           *   [integer]-0-0
-           *   [integer]-[integer]-0
-           */
-          deferred.resolve({
-            action: 'SYNC',
-            success: true,
-            info: {
-              syncCode: body,
-            },
-          });
-        }
-      },
-    );
-  });
-
-  return deferred.promise;
-};
-
-/**
- * Internet available wrapper.
- *
- * @param {Q.Deferred} deferred    - Used for rejecting promises.
- * @param {Function}   runFunction - Run function if internet is available.
- *
- * @since 1.0.0
- */
-Pulse.prototype.hasInternetWrapper = function hasInternetWrapper(deferred, runFunction) {
-  const settings = {
-    timeout: 5000,
-    retries: 3,
-    domainName: `${countrySubDomain}.adtpulse.com`,
-    port: 53,
-  };
-
-  hasInternet(settings).then(runFunction).catch(() => {
-    this.consoleLogger(`ADT Pulse: Internet connection is offline or "https://${countrySubDomain}.adtpulse.com" is unavailable.`, 'error');
-
-    deferred.reject({
-      action: 'CONNECT',
-      success: false,
-      info: null,
-    });
-  });
-};
-
-/**
- * Request options generator.
- *
- * @param {object} additionalOptions - Additional options.
- *
- * @returns {object}
- *
- * @since 1.0.0
- */
-Pulse.prototype.generateRequestOptions = function generateRequestOptions(additionalOptions = {}) {
-  const options = {
-    jar,
-    headers: {
-      Accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
-      Host: `${countrySubDomain}.adtpulse.com`,
-      'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36 Edg/100.0.1185.44',
-    },
-    ciphers: [
-      'ECDHE-RSA-AES256-GCM-SHA384',
-      'ECDHE-RSA-AES128-GCM-SHA256',
-    ].join(':'),
-  };
-
-  // Merge additional options.
-  return _.merge(options, additionalOptions);
-};
-
-/**
- * ADT Pulse get error message.
- *
- * @param {string} responseBody - The response body.
- *
- * @returns {(null|string)}
- *
- * @since 1.0.0
- */
-Pulse.prototype.getErrorMessage = function getErrorMessage(responseBody) {
-  // Returns array or null.
-  let errorMessage = (responseBody) ? responseBody.match(/<div id="warnMsgContents" class="p_signinWarning">(.*?)<\/div>/g) : null;
-
-  // Returns string.
-  errorMessage = (errorMessage) ? errorMessage[0] : '';
-
-  // Replace single line break with space.
-  errorMessage = errorMessage.replace(/<br ?\/?>/ig, ' ');
-
-  // Remove all HTML code.
-  errorMessage = errorMessage.replace(/(<([^>]+)>)/ig, '');
-
-  // If empty message, return null.
-  return errorMessage || null;
-};
-
-/**
- * ADT Pulse console logger.
- *
- * @param {string} content - The message or content being recorded into the logs.
- * @param {string} type    - Can be "error", "warn", or "log".
- *
- * @since 1.0.0
- */
-Pulse.prototype.consoleLogger = function consoleLogger(content, type) {
-  const that = this;
-
-  if (that.debug) {
-    switch (type) {
-      case 'error':
-        console.error(content);
-        break;
-      case 'warn':
-        console.warn(content);
-        break;
-      case 'log':
-        console.log(content);
-        break;
-      default:
-        break;
-    }
-  }
-};
-
-module.exports = Pulse;