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

package/config.schema.json

@@ -1,237 +1,326 @@
 {
-    "pluginAlias": "ADTPulse",
-    "pluginType": "platform",
-    "singular": true,
-    "headerDisplay": "An account to link your [ADT Pulse](https://portal.adtpulse.com/) system to Homebridge is required. This will be used to control your security panel and read sensor status.",
-    "footerDisplay": "If you need assistance, you may read the [plugin instructions](https://github.com/mrjackyliang/homebridge-adt-pulse#readme) or feel free to [submit an issue](https://github.com/mrjackyliang/homebridge-adt-pulse/issues/new/choose).",
-    "schema": {
-        "type": "object",
-        "properties": {
+  "pluginAlias": "ADTPulse",
+  "pluginType": "platform",
+  "singular": true,
+  "headerDisplay": "Welcome to the configuration page for **[ADT Pulse for Homebridge](https://github.com/mrjackyliang/homebridge-adt-pulse)**! You will find customizable settings to tailor your experience here. Start by inputting your login credentials, and then specify the sensors you want to incorporate into this setup.",
+  "footerDisplay": "For further assistance, please consult the [readme](https://github.com/mrjackyliang/homebridge-adt-pulse#readme) file. Should you encounter any issues, such as crashes or unexpected results, please [create a new issue](https://github.com/mrjackyliang/homebridge-adt-pulse/issues/new/choose) on GitHub.",
+  "schema": {
+    "type": "object",
+    "properties": {
+      "name": {
+        "title": "Name",
+        "type": "string",
+        "required": true,
+        "description": "Enter a unique name for this plugin. The name will mainly be used for identification purposes, such as in Homebridge logs.",
+        "default": "ADT Pulse",
+        "placeholder": "ADT Pulse",
+        "minLength": 1,
+        "maxLength": 50
+      },
+      "subdomain": {
+        "title": "Portal Region",
+        "type": "string",
+        "required": true,
+        "description": "Select the portal region based on where you are subscribed in. For subscribers in Canada, choose \"Canada\" from the dropdown menu.",
+        "oneOf": [
+          {
+            "title": "United States \uD83C\uDDFA\uD83C\uDDF8 - portal.adtpulse.com</span>",
+            "enum": [
+              "portal"
+            ]
+          },
+          {
+            "title": "Canada \uD83C\uDDE8\uD83C\uDDE6 - portal-ca.adtpulse.com",
+            "enum": [
+              "portal-ca"
+            ]
+          }
+        ],
+        "default": "portal"
+      },
+      "username": {
+        "title": "Username",
+        "type": "string",
+        "required": true,
+        "description": "Provide the username you use to login to the portal.",
+        "placeholder": "e.g. user@example.com",
+        "minLength": 1,
+        "maxLength": 100
+      },
+      "password": {
+        "title": "Password",
+        "type": "string",
+        "required": true,
+        "description": "Provide the password you use to login to the portal.",
+        "placeholder": "e.g. Mys7r0nG!P@ssw0rd",
+        "minLength": 1,
+        "maxLength": 300
+      },
+      "fingerprint": {
+        "title": "Fingerprint",
+        "type": "string",
+        "required": true,
+        "description": "After logging in and selecting \"Trust this device\", paste in the device fingerprint generated through the <a href=\"https://raw.githack.com/mrjackyliang/homebridge-adt-pulse/main/fingerprint/index.html\" target=\"_blank\">ADT Pulse Device Fingerprint Detector</a>.",
+        "placeholder": "e.g. VGhpc0lzQVNlY3VyZVBhc3N3b3JkMTIzIQ==",
+        "minLength": 1,
+        "maxLength": 5120
+      },
+      "mode": {
+        "title": "Operational Mode",
+        "type": "string",
+        "required": true,
+        "description": "Choose the operational mode for the plugin. Debug mode is enabled only when Homebridge debug mode is on; there is no separate setting for this.",
+        "oneOf": [
+          {
+            "title": "Normal",
+            "enum": [
+              "normal"
+            ]
+          },
+          {
+            "title": "Paused",
+            "enum": [
+              "paused"
+            ]
+          },
+          {
+            "title": "Reset (danger)",
+            "enum": [
+              "reset"
+            ]
+          }
+        ],
+        "default": "normal"
+      },
+      "speed": {
+        "title": "Synchronization Speed",
+        "type": "number",
+        "required": true,
+        "description": "Choose the synchronization speed for the plugin. Designed to enhance the performance of devices with older hardware. May result in slower device updates.",
+        "oneOf": [
+          {
+            "title": "Normal Speed (1x)",
+            "enum": [
+              1
+            ]
+          },
+          {
+            "title": "Moderate Speed (0.75x)",
+            "enum": [
+              0.75
+            ]
+          },
+          {
+            "title": "Slower Speed (0.5x)",
+            "enum": [
+              0.5
+            ]
+          },
+          {
+            "title": "Slowest Speed (0.25x)",
+            "enum": [
+              0.25
+            ]
+          }
+        ],
+        "default": 1
+      },
+      "sensors": {
+        "title": "Sensors",
+        "type": "array",
+        "required": true,
+        "description": "Define your sensors here. Sensors include devices like \"Door/Window Sensor\" or \"Motion Sensor\". <strong class=\"font-weight-bold\">Please note that Z-Wave accessories are not supported.</strong> A maximum of 148 sensors can be added (the plugin reserves 2 accessories for the gateway and security panel).",
+        "items": {
+          "type": "object",
+          "properties": {
             "name": {
-                "title": "Name",
-                "type": "string",
-                "default": "ADT Pulse",
-                "required": true,
-                "description": "Plugin name as displayed in the Homebridge log"
+              "title": "Name",
+              "type": "string",
+              "required": false,
+              "description": "<strong class=\"font-weight-bold\">Optional.</strong> Provide a display name for this sensor to differentiate it from the names assigned by ADT technicians during installation.",
+              "placeholder": "e.g. Family Room Couch Window 1",
+              "minLength": 1,
+              "maxLength": 50
             },
-            "username": {
-                "title": "Username",
-                "type": "string",
-                "default": "",
-                "required": true,
-                "format": "email",
-                "minLength": 6,
-                "maxLength": 50,
-                "description": "Email address used for ADT Pulse login"
+            "adtName": {
+              "title": "ADT Sensor Name",
+              "type": "string",
+              "required": true,
+              "description": "Specify the <strong class=\"font-weight-bold\">exact name</strong> associated with the sensor you want to add. Double-check the names to ensure they don't include extra characters when copying and pasting.",
+              "placeholder": "e.g. Family Room Window (99)",
+              "minLength": 1,
+              "maxLength": 100
             },
-            "password": {
-                "title": "Password",
-                "type": "string",
-                "default": "",
-                "required": true,
-                "minLength": 8,
-                "maxLength": 50,
-                "description": "Password used for ADT Pulse login"
+            "adtType": {
+              "title": "ADT Sensor Type",
+              "type": "string",
+              "required": true,
+              "description": "Select the <strong class=\"font-weight-bold\">type</strong> associated with the sensor you want to add. Ensure your selection matches the sensor type, as selecting the wrong type may lead to incorrect status detection.",
+              "oneOf": [
+                {
+                  "title": "Carbon Monoxide Detector",
+                  "enum": [
+                    "co"
+                  ]
+                },
+                {
+                  "title": "Door/Window Sensor :: Door Sensor :: Window Sensor",
+                  "enum": [
+                    "doorWindow"
+                  ]
+                },
+                {
+                  "title": "Fire (Smoke/Heat) Detector",
+                  "enum": [
+                    "fire"
+                  ]
+                },
+                {
+                  "title": "Water/Flood Sensor",
+                  "enum": [
+                    "flood"
+                  ]
+                },
+                {
+                  "title": "Glass Break Detector",
+                  "enum": [
+                    "glass"
+                  ]
+                },
+                {
+                  "title": "Keypad/Touchpad",
+                  "enum": [
+                    "keypad"
+                  ]
+                },
+                {
+                  "title": "Motion Sensor :: Motion Sensor (Notable Events Only)",
+                  "enum": [
+                    "motion"
+                  ]
+                },
+                {
+                  "title": "Audible Panic Button/Pendant :: Silent Panic Button/Pendant",
+                  "enum": [
+                    "panic"
+                  ]
+                },
+                {
+                  "title": "Shock Sensor",
+                  "enum": [
+                    "shock"
+                  ]
+                },
+                {
+                  "title": "Temperature Sensor",
+                  "enum": [
+                    "temperature"
+                  ]
+                }
+              ]
             },
-            "fingerprint": {
-                "title": "MFA Fingerprint",
-                "type": "string",
-                "default": "",
-                "required": true,
-                "description": "MFA Fingerprint from browser registered with ADT Pulse"
+            "adtZone": {
+              "title": "ADT Sensor Zone",
+              "type": "number",
+              "required": true,
+              "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
+            }
+          }
+        },
+        "minItems": 0,
+        "maxItems": 148
+      }
+    }
+  },
+  "layout": [
+    {
+      "type": "tabs",
+      "tabs": [
+        {
+          "title": "General",
+          "htmlClass": "px-3 pt-3 pb-0",
+          "items": [
+            {
+              "key": "name",
+              "type": "text"
             },
-            "overrideSensors": {
-                "title": "Override Sensors",
-                "type": "array",
-                "items": {
-                    "type": "object",
-                    "properties": {
-                        "name": {
-                            "title": "Name",
-                            "type": "string",
-                            "default": "",
-                            "required": true,
-                            "description": "The sensor name for the sensor you would like to override"
-                        },
-                        "type": {
-                            "title": "Type",
-                            "type": "string",
-                            "default": "",
-                            "oneOf": [
-                                {
-                                    "title": "Door/Window Sensor",
-                                    "enum": [
-                                        "sensor,doorWindow"
-                                    ]
-                                },
-                                {
-                                    "title": "Glass Break Detector",
-                                    "enum": [
-                                        "sensor,glass"
-                                    ]
-                                },
-                                {
-                                    "title": "Motion Sensor",
-                                    "enum": [
-                                        "sensor,motion"
-                                    ]
-                                },
-                                {
-                                    "title": "Carbon Monoxide Detector",
-                                    "enum": [
-                                        "sensor,co"
-                                    ]
-                                },
-                                {
-                                    "title": "Fire (Smoke/Heat) Detector",
-                                    "enum": [
-                                        "sensor,fire"
-                                    ]
-                                }
-                            ],
-                            "required": true,
-                            "description": "The sensor type for the sensor you would like to override"
-                        }
-                    }
-                },
-                "description": "When a sensor cannot be detected accurately, you can manually set the sensor here to override the default detection features"
+            {
+              "key": "mode",
+              "type": "select"
             },
-            "country": {
-                "title": "Country",
-                "type": "string",
-                "default": "us",
-                "oneOf": [
-                    {
-                        "title": "United States",
-                        "enum": [
-                            "us"
-                        ]
-                    },
-                    {
-                        "title": "Canada",
-                        "enum": [
-                            "ca"
-                        ]
-                    }
-                ],
-                "required": false,
-                "description": "Select a country where ADT Pulse will connect to"
+            {
+              "key": "speed",
+              "type": "select"
+            }
+          ]
+        },
+        {
+          "title": "Login",
+          "htmlClass": "px-3 pt-3 pb-0",
+          "items": [
+            {
+              "key": "subdomain",
+              "type": "select"
             },
-            "logLevel": {
-                "title": "Log Level",
-                "type": "integer",
-                "default": 30,
-                "oneOf": [
-                    {
-                        "title": "Errors (Level 10)",
-                        "enum": [
-                            10
-                        ]
-                    },
+            {
+              "key": "username",
+              "type": "text"
+            },
+            {
+              "key": "password",
+              "type": "password"
+            },
+            {
+              "key": "fingerprint",
+              "type": "password"
+            },
+            {
+              "type": "help",
+              "helpvalue": "<div class=\"alert alert-primary\" role=\"alert\">If you wish, you can optionally view the \"Device Details\" tab to see what information the device fingerprint contains about your browser.</div>"
+            }
+          ]
+        },
+        {
+          "title": "Devices",
+          "htmlClass": "px-3 pt-3 pb-0",
+          "items": [
+            {
+              "key": "sensors",
+              "htmlClass": "p-10",
+              "buttonText": "Add Sensor",
+              "items": [
+                {
+                  "type": "div",
+                  "htmlClass": "my-3",
+                  "items": [
                     {
-                        "title": "Warnings (Level 20)",
-                        "enum": [
-                            20
-                        ]
+                      "key": "sensors[].name",
+                      "type": "text"
                     },
                     {
-                        "title": "Info (Level 30)",
-                        "enum": [
-                            30
-                        ]
+                      "key": "sensors[].adtName",
+                      "type": "text"
                     },
                     {
-                        "title": "Debug (Level 40)",
-                        "enum": [
-                            40
-                        ]
+                      "key": "sensors[].adtType",
+                      "type": "select"
                     },
                     {
-                        "title": "Verbose (Level 50)",
-                        "enum": [
-                            50
-                        ]
+                      "key": "sensors[].adtZone",
+                      "type": "number"
                     }
-                ],
-                "required": false,
-                "pattern": "^([1-5])([0])$",
-                "description": "Higher levels mean more logs will show. Turn on Homebridge Debug Mode for levels 40 and 50. Recommended setting is \"Info (Level 30)\""
-            },
-            "logActivity": {
-                "title": "Log Activity",
-                "type": "boolean",
-                "default": true,
-                "required": false
-            },
-            "removeObsoleteZones": {
-                "title": "Remove Obsolete Zones",
-                "type": "boolean",
-                "default": true,
-                "required": false
-            },
-            "pausePlugin": {
-                "title": "Pause Plugin",
-                "type": "boolean",
-                "default": false,
-                "required": false
-            },
-            "resetAll": {
-                "title": "Reset Plugin \uD83D\uDED1",
-                "type": "boolean",
-                "default": false,
-                "required": false
-            }
-        }
-    },
-    "layout": [
-        {
-            "key": "name"
-        },
-        {
-            "display": "flex",
-            "flex-flow": "row nowrap",
-            "justify-content": "space-between",
-            "items": [
-                {
-                    "key": "username",
-                    "flex": "1 0 0px"
-                },
-                {
-                    "key": "password",
-                    "flex": "1 0 0px"
+                  ]
                 }
-            ]
-        },
-        {
-            "key": "fingerprint"
-        },
-        {
-            "key": "overrideSensors",
-            "buttonText": "Add Sensor",
-            "items": [
-                "overrideSensors[].name",
-                "overrideSensors[].type"
-            ]
-        },
-        {
-            "key": "country"
-        },
-        {
-            "key": "logLevel"
-        },
-        {
-            "key": "logActivity"
-        },
-        {
-            "key": "removeObsoleteZones"
-        },
-        {
-            "key": "pausePlugin"
-        },
-        {
-            "key": "resetAll"
+              ]
+            }
+          ]
         }
-    ],
-    "form": null,
-    "display": null
+      ]
+    }
+  ],
+  "form": null,
+  "display": null
 }

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "homebridge-adt-pulse",
   "displayName": "Homebridge ADT Pulse",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.11",
   "description": "Homebridge security system platform for ADT Pulse",
+  "main": "./build/src/index.js",
   "exports": "./build/src/index.js",
   "type": "module",
   "private": false,
@@ -13,7 +14,8 @@
     "build:cleanup": "rimraf build",
     "build:tsc": "tsc --project tsconfig.json",
     "build:fix-paths": "tsconfig-replace-paths --project tsconfig.json",
-    "postinstall": "npm run build",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build",
     "repl": "node ./build/src/scripts/repl.js",
     "test-api": "node ./build/src/scripts/test-api.js"
   },
@@ -41,7 +43,7 @@
     "url": "https://github.com/mrjackyliang/homebridge-adt-pulse/issues"
   },
   "files": [
-    "./src",
+    "./build",
     "config.schema.json"
   ],
   "homepage": "https://github.com/mrjackyliang/homebridge-adt-pulse",
@@ -54,6 +56,7 @@
     "axios-cookiejar-support": "4.0.7",
     "chalk": "5.3.0",
     "jsdom": "23.0.1",
+    "latest-version": "7.0.0",
     "lodash": "4.17.21",
     "serialize-error": "11.0.3",
     "tough-cookie": "4.1.3",
@@ -62,14 +65,14 @@
   "devDependencies": {
     "@types/jsdom": "21.1.6",
     "@types/lodash": "4.14.202",
-    "@types/node": "20.10.4",
+    "@types/node": "20.10.5",
     "@types/tough-cookie": "4.0.5",
-    "@typescript-eslint/eslint-plugin": "6.13.2",
-    "@typescript-eslint/parser": "6.13.2",
-    "eslint": "8.55.0",
+    "@typescript-eslint/eslint-plugin": "6.15.0",
+    "@typescript-eslint/parser": "6.15.0",
+    "eslint": "8.56.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-config-airbnb-typescript": "17.1.0",
-    "eslint-plugin-import": "2.29.0",
+    "eslint-plugin-import": "2.29.1",
     "homebridge": "1.7.0",
     "npm-run-all": "4.1.5",
     "rimraf": "5.0.5",

package/src/index.ts

@@ -1,18 +0,0 @@
-import { ADTPulsePlatform } from '@/lib/platform.js';
-import type { InitializeApi, InitializeReturns } from '@/types/index.d.ts';
-
-/**
- * Initialize.
- *
- * @param {InitializeApi} api - Api.
- *
- * @returns {InitializeReturns}
- *
- * @since 1.0.0
- */
-function initialize(api: InitializeApi): InitializeReturns {
-  api.registerPlatform('ADTPulse', ADTPulsePlatform);
-}
-
-// Tell Homebridge this is the starting point.
-export default initialize;