UniFi Protect for Home Assistant (built-in integration)

About

UniFi Protect is a built-in integration that connects Home Assistant to Ubiquiti UniFi Protect cameras and related devices over the local network. It adds cameras, lights, a speaker, a siren, sensors, switches, number and select controls, buttons, and event entities for things like doorbell rings, motion, fingerprint, NFC and smart detections. Many binary sensors and switches cover detection types such as animals, baby cries, barking, car horns and alarm sounds. Actions can add or remove doorbell messages, move a PTZ camera to a saved preset, remove a privacy zone, pair doorbells with a smart chime, and fetch user keyring details. Setup is done in the UI with either an API key from the UniFi OS Console or a local user account, and the API key mode leaves out some entities that need a local user. Options allow disabling the RTSP stream, enabling realtime metrics, and limiting how many events the Media Browser loads.

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.
Cleans up devices Devices that are gone are removed by themselves.
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

Lights
Cameras
Alarms
Media
Switches
Sensors

Setting it up

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

UniFi Protect setup (API key)

API keyAPI key from your UniFi OS Console. Only the public Integration API is used; some entities that require a local user are unavailable in this mode.
HostHostname or IP address of your UniFi Protect device.
PortPort of your UniFi Protect device.
Verify SSL certificateVerify SSL certificate of the UniFi Protect device.

Also asked when changing the connection.

UniFi Protect discovered (API key)

API keyAPI key from your UniFi OS Console. Only the public Integration API is used; some entities that require a local user are unavailable in this mode.
PortPort of your UniFi Protect device.

UniFi Protect discovered (local user)

API keyAPI key for your local user account.
PasswordPassword for your local user account.
PortPort of your UniFi Protect device.
UsernameUsername for your local (not cloud) user account.
Verify SSL certificateVerify SSL certificate of the UniFi Protect device.

UniFi Protect setup (local user)

API keyAPI key for your local user account.
HostHostname or IP address of your UniFi Protect device.
PasswordPassword for your local user account.
PortPort of your UniFi Protect device.
UsernameUsername for your local (not cloud) user account.
Verify SSL certificateVerify SSL certificate of the UniFi Protect device.

Reauth UniFi Protect (API key)

API keyAPI key from your UniFi OS Console. Only the public Integration API is used; some entities that require a local user are unavailable in this mode.

Reauth UniFi Protect

API keyAPI key for your local user account. Leave empty to keep your existing API key.
PasswordPassword for your local user account. Leave empty to keep your existing password.
UsernameUsername for your local (not cloud) user account.

Reconfigure UniFi Protect (local user)

API keyAPI key for your local user account. Leave empty to keep your existing API key.
HostHostname or IP address of your UniFi Protect device.
PasswordPassword for your local user account. Leave empty to keep your existing password.
PortPort of your UniFi Protect device.
UsernameUsername for your local (not cloud) user account.
Verify SSL certificateVerify SSL certificate of the UniFi Protect device.

After setup

Realtime metrics (WARNING: Greatly increases CPU usage)Enable realtime metrics updates. Only use if you have enabled diagnostic sensors and want them updated in realtime.
Disable the RTSP streamDisable the RTSP stream for all cameras. Use this if you don't need live video feeds.
Max number of event to load for Media Browser (increases RAM usage)Maximum number of events to load in the Media Browser. Higher values use more RAM.
Override connection hostOverride the connection host for the UniFi Protect device.

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

Entities

AlarmsAlarm Manager
Binary sensorsAlarm sound detection, Animal detected, Audio object detected, Baby cry detected, Barking detected, Car alarm detected, Car horn detected, CO alarm detected, Contact, and 42 more
ButtonsAdopt device, Clear tamper, Play buzzer, Play chime, Unadopt device
EventsDoorbell, Fingerprint, Button, Motion detection, NFC, Package, Smart detection, Sound detection, Vehicle
MediaSpeaker
NumbersAuto-shutoff duration, Chime duration, Doorbell ring volume, Infrared custom lux trigger, Microphone level, Motion sensitivity, System sounds volume, Volume, Wide dynamic range, and 1 more
SelectsChime type, Doorbell text, HDR mode, Infrared mode, Light mode, Liveview, Mount type, Alarm profile, Paired camera, and 2 more
SensorsAlarm sound detected, Bluetooth signal strength, Chime type, CPU temperature, CPU utilization, Disk write rate, Doorbell text, Status, and 33 more
SwitchesAlarm sound detection, Analytics enabled, Color night vision, Animal detection, Baby cry detection, Barking detection, Car alarm detection, Car horn detection, and 26 more
TextsDoorbell

Actions

Add doorbell textAdds a new custom message for doorbells.Fields: UniFi Protect NVR, Custom message
Get user keyring infoFetches a detailed list of users with NFC and fingerprint associations for automations.Fields: UniFi Protect NVR
PTZ go to presetMoves a PTZ camera to a saved preset position.Fields: Camera, Preset
Remove doorbell textRemoves an existing custom message for doorbells.Fields: UniFi Protect NVR, Custom message
Remove privacy zoneRemoves a privacy zone from a camera.Fields: Camera, Privacy zone
Set chime paired doorbellsPairs doorbell(s) with a smart chime.Fields: Chime, Doorbells

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Ubiquiti Cloud Users are not Supported, HDR Mode switch deprecated, Insecure camera entity removed, Package binary sensor removed, Read-only sensor setting entity deprecated