Install the integration

Install keymaster via HACS

This integration can be added manually, but the supported method is via HACS. If you do not already have HACS, it is simple to install.

Open HACS, go to Integrations, click +, and search for keymaster. You will be prompted to restart Home Assistant.

Create one Keymaster config entry per lock you want to manage:

1. Go to Settings → Devices & Services
2. Click Add Integration
3. Search for keymaster

If keymaster does not appear in the integration list right away, refresh the page and try again.

Keymaster supports lock entities from various integrations via its provider abstraction model (e.g., Z-Wave JS, ZHA, Zigbee2MQTT, Schlage, Local Akuvox).

Config flow fields

Keymaster will prompt for these values:

1. keymaster Lock Name
   Friendly lock name used for entities and notifications (example: frontdoor).

2. Physical Lock
   The lock.* entity for this door.

3. keymaster Parent Lock (optional)
   Makes this lock a child lock and inherits slot settings from a parent lock.

4. Code Slots
   Number of user code slots to manage.

5. Starting Code Slot #
   Slot offset for locks that do not start at slot 1.

6. Door Sensor (optional)
   A binary_sensor.* entity for door open/closed state.

7. Alarm Level/User Code Sensor (optional)
   Sensor used to identify which slot triggered a keypad action.

8. Alarm Type/Access Control Sensor (optional)
   Sensor used to identify lock action type.

9. Notification Script (optional)
   Script entity used for keymaster notifications. If empty, defaults to script.keymaster_<lock_name>_manual_notify.

10. Enable the advanced date range feature
    Enables per-slot date range controls.

11. Enable the advanced day of week feature
    Enables per-slot day/time scheduling controls.

12. Hide PINs in UI
    Stores PIN text entities in password mode.

After saving, Keymaster creates entities immediately and auto-generates Lovelace strategy files.

Options configuration

After initial setup, you can customize additional settings by going to Settings → Devices & Services, finding your Keymaster entry, and clicking Configure:

1. Redact slot names in debug logs
   Hides slot names in Home Assistant debug logs to protect privacy.
2. Redact PIN codes in debug logs
   Hides PIN code values in Home Assistant debug logs.