Skip to content

einari/easycodetouch

Repository files navigation

EasyCodeTouch for Homebridge

Build npm version

This repository holds a Homebridge plugin that enables the use of the Easy Access product called Easy Code Touch.

Have a look at the changelog for details on all versions.

Prerequisites

You'll need to have the Zigbee / BLE installed in the lock.

This plugin relies on MQTT and specifically the protocol defined by Easy Access. The easiest would be to use something like Zigbee2MQTT. The protocol in question is defined here.

Install

If you're using the Homebridge UI, you can simply find and install the plugin from there:

Then you need to configure one or more accessories (you can have multiple, if you have multiple locks). Open the configuration editor in the UI and locate the accessories key and add something like below:

The configuration object:

"accessories": [
    {
        "accessory": "EasyCodeTouch",
        "name": "EasyCodeTouch",
        "mqtt-server": "localhost",
        "mqtt-port": 1883,
        "friendly-name": "Frontdoor"
    }
]

Build

You'll need Yarn to leverage the scripts in the package.json file.

For development purposes, install a local Homebridge on your dev-box:

sudo npm install -g --unsafe-perm homebridge homebridge-config-ui-x

Note: You can drop the last package, if you don't want to have the Homebridge UI.

Then you can run this plugin with watch:

yarn watch