home-assistant.io/source/_components/camera.onvif.markdown
karlkar ebc2094347 Support for PTZ in Onvif cameras (#4409)
* Service PTZ description

* Changed attribute names
2018-02-21 16:06:39 +01:00

1.7 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_release
page ONVIF Camera Instructions on how to integrate a ONVIF camera within Home Assistant. 2017-06-09 21:00 true false true true onvif.png Camera 0.47

The onvif camera platform allows you to use an ONVIF camera in Home Assistant. This requires the ffmpeg component to be already configured.

To enable your ONVIF camera in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
camera:
  - platform: onvif
    host: 192.168.1.111

Configuration variables:

  • host (Required): An IP or hostname of the camera.
  • name (Optional): Override the name of your camera.
  • username (Optional): The username for the camera.
  • password (Optional): The password for the camera.
  • port (Optional): The port for the camera. This defaults to 5000
  • extra_arguments (Optional): Extra options to pass to ffmpeg, e.g. image quality or video filter options. More details in FFmpeg component.

{% linkable_title Service camera.onvif_ptz %}

If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera.

Service data attribute Description
entity_id String or list of strings that point at entity_ids of cameras. Else targets all.
tilt Tilt direction. Allowed values: UP, DOWN
pan Pan direction. Allowed values: RIGHT, LEFT
zoom Zoom. Allowed values: ZOOM_IN, ZOOM_OUT

If you are running into trouble with this sensor, please refer to the Troubleshooting section.