ONVIF


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

Configuration

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

(string)(Required)

The IP address or hostname of the camera.

name

(string)(Optional)

Override the name of your camera.

Default value:

ONVIF Camera

username

(string)(Optional)

The username for the camera.

Default value:

admin

password

(string)(Optional)

The password for the camera.

Default value:

888888

port

(integer)(Optional)

The (HTTP) port for the camera.

Default value:

5000

profile

(integer)(Optional)

Video profile that will be used to obtain the stream, more details below.

Default value:

0

rtsp_transport

(string)(Optional)

RTSP transport protocols. The possible options are: tcp, udp, udp_multicast, http.

Default value:

tcp

extra_arguments

(string)(Optional)

Extra options to pass to ffmpeg, e.g., image quality or video filter options. More details in ffmpeg component.

Default value:

-q:v 2

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.

Service 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. Use entity_id: all to target all.
tilt Tilt direction. Allowed values: UP, DOWN, NONE
pan Pan direction. Allowed values: RIGHT, LEFT, NONE
zoom Zoom. Allowed values: ZOOM_IN, ZOOM_OUT, NONE
distance Distance coefficient. Sets how much PTZ should be executed in one request. Allowed values: floating point numbers, 0 to 1. Default : 0.1
speed Speed coefficient. Sets how fast PTZ will be executed. Allowed values: floating point numbers, 0 to 1. Default : 0.5
move_mode PTZ moving mode. Allowed values: ContinuousMove, RelativeMove, AbsoluteMove. Default :RelativeMove
continuous_duration Set ContinuousMove delay in seconds before stoping the move. Allowed values: floating point numbers or integer. Default : 0.5

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