From f485411ae2f8437a0c3169f9ebec414038d221c8 Mon Sep 17 00:00:00 2001 From: alxrdn Date: Tue, 5 May 2020 10:40:30 +0200 Subject: [PATCH] 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 --- source/_integrations/rpi_camera.markdown | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/source/_integrations/rpi_camera.markdown b/source/_integrations/rpi_camera.markdown index 9a690faa564..292a603ab40 100644 --- a/source/_integrations/rpi_camera.markdown +++ b/source/_integrations/rpi_camera.markdown @@ -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