home-assistant.github.io/source/_components/camera.local_file.markdown
Paulus Schoutsen 1f40fdb09d 0.22 (#570)
* Initial snmp sensor docs (#538)

* Fixed markdown and added logo (#551)

* Added documentation for router operating mode for asuswrt (#545)

* local_file camera component documenatation (#554)

* Documenation for local_file camera component

* Update camera.local_file.markdown

* Added information about voltage sensor

* Instructions for Pandora media player (#552)

* Add release

* Add pub_key

* Add BT Home Hub docs

* Markdown tweaks (#553)

* Add docs about MySensors IR switch (#556)

* Update sensor.mysensors docs, about moving V_IR_SEND type to switch
  platform.
* Update switch.mysensors docs. Add section about the new service and
  additional example sketch for the IR switch device.

* Update index.html

* plex sensor (#526)

* Add var descriptions

* Adds documentation for the Local File Camera (#482)

* Revert "Adds documentation for the Local File Camera" (#563)

* Minor changes

* Add Wink Rollershutter (#559)

* Added example of using template in shell_command. (#547)

* Add Documentation for Netatmo Welcome (#542)

* Reorganize  documentation for Netatmo

As Netatmo is now a Hub component, documentations has been splitted in several
parts betweent the hub, the sensors and the camera

Signed-off-by: Hugo D. (jabesq) <jabesq@gmail.com>

* Add configuration variables for Netatmo Welcome cameras

* Add ha_release information on new documentation pages

* Netatmo Weather Station is a weather sensor

* Add blog post 0.22
2016-06-18 13:24:52 -07:00

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 periodacally 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
name: Local File
file_path: /tmp/image.jpg
```
Configuration variables:
- **name** (*Optional*): Name of the camera
- **file_path** (*Required*): File to serve as 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>