Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add minimal UniFi Access integration #135139

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

hagen93
Copy link

@hagen93 hagen93 commented Jan 8, 2025

Proposed change

Adds very minimal initial support or UniFi Access (only lock entities).

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @andreashagensjolvsagt

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant bot marked this pull request as draft January 8, 2025 21:16
@home-assistant
Copy link

home-assistant bot commented Jan 8, 2025

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@hagen93
Copy link
Author

hagen93 commented Jan 8, 2025

Hi! I've implemented a very bare bones UniFi Access lock integration based on the new(-ish) UniFi Access REST API. It can currently trigger an unlock and refreshes back to locked when notified by UniFi that the door has been reset back to locked. Locking is not implemented as unlocks in UniFi is mainly time based.

I've had a few stumbles with how the integration code is intended to be structured, but for now I've taken note of the following that might need changes before merge:

  • I've not found the indented way to start a background thread for a perpetual websocket, so my current implementation causes HA to never finish initialization (message on the bottom never disappears).
  • I've not been able to understand how tests are intended to be structured to ensure the integration plays nice with HA. I've gathered as much as one seems to be intended to initialize HA with the required integration components loaded and then orchestrate the test state, but I've not found reliable examples for how to do this for e.g. a coordinator or an entity class. I'm happy to improve this given some examples from other similar code, possibly with a quick line or two of explanation.

Cheers,
Andy

@bdraco
Copy link
Member

bdraco commented Jan 9, 2025

Since this is new, please use unifi_access for the naming.

Thanks

@andreashagensjolvsagt
Copy link

Since this is new, please use unifi_access for the naming.

Thanks

How about now? 🙂

@hagen93 hagen93 marked this pull request as ready for review January 11, 2025 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants