Improved documentation (#5503)

Added a few details that helps the user understand how the component works, and how to set it up. I was confused myself, so i thought i would help others.
Also fixed the broken link.
This commit is contained in:
Anton-Juul-Naber 2018-06-07 17:18:52 +02:00 committed by Fabian Affolter
parent 774a166fed
commit 3a7d05363e

View File

@ -14,9 +14,15 @@ ha_iot_class: "Local Polling"
---
The `uvc` component allows you to integrate [UniFi Video Camera (UVC)](https://www.ubnt.com/unifi-video/unifi-video-camera/) into Home Assistant.
The `uvc` component allows you to integrate [UniFi Video Camera (UVC)](https://www.ubnt.com/products/#unifivideo) into Home Assistant.
To enable a UVC camera in your installation, add the following to your `configuration.yaml` file:
The component connects to the Unifi NVR software and automatically discovers/adds any camera connected to the NVR.
<p class='note warning'>
This component uses an unsupported API, so it might break at any time.
</p>
To enable, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -30,5 +36,11 @@ Configuration variables:
- **nvr** (*Required*): The IP or hostname of the NVR (Network Video Recorder) server.
- **key** (*Required*): The API key available from the NVR web interface.
- **port** (*Optional*): The port number to use for accessing the NVR.
- **port** (*Optional*): The port number to use for accessing the NVR. Default is `7080`.
- **password** (*Optional*): The camera password. Defaults to `ubnt` if not given.
It is recommended that you create a new user for this component in the NVR software, and only give the user the permissions it need to operate.
The API-key is found in the specific users `API Access` tab in the NVR software.
The camera password is found in `Settings` -> `Camera Settings` -> `Camera Password` in the NVR software.