Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bryan-bartow/homebridge-alarm.com
Alarm.com plugin for Homebridge
https://github.com/bryan-bartow/homebridge-alarm.com
alarm alarmdotcom home-automation homebridge homebridge-alarm homebridge-plugin homekit lights locks
Last synced: 2 months ago
JSON representation
Alarm.com plugin for Homebridge
- Host: GitHub
- URL: https://github.com/bryan-bartow/homebridge-alarm.com
- Owner: bryan-bartow
- License: isc
- Created: 2015-12-14T14:00:42.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-28T02:07:07.000Z (almost 7 years ago)
- Last Synced: 2024-10-03T00:24:43.241Z (4 months ago)
- Topics: alarm, alarmdotcom, home-automation, homebridge, homebridge-alarm, homebridge-plugin, homekit, lights, locks
- Language: JavaScript
- Size: 81.1 KB
- Stars: 43
- Watchers: 19
- Forks: 11
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# homebridge-alarm.com
Alarm.com plugin for [Homebridge](https://github.com/nfarina/homebridge)
# Installation
1. Install homebridge: `npm install -g homebridge`
2. Install this plugin: `npm install -g homebridge-alarmdotcom`
3. Sign up for [WrapAPI](https://www.wrapapi.com)
4. Bookmark each API [documented below](#wrapapi-calls) so you can call them with your server API key
5. Update your configuration file [(see example snippet below)](#configuration)
# WrapAPI Calls
Bookmark each of the following calls on [WrapAPI](https://www.wrapapi.com). Once you do this and generate a server API key you can use to call the API.
* [initlogin](https://wrapapi.com/api/bryanbartow/alarmdotcom/initlogin/latest)
* [login](https://wrapapi.com/api/jdshkolnik/alarmdotcom/login/latest)
* [getviewstate](https://wrapapi.com/api/bryanbartow/alarmdotcom/getviewstate/latest)
* [disarm](https://wrapapi.com/api/bryanbartow/alarmdotcom/disarm/latest)
* [armstay](https://wrapapi.com/api/bryanbartow/alarmdotcom/armstay/latest)
* [armaway](https://wrapapi.com/api/bryanbartow/alarmdotcom/armaway/latest)
* [locks](https://wrapapi.com/api/andrewmattie/alarmdotcom/locks/latest)
* [lock](https://wrapapi.com/api/yungsters/alarmdotcom/lock/latest)
* [unlock](https://wrapapi.com/api/yungsters/alarmdotcom/unlock/latest)
* [lights](https://wrapapi.com/api/rcaslis/alarmdotcom/lights/latest)
* [lighton](https://wrapapi.com/api/rcaslis/alarmdotcom/lighton/latest)
* [lightoff](https://wrapapi.com/api/rcaslis/alarmdotcom/lightoff/latest)
# Configuration
sample-config.json:
```json
{
"platforms": [
{
"platform": "Alarmdotcom",
"name": "Security Panel",
"username": "[email protected]",
"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](http://www.wrapapi.com) Server API key for the alarmdotcom API (required)
* "apiUsername": [WrapAPI.com](http://www.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.