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.
{
"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.
| Field | Type | Description |
|---|---|---|
platform | string | Plugin identifier. Must be "ADTPulse". |
name | string | Display name used in Homebridge logs. 1 to 50 characters. |
subdomain | string | Portal region. One of "portal" or "portal-ca". |
username | string | The username you use to log in to the portal. 1 to 100 characters. |
password | string | The password you use to log in to the portal. 1 to 300 characters. |
fingerprint | string | Device fingerprint required for two-factor authentication. 1 to 10240 characters. |
mode | string | Operational mode. One of "normal", "paused", or "reset". |
speed | number | Synchronization speed. One of 1, 0.75, 0.5, or 0.25. |
options | string[] | Advanced options that disable specific features. Defaults to an empty array. |
sensors | object[] | 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.
mode— Switches between normal operation, a paused state, and a reset that removes accessories. See Operational Mode.speed— Adjusts how often the plugin polls the portal, which helps on older hardware or slower routers. See Synchronization Speed.options— Disables specific features such as the alarm ringing switch. See Advanced Options.
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.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Display name for the sensor. Up to 50 characters. Helps identify the sensor after a reset. |
adtName | string | Yes | The exact name shown in the portal's "System" tab. 1 to 100 characters. |
adtZone | number | Yes | The exact zone shown in the portal's "System" tab. Supported zones are 1 through 99. |
adtType | string | Yes | The sensor type. Must match one of the supported device types listed below. |
The adtType value must be one of the supported sensor types:
| Value | Sensor Type |
|---|---|
co | Carbon Monoxide Detector |
doorWindow | Door/Window Sensor, Door Sensor, or Window Sensor |
fire | Fire (Smoke/Heat) Detector |
flood | Water/Flood Sensor |
glass | Glass Break Detector |
heat | Heat (Rate-of-Rise) Detector |
motion | Motion Sensor, or Motion Sensor (Notable Events Only) |
shock | Shock Sensor |
temperature | Temperature 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
Next Steps
- Configuration Schema — Field-by-field reference with every constraint and enum value.
- Operational Mode — Understand normal, paused, and reset behavior before changing
mode. - Sensors and Zones — Match each sensor's name, zone, and type from the portal.