mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 07:16:47 +00:00
38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
---
|
|
layout: page
|
|
title: "Local File"
|
|
description: "Instructions how to use Local File as a Camera within Home Assistant."
|
|
date: 2016-06-12 17:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: file.png
|
|
ha_category: Camera
|
|
ha_iot_class: "Local Polling"
|
|
ha_release: 0.22
|
|
---
|
|
|
|
The `local_file` camera platform allows you to integrate any readable image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated.
|
|
|
|
This can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant.
|
|
|
|
To enable this camera in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
camera:
|
|
- platform: local_file
|
|
file_path: /tmp/image.jpg
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **file_path** (*Required*): File to serve as the camera.
|
|
- **name** (*Optional*): Name of the camera
|
|
|
|
<p class='note'>
|
|
The given `file_path` must be an existing file because the camera platform setup make a readable check on it.
|
|
</p>
|
|
|