From ecb7c9704a57875ec1d37fc09223e77b5cc12964 Mon Sep 17 00:00:00 2001 From: Jason Hunter Date: Wed, 29 Apr 2020 17:24:28 -0400 Subject: [PATCH 1/2] update ONVIF docs --- source/_integrations/onvif.markdown | 46 +++++------------------------ 1 file changed, 8 insertions(+), 38 deletions(-) diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index 918ac0d02dc3..db9c1b065ea3 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -7,49 +7,19 @@ ha_release: 0.47 ha_domain: onvif --- -The `onvif` camera platform allows you to use an [ONVIF](https://www.onvif.org/) camera in Home Assistant. This requires the [`ffmpeg` component](/integrations/ffmpeg/) to be already configured. +The `onvif` camera platform allows you to use an [ONVIF](https://www.onvif.org/) Profile S conformant device in Home Assistant. This requires the [`ffmpeg` component](/integrations/ffmpeg/) to be already configured. ## Configuration -To enable your ONVIF camera in your installation, add the following to your `configuration.yaml` file: +Home Assistant offers UniFi integration through **Configuration** -> **Integrations** -> **ONVIF**. Follow the instructions to get it set up. -```yaml -# Example configuration.yaml entry -camera: - - platform: onvif - host: 192.168.1.111 -``` +
+ It is recommended that you create a user on your device specifically for Home Assistant. For all current functionality, it is enough to create a standard user. +
+ +You can configure specific FFPMEG options through the integration options flow by clicking the gear icon on the top right of the integration details page. {% configuration %} -host: - description: The IP address or hostname of the camera. - required: true - type: string -name: - description: Override the name of your camera. - required: false - type: string - default: ONVIF Camera -username: - description: The username for the camera. - required: false - type: string - default: admin -password: - description: The password for the camera. - required: false - type: string - default: 888888 -port: - description: The (HTTP) port for the camera. - required: false - type: integer - default: 5000 -profile: - description: Video profile that will be used to obtain the stream, more details below. - required: false - type: integer - default: 0 rtsp_transport: description: "RTSP transport protocols. The possible options are: `tcp`, `udp`, `udp_multicast`, `http`." required: false @@ -62,7 +32,7 @@ extra_arguments: default: -q:v 2 {% endconfiguration %} -Most of the ONVIF cameras support more than one audio/video profile. Each profile provides different image quality. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. One of the reasons may be that your hardware isn't able to render the highest quality image in real-time, especially when running on Raspberry Pi. Therefore you can choose which profile do you want to use by setting in configuration `profile` variable. +Most of the ONVIF devices support more than one audio/video profile. Each profile provides different image quality, or in the case of an NVR, separate connected cameras. This integration will add entities for all compatible profiles with the video encoding set to H254. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. You may disable unwanted entities through the Home Assistant UI. ### Service `onvif.ptz` From 816ccf0c4953b5377cf6208a6226a74e131e0ecf Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 30 Apr 2020 00:15:35 +0200 Subject: [PATCH 2/2] :pencil2: Tweaks --- source/_integrations/onvif.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index db9c1b065ea3..e4eb07e1b7e0 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -11,13 +11,13 @@ The `onvif` camera platform allows you to use an [ONVIF](https://www.onvif.org/) ## Configuration -Home Assistant offers UniFi integration through **Configuration** -> **Integrations** -> **ONVIF**. Follow the instructions to get it set up. +Home Assistant offers ONVIF integration through **Configuration** -> **Integrations** -> **ONVIF**. Follow the instructions to get it set up.
It is recommended that you create a user on your device specifically for Home Assistant. For all current functionality, it is enough to create a standard user.
-You can configure specific FFPMEG options through the integration options flow by clicking the gear icon on the top right of the integration details page. +You can configure specific FFmpeg options through the integration options flow by clicking the gear icon on the top right of the integration details page. {% configuration %} rtsp_transport: