Document new wrapper for overlay options to rpi_camera (#13097)

* 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>
This commit is contained in:
alxrdn 2020-05-05 10:40:30 +02:00 committed by GitHub
parent 3c040bf1a7
commit f485411ae2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -8,7 +8,7 @@ ha_release: 0.17
ha_domain: rpi_camera
---
The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
The `rpi_camera` integration allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
## Configuration
@ -16,10 +16,12 @@ To enable this camera in your installation, add the following to your `configura
```yaml
# Example configuration.yaml entry
camera:
- platform: rpi_camera
rpi_camera:
```
The whole set of configuration variables is documented here [`Raspberry Pi Camera Module - Raspberry Pi Documentation`](https://www.raspberrypi.org/documentation/raspbian/applications/camera.md).
They are not all wrapped by this `rpi_camera` platform.
{% configuration %}
image_width:
description: Set the image width.
@ -61,6 +63,16 @@ timelapse:
required: false
type: integer
default: 1000
overlay_metadata:
description: Adds some text and/or metadata onto the picture. Check the [`--annotate`](https://www.raspberrypi.org/documentation/raspbian/applications/camera.md) section.
required: false
type: integer
default: none
overlay_timestamp:
description: Helper to add date/time onto the picture. Format as used by [`strftime`](http://man7.org/linux/man-pages/man3/strftime.3.html).
required: false
type: string
default: none
file_path:
description: Save the picture in a custom file path.
required: false