Skip to main content

Configuration

Configure the ADT Pulse platform block in config.json with your credentials and device settings.

Sample Configuration

The plugin reads a single platform block from your Homebridge config.json. Place it inside the platforms array alongside any other Homebridge platforms.

config.json
json
{
  "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"
        }
      ]
    }
  ]
}

Customize the values above to match your own setup. If you prefer a guided experience, the Homebridge Config UI exposes the same fields under the "Plugins" tab.

Platform Fields

Every field in the platform block is required except where noted. The platform value must be exactly ADTPulse so Homebridge can match the plugin.

FieldTypeDescription
platformstringPlugin identifier. Must be "ADTPulse".
namestringDisplay name used in Homebridge logs. 1 to 50 characters.
subdomainstringPortal region. One of "portal" or "portal-ca".
usernamestringThe username you use to log in to the portal. 1 to 100 characters.
passwordstringThe password you use to log in to the portal. 1 to 300 characters.
fingerprintstringDevice fingerprint required for two-factor authentication. 1 to 10240 characters.
modestringOperational mode. One of "normal", "paused", or "reset".
speednumberSynchronization speed. One of 1, 0.75, 0.5, or 0.25.
optionsstring[]Advanced options that disable specific features. Defaults to an empty array.
sensorsobject[]Sensors to expose in the Home app. Each entry describes one sensor. Defaults to an empty array.

tip

Search for adt-pulse in the Homebridge Config UI to configure these fields through a form instead of editing config.json by hand.

Credentials

The username and password values are the same credentials you use to sign in to the ADT Pulse Web Portal.

  • subdomain — Selects the United States (portal) or Canada (portal-ca) portal. See Portal Region for how to choose.
  • fingerprint — Required since ADT introduced two-factor authentication. See Device Fingerprint for how the setup wizard creates it.

Behavior Settings

Three fields control how the plugin runs day to day. Each has a dedicated page with the full list of choices and their tradeoffs.

warning

Running with a non-normal mode, a reduced speed, or a non-empty options array triggers a startup warning that cannot be disabled.

Sensors

Each object in the sensors array describes one sensor you want to expose in the Home app. You must specify each sensor explicitly; the plugin no longer auto-detects them.

FieldTypeRequiredDescription
namestringNoDisplay name for the sensor. Up to 50 characters. Helps identify the sensor after a reset.
adtNamestringYesThe exact name shown in the portal's "System" tab. 1 to 100 characters.
adtZonenumberYesThe exact zone shown in the portal's "System" tab. Supported zones are 1 through 99.
adtTypestringYesThe sensor type. Must match one of the supported device types listed below.

The adtType value must be one of the supported sensor types:

ValueSensor Type
coCarbon Monoxide Detector
doorWindowDoor/Window Sensor, Door Sensor, or Window Sensor
fireFire (Smoke/Heat) Detector
floodWater/Flood Sensor
glassGlass Break Detector
heatHeat (Rate-of-Rise) Detector
motionMotion Sensor, or Motion Sensor (Notable Events Only)
shockShock Sensor
temperatureTemperature Sensor

For a walkthrough of matching the name, zone, and type from the portal, see Sensors and Zones. For the full list of exposed accessories, see Supported Devices.

info

Leave sensors as an empty array ([]) if you do not want to add any sensors. Including your supported sensors is recommended, since having none does not optimize plugin performance.

Next Steps