From 3a7d05363ef38f379219e784d4c705064189778c Mon Sep 17 00:00:00 2001 From: Anton-Juul-Naber Date: Thu, 7 Jun 2018 17:18:52 +0200 Subject: [PATCH] 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. --- source/_components/camera.uvc.markdown | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/source/_components/camera.uvc.markdown b/source/_components/camera.uvc.markdown index 02743bda453..a63284099c0 100644 --- a/source/_components/camera.uvc.markdown +++ b/source/_components/camera.uvc.markdown @@ -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. + +

+This component uses an unsupported API, so it might break at any time. +

+ +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.