Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.91 KB

README.md

File metadata and controls

75 lines (54 loc) · 2.91 KB
Raw

Mjpeg Timelapse integration for Home Assistant

Repository Stars Github Activity hacs_badge BuyMeCoffee

Description

Provides a simple camera platform that captures the image for playback. This is similar to the Generic IP Camera platform but captures and stores the image periodically to playback as a MJPEG video.

Installation

There are two ways this integration can be installed into Home Assistant.

The easiest way is to install the integration using HACS.

Alternatively, installation can be done manually by copying the files in this repository into the custom_components directory in the HA configuration directory:

  1. Open the configuration directory of your HA configuration.
  2. If you do not have a custom_components directory, you need to create it.
  3. In the custom_components directory create a new directory called mjpeg_timelapse.
  4. Copy all the files from the custom_components/mjpeg_timelapse/ directory in this repository into the mjpeg_timelapse directory.
  5. Restart Home Assistant
  6. Add the integration to Home Assistant (see Configuration)

Configuration

After you have installed the custom component (see above):

  1. Goto the Configuration -> Integrations page.
  2. On the bottom right of the page, click on the + Add Integration sign to add an integration.
  3. Search for Mjpeg Timelapse. (If you don't see it, try refreshing your browser page to reload the cache.)
  4. Click Submit so add the integration.

Alternatively, you can add entries in your configuration.yaml file.

camera:
  - platform: mjpeg_timelapse
    image_url: http://example.com/foobar.gif
    name: Example
    fetch_interval: 30
    max_frames: 10
    framerate: 3
    quality: 50
    loop: false
    headers:
      X-Custom-Header: Some Value

Configuration Variables

image_url

  • (string)(Required)The URL of the image.

name

  • (string)(Optional)The name of the entity.

fetch_interval

  • (integer)(Optional)The time interval in seconds between fetching the image. Default is 60 seconds.

max_frames

  • (integer)(Optional)The number of frames to keep. Default is 100.

framerate

  • (integer)(Optional)The playback framerate of the timelapse. Default is 2.

quality

  • (integer)(Optional)The image quality between 1 and 100. Default is 75.

loop

  • (boolean)(Optional)Loop the playback of the timelapse. Default is true.

headers

  • (boolean)(Optional)Additional headers to the image request.