2017-07-01 04:06:56 +00:00
# Describes the format for available camera services
2018-07-24 17:13:26 +00:00
turn_off :
description : Turn off camera.
fields :
entity_id :
description : Entity id.
example : 'camera.living_room'
turn_on :
description : Turn on camera.
fields :
entity_id :
description : Entity id.
example : 'camera.living_room'
2017-07-01 04:06:56 +00:00
enable_motion_detection :
2017-10-30 20:39:12 +00:00
description : Enable the motion detection in a camera.
2017-07-01 04:06:56 +00:00
fields :
entity_id :
2017-10-30 20:39:12 +00:00
description : Name(s) of entities to enable motion detection.
2017-07-01 04:06:56 +00:00
example : 'camera.living_room_camera'
disable_motion_detection :
2017-10-30 20:39:12 +00:00
description : Disable the motion detection in a camera.
2017-10-29 22:14:26 +00:00
fields :
entity_id :
2017-10-30 20:39:12 +00:00
description : Name(s) of entities to disable motion detection.
2017-10-29 22:14:26 +00:00
example : 'camera.living_room_camera'
snapshot :
2017-10-30 20:39:12 +00:00
description : Take a snapshot from a camera.
2017-07-01 04:06:56 +00:00
fields :
entity_id :
2017-10-30 20:39:12 +00:00
description : Name(s) of entities to create snapshots from.
2017-07-01 04:06:56 +00:00
example : 'camera.living_room_camera'
2017-10-29 22:14:26 +00:00
filename :
2017-10-30 20:39:12 +00:00
description : Template of a Filename. Variable is entity_id.
2017-10-29 22:14:26 +00:00
example : '/tmp/snapshot_{{ entity_id }}'
2018-02-18 16:08:56 +00:00
2019-03-12 02:57:10 +00:00
play_stream :
description : Play camera stream on supported media player.
fields :
entity_id :
description : Name(s) of entities to stream from.
example : 'camera.living_room_camera'
media_player :
description : Name(s) of media player to stream to.
example : 'media_player.living_room_tv'
format :
description : (Optional) Stream format supported by media player.
example : 'hls'
2019-03-28 04:47:07 +00:00
record :
description : Record live camera feed.
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.
example : '/tmp/snapshot_{{ entity_id }}.mp4'
duration :
2019-03-28 06:49:10 +00:00
description : (Optional) Target recording length (in seconds).
default : 30
2019-03-28 04:47:07 +00:00
example : 30
lookback :
description : (Optional) Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream.
example : 4
2018-02-18 16:08:56 +00:00
onvif_ptz :
description : Pan/Tilt/Zoom service for ONVIF camera.
fields :
entity_id :
description : Name(s) of entities to pan, tilt or zoom.
example : 'camera.living_room_camera'
pan :
description : "Direction of pan. Allowed values: LEFT, RIGHT."
example : 'LEFT'
tilt :
description : "Direction of tilt. Allowed values: DOWN, UP."
example : 'DOWN'
zoom :
description : "Zoom. Allowed values: ZOOM_IN, ZOOM_OUT"
example : "ZOOM_IN"