homebridge-envisakit v0.1.4

homebridge-envisakit

EnvisaKit plugin for HomeBridge

This plugin connects your Honeywell Vista security panel to HomeKit through your EnvisaLink module, HomeBridge, and EnvisaKit.

Note: This module is not compatible with DSC security panels at this time.

Features

This plugin allows you to use Siri or a compatible HomeKit app to perform the following functions on the alarm panel:

• Arm the security panel in modes: Away, Stay, Night
• Disarm the security panel
• Enable bypass for a pre-determined zone
• Toggle chime mode
• See if panel is in alarm, or has an alarm in memory
• See if panel is ready to arm ("Obstruction Detected")
• See faulted zone number
• See battery status (Normal or Low)

Screenshots

Elgato Eve

December 2015

iDevices Connected

December 2015

Installation

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

Configuration

Configuration sample:

"accessories": [
		{
			"accessory": "Envisakit",
			"name": "Honeywell Vista 15P",
			"envisakit-path" : "/opt/envistakit/envisakit-cli",
			"pin" : "1234",
			"periodic_update": false,
			"cache_timeout": 15,
			"args": "",
			"bypass_zone": "13",
			"show_alarm_detected": true,
			"show_chime": true,
			"show_battery_level": true
		}
	],

Fields:

• "platform": Must always be "Envisakit" (required)
• "name": Can be anything (required)
• "envisakit-path": Absolute path to your envisakit-cli script (required)
• "pin": 4-digit security panel code to use with all HomeKit operations (required)
• "periodic_update": When true, the panel will be polled every cache_timeout seconds for status so that HomeKit responds instantly. When false, the panel will be polled only when the data has not been refreshed in the last cache_timeout seconds.
• "cache_timeout": Minimum amount of time between polling the device for alarm status - see also: periodic_update (optional, default: 10 seconds)
• "args": Additional arguments to append to the envisalink-cli command (optional)
• "bypass_zone": When defined, configures a switch to bypass the specified zone (optional, default: not defined)
• "show_alarm_detected": Configures a characteristic to show if the alarm is active or in memory (optional, default: true)
• "show_chime": Configures a characteristic to enable or disable chime mode (optional, default: true)
• "show_battery_level": Configures a characteristic to display low battery mode (optional, default: true)

Usage

App Compatibility

Since Security System support was only introduced to HomeKit in iOS 9, only a handful of apps support it today.

In my own testing, Elgato Eve has very good support for most features of this plugin.

Tested features across major HomeKit applications:

If you've tested with a different HomeKit app or if your experience differs from the table, please create an issue!

Using Siri

To use Siri, you will need to create scenes for the desired alarm conditions. In my testing, Siri will not recognize any commands for the accessory out-of-the-box - you can only achieve this through scenes.

To create the scenes, you must use a compatible HomeKit app.

Recommended scenes and security panel actions (scene name in italics):

• Hey Siri, I'm leaving (set Security System State to AWAY ARM)
• Hey Siri, I'm home (set Security System State to DISARM)
• Hey Siri, set the armed panel scene (set Security System State to STAY ARM)
• Hey Siri, set the night arm scene (set Security System State to NIGHT ARM)
• Hey Siri, All clear (set Security System State to DISARM)

Credit

Thanks to the contributors of homebridge, HAP-NodeJS.

Also thanks to the contributors of homebridge-nest which parts of the code are modeled after.