search

rsnodgrass / pyadtpulse

Python interface for ADT Pulse security systems
Other
15 stars 5 forks source link

readme

pyadtpulse - Python interface for ADT Pulse

Python client interface to the ADT Pulse security system.

PyPi License Donate

UNSUPPORTED

This is an unsupported interface provided only as a basis for others to explore integrating their ADT system wtih their own tools. PLEASE FEEL FREE TO CONTRIBUTE CHANGES! Pull requests are accepted.

While two or three Python clients to ADT Pulse existed, they generally only provided arm/disarm support and none provided support for ADT Pulse when multiple sites existed under a single account. This attempts to provide APIs to both all the zones (motion sensors, door sensors, etc) as well as arming and disarming individual sites.

NOTE: Since this interacts with the unofficial ADT Pulse AJAX web service, the behavior is subject to change by ADT without notice.

Developer Note

NOTE: This package use pre-commit hooks for maintaining code quality. Please install pre-commit and enable it for your local git copy before committing.

WARNING

Do not reauthenticate to the ADT service frequently as ADT's service is not designed for high volume requests. E.g. every 5 minutes, not seconds. Keep your authenticated session to avoid logging in repeatedly.

Installation

pip3 install pyadtpulse

Usage

Since ADT Pulse automatically logs out other sessions accessing the same account, a best practice is to create a new username/password combination for each client accessing ADT Pulse.

Additionally, since pyadtpulse currently does not support multiple sites (premises/locations), a simple approach is to create a separate username/password for each site and configured such that the username only has access to ONE site. This ensures that clients are always interacting with that one site (and not accidentally with another site location).

Notes

Examples

adt = PyADTPulse(username, password, fingerprint)

for site in adt.sites:
    site.status
    site.zones

    site.disarm()
    site.arm_away()
    site.arm_away(force=True)

Async version (preferred for new integrations):

adt = PyADTPulse(username, password, fingerprint, do_login=false)

await adt.async_login()

for site in adt.sites:
    site.status
    site.zones

    await site.async_disarm()
    await site.async_arm_away()
    await site.async_arm_away(force=True)

The pyadtpulse object runs background tasks and refreshes its data automatically.

Certain parameters can be set to control how often certain actions are run.

Namely:

adt.poll_interval = 0.75  # check for updates every 0.75 seconds
adt.relogin_interval = 60 # relogin every 60 minutes
adt.keepalive_interval = 10 # run keepalive (prevent logout) every 10 minutes

See example-client.py for a working example.

Browser Fingerprinting

ADT Pulse requires 2 factor authentication to log into their site. When you perform the 2 factor authentication, you will see an option to save the browser to not have to re-authenticate through it.

Internally, ADT uses some Javascript code to create a browser fingerprint. This (very long) string is used to check that the browser has been saved upon subsequent logins. It is the "fingerprint" parameter required to be passed in to the PyADTPulse object constructor.

Notes:

The browser fingerprint will change with a browser/OS upgrade. While it is not strictly necessary to create a separate username/password for logging in through pyadtpulse, it is recommended to do so.

Warning: If another connection is made to the Pulse portal with the same fingerprint, the first connection will be logged out. For this reason it is recommended to use a browser/machine you would not normally use to log into the Pulse web site to generate the fingerprint.

There are 2 ways to determine this fingerprint:

  1. Visit this link using the same browser you used to authenticate with ADT Pulse. This should determine the correct browser fingerprint

  2. Follow the instructions here

See Also

Future Enhancements

Feature ideas:

Feature ideas, but no plans to implement: