README

elkmon

elkmon is a module for interfacing with the Elk M1 security and automation control system.

Not all features have been implemented. This is something I have been experimenting with in my free time. I don't have a thermostat integrated with my home system so I haven't implemented those commands yet. However, a Thermostat Reply Message (TR) will be parsed.

Note: For users upgrading to version 1.0.0 from an earlier version, please be aware that there was a bug where the Physical and Logical status, for a zone, was incorrectly swapped. This has been fixed in version 1.0.0.

Features

Supports both secure and non-secure communication with Elk M1XEP

All received messages are parsed into an ElkMessage

Example

  {
    message: '1EAS000000001111111100000000000E', // Full message
    body: '00000000111111110000000000', // Parsed message
    type: 'AS', // Type of message
    hexLength: '1E',
    checkSum: '0E'
  }

Some messages are parsed into a specific message type. For example, ZoneStatusReport (ZS) which includes an array of zones:

{
  message: 'D6ZS33333333333333303333000000000000333300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000034',
  body: '333333333333333033330000000000003333000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
  type: 'ZS',
  hexLength: 'D6',
  checkSum: '34',
  zones:
    [
      { id: 1, physicalStatus: 'Short', logicalState: 'Normal' },
      { id: 2, physicalStatus: 'Short', logicalState: 'Normal' },
      ...
    ]
}

Events are emitted when messages are received. You can listen for all (*) or by type (KC, ZD, ZC, etc).
Requests for data return a Promise and can be chained together.

Example Usage

var Elk = require('elkmon');

// Instantiate a new Elk instance (non-secure)
var elk = new Elk(
  2101, // port
  '192.168.1.100' // M1XEP address
);

// Register any event handlers
elk.on('connected', () => {
  console.log('***connected***');

  // Request arming status report
  elk.requestArmingStatus()
    .then((report) => {
      console.log(report.areas);
      // Request zones status report
      return elk.requestZoneStatusReport()
    })
    .then((report) => {
      console.log(report.zones);
      elk.speak('all clear');
  });
});

// Listen for all messages
elk.on('*', (message) => {
  console.log(message);
});

// Listen for messages by type (Zone Change)
elk.on('ZC', (message) => {
  console.log('Zone Change Report: ', message);
});

elk.connect();

// Instantiate a secure instance
var elk = new Elk(
  2601,
  '192.168.1.100', {
    secure: true,
    userName: 'SomeUser',
    password: 'YourPassword',
    keypadCode: 'YourPin',
    rejectUnauthorized: false,
    secureProtocol: 'TLSv1_method'
  }
);

API

connect()

Connects to M1XEP.

disconnect()

Closes connection to M1XEP.

arm(areaId, armMode, keypadCode)

Arm Elk in specified arming mode

disarm(areaId, keypadCode)

Disarm Elk

activateTask(taskId)

Activates a task

setOutputOn(outputId, seconds)

Turns an output on

setOutputOff(outputId)

Turns an output off

speak(message)

Command Elk panel to speak a message over it's speaker.

toggleOutput(outputId)

Toggles a control Output On/Off.

requestOutputStatusReport([timeout])

Request the Control Output Status report from Elk panel.

bypassZone(zoneId, areaId, keypadCode)

Bypass a Zone.

requestArmingStatus([timeout])

Requests an Arming Status Report.

requestAreas([timeout])

Request Keypad Area assignments

requestZoneDefinitionReport([timeout])

Requests a Zone Definition Report.

requestZonePartitionReport([timeout])

Requests a Zone Partition Report.

requestZoneVoltageReport(id, [timeout])

Requests a Zone Voltage Report.

requestZoneStatusReport([timeout])

Requests a Zone Status Report.

requestTextDescription(id, type, [timeout])

Requests a text description.

requestTextDescriptionAll(type)

Requests the configured Text Descriptions, by type.

Usage no npm install needed!