2024.11.0
Home ▸ Integrations ▸

VIVOTEK

The VIVOTEK camera integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to integrate a VIVOTEK IP camera into Home Assistant.

Home Assistant will serve the images via its server, making it possible to view your IP cameras while outside of your network. The endpoint is /api/camera_proxy/camera.[name].

Configuration

To enable this camera in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry
camera:
  - platform: vivotek
    ip_address: IP_ADDRESS
    username: USERNAME
    password: PASSWORD

Configuration Variables

Looking for your configuration file?
ip_address string Required

The IP address of your camera, e.g., 192.168.1.2.

name string (Optional, default: VIVOTEK Camera)

This parameter allows you to override the name of your camera.

username string Required

The username for accessing your camera.

password string Required

The password for accessing your camera.

authentication string (Optional, default: basic)

Type for authenticating the requests basic or digest.

security_level string (Optional, default: admin)

The security level of the user accessing your camera. This could be admin or viewer.

ssl boolean (Optional, default: false)

Enable or disable SSL. Set to false to use an HTTP-only camera.

verify_ssl boolean (Optional, default: true)

Enable or disable SSL certificate verification. Set to false to use an HTTP-only camera, or you have a self-signed SSL certificate and haven’t installed the CA certificate to enable verification.

framerate integer (Optional, default: 2)

The number of frames-per-second (FPS) of the stream. Can cause heavy traffic on the network and/or heavy load on the camera.

stream_path string (Optional, default: live.sdp)

This parameter allows you to override the stream path.

Advanced configuration 

# Example configuration.yaml entry
camera:
  - platform: vivotek
    name: Front door camera
    ip_address: 192.168.1.2
    ssl: true
    username: !secret fd_camera_username
    password: !secret fd_camera_pwd
    authentication: digest
    security_level: admin
    verify_ssl: false
    framerate: 5
    stream_path: live2.sdp

Actions

Once loaded, the camera platform will expose actions that can be called to perform various actions.

Available actions: enable_motion_detection, disable_motion_detection, snapshot, and play_stream.

Action play_stream

Play a live stream from a camera to selected media player(s). Requires stream integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] to be set up.

Data attribute Optional Description
entity_id no Name of entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] to fetch stream from, e.g., camera.front_door_camera.
media_player no Name of media player to play stream on, e.g., media_player.living_room_tv.
format yes Stream format supported by stream integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] and selected media_player. Default: hls

For example, the following action in an automation would send an hls live stream to your chromecast.

actions:
  - action: camera.play_stream
    target:
      entity_id: camera.yourcamera
    data:
      media_player: media_player.chromecast

Action enable_motion_detection

Enable motion detection in a camera. Currently, this will enable the first event configured on the camera.

Data attribute Optional Description
entity_id yes Name(s) of entities to enable motion detection, e.g., camera.front_door_camera.

Action disable_motion_detection

Disable the motion detection in a camera. Currently, this will disable the first event configured on the camera.

Data attribute Optional Description
entity_id yes Name(s) of entities to disable motion detection, e.g., camera.front_door_camera.

Action snapshot

Take a snapshot from a camera.

Data attribute Optional Description
entity_id no Name(s) of entities to create a snapshot from, e.g., camera.front_door_camera.
filename no Template of a file name. Variable is entity_id, e.g., /tmp/snapshot_{{ entity_id }}.

The path part of filename must be an entry in the allowlist_external_dirs in your homeassistant: section of your configuration.yaml file.

For example, the following action is an automation that would take a snapshot from “front_door_camera” and save it to /tmp with a timestamped filename.

actions:
  - action: camera.snapshot
    target:
      entity_id: camera.front_door_camera
    data:
      filename: '/tmp/yourcamera_{{ now().strftime("%Y%m%d-%H%M%S") }}.jpg'

Related topics