[unifiaccess] Unifi access binding initial contribution by digitaldan · Pull Request #19412 · openhab/openhab-addons

digitaldan · 2025-09-30T15:27:26Z

This binding integrates Ubiquiti UniFi Access with openHAB. It connects to your UniFi Access controller over HTTPS and listens for live door events while exposing channels to monitor and control door locks.

This is very WIP as i only have a door hub right now to test with, i'm waiting for the G6 Pro Entry to be released in the next couple months to get a full working access system.

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Copilot

Pull Request Overview

Initial contribution of a new UniFi Access binding integrating Ubiquiti UniFi Access controllers, doors and devices into openHAB, including discovery, channel definitions, handlers, API client, and documentation.

Adds new bundle org.openhab.binding.unifiaccess with thing types, handlers, DTOs, API client, discovery, i18n, feature, README, and BOM / aggregator references.
Introduces WebSocket-based live event handling (doorbell, access attempts, logs) and REST interactions (lock control, device access method configuration).
Provides i18n resources and documentation, though some naming/branding and translation duplication issues are present.

Reviewed Changes

Copilot reviewed 45 out of 48 changed files in this pull request and generated 16 comments.

Show a summary per file

File	Description
bundles/pom.xml	Adds unifiaccess module and formatting change to root POM (one-line collapse).
org.openhab.binding.unifiaccess/.../thing-types.xml	Defines bridge, door, and device thing and channel types.
unifiaccess.properties	Adds i18n labels (some duplication & branding inconsistencies).
addon.xml	Declares addon metadata (branding inconsistency).
Multiple handler Java classes	Implements bridge, door, and device handlers; several silent exception swallows and incomplete state updates.
UniFiAccessApiClient.java	Implements REST/WebSocket client (potential NPE in media type logging).
DTO classes	Data models for API (mostly straightforward POJOs).
Binding constants / factory / discovery	Wiring for thing creation and discovery.
feature.xml	Karaf feature for new binding.
BOM & CODEOWNERS	Registers new binding in build and ownership.
README.md	User documentation (branding mismatches & incorrect product name in examples).

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

bundles/pom.xml

bundles/org.openhab.binding.unifiaccess/src/main/resources/OH-INF/i18n/unifiaccess.properties

...s/src/main/java/org/openhab/binding/unifiaccess/internal/handler/UnifiAccessDoorHandler.java

...src/main/java/org/openhab/binding/unifiaccess/internal/handler/UnifiAccessDeviceHandler.java

bundles/org.openhab.binding.unifiaccess/README.md

bundles/org.openhab.binding.unifiaccess/src/main/resources/OH-INF/thing/thing-types.xml

...iaccess/src/main/java/org/openhab/binding/unifiaccess/internal/api/UniFiAccessApiClient.java

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Copilot

Pull Request Overview

Copilot reviewed 46 out of 49 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

bundles/org.openhab.binding.unifiaccess/src/main/resources/OH-INF/thing/thing-types.xml

bundles/org.openhab.binding.unifiaccess/src/main/resources/OH-INF/i18n/unifiaccess.properties

...src/main/java/org/openhab/binding/unifiaccess/internal/handler/UnifiAccessDeviceHandler.java

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

lsiepel

Picked up the review of this binding. Will continue when these are fixed. Looked at all files except the handlers and apiclient.

lsiepel · 2025-12-23T22:29:34Z

bundles/org.openhab.binding.unifiaccess/README.md

+![logo](doc/logo.png)
+


Logo can be added afterwards. Please remove from the docs here.

lsiepel · 2025-12-23T22:30:23Z

bundles/org.openhab.binding.unifiaccess/README.md

+- `unifiaccess:bridge` (Bridge): The UniFi Access controller instance.
+  Required to discover and manage door things.
+- `unifiaccess:door`: A UniFi Access door with status and control channels.
+- `unifiaccess:device`: A UniFi Access device (reader, hub, or camera) with device-level status and controls.


no need to add the binding id.

Suggested change

- `unifiaccess:bridge` (Bridge): The UniFi Access controller instance.

Required to discover and manage door things.

- `unifiaccess:door`: A UniFi Access door with status and control channels.

- `unifiaccess:device`: A UniFi Access device (reader, hub, or camera) with device-level status and controls.

- `bridge` (Bridge): The UniFi Access controller instance.

Required to discover and manage door things.

- `door`: A UniFi Access door with status and control channels.

- `device`: A UniFi Access device (reader, hub, or camera) with device-level status and controls.

lsiepel · 2025-12-23T22:31:02Z

bundles/org.openhab.binding.unifiaccess/README.md

+## Discovery
+
+- Add the `Bridge` by entering the controller Hostname or IP and an API Token.
+- Once the Bridge is ONLINE, Doors are discovered automatically and appear in the Inbox.


Suggested change

- Once the Bridge is ONLINE, Doors are discovered automatically and appear in the Inbox.

- Once the `bridge` is ONLINE, `door`s are discovered automatically and appear in the Inbox.

lsiepel · 2025-12-23T22:31:32Z

bundles/org.openhab.binding.unifiaccess/README.md

+
+## Thing Configuration
+
+### Bridge `unifiaccess:bridge`


Also check other places

Suggested change

### Bridge `unifiaccess:bridge`

### Bridge `bridge`

lsiepel · 2025-12-23T22:32:03Z

bundles/org.openhab.binding.unifiaccess/README.md

+| door-sensor           | Contact   | R  | Door position sensor.                                       |
+| doorbell-contact      | Contact   | R  | Doorbell contact.                                           |
+
+


Suggested change

lsiepel · 2025-12-23T22:44:31Z

bundles/org.openhab.binding.unifiaccess/src/main/resources/OH-INF/thing/thing-types.xml

+	<channel-type id="face-detect-distance">
+		<item-type>String</item-type>
+		<label>Face Detect Distance</label>
+		<description>Face Detect Distance</description>


Applies to all channel type descriptions. Either make the description a good description (add value) or remove it. It should not be a copy of the label.

lsiepel · 2025-12-23T22:45:32Z

bundles/org.openhab.binding.unifiaccess/src/main/resources/OH-INF/thing/thing-types.xml

+		<label>Emergency Status</label>
+		<description>Emergency Status</description>
+		<category>Alarm</category>
+		<state>


Applies to all channel types, consider marking them readOnly="true" where appropiate.

lsiepel · 2025-12-23T22:46:37Z

bundles/org.openhab.binding.unifiaccess/src/main/resources/OH-INF/thing/thing-types.xml

+		<item-type>DateTime</item-type>
+		<label>Last Unlock</label>
+		<category>Time</category>
+		<state readOnly="true"/>


Provide a pattern?

lsiepel · 2025-12-23T22:47:40Z

bundles/org.openhab.binding.unifiaccess/src/main/resources/OH-INF/addon/addon.xml

+	<type>binding</type>
+	<name>UnifiAccess Binding</name>
+	<description>This is the binding for UnifiAccess.</description>
+


Can you add the connection tag ?

Does the controller announce itself on mDNS? Or any other mechanism that can be used for the binding suggestion finder ?

lsiepel · 2025-12-23T22:48:04Z

bundles/org.openhab.binding.unifiaccess/src/main/resources/OH-INF/addon/addon.xml

+
+	<type>binding</type>
+	<name>UnifiAccess Binding</name>
+	<description>This is the binding for UnifiAccess.</description>


Not wrong, but can use a better description.

digitaldan added 3 commits September 29, 2025 12:56

Unifi Access Binding

2684e0b

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

README updates

24c73ce

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Clean up

9f64358

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

digitaldan requested a review from a team as a code owner September 30, 2025 15:27

digitaldan changed the title ~~Unifi access~~ [unifiaccess] Unifi access binding initial contribution Sep 30, 2025

digitaldan marked this pull request as draft September 30, 2025 15:27

small cleanups

9aeea2e

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

wborn requested a review from Copilot October 1, 2025 06:38

Copilot AI reviewed Oct 1, 2025

View reviewed changes

lolodomo added the new binding If someone has started to work on a binding. For a new binding PR. label Oct 4, 2025

digitaldan added 5 commits October 16, 2025 09:21

Missing file

0655d63

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Lots of cleanup

dfadcbf

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

revert IDE formatting

b79ba7e

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

CLean up

0630b40

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Clean up

a01abb7

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

digitaldan requested a review from Copilot November 1, 2025 17:03

Copilot AI reviewed Nov 1, 2025

View reviewed changes

digitaldan added 2 commits November 1, 2025 10:23

co-pilot feedback

50cc5b8

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Small Cleanups

bd8bcd9

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

lsiepel requested changes Dec 23, 2025

View reviewed changes

	- Once the Bridge is ONLINE, Doors are discovered automatically and appear in the Inbox.
	- Once the `bridge` is ONLINE, `door`s are discovered automatically and appear in the Inbox.

		\| door-sensor \| Contact \| R \| Door position sensor. \|
		\| doorbell-contact \| Contact \| R \| Doorbell contact. \|

		![logo](doc/logo.png)

Uh oh!

Comments

Conversation

digitaldan commented Sep 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lsiepel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants