Giter Site home page Giter Site logo

homebridge-elkm1's Introduction

homebridge-elkm1

Homebridge plugin for the Elk M1 alarm panel

homebridge-elkm1 lets you connect homebridge to an Elk Products M1 Alarm panel via an M1XEP Ethernet interface

Functionality

homebridge-elkm1 exposes the following functionality via HomeKit:

  • Arm/Disarm the alarm (Stay, Night and Away modes)
  • See the status of zones
  • Use zone status in HomeKit automation rules
  • Control M1 outputs
  • Activate M1 tasks

Most configuration items are discovered automatically, however you need to indicate zone types in the configuration file.

Installation

  1. Install homebridge - sudo npm install -g --unsafe-perm homebridge
  2. Install homebridge-elkm1 - sudo npm install -g --unsafe-perm homebridge-elkm1
  3. Update your configuration file. There is a sample file in this repository.

Note Your node.js must be version 6 or later in order for this plugin to work. If you get a syntax error on startup, you probably need to upgrade your Node.js

Configuration

homebridge-elkm1 exposes a platform to homebridge, so you need to add it to the platforms section of your config.json file.

 "platforms": [
        {
            "platform": "ElkM1",
            "name": "ElkM1",
            "elkAddress": "x.x.x.x",
            "elkPort": "2101",
            "area": "1",
            "keypadCode": "1234",
            "zoneTypes": {
                "1": "contact",
                "2": "garage",
                "3": "contact",
                "4": "contact",
                "5": "motion",
                "6": "motion",
                "7": "motion",
                "8": "motion",
                "9": "motion",
                "10": "motion",
                "16": "smoke"
            },
            "garageDoors":[
            {
                "stateZone":"2",
                "openOutput":"11",
                "closeOutput":"11",
                "name":"Garage door"
            }
            ]
        }
    ]
name description
elkAddress IP address or hostname of your Elk M1XEP ethernet interface
elkPort The insecure port for your M1XEP; 2101 is the default if you haven't changed it
area The area you want to control; typically 1
keypadCode A valid keypad code that homebridge-elkm1 can use to arm & disarm your area
zoneTypes A dictionary of zone numbers and their types. Valid types are: contact, motion, smoke or garage
garageDoors An array of garage door objects. Each garage door has a zone that shows the state of the door (This must be a garage zone type), a name, and two outputs; one that is pulsed to open the door and one that is pulsed to close it. For many openers this will be the same output

You should now be able to start homebridge and see your M1.

TODO

  • Secure connections are not currently supported

homebridge-elkm1's People

Contributors

paulw11 avatar

Watchers

 avatar  avatar

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.