UniFi Network for Home Assistant (built-in integration)

About

UniFi Network is a built-in integration that connects Home Assistant to a Ubiquiti UniFi Network controller over the local network. It creates device tracker entities for network clients and for Ubiquiti devices, with options to limit tracking to chosen SSIDs, include wired clients, and set how long a client can go unseen before it counts as away. Entities cover buttons, images, lights, sensors, switches and updates, including bandwidth, uptime, CPU, memory, temperature, PoE power and link speed readings. Switches can block clients, control PoE ports, and manage DPI restriction groups. Actions can ask a wireless client to reconnect or remove clients that were only briefly associated with the controller. It is set up in the interface with the controller address and a local user, and new devices appear without repeating setup.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Adds new devices New devices show up without setting it up again.
Change settings later Its connection settings can change without removing it.
Silver quality Home Assistant's own rating of its code and setup experience.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Lights
Switches
Sensors
Presence

Setting it up

It is added under Settings, Devices and services, with Add integration.

Set up UniFi Network

HostHostname or IP address of your UniFi Network.
PasswordThe password of the local UniFi Network user.
PortThe port your UniFi Network is running on.
Site ID
UsernameThe username of the local UniFi Network user.
Verify SSL certificateWhether to verify the SSL certificate of the UniFi Network.

Also asked when changing the connection.

Site

Site IDThe site ID of the UniFi Network site to manage.

After setup

Network access controlled clientsSelect clients whose network access you want to control via switches.
Track network clientsCreate device tracker entities for network clients.
Track network devices (Ubiquiti devices)Create device tracker entities for Ubiquiti network devices.
Bandwidth usage sensors for network clientsCreate bandwidth usage sensors for network clients.
Uptime sensors for network clientsCreate uptime sensors for network clients.
Create entities from network clientsSelect which network clients to create entities from.
Time in seconds from last seen until considered awayNumber of seconds since last seen before a client is considered away.
Allow control of DPI restriction groupsEnable switches to control DPI restriction groups.
Ignore Wi-Fi clients with private (e.g. randomized) MAC addressesDon't create entities for Wi-Fi clients whose MAC is locally administered (e.g. private/randomized Wi-Fi addresses). Wired clients are unaffected. Clients in "Create entities from network clients" are still included.
Disable UniFi Network wired bug logicDisable workaround for a UniFi Network bug that sometimes reports wired clients as wireless.
Select SSIDs to track wireless clients onOnly track wireless clients connected to selected SSIDs.
Include wired network clientsInclude wired clients in device tracking.

Texts from Home Assistant's source code, Apache License 2.0.

Entities

ButtonsPower cycle, Regenerate password
ImagesQR code
LightsLED
SensorsRX, TX, Clients, CPU utilization, Memory utilization, State, Temperature, Uplink MAC, Outlet power, Link speed, PoE power, AC power budget, and 9 more
SwitchesBlocked, PoE, Enabled

Actions

Reconnect wireless clientTries to get wireless client to reconnect to UniFi Network.Fields: Device
Remove clients from the UniFi NetworkCleans up clients that have only been associated with the controller for a short period of time.