node-alarm-dot-com / homebridge-node-alarm-dot-com Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jhurliman/homebridge-frontpoint

58.0 58.0 23.0 1.14 MB

Alarm.com plugin for Homebridge using Node.js

License: MIT License

TypeScript 100.00%

alarmdotcom homebridge homebridge-plugin homekit plugin

homebridge-node-alarm-dot-com's Introduction

Node.js Alarm.com Interface

Unofficial interface module written in Node.js to access and operate Alarm.com security systems.

This interface works best with the fork: https://github.com/node-alarm-dot-com/homebridge-node-alarm-dot-com, based off of John Hurliman's FrontPoint* plugin for Homebridge↗. This variation ~~adds~~ changes the default login authentication ~~for~~ to Alarm.com. ~~with a switch to use the FrontPoint login authentication process if desired.~~

*FrontPoint is simply a rebranded service provider for Alarm.com.

Originally intended for use with the fork: https://github.com/node-alarm-dot-com/homebridge-node-alarm-dot-com, originally created by Bryan Bartow for his Alarm.com plugin for Homebridge↗.

Supported Features

Querying panels
- Arming
- Disarming
Sensors
- Contact states
- ~~Occupancy states~~ (this does not work due to lag in the Alarm.com webAPI itself)
- Water Leak states
Lights
- On/Off switch
- Dimmer switch
Locks
- Lock/Unlock switch
Thermostats
- State (Off, Heat, Cool, Auto)
- Desired Heat setpoint
- Desired Cool setpoint

Usage

Install:

npm i node-alarm-dot-com

Querying:

const nodeADC = require('node-alarm-dot-com');

nodeADC
  .login('your_username', 'your_password')
  .then((authOpts) => nodeADC.getCurrentState(authOpts.systems[0], authOpts))
  .then((res) => {
    console.log('Security Systems:', res.partitions);
    console.log('Sensors:', res.sensors);
  })
  .catch((err) => console.error(err));

Arming:

const nodeADC = require('node-alarm-dot-com');

nodeADC
  .login('your_username', 'your_password')
  .then((authOpts) => {
    return nodeADC.getCurrentState(authOpts.systems[0], authOpts).then((res) => {
      // This will take 20-30 seconds
      nodeADC.armStay(res.partitions[0].id, authOpts).then((res) => {
        console.log(res);
      });
    });
  })
  .catch((err) => console.error(err));

Documentation

nodeADC
- ~login(username, password) ⇒ Promise
- ~getCurrentState(systemID, authOpts) ⇒ Promise
- ~getPartition(partitionID, authOpts) ⇒ Promise
- ~getSensors(sensorIDs, authOpts) ⇒ Promise
- ~getLights(lightIDs, authOpts) ⇒ Promise
- ~turnOnLight(lightID, brightness, authOpts) ⇒ Promise
- ~turnOffLight(lightID, brightness, authOpts) ⇒ Promise
- ~getLocks(lockIDs, authOpts) ⇒ Promise
- ~setLockSecure(lockID, authOpts) ⇒ Promise
- ~setLockUnsecure(lockID, authOpts) ⇒ Promise
- ~setThermostatState(thermostatID, newState, authOpts) ⇒ Promise
- ~setThermostatTargetHeatTemperature(thermostatID, newTemp, authOpts) ⇒ Promise
- ~setThermostatTargetCoolTemperature(thermostatID, newTemp, authOpts) ⇒ Promise
- ~armStay(partitionID, authOpts, opts) ⇒ Promise
- ~armAway(partitionID, authOpts, opts) ⇒ Promise
- ~disarm(partitionID, authOpts) ⇒ Promise

nodeADC~login(username, password) ⇒ `Promise`

Authenticate with alarm.com using the mobile webpage login form (loads faster than the desktop webpage login form). Returns an authentication object that can be passed to other methods.

Kind: inner method of module_nodeADC

Param	Type	Description
username	`string`	FrontPoint username.
password	`string`	FrontPoint password.

nodeADC~getCurrentState(systemID, authOpts) ⇒ `Promise`

Retrieve information about the current state of a security system including attributes, partitions, sensors, and relationships.