Bug fixes and enhancements

### UPDATED
- Universal `.gitignore` file.
- Limit sensor zones to support only from Zone 1 through 99 due to unwanted rogue devices appearing as sensors.
- Naming convention for documented items (now sorted into collections, devices, and items for clarity).
- Rewritten debug parser detector to better detect parser anomalies.
- `generateHash` function now only accepts objects and array of objects to remove data that does not necessarily need to be hashed (e.g. "Last Update" or `rawHtml`).
- Logs will not include `rawHtml` anymore since it fills up the screen full of information that is best sent to the developer automatically.
- Changed wording for debug logs regarding stale login sessions.

### FIXED
- Missing "Tampered" status documentation in sensor statuses.

### ADDED
- GitHub workflows.
- Keep alive requests will now check for error codes so logs don't get unnecessarily spammed.
- Privacy notice in `README.md` that if the plugin detects anomalies, information sent to the plugin author will include unfiltered raw HTML.

### REMOVED
- `FunctionName` type.
- User reminders for when the detector function sends information out since `rawHtml` is not included in logs anymore due to it taking up too much space.

Author: mrjackyliang

.github/workflows/lock-threads.yml

@@ -2,7 +2,7 @@ name: 'Lock Threads'
 
 on:
   schedule:
-    - cron: '0 * * * *'
+    - cron: '0 0 * * *'
 
 permissions:
   issues: write

.gitignore

@@ -61,11 +61,26 @@ package-lock.json
 #################
 .next/
 
+#####################
+#### AWS Amplify ####
+#####################
+amplify/.config/local-*
+amplify/backend/.temp
+amplify/backend/amplify-meta.json
+amplify/\#current-cloud-backend
+amplify/hooks/*.sample
+amplify/logs
+amplify/mock-api-resources
+amplify/mock-data
+src/amplifyconfiguration.json
+src/aws-exports.js
+
 ##################
 #### Firebase ####
 ##################
-**/.firebase
-**/.firebaserc
+.firebase
+.firebaserc
+firebase-debug.log
 
 ###################
 #### JetBrains ####

README.md

@@ -145,6 +145,9 @@ All sensors are now organized within an array of objects, with each object conta
   - For example, if the type is "Door/Window Sensor", the value should be `doorWindow`. Read the [Supported Devices](#supported-devices) section for more information.
 - __ADT Zone__ (`adtZone`)
   - Must match the zone shown under the "Zone" column in the "System" tab when logged into the portal.
+  - For compatibility reasons, only devices with zones 1 through 99 are supported.
+
+If you do not wish to add sensors, simply assign an empty array (e.g. `[]`). However, it is advisable to include all supported sensors, as having none does not optimize plugin performance.
 
 If you do not find the supported type listed, please note that the plugin will notify me. Do not create a separate issue on GitHub. I am actively working on adding support as soon as I gather sufficient information to determine the statuses displayed on the portal.
 
@@ -257,7 +260,9 @@ Here is an example of the information I see when the plugin detects unknown stat
   }
 }
 ```
-__Notice:__ If you prefer to prevent this functionality, you can block the URL that the plugin utilizes to notify me. However, it is essential to note that I will not be able to offer assistance or support if you choose to impede the plugin from fulfilling its purpose to the best of its capabilities.
+__Note:__ If you prefer to prevent this functionality, you can block the URL that the plugin utilizes to notify me. However, it is essential to note that I will not be able to offer assistance or support if you choose to impede the plugin from fulfilling its purpose to the best of its capabilities.
+
+__Note 2:__ In certain scenarios, the plugin may identify anomalies while parsing portal data. Such reports may contain raw HTML data (redacted in the logs). To ensure prompt updates, the raw HTML sent to me will remain unfiltered.
 
 ## Credits and Appreciation
 If you find value in the ongoing development of this plugin and wish to express your appreciation, you have the option to become my supporter on [GitHub Sponsors](https://github.com/sponsors/mrjackyliang)!

config.schema.json

@@ -233,7 +233,7 @@
               "description": "Specify the <strong class=\"font-weight-bold\">exact zone</strong> associated with the sensor you want to add. Double-check the zone to ensure the correct sensor is added.",
               "placeholder": "e.g. 99",
               "minimum": 1,
-              "maximum": 999
+              "maximum": 99
             }
           }
         },

package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-adt-pulse",
   "displayName": "Homebridge ADT Pulse",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "description": "Homebridge security system platform for ADT Pulse",
   "main": "./build/index.js",
   "exports": "./build/index.js",

src/lib/accessory.ts

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 
-import { condensedSensorTypeItems } from '@/lib/items.js';
+import { itemCondensedSensorTypes } from '@/lib/items.js';
 import {
   condensePanelStates,
   convertPanelCharacteristicValue,
@@ -405,7 +405,7 @@ export class ADTPulseAccessory {
       || type === 'gateway'
       || type === 'panel'
       || type === 'panelSwitch'
-      || !condensedSensorTypeItems.includes(type)
+      || !itemCondensedSensorTypes.includes(type)
     ) {
       hapStatus = new this.#api.hap.HapStatusError(this.#api.hap.HAPStatus.RESOURCE_DOES_NOT_EXIST);
 

src/lib/api.ts

@@ -42,7 +42,6 @@ import {
   generateDynatracePCHeaderValue,
   generateFakeReadyButtons,
   generateHash,
-  isEmptyOrbTextSummary,
   isPortalSyncCode,
   parseArmDisarmMessage,
   parseDoSubmitHandlers,
@@ -866,25 +865,12 @@ export class ADTPulse {
        */
       await this.newInformationDispatcher('gateway-information', gatewayInformation);
 
-      // TODO Need a more permanent way and safer way to determine gateway model.
-      // If the parsing function may be parsing data incorrectly.
-      if (
-        Object.keys(fetchedTableCells).length !== 10 // Lynx/QuickConnect Cellular-Only Gateway / Cellular Mode.
-        && Object.keys(fetchedTableCells).length !== 11 // Compact SMA Protocol Gateway / Cellular Mode.
-        && Object.keys(fetchedTableCells).length !== 17 // ADT Pulse Gateway / Broadband Mode / No Router WAN IP Address.
-        && Object.keys(fetchedTableCells).length !== 18 // ADT Pulse Gateway / Broadband Mode.
-      ) {
-        if (this.#internal.debug) {
-          debugLog(this.#internal.logger, 'api.ts / ADTPulse.getGatewayInformation()', 'warn', 'The fetchTableCells() function may be parsing the gateway information incorrectly');
-        }
-
-        await this.newInformationDispatcher('debug-parser', {
-          parserName: 'fetchTableCells()',
-          parserReason: 'length does not match 10, 11, 17, and 18',
-          parserResponse: fetchedTableCells,
-          rawData: sessions.axiosSystemGateway.data,
-        });
-      }
+      // Check if the parsing function is parsing data incorrectly.
+      await this.newInformationDispatcher('debug-parser', {
+        method: 'getGatewayInformation',
+        response: fetchedTableCells,
+        rawHtml: sessions.axiosSystemGateway.data,
+      });
 
       if (this.#internal.debug) {
         debugLog(this.#internal.logger, 'api.ts / ADTPulse.getGatewayInformation()', 'success', `Successfully retrieved gateway information from "${this.#internal.baseUrl}"`);
@@ -941,9 +927,6 @@ export class ADTPulse {
         }),
       );
 
-      // TODO Check for 500 Internal Server Error (add it to every API method).
-      // TODO sessions.axiosSystemDeviceId1.status
-
       // If the "ClientRequest" object does not exist in the Axios response.
       if (typeof sessions.axiosSystemDeviceId1?.request === 'undefined') {
         if (this.#internal.debug) {
@@ -1087,24 +1070,12 @@ export class ADTPulse {
        */
       await this.newInformationDispatcher('panel-information', panelInformation);
 
-      // TODO Need a more permanent way and safer way to determine panel status.
-      // If the parsing function may be parsing data incorrectly.
-      if (
-        Object.keys(fetchedTableCells).length !== 3 // PowerSeries/PremisePro.
-        && Object.keys(fetchedTableCells).length !== 4 // Impassa SCW9057.
-        && Object.keys(fetchedTableCells).length !== 5 // Safewatch Pro 3000/3000CN.
-      ) {
-        if (this.#internal.debug) {
-          debugLog(this.#internal.logger, 'api.ts / ADTPulse.getPanelInformation()', 'warn', 'The fetchTableCells() function may be parsing the panel information incorrectly');
-        }
-
-        await this.newInformationDispatcher('debug-parser', {
-          parserName: 'fetchTableCells()',
-          parserReason: 'length does not match 3, 4, and 5',
-          parserResponse: fetchedTableCells,
-          rawData: sessions.axiosSystemDeviceId1.data,
-        });
-      }
+      // Check if the parsing function is parsing data incorrectly.
+      await this.newInformationDispatcher('debug-parser', {
+        method: 'getPanelInformation',
+        response: fetchedTableCells,
+        rawHtml: sessions.axiosSystemDeviceId1.data,
+      });
 
       if (this.#internal.debug) {
         debugLog(this.#internal.logger, 'api.ts / ADTPulse.getPanelInformation()', 'success', `Successfully retrieved panel information from "${this.#internal.baseUrl}"`);
@@ -1321,19 +1292,12 @@ export class ADTPulse {
        */
       await this.newInformationDispatcher('panel-status', parsedOrbTextSummary);
 
-      // If the parsing function may be parsing data incorrectly.
-      if (isEmptyOrbTextSummary(parsedOrbTextSummary)) {
-        if (this.#internal.debug) {
-          debugLog(this.#internal.logger, 'api.ts / ADTPulse.getPanelStatus()', 'warn', 'The parseOrbTextSummary() function may be parsing sensors information incorrectly');
-        }
-
-        await this.newInformationDispatcher('debug-parser', {
-          parserName: 'parseOrbTextSummary()',
-          parserReason: 'empty response',
-          parserResponse: parsedOrbTextSummary,
-          rawData: sessions.axiosSummary.data,
-        });
-      }
+      // Check if the parsing function is parsing data incorrectly.
+      await this.newInformationDispatcher('debug-parser', {
+        method: 'getPanelStatus',
+        response: parsedOrbTextSummary,
+        rawHtml: sessions.axiosSummary.data,
+      });
 
       if (this.#internal.debug) {
         debugLog(this.#internal.logger, 'api.ts / ADTPulse.getPanelStatus()', 'success', `Successfully retrieved panel status from "${this.#internal.baseUrl}"`);
@@ -1651,19 +1615,12 @@ export class ADTPulse {
        */
       await this.newInformationDispatcher('orb-security-buttons', parsedOrbSecurityButtons);
 
-      // If the parsing function may be parsing data incorrectly.
-      if (parsedOrbSecurityButtons.length < 1 || parsedOrbSecurityButtons.length > 3) {
-        if (this.#internal.debug) {
-          debugLog(this.#internal.logger, 'api.ts / ADTPulse.setPanelStatus()', 'warn', 'The parseOrbSecurityButtons() function may be parsing the orb security buttons incorrectly');
-        }
-
-        await this.newInformationDispatcher('debug-parser', {
-          parserName: 'parseOrbSecurityButtons()',
-          parserReason: 'length is not between 1 to 3',
-          parserResponse: parsedOrbSecurityButtons,
-          rawData: sessions.axiosSummary.data,
-        });
-      }
+      // Check if the parsing function is parsing data incorrectly.
+      await this.newInformationDispatcher('debug-parser', {
+        method: 'setPanelStatus',
+        response: parsedOrbSecurityButtons,
+        rawHtml: sessions.axiosSummary.data,
+      });
 
       // Only keep all ready (enabled) orb security buttons.
       let readyButtons = parsedOrbSecurityButtons.filter((parsedOrbSecurityButton): parsedOrbSecurityButton is ADTPulseSetPanelStatusReadyButton => !parsedOrbSecurityButton.buttonDisabled);
@@ -2008,19 +1965,12 @@ export class ADTPulse {
        */
       await this.newInformationDispatcher('sensors-information', parsedSensorsTable);
 
-      // If the parsing function may be parsing data incorrectly.
-      if (parsedSensorsTable.length < 1) {
-        if (this.#internal.debug) {
-          debugLog(this.#internal.logger, 'api.ts / ADTPulse.getSensorsInformation()', 'warn', 'The parseSensorsTable() function may be parsing the sensors table incorrectly');
-        }
-
-        await this.newInformationDispatcher('debug-parser', {
-          parserName: 'parseSensorsTable()',
-          parserReason: 'length is not 1 or more',
-          parserResponse: parsedSensorsTable,
-          rawData: sessions.axiosSystem.data,
-        });
-      }
+      // Check if the parsing function is parsing data incorrectly.
+      await this.newInformationDispatcher('debug-parser', {
+        method: 'getSensorsInformation',
+        response: parsedSensorsTable,
+        rawHtml: sessions.axiosSystem.data,
+      });
 
       if (this.#internal.debug) {
         debugLog(this.#internal.logger, 'api.ts / ADTPulse.getSensorsInformation()', 'success', `Successfully retrieved sensors information from "${this.#internal.baseUrl}"`);
@@ -2260,19 +2210,12 @@ export class ADTPulse {
        */
       await this.newInformationDispatcher('sensors-status', parsedOrbSensors);
 
-      // If the parsing function may be parsing data incorrectly.
-      if (parsedOrbSensors.length < 1) {
-        if (this.#internal.debug) {
-          debugLog(this.#internal.logger, 'api.ts / ADTPulse.getSensorsStatus()', 'warn', 'The parseOrbSensors() function may be parsing the orb sensors incorrectly');
-        }
-
-        await this.newInformationDispatcher('debug-parser', {
-          parserName: 'parseOrbSensors()',
-          parserReason: 'length is not 1 or more',
-          parserResponse: parsedOrbSensors,
-          rawData: sessions.axiosSummary.data,
-        });
-      }
+      // Check if the parsing function is parsing data incorrectly.
+      await this.newInformationDispatcher('debug-parser', {
+        method: 'getSensorsStatus',
+        response: parsedOrbSensors,
+        rawHtml: sessions.axiosSummary.data,
+      });
 
       if (this.#internal.debug) {
         debugLog(this.#internal.logger, 'api.ts / ADTPulse.getSensorsStatus()', 'success', `Successfully retrieved sensors status from "${this.#internal.baseUrl}"`);
@@ -2987,19 +2930,12 @@ export class ADTPulse {
        */
       await this.newInformationDispatcher('orb-security-buttons', parsedOrbSecurityButtons);
 
-      // If the parsing function may be parsing data incorrectly.
-      if (parsedOrbSecurityButtons.length < 1 || parsedOrbSecurityButtons.length > 3) {
-        if (this.#internal.debug) {
-          debugLog(this.#internal.logger, 'api.ts / ADTPulse.armDisarmHandler()', 'warn', 'The parseOrbSecurityButtons() function may be parsing the orb security buttons incorrectly');
-        }
-
-        await this.newInformationDispatcher('debug-parser', {
-          parserName: 'parseOrbSecurityButtons()',
-          parserReason: 'length is not between 1 to 3',
-          parserResponse: parsedOrbSecurityButtons,
-          rawData: sessions.axiosSummary.data,
-        });
-      }
+      // Check if the parsing function is parsing data incorrectly.
+      await this.newInformationDispatcher('debug-parser', {
+        method: 'armDisarmHandler',
+        response: parsedOrbSecurityButtons,
+        rawHtml: sessions.axiosSummary.data,
+      });
 
       let readyButtons = parsedOrbSecurityButtons.filter((parsedOrbSecurityButton): parsedOrbSecurityButton is ADTPulseArmDisarmHandlerReadyButton => !parsedOrbSecurityButton.buttonDisabled);
 
@@ -3163,22 +3099,12 @@ export class ADTPulse {
        */
       await this.newInformationDispatcher('do-submit-handlers', parsedDoSubmitHandlers);
 
-      // If the parsing function may be parsing data incorrectly.
-      if (
-        parsedDoSubmitHandlers.length !== 0 // No force arming required.
-        && parsedDoSubmitHandlers.length !== 2 // Force arming required.
-      ) {
-        if (this.#internal.debug) {
-          debugLog(this.#internal.logger, 'api.ts / ADTPulse.armDisarmHandler()', 'warn', 'The parseDoSubmitHandlers() function may be parsing the do submit handlers incorrectly');
-        }
-
-        await this.newInformationDispatcher('debug-parser', {
-          parserName: 'parseDoSubmitHandlers()',
-          parserReason: 'length does not match 0 and 2',
-          parserResponse: parsedDoSubmitHandlers,
-          rawData: response.data,
-        });
-      }
+      // Check if the parsing function is parsing data incorrectly.
+      await this.newInformationDispatcher('debug-parser', {
+        method: 'forceArmHandler',
+        response: parsedDoSubmitHandlers,
+        rawHtml: response.data,
+      });
 
       // Check if there are no force arm buttons available.
       if (
@@ -3436,7 +3362,7 @@ export class ADTPulse {
    * @since 1.0.0
    */
   private async newInformationDispatcher(type: ADTPulseNewInformationDispatcherType, data: ADTPulseNewInformationDispatcherData<ADTPulseNewInformationDispatcherType>): ADTPulseNewInformationDispatcherReturns {
-    const dataHash = generateHash(`${type}: ${JSON.stringify(data)}`);
+    const dataHash = generateHash(data);
 
     // If the detector has not reported this event before.
     if (this.#internal.reportedHashes.find((reportedHash) => dataHash === reportedHash) === undefined) {