Config Schema

Reference every platform config field, its type, defaults, and accepted values as defined by the plugin schema.

Platform Block

Every setting lives inside a single platform object under the top-level platforms array in your Homebridge config.json. The platform value identifies the plugin and must be exactly ADTPulse.

The table below lists the fields the platform accepts, in schema order.

Name

The name field is a free-form string used mainly for identification, such as in Homebridge logs.

Subdomain

The subdomain field selects the ADT Pulse portal region tied to your account.

The ability to switch regions is determined by the ADT region you are subscribed to. See Portal Region for more detail.

Username and Password

The username and password fields hold the credentials you use to log in to the portal.

Fingerprint

The fingerprint field holds the device fingerprint that ADT Pulse requires during login once two-factor authentication is enabled.

Starting from v3.4.0, the fingerprint is created by the built-in Homebridge setup wizard. Re-run the wizard and save its configuration to replace an old value.

See Device Fingerprint for the full walkthrough.

Mode

The mode field controls how the plugin runs.

Debug mode is enabled only when Homebridge debug mode is on; there is no separate setting for it.

See Operational Mode for the full behavior of each mode.

Speed

The speed field adjusts the interval at which the plugin fires sync check and keep-alive signals, which can ease network load and CPU usage on older hardware.

Any value other than 1 may result in slower device updates and produces a startup warning that cannot be disabled. See Synchronization Speed for guidance on when to slow it down.

Options

The options field is an array of feature toggles that deactivate specific plugin behaviors. Leave it empty ([]) to keep all functionality enabled.

A non-empty options array produces a startup warning that cannot be disabled. See Advanced Options for the caveats of each toggle.

Sensors

The sensors field is an array of objects, one per sensor you want to expose to HomeKit. Each sensor is read-only, and you must declare every sensor explicitly.

The maximum of 147 accounts for 3 reserved slots (the gateway, security panel, and alarm ringing switch). Z-Wave accessories are not supported.

Sensor Fields

Each object in the sensors array accepts the following fields.

Field constraints:

• name can be omitted or left blank to use an ADT-derived display name. A custom name accepts 2 to 50 characters, must start and end with a letter or number, and cannot contain emojis or unsupported symbols.
• adtName accepts 1 to 100 characters.
• adtZone accepts a number from 1 to 99.

Sensor Types

The adtType field must match one of the supported sensor types below.

See Sensors and Zones for how to find these values, and Supported Devices for what each type maps to in HomeKit.

Full Example

This example shows a complete platform block with a single door/window sensor.

{
  "platforms": [
    {
      "platform": "ADTPulse",
      "name": "ADT Pulse",
      "subdomain": "portal",
      "username": "user@example.com",
      "password": "Mys7r0nG!P@ssw0rd",
      "fingerprint": "VGhpc0lzQVNlY3VyZVBhc3N3b3JkMTIzIQ==",
      "mode": "normal",
      "speed": 1,
      "options": [],
      "sensors": [
        {
          "name": "Family Room Couch Window 1",
          "adtName": "Family Room Window (99)",
          "adtZone": 99,
          "adtType": "doorWindow"
        }
      ]
    }
  ]
}

For a task-oriented walkthrough of these fields, see Configuration.