Skip to content
This repository has been archived by the owner on Aug 26, 2022. It is now read-only.

Latest commit

 

History

History
70 lines (62 loc) · 3.39 KB

unifiprotect.markdown

File metadata and controls

70 lines (62 loc) · 3.39 KB
title description ha_category ha_release ha_iot_class ha_config_flow ha_quality_scale ha_codeowners ha_domain ha_ssdp ha_platforms
Ubiquiti UniFi Protect
Instructions on how to configure UniFi Protect integration by Ubiquiti.
Hub
Camera
Light
Number
Sensor
Select
Switch
2021.11
Local Push
true
platinum
@briis
unifiprotect
true
camera
binary_sensor
sensor
light
switch
select
number

The UniFi Protect Integration by Ubiquiti Networks, inc., adds support for retrieving Camera feeds and Sensor data from a UniFi Protect installation on either a Ubiquiti CloudKey+, Ubiquiti UniFi Dream Machine Pro or UniFi Protect Network Video Recorder.

There is support for the following device types within Home Assistant:

  • Camera
    • A camera entity for each camera found on the NVR device will be created
  • Sensor
    • A sensor for each camera found will be created. This sensor will hold the current recording mode.
    • A sensor for each Floodlight device found will be created. This sensor will hold the status of when light will turn on.
  • Binary Sensor
    • One to two binary sensors will be created per camera found. There will always be a binary sensor recording if motion is detected per camera. If the camera is a doorbell, there will also be a binary sensor created that records if the doorbell is pressed.
  • Switch
    • For each camera supporting High Dynamic Range (HDR) a switch will be created to turn this setting on or off.
    • For each camera supporting High Frame Rate recording a switch will be created to turn this setting on or off.
    • For each camera a switch will be created to turn the status light on or off.
  • Light
    • A light entity will be created for each UniFi Floodlight found. This works as a normal light entity, and has a brightness scale also.
  • Select
    • For each Camera found there will be a Select entity created from where you can set the cameras recording mode.
    • For each Doorbell found, there will be a Select entity created that makes it possible to set the LCD Text. If you make a list of Texts in the Integration configuration, you can both set the standard texts and custom text that you define here.
    • For each Camera found there will be a Select entity created from where you can set the behavior of the Infrared light on the Camera
    • For each Viewport found, there will be a Select entity from where you change the active View being displayed on the Viewport.
    • For each Floodlight device there be a Select entity to set the behavior of the built-in motion sensor.
  • Number
    • For each camera supporting WDR, a number entity will be setup to set the active value.
    • For each camera a number entity will be created from where you can set the microphone sensitivity level.
    • For each camera supporting Optical Zoom, a number entity will be setup to set the zoom position.

{% include integrations/config_flow.md %}

Hardware

This Integration supports all Ubiquiti Hardware that can run UniFi Protect. Currently this includes:

  • UniFi Protect Network Video Recorder (UNVR)
  • UniFi Dream Machine Pro (UDMP)
  • UniFi Cloud Key Gen2 Plus (CKGP) Minimum required Firmware version is 2.0.24 Below that this Integration will not run on a CloudKey+

Software Versions

  • UniFi Protect minimum version is 1.20.0
  • Home Assistant minimum version is 2021.9.0