Ubiquiti Unifi WAP


This platform allows you to detect presence by looking at devices connected to a Ubiquiti Unifi controller.

To use this device tracker in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
device_tracker:
  - platform: unifi
    host: unifi
    username: username
    password: password
    ssid_filter:
      - 'HomeSSID'
      - 'IoTSSID'

Configuration Variables

username

(string)(Required)A user on the controller

password

(string)(Required)The password for the account

host

(string)(Optional)The hostname or IP address of your controller

Default value: localhost

port

(int)(Optional)The port of your controller’s web interface

Default value: 8443

site_id

(string)(Optional)For multisite installations, you can specify site_id to specify which is used

Default value: default

verify_ssl

(boolean or filename)(Optional)Whether to do strict validation on SSL certificates of the Unifi controller. This can be true/false or the path to a locally trusted certificate to use for verification (i.e. “/path/to/custom_cert.pm”)

Default value: true

detection_time

(int)(Optional)How long since the last seen time before the device is marked away, specified in seconds.

Default value: 300

ssid_filter

(list of strings)(Optional)Filter the SSIDs that tracking will occur on.

Default value: None

See the device tracker component page for instructions how to configure the people to be tracked.

Configuring Users

The Unifi controller allows you to create multiple users on it besides the main administrator. It is recommended that you create a limited user that has read-only permissions for the Unifi device tracker.

Conflicts with MQTT

The Unifi controller can either be a dedicated hardware device (Unifi’s cloud key), or as software any Linux system. If you run the the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT component as well.

It is recommended that you run the Unifi controller in a dedicated virtual machine to avoid that situation.

Troubleshooting and Time Synchronization

Presence detection depends on accurate time configuration between Home Assistant and the Unifi controller.

If Home Assistant and the Unifi controller are running on separate machines or VMs ensure that all clocks are syncronized. Failing to have syncronized clocks will lead to Home Assistant failing to mark a device as home.

Related Issue