2024.10.4
Home ▸ Integrations ▸

Ubiquiti UniFi Video

The uvc camera integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to integrate UniFi Video Camera (UVC) into Home Assistant.

The platform connects to the UniFi NVR software and automatically discovers/adds any camera connected to the NVR.

Setup

It is recommended that you create a new user for this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] in the NVR software and only give the user the permissions it need to operate.

  • The API key is found in User -> My account -> API Access in the NVR software.
  • The camera password is found in Settings -> Camera Settings -> Camera Password in the NVR software.

Configuration

To use the integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry
camera:
  - platform: uvc
    nvr: IP_ADDRESS
    key: API_KEY

Configuration Variables

Looking for your configuration file?
nvr string Required

The IP or hostname of the NVR (Network Video Recorder) server.

port integer (Optional, default: 7080)

The port number to use for accessing the NVR.

key string Required

The API key available from the NVR web interface.

password string (Optional, default: ubnt)

The camera password.

ssl boolean (Optional, default: false)

Should use SSL/TLS to connect to the NVR.

Important

When using an API_KEY to access cameras controlled by Ubiquiti’s NVR Software, the associated user account MUST have at least Administrator privileges within the NVR Software in order for new cameras to be added into Home Assistant. Once the entities have been created in Home Assistant, privileges for the user account can be lowered.

Related topics