homebridge-alarmdotcom

Alarm.com plugin for homebridge: https://github.com/nfarina/homebridge


Keywords
homebridge-plugin, alarm.com, alarm, alarmdotcom, home-automation, homebridge, homebridge-alarm, homekit, lights, locks
License
ISC
Install
npm install homebridge-alarmdotcom@0.7.2

Documentation

homebridge-alarm.com

Alarm.com plugin for Homebridge

Installation

  1. Install homebridge: npm install -g homebridge
  2. Install this plugin: npm install -g homebridge-alarmdotcom
  3. Sign up for WrapAPI
  4. Bookmark each API documented below so you can call them with your server API key
  5. Update your configuration file (see example snippet below)

WrapAPI Calls

Bookmark each of the following calls on WrapAPI. Once you do this and generate a server API key you can use to call the API.

Configuration

sample-config.json:

{
  "platforms": [
    {
      "platform": "Alarmdotcom",
      "name": "Security Panel",
      "username": "test@example.com",
      "password": "testpassword",
      "apiKey": "wrapapikeygoeshere",
      "apiUsername": "wrapapiusername",
      "accessories": {
        "panel": true,
        "lights": false,
        "locks": true
      }
    }
  ]
}

Fields:

  • "platform": Must always be "Alarmdotcom" (required)
  • "name": Can be anything (required)
  • "username": Alarm.com login username, same as app (required)
  • "password": Alarm.com login password, same as app (required)
  • "apiKey": WrapAPI.com Server API key for the alarmdotcom API (required)
  • "apiUsername": WrapAPI.com username
  • "accessories": Object containing a key for each supported accessory device type, whose boolean value determines whether or not the plugin will (attempt to) use the accessory

Alarm.com Nag Screens

This plugin depends on the status screen being shown immediately after login but, occasionally, users will be nagged by a variety of screens after logging into alarm.com asking them to confirm email addresses, etc. before they are shown their system status screen. If you're getting errors, the first thing you should try is manually logging into alarm.com on your browser and dismiss / handle any tasks you're presented before the status page. The plugin will most likely work once this is finished.