Control4 UniFi Access: HOW TO program for Visitors / Users Unlock attempts for Access door locks

Control4 UniFi Access: HOW TO program for Visitors / Users Unlock attempts for Access door locks

Summary

This article explains how to perform actions or programming in Control4 when specific Users or Visitors unlock a door

Prerequisites

  1. Chowmain UniFi Driver Version 20260428 or later 
  2. UniFi Access. This procedure will not work for doorbells
  3. Ensure that the Chowmain UniFi Door Driver has been added for the lock and is working
  4. Ensure that the API key and local user login has been correctly set up and working 

Using Events


Chowmain's UniFi Access driver always includes 2 events for door unlocking
  1. Door Unlocked: This triggers whenever the door is unlocked using any method
  2. Door Unlock Failed - Any: This triggers whenever a door unlock fails. Generally, this will be wrong passcode or using a NFC device which isn't authorised 

Chowmain's UniFi Access Driver is also capable of automatically creating events for Door Unlocking. To customise whether these events are created, set the "Auto Create Unlock Events" Property to Automatic.

These events are created on the first unlock attempt by a visitor, and are called "Door Unlocked-<DISPLAY NAME>" (as an example, Door Unlocked - Andrew Luecke). 

Warning
Please note, if the display name changes in UniFi, a new event will be required/created with the new name. This is not recommended for systems with a large number of visitors which regularly change


Using Variables 

We include variables which are triggered on all unlock attempts (whether successful or not) which can also be used. Variable Agent can be used to identify what possible values are, and the included Unlocking Feedback properties. The easiest way to identify available values is to test the unlock for the user. 
  1. LAST_UNLOCK_ATTEMPT_RESULT: Whether the unlock was successful. "ACCESS" generally means success, "BLOCKED" generally means failed. We have also observed a "INCOMPLETE" signal too for Google wallet. We recommend using NOT EQUAL "ACCESS" for failed  
  2. LAST_UNLOCK_ATTEMPT_ACTOR_ID: The internal UniFi ID for the user performing the unlock.  
  3. LAST_UNLOCK_ATTEMPT_ACTOR_NAME: The Display / Friendly name for the User performing the Unlock. This may change if the display name for the user is changed in the UniFi Access interface 
  4. LAST_UNLOCK_ATTEMPT_TIME: The Human friendly time the attempt was performed
  5. LAST_UNLOCK_ATTEMPT_TYPE: How the door attempt was unlocked.  Values include NFC, PIN_CODE. 
  6. LAST_UNLOCK_ATTEMPT_TIMESTAMP: The machine Timestamp of when the unlock was attempted. This is generally only used for advanced programming. Most users who actually require webhooks instead. 

Custom Webhooks


Our UniFi driver allows custom webhooks to be utilised as an alternative way of triggering events based on unlocks. This is generally more recommended for solutions where UniFi is managed by the end user, and control4 is managed by the installer; where the programming in Control4 should remain static, where requirements often change or more advanced scenarios.

    • Related Articles

    • Control4 UniFi: Setup Door Unlock In Intercom (Custom Buttons)

      To set up Door Unlocking in a UniFi intercom Ensure you are using the latest version of the Chowmain UniFi Drivers: https://chowmain.software/drivers/control4-unifi Add the Intercom as per normal in UniFi Access: ...

    • Control4 UniFi: Manual Setup of UniFi Access Door

      Control4 UniFi: Manual Setup of UniFi Access Door It is strongly recommended to use Auto Setup to correctly configure and add new devices instead of Manual Setu Ensure that UniFi Access Controller has been added to project and is correctly ...

    • Control4 UniFi: Unifi Access Quick Setup

      The UniFi access integration enables basic control of doors and intercoms. Install all of the drivers It is recommended to use Drivers => Add Or Update Driver or Agent to install the drivers Use Ctrl+A or use the mouse to install and update all C4z ...

    • Control4 UniFi: Setup Unifi Doorbells

      Integration of UniFi Protect Doorbells UniFi Protect Doorbells such as the G4 Doorbell do not provide SIP access and cannot directly integrate using the Intercom/2-way interface. UniFi Intercoms however do support the ability to make calls outgoing ...

    • Control4 Unifi - Supported Intercoms

      Two Way Communications / Intercom Support For the latest list of intercoms which are known to support two way communications (third party SIP) , refer to: ...