Lovelace Configuration Automatic

Lovelace Configuration (Automatic)

Keymaster provides Lovelace strategies that automatically generate dashboards and views for managing your locks. This eliminates the need to manually copy and paste YAML configuration.

Prerequisites

The Keymaster frontend must be loaded. This happens automatically when you have at least one Keymaster integration configured.

If your Home Assistant Lovelace resources are managed in YAML mode, add this manually:

lovelace:
  resources:
    - url: /keymaster_files/keymaster.js
      type: module

Dashboard Strategy

The easiest way to use Keymaster is to create a dedicated dashboard that automatically shows all your configured locks.

Creating a Keymaster Dashboard

1. Go to Settings → Dashboards
2. Click Add Dashboard
3. Enter a title (e.g., "Keymaster")
4. Toggle "Open in a new tab" as desired
5. Click Create
6. Click Open on the new dashboard
7. Click the three dots menu → Edit Dashboard
8. Click the three dots menu → Raw configuration editor
9. Replace all content with:

strategy:
  type: custom:keymaster

10. Click Save, then Done

The dashboard will automatically create a view (tab) for each configured lock, sorted alphabetically.

View Strategy

If you prefer to add Keymaster views to an existing dashboard, use the view strategy.

Adding a Lock View to an Existing Dashboard

Edit your dashboard's raw configuration and add a view:

views:
  # Your existing views...

  - strategy:
      type: custom:keymaster
      lock_name: Front Door

View Strategy Options

Option	Required	Description
lock_name	Yes*	The name of the lock as configured in Keymaster
config_entry_id	Yes*	The config entry ID (alternative to lock_name)
title	No	Override the view tab title
icon	No	Set a custom icon for the view tab
path	No	Custom URL path for the view
visible	No	Control view visibility
theme	No	Apply a specific theme to the view

*Provide either lock_name or config_entry_id, not both.

Example with Options

views:
  - strategy:
      type: custom:keymaster
      lock_name: Front Door
      title: Front Lock
      icon: mdi:door-closed-lock

Section Strategy

For advanced use cases, you can use the section strategy to add individual code slot sections:

views:
  - type: sections
    title: My Custom View
    sections:
      - strategy:
          type: custom:keymaster
          lock_name: Front Door
          slot_num: 1
      - strategy:
          type: custom:keymaster
          lock_name: Front Door
          slot_num: 2

Troubleshooting

"Timeout waiting for strategy element ... to be registered"

This message appears when there is a typo in the strategy type.

Ensure that you copied and pasted the full, correct strategy name into the YAML configuration.

Note: A previous version of this page had a typo in the strategy type. Copy and paste the corrected version into your YAML configuration.

"No Keymaster configurations found!"

This message appears when:

• No Keymaster integrations are configured
• All Keymaster integrations are disabled

Ensure you have at least one enabled Keymaster integration in Settings → Devices & Services.

Lock not appearing in dashboard

• Verify the lock integration is enabled (not disabled)
• Check that the lock name matches exactly (case-sensitive when using lock_name)
• Refresh the browser page after making configuration changes

Changes not reflecting

Lovelace strategies are generated dynamically. If you add or remove locks:

1. Refresh your browser
2. If using a dashboard strategy, views will automatically update

If you rely on the generated per-lock YAML files, you can run keymaster.regenerate_lovelace from Developer Tools → Actions.