core/homeassistant/components/nest/services.yaml

91 lines
2.4 KiB
YAML
Raw Normal View History

2019-10-23 06:09:28 +00:00
# Describes the format for available Nest services
2018-11-30 15:31:35 +00:00
snapshot_event:
name: Take event snapshot
description: Take a snapshot from a camera for an event.
target:
entity:
integration: nest
domain: camera
fields:
nest_event_id:
name: Nest Event Id
description: The nest_event_id from the event to snapshot. Can be populated by an automation trigger for a 'nest_event' with 'data_template'.
required: true
selector:
text:
filename:
name: Filename
description: A filename where the snapshot for the event is written.
required: true
example: "/tmp/snapshot_my_camera.jpg"
selector:
text:
2019-10-23 06:09:28 +00:00
set_away_mode:
name: Set away mode
description: Set the away mode for a Nest structure. For Legacy API.
2018-11-30 15:31:35 +00:00
fields:
2019-10-23 06:09:28 +00:00
away_mode:
name: Away mode
description: New mode to set.
required: true
selector:
select:
options:
- 'away'
- 'home'
2019-10-23 06:09:28 +00:00
structure:
name: Structure
2019-10-23 06:09:28 +00:00
description: Name(s) of structure(s) to change. Defaults to all structures if not specified.
example: "Apartment"
selector:
object:
2019-10-23 06:09:28 +00:00
set_eta:
name: Set estimated time of arrival
description: Set or update the estimated time of arrival window for a Nest structure. For Legacy API.
2019-10-23 06:09:28 +00:00
fields:
eta:
name: ETA
2019-10-23 06:09:28 +00:00
description: Estimated time of arrival from now.
required: true
selector:
time:
2019-10-23 06:09:28 +00:00
eta_window:
name: ETA window
description: Estimated time of arrival window.
default: "00:01"
selector:
time:
2019-10-23 06:09:28 +00:00
trip_id:
name: Trip ID
2019-10-23 06:09:28 +00:00
description: Unique ID for the trip. Default is auto-generated using a timestamp.
example: "Leave Work"
selector:
text:
2019-10-23 06:09:28 +00:00
structure:
name: Structure
2019-10-23 06:09:28 +00:00
description: Name(s) of structure(s) to change. Defaults to all structures if not specified.
example: "Apartment"
selector:
object:
2019-10-23 06:09:28 +00:00
cancel_eta:
name: Cancel ETA
description: Cancel an existing estimated time of arrival window for a Nest structure. For Legacy API.
2019-10-23 06:09:28 +00:00
fields:
trip_id:
name: Trip ID
2019-10-23 06:09:28 +00:00
description: Unique ID for the trip.
required: true
2019-10-23 06:09:28 +00:00
example: "Leave Work"
selector:
text:
2019-10-23 06:09:28 +00:00
structure:
name: Structure
2019-10-23 06:09:28 +00:00
description: Name(s) of structure(s) to change. Defaults to all structures if not specified.
example: "Apartment"
selector:
object: