Overview
The 4Drivers Yale Connect Lock driver represents an individual lock from the Yale Connect account inside the Control4 project. It receives state updates and access events from the Hub driver, fires Control4 events for automations, and can send notifications by email or via 4Drivers Message Sender.
This driver does not need to be added manually to the project. The Hub driver automatically creates and configures one instance for each lock found in the Yale account when List Locks is executed.
- Reflects lock state in real time (locked, unlocked, online, battery)
- Fires Control4 events by access type: app, manual, keypad, fingerprint
- Supports email notifications and 4Drivers Message Sender
- Exposes Control4 variables for use in programming (user, battery)
- Integrates with the Control4 LOCK proxy — compatible with native security automations
Properties
Identification
| Property | Type | Description |
|---|
| Lock ID Selected read-only | String | Yale internal ID for the lock. Filled in automatically by the Hub via List Locks. |
| Lock Name Selected | String | Lock name. Filled in by the Hub; can be adjusted by the integrator to a more user-friendly name. |
| Visible on Interface | List | Yes (default) — lock appears in the Hub's HTML interface. No — hidden; useful for service locks or private areas. |
| Driver Version read-only | String | Installed driver version. |
Lock Status all read-only
| Property | Description |
|---|
| Online | Indicates whether the lock is communicating with the Yale hub: Yes or No |
| Battery | Battery state: OK or Low Battery |
| Alarm | Lock alarm code, when available |
| Entry Code | Last recorded entry code |
| Last State | Last state change (LOCKED/UNLOCKED) with date and time |
| Last Access | Full description of the last access: state, type, user, and time |
| Access Type | How the lock was operated: app, fingerprint, manual, keypad |
| Access User | Name of the user who operated via app. Empty for physical access. |
| Last Update | Date and time of the last communication received from the Hub |
Notifications
| Property | Type | Description |
|---|
| E-mail Address | String | Email address for access notification delivery |
| When Unlocked | List | Action when unlock is detected: E-mail, 4Drivers Message Sender, Both, or Do not send |
| When Locked | List | Action when lock is detected: same options as above |
Debug
| Property | Type | Description |
|---|
| Debug Mode | List | Off (default) or Print — displays logs in the Composer console. Disable after commissioning. |
| Developers Use | Password | Reserved for 4Drivers use. |
Control4 Variables
Variables exposed to the Control4 system for use in programming and automations:
| Variable | Type | Description |
|---|
| Last Valid User ID | Number | ID of the last user identified with valid access |
| Last Valid User Name | String | Name of the last user with valid access |
| Battery Level | Number | Battery level: 100 = OK, 10 = Low Battery |
Events
The driver fires the following Control4 events, available for use in programming:
Connectivity
| Event | When it fires |
|---|
| Lock Online | The lock resumed communication with the Yale hub |
| Lock Offline | The lock lost communication with the Yale hub |
General State
| Event | When it fires |
|---|
| Lock Locked | The lock was locked by any means |
| Lock Unlocked | The lock was unlocked by any means |
By Access Type
| Event | When it fires |
|---|
| Locked by App | Locked via Yale Connect application |
| Unlocked by App | Unlocked via Yale Connect application |
| Locked Manually | Physical lock (button or cylinder turn) |
| Unlocked Manually | Physical unlock |
| Locked by Keypad | Locked via numeric keypad |
| Unlocked by Keypad | Unlocked via numeric keypad |
| Locked by Fingerprint | Locked via fingerprint reader |
| Unlocked by Fingerprint | Unlocked via fingerprint reader |
Battery
| Event | When it fires |
|---|
| Low Battery | Battery level entered a low state |
| Battery Normal | Battery level returned to normal |
Actions
| Action | Description |
|---|
| Unlock | Sends an unlock command to the lock via the Hub |
| Lock | Sends a lock command to the lock via the Hub |
| Refresh Devices List | Requests the Hub to re-sync the ID of this lock |
| List Users | Requests the list of users registered on the lock |
Setup
The driver is added and configured automatically by the Hub. In most cases no additional action is needed beyond the steps below.
1 — Verify identification
- After the Hub runs List Locks, open this driver's Properties
- Confirm that Lock ID Selected is filled with the Yale lock ID
- Adjust Lock Name Selected to a user-friendly name if desired
2 — Interface visibility
- Keep Visible on Interface set to
Yes for locks in regular use
- Set to
No for service locks or locks that should not appear in the Hub's HTML interface
3 — Configure notifications (optional)
- Fill in E-mail Address with the notification recipient address
- In When Unlocked and When Locked, choose the desired delivery channel
- To use 4Drivers Message Sender, that driver must be installed and bound to the 4Drivers Message Sender binding of this driver
4 — Finish
- Make sure Debug Mode is set to
Off
- Save and publish the project
Change Log
| Version | Date | Changes |
|---|
| 1055 | 07/24/2026 | Initial adjustments |
| 1050 | 07/19/2026 | Initial release |
