Skip to content

Commit

Permalink
Reverses fix to dot in the manufacture name. Alters plugin name, upda…
Browse files Browse the repository at this point in the history
…tes readme and title for package. Adds troubleshooting tips in readme for installing.
  • Loading branch information
mkormendy committed Sep 3, 2018
1 parent 506e31b commit 3275421
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 11 deletions.
17 changes: 11 additions & 6 deletions README.md
@@ -1,15 +1,14 @@
# HomeBridge Alarm.com Plugin
# Alarm.com plugin for Homebridge using Node.js

Alarm.com plugin for [Homebridge](https://github.com/nfarina/homebridge) using the [node-alarm-dot-com](https://github.com/mkormendy/node-alarm-dot-com) interface.

Based purely off of John Hurliman's FrontPoint* plugin for Homebridge<small>[](https://github.com/jhurliman/homebridge-frontpoint)</small> with modifications to the namespace and branding as Alarm.com instead.
Forked from John Hurliman's FrontPoint* plugin for Homebridge<small>[](https://github.com/jhurliman/homebridge-frontpoint)</small> to replace the branding and code namespace from FrontPoint to Alarm.com.

> **NOTE:** Because this uses Node.js-based HTTP requests to communicate with Alarm.com directly, this plugin does not require any additional accounts with access to external proxy APIs (e.g., WrapAPI). 🎉
> **NOTE:** Because this implementation uses Node.js-based HTTP requests to communicate with Alarm.com directly, this plugin does not require accounts or access with WrapAPI. 🎉
<small>*FrontPoint is simply a rebranded service provider for Alarm.com, but FrontPoint is not needed for this plugin to work.</small>

Supported Features
------------------
# Supported Features

* Querying panels
* Arming
Expand Down Expand Up @@ -67,4 +66,10 @@ Supported Features
* "name": Can be anything (required)
* "username": Alarm.com login username, same as app (required)
* "password": Alarm.com login password, same as app (required)
* "armingModes": Object of objects with arming mode options of boolean choices
* "armingModes": Object of objects with arming mode options of boolean choices

# Troubleshooting

If you are replacing the Bryan Bartow's Homebridge plugin with this implementation, you may be required to delete the `~/.homebridge/accessories/cachedAccessories` file for the new platform to show up with the new panel, accessories and devices.

**WARNING:** If you delete the contents of the `~/.homebridge/persist` folder, your Homebridge and devices will become unresponsive and you will have to entirely re-pair the Homebridge bridge (remove and re-scan the QR-code for Homebridge and set up all of your accessories/devices again).
4 changes: 2 additions & 2 deletions index.js
@@ -1,8 +1,8 @@
const nodeADC = require('node-alarm-dot-com')

const PLUGIN_ID = 'homebridge-node-alarm-dot-com'
const PLUGIN_NAME = 'Alarm-dot-com'
const MANUFACTURER = 'Alarmdotcom'
const PLUGIN_NAME = 'Alarmdotcom'
const MANUFACTURER = 'Alarm.com'
const AUTH_TIMEOUT_MS = 1000 * 60 * 10
const DEFAULT_REFRESH_S = 60

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
@@ -1,7 +1,7 @@
{
"name": "homebridge-node-alarm-dot-com",
"version": "1.1.2",
"description": "Homebridge plugin for operating Alarm.com alarm systems (Node.js-only authentication).",
"description": "Alarm.com plugin for Homebridge using Node.js",
"author": {
"name": "Mike Kormendy",
"email": "mike@somethinginteractive.com"
Expand Down

0 comments on commit 3275421

Please sign in to comment.