homebridge-elkm1 lets you connect homebridge to an Elk Products M1 Alarm panel via an M1XEP Ethernet interface
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.
- Install homebridge -
sudo npm install -g --unsafe-perm homebridge
- Install homebridge-elkm1 -
sudo npm install -g --unsafe-perm homebridge-elkm1
- 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
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.
- Secure connections are not currently supported