alarm-dot-com

A Rust library for interfacing with Alarm.com security panels.

This library reverse-engineers the Alarm.com web portal's AJAX API to provide programmatic access to your alarm panel, sensors, locks, garage doors, lights, and thermostats.

Note: ADT Control uses Alarm.com as its backend platform, so this library is fully compatible with ADT Control systems.

Disclaimer: This is an unofficial library, not affiliated with Alarm.com or ADT. The underlying API is undocumented and may change without notice.

Features

• Partitions -- arm stay, arm away, arm night, disarm, clear faults
• Sensors -- door/window, motion, glass break, smoke, CO, flood, temperature
• Locks -- lock, unlock, state monitoring
• Garage doors -- open, close, state monitoring
• Lights -- on, off, brightness control for dimmers
• Thermostats -- mode, heat/cool setpoints, ambient temperature and humidity
• Session management -- automatic retry on transient failures, re-login on expired sessions

Prerequisites

This library requires a trusted device cookie to bypass Alarm.com's two-factor authentication. Follow these steps to obtain it:

1. Go to www.alarm.com and log in with your credentials
2. Complete the 2FA challenge when prompted (you may be asked to name the device — this can be anything)
3. Open your browser's developer tools:
   • Chrome / Edge: right-click the page → Inspect → Application tab → Cookies → https://www.alarm.com
   • Firefox: right-click → Inspect → Storage tab → Cookies → https://www.alarm.com
   • Safari: Develop menu → Show Web Inspector → Storage tab → Cookies
4. Find the cookie named twoFactorAuthenticationId — its value is a 64-character alphanumeric string
5. Copy that value and set it as your ALARM_MFA_COOKIE environment variable

Quick Start

Add to your Cargo.toml:

[dependencies]
alarm-dot-com = "0.1"
tokio = { version = "1", features = ["full"] }

use alarm_dot_com::AlarmDotCom;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut alarm = AlarmDotCom::new("user@example.com", "password");
    alarm.set_trusted_device_cookie("your-mfa-cookie-value");

    alarm.login().await?;

    let status = alarm.fetch_status().await?;
    println!("System: {}", status.system.name);

    for p in &status.partitions {
        println!("  Partition {}: {}", p.name, p.state);
    }
    for s in &status.sensors {
        println!("  Sensor {} ({}): {}", s.name, s.sensor_type, s.state);
    }

    // Arm in stay mode
    if let Some(partition) = status.partitions.first() {
        alarm.arm_stay(&partition.id, &[]).await?;
    }

    Ok(())
}

CLI Examples

Set your credentials as environment variables, then run the examples:

export ALARM_USERNAME="you@email.com"
export ALARM_PASSWORD="your-password"
export ALARM_MFA_COOKIE="your-twoFactorAuthenticationId-cookie"

Get system status

cargo run --example status

Prints all partitions, sensors, locks, garage doors, lights, and thermostats with their current states.

Arm/disarm

# Arm stay
cargo run --example arm -- stay

# Arm away
cargo run --example arm -- away

# Arm night
cargo run --example arm -- night

# Disarm
cargo run --example arm -- disarm

# Arm stay, bypassing open sensors
cargo run --example arm -- stay-bypass

# Target a specific partition
cargo run --example arm -- stay PARTITION_ID

API Overview

AlarmDotCom

The main entry point. Created with credentials, then login() to authenticate.

Arming Options

Pass to arm_stay, arm_away, or arm_night:

use alarm_dot_com::models::partition::ArmingOption;

alarm.arm_away(&id, &[
    ArmingOption::BypassSensors,
    ArmingOption::SilentArming,
]).await?;

Error Handling

All operations return Result<T, AlarmError>. Key variants:

Project Structure

src/
  lib.rs              High-level AlarmDotCom API
  auth.rs             Login flow, ViewState parsing
  client.rs           HTTP client, cookie jar, retry logic
  error.rs            Error types
  models/
    jsonapi.rs        JSON:API response deserialization
    device.rs         Shared traits and ResourceType enum
    partition.rs      Alarm panel state and commands
    sensor.rs         Sensor types and state
    lock.rs           Lock state and commands
    garage_door.rs    Garage door state and commands
    light.rs          Light state and commands
    thermostat.rs     Thermostat state and commands
    system.rs         System-level info
  controllers/
    partitions.rs     Partition fetch/command operations
    sensors.rs        Sensor fetch operations
    locks.rs          Lock fetch/command operations
    garage_doors.rs   Garage door fetch/command operations
    lights.rs         Light fetch/command operations
    thermostats.rs    Thermostat fetch/command operations
    systems.rs        System discovery and fetch
examples/
  status.rs           Print full system status
  arm.rs              Arm/disarm via CLI

License

MIT