mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-04 17:26:50 +00:00

* 🔥 Removes octopress.js * 🔥 Removes use of root_url var * 🔥 Removes Octopress generator reference from feed * 🔥 Removes delicious support * 🔥 Removes support for Pinboard * 🔥 Removes support for Disqus * 🔥 Removes support for Google Plus * ↩️ Migrate custom after_footer to default template * ↩️ Migrate custom footer to default template * ↩️ Migrate custom header to default template * 🔥 Removes unused template files * 🚀 Places time to read directly in post template * 🚀 Removes unneeded capture from archive_post.html template * 🔥 🚀 Removes unused, but heaving sorting call in component page * 🚀 Merged javascripts into a single file * 🔥 Removes more uses of root_url * 🚀 Removal of unneeded captures from head * 🔥 🚀 Removal of expensive liquid HTML compressor * 🔥 Removes unneeded templates * 🚀 Replaces kramdown with GitHub's CommonMark 🚀 * 💄 Adds Prism code syntax highlighting * ✨ Adds support for redirect in Netlify * ↩️ 🔥 Let Netlify handle all developer doc redirects * ✏️ Fixes typo in redirects file: Netify -> Netlify * 🔥 Removes unused .themes folder * 🔥 Removes unused aside.html template * 🔥 Removes Disqus config leftover * 🔥 Removes rouge highlighter config * 🔥 Removes Octopress 🎉 * 💄 Adjust code block font size and adds soft wraps * 💄 Adds styling for inline code blocks * 💄 Improve styling of note/warning/info boxes + div support * 🔨 Rewrites all note/warning/info boxes
65 lines
2.0 KiB
Markdown
65 lines
2.0 KiB
Markdown
---
|
|
title: "UniFi Video Camera"
|
|
description: "Instructions on how to integrate UVC cameras within Home Assistant."
|
|
logo: ubiquiti.png
|
|
ha_category:
|
|
- Camera
|
|
ha_release: 0.13
|
|
ha_iot_class: Local Polling
|
|
redirect_from:
|
|
- /components/camera.uvc/
|
|
---
|
|
|
|
The `uvc` camera platform allows you to integrate [UniFi Video Camera (UVC)](https://www.ubnt.com/products/#unifivideo) 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 platform 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 enable, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
camera:
|
|
- platform: uvc
|
|
nvr: IP_ADDRESS
|
|
key: API_KEY
|
|
```
|
|
|
|
{% configuration %}
|
|
nvr:
|
|
description: The IP or hostname of the NVR (Network Video Recorder) server.
|
|
required: true
|
|
type: string
|
|
port:
|
|
description: The port number to use for accessing the NVR.
|
|
required: false
|
|
type: integer
|
|
default: 7080
|
|
key:
|
|
description: The API key available from the NVR web interface.
|
|
required: true
|
|
type: string
|
|
password:
|
|
description: The camera password.
|
|
required: false
|
|
type: string
|
|
default: ubnt
|
|
ssl:
|
|
description: Should use SSL/TLS to connect to the NVR.
|
|
required: false
|
|
type: boolean
|
|
default: false
|
|
{% endconfiguration %}
|
|
|
|
<div class='note'>
|
|
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.
|
|
</div>
|