From 9ea0d12b0c72d6189d16e6e5bf47266d2259379c Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 5 Nov 2017 14:24:14 +0100 Subject: [PATCH] Camera (#3896) * Add 'whitelist_external_dirs' * Add 'whitelist_external_dirs' and update style --- source/_components/camera.markdown | 2 + source/_components/camera.rpi_camera.markdown | 58 +++++++++++++++---- 2 files changed, 49 insertions(+), 11 deletions(-) diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown index 48d1f58f5f0..23cb4f87c1a 100644 --- a/source/_components/camera.markdown +++ b/source/_components/camera.markdown @@ -43,6 +43,8 @@ Take a snapshot from a camera. | `entity_id` | no | Name(s) of entities to create a snopshot from, e.g., `camera.living_room_camera`. | | `filename ` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. | +The `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file. + ### {% linkable_title Test if it works %} A simple way to test if you have set up your `camera` platform correctly, is to use service developer tool icon **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_components/camera.rpi_camera.markdown b/source/_components/camera.rpi_camera.markdown index 7189dfd3d8a..6bfeb7696ea 100644 --- a/source/_components/camera.rpi_camera.markdown +++ b/source/_components/camera.rpi_camera.markdown @@ -24,17 +24,53 @@ camera: - platform: rpi_camera ``` -Configuration variables: - - - **name** (*Optional*): Name of the camera - - **image_width** (*Optional*): Set the image width (default: 640) - - **image_height** (*Optional*): Set the image height (default: 480) - - **image_quality** (*Optional*): Set the image quality (from 0 to 100, default: 7) - - **image_rotation** (*Optional*): Set image rotation (0-359, default: 0) - - **horizontal_flip** (*Optional*): Set horizontal flip (0 to disable, 1 to enable, default: 0) - - **vertical_flip** (*Optional*): Set vertical flip (0 to disable, 1 to enable, default: 0) - - **timelapse** (*Optional*): Takes a picture every ms (default: 1000) - - **file_path** (*Optional*): Save the picture in a custom file path (default: camera components folder) +{% configuration %} +image_width: + description: Set the image width. + required: false + default: 640 + type: int +name: + description: Name of the camera. + required: false + default: Raspberry Pi Camera + type: string +image_height: + description: Set the image height. + required: false + default: 480 + type: int +image_quality: + description: Set the image quality (from 0 to 100). + required: false + default: 7 + type: int +image_rotation: + description: Set image rotation (0-359). + required: false + default: 0 + type: int +horizontal_flip: + description: Set horizontal flip (0 to disable, 1 to enable). + required: false + default: 0 + type: int +vertical_flip: + description: Set vertical flip (0 to disable, 1 to enable). + required: false + default: 0 + type: int +timelapse: + description: Takes a picture every millisecond. + required: false + default: 1000 + type: int +file_path: + description: Save the picture in a custom file path. + required: false + default: The camera components folder. + type: string +{% endconfiguration %} The given **file_path** must be an existing file because the camera platform setup make a writeable check on it.