f485411ae2
* document new wrapper for overlay options to rpi_camera * Move yaml configuration to rpi_camera key * Remove optional parameters from yaml config example * Minor changes Co-authored-by: Fabian Affolter <mail@fabian-affolter.ch>
2.6 KiB
title, description, ha_category, ha_iot_class, ha_release, ha_domain
| title | description | ha_category | ha_iot_class | ha_release | ha_domain | |
|---|---|---|---|---|---|---|
| Raspberry Pi Camera | Instructions on how to integrate Raspberry Pi within Home Assistant. |
|
Local Polling | 0.17 | rpi_camera |
The rpi_camera integration allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application raspistill to store the image from camera.
Configuration
To enable this camera in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
rpi_camera:
The whole set of configuration variables is documented here Raspberry Pi Camera Module - Raspberry Pi Documentation.
They are not all wrapped by this rpi_camera platform.
{% configuration %}
image_width:
description: Set the image width.
required: false
type: integer
default: 640
name:
description: Name of the camera.
required: false
type: string
default: Raspberry Pi Camera
image_height:
description: Set the image height.
required: false
type: integer
default: 480
image_quality:
description: Set the image quality (from 0 to 100).
required: false
type: integer
default: 7
image_rotation:
description: Set image rotation (0-359).
required: false
type: integer
default: 0
horizontal_flip:
description: Set horizontal flip (0 to disable, 1 to enable).
required: false
type: integer
default: 0
vertical_flip:
description: Set vertical flip (0 to disable, 1 to enable).
required: false
type: integer
default: 0
timelapse:
description: Takes a picture every this many milliseconds (thousands of a second) - the default means one picture a second.
required: false
type: integer
default: 1000
overlay_metadata:
description: Adds some text and/or metadata onto the picture. Check the --annotate section.
required: false
type: integer
default: none
overlay_timestamp:
description: Helper to add date/time onto the picture. Format as used by strftime.
required: false
type: string
default: none
file_path:
description: Save the picture in a custom file path.
required: false
type: string
default: A temporary file is used.
{% endconfiguration %}
The given file_path must be an existing file because the camera platform setup performs a writeable check on it. Also, keep in mind that the path should be whitelisted.