Home

Lock Code Manager Wiki

Welcome to the Lock Code Manager wiki!

Getting Started

• Configuration-Structure - YAML configuration format

UI

• Add-a-UI-for-lock-code-management - Overview and decision guide for the dashboard, strategies, and cards
• UI-Strategies - Dashboard, view, and section strategies (let LCM generate UI from your config)
• Custom-Cards - Slot card and lock-codes card (compose your own dashboard)

Features

• Services-and-Actions - All registered actions: set/clear PINs, manage condition entities, generate random PINs
• Blueprints - Usage limiting, calendar-driven PINs, and more
• Tracking-lock-state-change-events - Listen for lock events in automations
• Using-Condition-Entities - Control PIN access with calendars, schedules, and more
• Unsupported-Condition-Entity-Integrations - Condition entities that don't work with LCM
• Notifications - Set up notifications for lock events

Advanced

• Advanced-Usage - Managing multiple config entries and automation tips

Development

• Development-Guide - Architecture overview and dev container setup
• Adding-a-Provider - Step-by-step guide to add support for a new lock integration
• Provider-State-Management - Understanding poll vs push modes

Troubleshooting

• Troubleshooting - Guidance for diagnosing issues and filing bug reports
• Troubleshooting-Debug-Logs - How to enable debug logging for LCM
• Troubleshooting-Device-Diagnostics - How to download diagnostics for your lock device
• Troubleshooting-Browser-Console-Logs - How to capture browser console logs for frontend issues

FAQ

• PIN-Codes-Visible-in-Activity-Log - Why PINs are visible in the device activity log
• Why-is-'x'-not-supported?-Will-it-be-supported-in-the-future?
• Unsupported-Integrations - Lock integrations that cannot currently be supported

Supported Integrations

• Akuvox-integration - Akuvox smart locks and intercoms
• Matter-integration - Matter-compatible locks
• Schlage-integration - Schlage WiFi locks
• Virtual-integration - Virtual locks for testing
• Z-Wave-integration - Z-Wave locks
• ZHA-integration - Zigbee Home Automation locks
• Zigbee2MQTT-integration - Zigbee2MQTT (MQTT-bridged) locks

---

If there is content missing that you'd like to see, please open an issue.