Setting up the Unifi Access Plugin


✅ Yubii Home / Fibaro HC3/HC3L

✅ Standalone


The UniFi Access plugin connects automationbridge to your UniFi Access console, discovers your doors and creates door-lock devices for monitoring and control.

This guide covers UniFi Access 4.x and assumes that your doors, hubs and readers are already configured and working in the UniFi Access application.

The plugin requires automationbridge PRO and an active UniFi Access plugin licence. Your automationbridge must be able to reach the UniFi console over the local network.


Step 1 – Create an API token in UniFi Access

Sign in to your UniFi console as an administrator and open Access.

Go to Settings → General → API Token. Depending on your Access version, you may need to expand Advanced to find API Token.

Click Create New and enter:

  • Name: AutomationBridge

  • Validity Period: Never Expire

UniFi calls this an API Token. This is the value you will enter into the automationbridge Access API key field.


Step 2 – Select the token permissions

Under Permissions, select the following options:

Permission Select
People & Groups None
Visitor None
Access Policy None
Credentials None
Locations Edit
Device View
System Log None
Webhooks None
API Server None

Locations → Edit allows automationbridge to discover and control your doors. Device → View allows it to receive events used to update door-lock status.

Click Create, then copy the token. UniFi displays the token only when it is created, so keep it available for the next steps.


Step 3 – Add the plugin to automationbridge

Open the automationbridge web interface and go to the Network Devices/Plugins page.

Find UniFi Access and click ADD.


Step 4 – Enter the connection details

Complete the following fields:

  • Controller IP / Hostname: The local IP address or hostname of the UniFi console running Access.

  • Access API key: The token created in Steps 1 and 2.

Enter only the controller’s IP address or hostname, without https:// or a port number.


Step 5 – Test the connection

Click Test and connect.

The plugin checks access to the door list and the event connection. If successful, the next page displays the doors found on your UniFi Access console.

If the connection fails, check the controller address, token and permissions before retrying.


Step 6 – Create the door devices

Click Next to synchronise your doors.

For Fibaro HC3/HC3L, automationbridge creates a door-lock device for each door.

For Standalone mode, the doors are added to automationbridge’s device list.


Step 7 – Complete the setup

Click OK to open the UniFi Access settings page.

The page lists your doors and their assigned device IDs.

If you add doors or change their names in UniFi Access, return to this page and click Sync. Existing device mappings are retained.


Using your doors

Each door provides Lock and Unlock controls.

Unlock releases the door for the normal unlock duration configured in UniFi Access. To leave a door unlocked continuously, use the appropriate setting in UniFi Access.

Lock status updates automatically from the status reported by UniFi Access, including changes made through the UniFi interface.

The displayed locked/unlocked status represents the lock relay. A door-position sensor’s open/closed reading is a separate measurement.


Replacing the API key

If you need to replace an expired, deleted or incorrectly configured token:

  1. Create a new token in UniFi Access using Never Expire and the permissions shown above.

  2. Open the UniFi Access settings page on automationbridge.

  3. Click Update API key, beside Sync.

  4. Paste the replacement token and click Test and update key.

The replacement is saved after the connection checks succeed. Your existing doors and HC3 device IDs are retained.



Troubleshooting

  • Unable to connect: Check the console’s local address and API token. If a firewall separates the devices, allow automationbridge to reach the console on TCP port 12445.

  • Doors are discovered but lock/unlock fails: Confirm that Locations is set to Edit. Discovery can succeed with View permission, but door commands require Edit.

  • Lock status is not updating: Confirm that Device is set to View and that the console remains reachable. Use Update API key if you need to replace the token.

If the issue continues, contact Skaro Technology support with the affected door name, what happened and the approximate time.