Add selectors to Camera service definitions (#46630)

This commit is contained in:
Franck Nijhof 2021-02-18 12:24:04 +01:00 committed by GitHub
parent 9f3fdb1b68
commit dec2eb36fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,69 +1,89 @@
# Describes the format for available camera services
turn_off:
description: Turn off camera.
fields:
entity_id:
description: Entity id.
example: "camera.living_room"
description: Turn off camera
target:
turn_on:
description: Turn on camera.
fields:
entity_id:
description: Entity id.
example: "camera.living_room"
description: Turn on camera
target:
enable_motion_detection:
description: Enable the motion detection in a camera.
fields:
entity_id:
description: Name(s) of entities to enable motion detection.
example: "camera.living_room_camera"
description: Enable the motion detection in a camera
target:
disable_motion_detection:
description: Disable the motion detection in a camera.
fields:
entity_id:
description: Name(s) of entities to disable motion detection.
example: "camera.living_room_camera"
description: Disable the motion detection in a camera
target:
snapshot:
description: Take a snapshot from a camera.
description: Take a snapshot from a camera
target:
fields:
entity_id:
description: Name(s) of entities to create snapshots from.
example: "camera.living_room_camera"
filename:
name: Filename
description: Template of a Filename. Variable is entity_id.
required: true
example: "/tmp/snapshot_{{ entity_id.name }}.jpg"
selector:
text:
play_stream:
description: Play camera stream on supported media player.
description: Play camera stream on supported media player
target:
fields:
entity_id:
description: Name(s) of entities to stream from.
example: "camera.living_room_camera"
media_player:
name: Media Player
description: Name(s) of media player to stream to.
required: true
example: "media_player.living_room_tv"
selector:
entity:
domain: media_player
format:
description: (Optional) Stream format supported by media player.
name: Format
description: Stream format supported by media player.
default: "hls"
example: "hls"
selector:
select:
options:
- "hls"
record:
description: Record live camera feed.
description: Record live camera feed
target:
fields:
entity_id:
description: Name of entities to record.
example: "camera.living_room_camera"
filename:
description: Template of a Filename. Variable is entity_id. Must be mp4.
name: Filename
description: Template of a Filename. Variable is entity_id. Must be mp4.
required: true
example: "/tmp/snapshot_{{ entity_id.name }}.mp4"
selector:
text:
duration:
description: (Optional) Target recording length (in seconds).
name: Duration
description: Target recording length.
default: 30
example: 30
selector:
number:
min: 1
max: 3600
step: 1
unit_of_measurement: seconds
mode: slider
lookback:
description: (Optional) Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream.
name: Lookback
description:
Target lookback period to include in addition to duration. Only
available if there is currently an active HLS stream.
default: 0
example: 4
selector:
number:
min: 0
max: 300
step: 1
unit_of_measurement: seconds
mode: slider