Home
Softono
keymaster

keymaster

Open source MIT Python
334
Stars
55
Forks
13
Issues
10
Watchers
1 week
Last Commit

About keymaster

Home Assistant integration for managing Z-Wave enabled locks

Platforms

Web Self-hosted

Languages

Python

Links

keymaster

Home Assistant keymaster integration for Z-Wave enabled locks. This integration allows you to control one (or more) Z-Wave enabled locks that have been added to your Z-Wave network. Besides being able to control your lock with lock/unlock commands, you can also control who may lock/unlock the device using the lock's front facing keypad. With the integration you may create multiple users or slots and each slot (the number depends upon the lock model) has its own PIN code.

Setting up a lock for the entire family can be accomplished in a matter of seconds. Did you just leave town and forgot to turn the stove off? through the Home Assistant interface you can create a new PIN instantly and give it to a neighbor and delete it later. Do you have house cleaners that come at specific times? With the advanced PIN settings you can create a slot that only unlocks on specific date and time ranges. You may also create slots that allow a number of entries, after which the lock won't respond to the PIN.

For more information, please see the topic for this package at the Home Assistant Community Forum.

Lovelace Dashboard

Keymaster includes Lovelace strategies that automatically generate dashboards for managing your locks. You can create a complete Keymaster dashboard with a single line of YAML, or add individual lock views to existing dashboards. See the Lovelace Configuration wiki page for setup instructions and configuration options.

Installation

Please visit this project's Wiki for the latest installation and update procedure.

Zigbee2MQTT Support

Keymaster supports Zigbee locks integrated via Zigbee2MQTT. Because Keymaster needs to read and write PIN codes directly from the lock, you must enable PIN code exposure in Zigbee2MQTT.

To do this, ensure expose_pin is set to true in your Zigbee2MQTT settings for the lock. For example, in your configuration.yaml for Zigbee2MQTT:

devices:
  '0x000d6f000d6f000d':
    friendly_name: front_door_lock
    expose_pin: true

Without this setting, Keymaster will not be able to retrieve or set user codes on the lock.