jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-26 02:37:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Extended documentation for proxy camera to include PR 18431 (#7491)

Browse Source 
* Extended documentation for proxy camera to include PR 18431

https://github.com/home-assistant/home-assistant/pull/18431

* Further refinements

* ✏️ Tweak
This commit is contained in:
Giuseppe 2018-12-05 09:02:46 +01:00 committed by Franck Nijhof
parent 0e5b9cd2ec
commit 4935d9d704
1 changed files with 34 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
source/_components/camera.proxy.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.65
The `proxy` camera platform allows you to pass another camera's output through post-processing routines and generate a new camera with the post-processed output. The `proxy` camera platform allows you to pass another camera's output through post-processing routines and generate a new camera with the post-processed output.
The current post-processing supports resizing the image/MJPEG as well as limiting the maximum refresh rate. The current post-processing supports resizing and/or cropping the image/MJPEG as well as limiting the maximum refresh rate.
The current proxy capabilities are intended to reduce the camera bandwidth for slower internet connections. The current proxy capabilities are intended to reduce the camera bandwidth for slower internet connections.
@ -39,14 +39,37 @@ name:
description: This parameter allows you to override the name of your camera. description: This parameter allows you to override the name of your camera.
required: false required: false
type: string type: string
mode:
description: The operating mode, either `resize` or `crop`.
required: false
type: string
default: resize
max_image_width: max_image_width:
description: The maximum width of single images taken from the camera (aspect ratio will be maintained). description: The maximum width of single images taken from the camera (aspect ratio will be maintained on resize processing).
required: false
type: integer
max_image_height:
description: The maximum height of single images taken from the camera, only used for crop operations. If not provided, the original height is assumed by default.
required: false required: false
type: integer type: integer
max_stream_width: max_stream_width:
description: The maximum width of the MJPEG stream from the camera (aspect ratio will be maintained). description: The maximum width of the MJPEG stream from the camera (aspect ratio will be maintained on resize processing).
required: false required: false
type: integer type: integer
max_stream_height:
description: The maximum height of the MJPEG stream from the camera, only used for crop operations. If not provided, the original height is assumed by default.
required: false
type: integer
image_top:
description: The top (y) coordinate to be used as a starting point for crop operations.
required: false
type: integer
default: 0
image_left:
description: The left (x) coordinate to be used as a starting point for crop operations.
required: false
type: integer
default: 0
image_quality: image_quality:
description: The quality level used for resulting JPEG for snapshots. description: The quality level used for resulting JPEG for snapshots.
required: false required: false
@ -73,7 +96,7 @@ cache_images:
## {% linkable_title Examples %} ## {% linkable_title Examples %}
Example of using a Camera proxy along with a Foscam camera: Example of using two Camera proxies along with a Foscam camera:
```yaml ```yaml
camera: camera:
@ -87,4 +110,11 @@ camera:
max_stream_width: 360 max_stream_width: 360
max_image_width: 480 max_image_width: 480
image_refresh_rate: 5.0 image_refresh_rate: 5.0
- platform: proxy
entity_id: camera.mycamera
name: My cropped camera
mode: crop
max_image_width: 480
max_image_height: 320
image_left: 100
``` ```