Giter VIP home page Giter VIP logo

homebridge-risco-alarm's Introduction

About

This is plugin that integrate Homebridge with Risco Cloud Alarm Security System. Integration works only when proper Ethernet module is added to your Risco Unit and you are able to arm & disarm your system via https://www.riscocloud.com/ELAS/WebUI.

For now there are only 2 working states (ARM / DISARM), where ARM is common for all HomeKit states (AWAY, NIGHT, AT HOME). If more than 0 Partitions (Zones) are armed, Plugin reports that as system is ARMED. HomeKit looks globally, cannot distinguish difference between multiple Zones armed / disarmed.

When Polling option is enabled, Alarm state is refreshed in background, that means when you open HomeApp - there is no delay to display RiscoAlarm status. It's retreived from cached value.

Installation

  1. Install homebridge using: npm install -g homebridge
  2. Install this plugin using: npm install -g homebridge-risco-alarm
  3. Update your configuration file. See sample config.json snippet below.

Configuration

Configuration sample:

   "accessories": [
       {
           "accessory": "RiscoAlarm",
           "name": "RiscoAlarm",
           "debuglogging": 0,
           "polling": true,
           "pollInterval": 15000,
           "riscoUsername": "",
           "riscoPassword": "",
           "riscoSiteId": 12345,
           "riscoPIN": "",
           "armCommand": "armed",
           "partialCommand": "partially",
           "homeCommand": "partially"
           "disarmCommand": "disarmed",
           "riscoPartMode": false,
           "riscoPartId": 0            
       }
   ]

Fields:

  • "accessory": Must always be "RiscoAlarm" (required)
  • "name": Can be anything (used in logs)
  • "debuglogging" , 0: levels as follows 0 = state logging, 1 = some debug logging, 2 = all debug logging
  • "riscoUsername" , "riscoPassword": UserName and Password for you Web interface to RiscoCloud
  • "riscoSiteId": This is your siteId to login.
  • "riscoPIN": PIN Code used for arm/disarm
  • "polling": optionally poll for latest RiscoCloud status
  • "pollInterval": time in ms for polling
  • "armCommand": partitions that should be armed
  • "partialCommand": partitions that should be partially armed
  • "homeCommand": partitions that should be partially armed
  • "disarmCommand": partitions that should be disarmed
  • "riscoPartMode": false by default. Set to true if you want to manage one or more partitions independently.
  • "riscoPartId": 0 by default. Used when riscoPartMode is active. (0 => 1st Zone/Partition, 1 => 2nd Zone/Partition,...)

To get your riscoSiteId, login to riscocloud via ChromeBrowser (first login screen), and before providing your PIN (second login page), display source of the page and find string: <div class="site-name" ... it will look like:

<div class="site-name" id="site_12345_div">

In that case "12345" is your siteId which should be placed in new config file.

When set partitions for arm/disarm please use below schema (when "riscoPartMode" is set to false): For all partitions actions use default "armed" and "disarmed" , for single partition use "1:armed" and "1:disarmed"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.