This app connects to an Elk1 M1 Gold alarm system with an M1EXP ethernet expander and publishes messages to an MQTT broker.
TODO
cp .env-sample .env
// fill out all the config details
npm install --production
npm start
| key | description | required |
|---|---|---|
| ELK_USER | Elk User Name (if using ELK_SECURE) | no |
| ELK_PASSWORD | Elk Password (if using ELK_SECURE) | no |
| ELK_HOST | IP address of M1EXP. | yes |
| ELK_PORT | Port (2101 for plaintext, 2601 for TLS) | no |
| ELK_SECURE | TLS encryption, also requires ELK_USER / ELK_PASSWORD / ELK_PORT (true, false) | no |
| ELK_DEBUG | Extra debug information for ELK (true, false) | no |
| ELK_IGNORE_ZONES | list of zones to ignore example (1 2 3 4 5 6 7 8) | no |
| MQTT_BROKER_ADDRESS | MQTT broker URL (eg. mqtt://localhost:1883) |
yes |
| MQTT_USER | Broker user | yes |
| MQTT_PASSWORD | Broker password | yes |
| MQTT_DEBUG | Extra debug information for MQTT (true, false) | no |
elk/alive - elkm1-mqtt has connected to the M1EXP, not quite ready for traffic yet - values: ('true')
elk/authorized - elkm1-mqtt has connected to the M1EXP, should be ready to rock - values: ('true')
elk/area/#/status - AS Arming status report data - values: ('Disarmed'|'Armed Away'|'Armed Stay'|'Armed Stay Instant','Armed to Night'|'Armed to Night Instant'|'Armed to Vacation')
elk/area/#/ready - AS armUpState state (ready to arm?) - values: ('true'|'false')
elk/zone/#/status - Zone change update - values ('Violated'|'Normal')
- Subscribe to some topics to send commands to the Elk M1 EXP (arm alarm, disarm alarm, say command)
- Publish discovery topic (zone names, areas, etc...)
- What else
- Bypass M1EXP and do utilize direct serial
This repository keeps a change log using GitHub's releases functionality. The format of the log is based on [Keep a Changelog][keepchangelog].
Releases are based on [Semantic Versioning][semver], and use the format
of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented
based on the following:
MAJOR: Incompatible or major changes.MINOR: Backwards-compatible new features and enhancements.PATCH: Backwards-compatible bugfixes and package updates.
Ths MQTT code was mostly lifted from Jeremy Bunting's ambient-mqtt app The module for the elkington code is currently being pulled from my branch instead of Kevin Ohara's offcial elkington repository due to some enhancements and fixes that I've not yet submitted a PR for.
MIT License
Copyright (c) 2018 Bill Church
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.