Double Take

If you are using a Home Assistant Add-on, you can use the Home Assistant secrets.yaml file to store sensitive information like MQTT passwords or API keys using the !secret tag.

Example usage in config.yml:

mqtt:
  password: !secret mqtt_password

detectors:
  compreface:
    key: !secret compreface_key

Corresponding entry in secrets.yaml:

mqtt_password: <password>
compreface_key: <api-key>

mqtt:
  host: localhost
  username: mqtt
  password: !secret mqtt_password

detectors:
  compreface:
    url: localhost:8000
    key: !secret compreface_key

You can deploy Double Take using Docker Compose. The following configuration sets up the service with a persistent volume for storage and exposes the UI/API on port 3000.

version: '3.7'

volumes:
  double-take:

services:
  double-take:
    container_name: double-take
    image: jakowenko/double-take
    restart: unless-stopped
    volumes:
      - double-take:/.storage
    ports:
      - 3000:3000

To develop on Double Take, you can run the services using Docker containers.

Available Services:

• UI: localhost:8080
• API: localhost:3000
• MQTT: localhost:1883

Commands:

• Start development containers: ./.develop/docker up
• Remove development containers: ./.develop/docker down
• Build local image: ./.develop/build

# start development containers
./.develop/docker up

# remove development containers
./.develop/docker down

Double Take configuration is stored in /.storage/config/config.yml. You can edit these settings directly in the file or via the web UI at http://localhost:3000/config.

Note: You only need to specify values that differ from the default settings.

Use the cameras block to define settings for specific cameras. You can apply masks to ignore certain areas or override global detection settings for that specific camera.

Masks:

• coordinates: A list of x,y coordinates defining the polygon.
• visible: If true, shows the mask on the final saved image (useful for debugging).
• size: The camera stream size used for resizing masks (e.g., 1920x1080).

cameras:
  front-door:
    # masks:
    #   coordinates:
    #     - 1920,0,1920,328,1638,305,1646,0
    #   visible: false
    #   size: 1920x1080
    # detect:
    #   match:
    #     save: true
    #     base64: false
    #     confidence: 60
    #     min_area: 10000
    #   unknown:
    #     save: true
    #     base64: false
    #     confidence: 40
    #     min_area: 0
    # snapshot:
    #   topic:
    #   url:

Use the mqtt block to enable subscribing to and publishing to MQTT topics. This is used for Frigate event subscriptions, Home Assistant discovery, and publishing matches.

Key configuration options include:

• host, username, password, client_id
• tls: For secure connections using cert, key, and ca files.
• topics:
  • frigate: Topic for Frigate message subscription (default: frigate/events).
  • homeassistant: Topic for Home Assistant discovery (default: homeassistant).
  • matches: Topic where matches are published by name (default: double-take/matches).
  • cameras: Topic where matches are published by camera name (default: double-take/cameras).

Double Take publishes results to specific MQTT topics. You must configure the mqtt.host to enable this.

Key topics include:

• double-take/matches/<name>: Publishes match details for a specific subject.
• double-take/cameras/<camera>: Publishes camera-specific event data.
• double-take/cameras/<camera>/person: Publishes the number of persons detected (resets to 0 after 30 seconds).
• double-take/errors: Publishes API errors.

mqtt:
  host: localhost

The notify.gotify block allows you to send notifications via Gotify.

• url: Gotify server URL.
• token: Gotify application token.
• priority: Notification priority (e.g., 5).
• cameras: List of specific cameras to notify from.
• zones: List of specific zones to notify from (e.g., camera: garage, zone: driveway).

notify:
  gotify:
    url: ""
    token: ""
    priority: 5
    # cameras:
    #   - front-door
    # zones:
    #   - camera: garage
    #     zone: driveway