Ubiquiti airOS for Home Assistant (built-in integration)

About

Ubiquiti airOS is a built-in integration that connects Home Assistant to Ubiquiti airOS wireless devices over the local network. It adds binary sensors, sensors, buttons and update entities for each device. Sensors cover CPU load, uptime, antenna gain, wireless distance, SSID, frequency, mode and role, plus download and upload capacity and the remote hostname. Binary sensors report states such as the DHCP client and server, port forwarding and the PPPoE link. Home Assistant can discover the device on the network and offer to add it, and setup is done in the UI with the device address, username and password, plus options for HTTPS and certificate checking. Connection settings can be changed later without removing the device, and a diagnostics file can be downloaded for bug reports.

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.
Found by itself Home Assistant spots it on the network and offers to add it.
Change settings later Its connection settings can change without removing it.
Platinum 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

Sensors

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Enter the address

HostIP address or hostname of the airOS device
PasswordPassword configured through the UISP app or web interface
UsernameAdministrator username for the airOS device, normally 'ubnt'
Use HTTPSWhether the connection should be encrypted (required for most devices)
Verify SSL certificateWhether the certificate should be verified when using HTTPS. This should be off for self-signed certificates

Configure device

PasswordPassword configured through the UISP app or web interface
UsernameAdministrator username for the airOS device, normally 'ubnt'
Use HTTPSWhether the connection should be encrypted (required for most devices)
Verify SSL certificateWhether the certificate should be verified when using HTTPS. This should be off for self-signed certificates

Choose a device

Select the device to configureSelect the device MAC address

Sign in again

PasswordPassword configured through the UISP app or web interface

Change the connection

PasswordPassword configured through the UISP app or web interface
Use HTTPSWhether the connection should be encrypted (required for most devices)
Verify SSL certificateWhether the certificate should be verified when using HTTPS. This should be off for self-signed certificates

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

Entities

Binary sensorsDHCPv6 server, DHCP client, DHCP server, Port forwarding, PPPoE link
SensorsCPU load, Network role, Uptime, Antenna gain, Wireless distance, Wireless SSID, Wireless frequency, Wireless mode, Download capacity, Upload capacity, Remote hostname, Wireless role, and 2 more