https://github.com/garthdb/hubitat-unifi-access

Custom Hubitat driver for the Unifi Access lock via local API.
https://github.com/garthdb/hubitat-unifi-access

hubitat unifi unifi-access

Last synced: about 2 months ago
JSON representation

Custom Hubitat driver for the Unifi Access lock via local API.

• Host: GitHub
• URL: https://github.com/garthdb/hubitat-unifi-access
• Owner: GarthDB
• License: apache-2.0
• Created: 2023-08-31T05:00:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-29T20:32:10.000Z (11 months ago)
• Last Synced: 2024-11-29T15:53:21.472Z (about 2 months ago)
• Topics: hubitat, unifi, unifi-access
• Language: Groovy
• Homepage:
• Size: 85.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hubitat Unifi Access

Unifi recently released a [release candidate](https://community.ui.com/releases/UniFi-Access-Application-1-9-3/c8e99eba-397a-4431-8d7b-497da987b4b7) of Unifi Access which includes an Open API. This repo contains a Hubitat driver that is an initial attempt to control the lock via this local API.

## Installation

Use [Hubitat Package Manager](https://hubitatpackagemanager.hubitatcommunity.com/installPkg.html) by looking for Unifi Access.

### Manual installation

* Import raw driver code from [Unifi-Access-Lock.groovy](https://raw.githubusercontent.com/GarthDB/hubitat-unifi-access/main/drivers/Unifi-Access-Lock.groovy) file

* Create a new virtual device using the driver

* Update the preferences for the device:

  * "The API host address of the Unifi Access Controller (e.g. https://console-ip:12445)" is usually the API of the controller. See the Unifi Access Open API documentation for details on "Obtain Your Hostname". It should contain `https://` and the port (e.g., `:12445`).

  * "The API token for the Unifi Access Controller" can be generated in the Unifi Access App. It needs the correct permissions to unlock and view the lock status. See the Unifi Access Open API documentation for details on "Create API Token & Download API Documentation".

  * "The ID of the door to control" can be obtained using the Open API to get a list of available doors and their corresponding IDs. See the Unifi Access Open API documentation for details on "Fetch Devices".

## Capabilities

* Unlock door

* See door lock status

### Polling

Since the local Unifi Access API requires polling to check the status of the lock, it's recommended to use [Rule Machine](https://docs2.hubitat.com/apps/rule-machine) to refresh or poll the lock status every 2-3 seconds.

Here's an example of a rule I've tested:



## Future feature ideas:

Some functionality that should be possible in future releases; pull requests are welcome.

* Use the API to list doors and select the door ID from a dropdown.

* Add support for managing codes(?)

* Automate polling. Currently, something external to the driver is required to poll the API to check the status.

* Create a driver to check and handle doorbell (`access.remotecall.request`) events. Using this with Rule Machine could allow for setting up a 3rd party door chime.