Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update services.yaml files #10229

Merged
merged 2 commits into from Oct 30, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 20 additions & 24 deletions homeassistant/components/alarm_control_panel/services.yaml
@@ -1,65 +1,61 @@
alarm_disarm:
description: Send the alarm the command for disarm
# Describes the format for available alarm control panel services

alarm_disarm:
description: Send the alarm the command for disarm.
fields:
entity_id:
description: Name of alarm control panel to disarm
description: Name of alarm control panel to disarm.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to disarm the alarm control panel with
description: An optional code to disarm the alarm control panel with.
example: 1234

alarm_arm_home:
description: Send the alarm the command for arm home

description: Send the alarm the command for arm home.
fields:
entity_id:
description: Name of alarm control panel to arm home
description: Name of alarm control panel to arm home.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to arm home the alarm control panel with
description: An optional code to arm home the alarm control panel with.
example: 1234

alarm_arm_away:
description: Send the alarm the command for arm away

description: Send the alarm the command for arm away.
fields:
entity_id:
description: Name of alarm control panel to arm away
description: Name of alarm control panel to arm away.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to arm away the alarm control panel with
description: An optional code to arm away the alarm control panel with.
example: 1234

alarm_arm_night:
description: Send the alarm the command for arm night

description: Send the alarm the command for arm night.
fields:
entity_id:
description: Name of alarm control panel to arm night
description: Name of alarm control panel to arm night.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to arm night the alarm control panel with
description: An optional code to arm night the alarm control panel with.
example: 1234

alarm_trigger:
description: Send the alarm the command for trigger

description: Send the alarm the command for trigger.
fields:
entity_id:
description: Name of alarm control panel to trigger
description: Name of alarm control panel to trigger.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to trigger the alarm control panel with
description: An optional code to trigger the alarm control panel with.
example: 1234

envisalink_alarm_keypress:
description: Send custom keypresses to the alarm

description: Send custom keypresses to the alarm.
fields:
entity_id:
description: Name of the alarm control panel to trigger
description: Name of the alarm control panel to trigger.
example: 'alarm_control_panel.downstairs'
keypress:
description: 'String to send to the alarm panel (1-6 characters)'
description: 'String to send to the alarm panel (1-6 characters).'
example: '*71'
6 changes: 2 additions & 4 deletions homeassistant/components/automation/services.yaml
@@ -1,30 +1,28 @@
# Describes the format for available automation services

turn_on:
description: Enable an automation.

fields:
entity_id:
description: Name of the automation to turn on.
example: 'automation.notify_home'

turn_off:
description: Disable an automation.

fields:
entity_id:
description: Name of the automation to turn off.
example: 'automation.notify_home'

toggle:
description: Toggle an automation.

fields:
entity_id:
description: Name of the automation to toggle on/off.
example: 'automation.notify_home'

trigger:
description: Trigger the action of an automation.

fields:
entity_id:
description: Name of the automation to trigger.
Expand Down
12 changes: 7 additions & 5 deletions homeassistant/components/calendar/services.yaml
@@ -1,19 +1,21 @@
# Describes the format for available calendar services

todoist:
new_task:
description: Create a new task and add it to a project.
fields:
content:
description: The name of the task. [Required]
description: The name of the task (Required).
example: Pick up the mail
project:
description: The name of the project this task should belong to. Defaults to Inbox. [Optional]
description: The name of the project this task should belong to. Defaults to Inbox (Optional).
example: Errands
labels:
description: Any labels that you want to apply to this task, separated by a comma. [Optional]
description: Any labels that you want to apply to this task, separated by a comma (Optional).
example: Chores,Deliveries
priority:
description: The priority of this task, from 1 (normal) to 4 (urgent). [Optional]
description: The priority of this task, from 1 (normal) to 4 (urgent) (Optional).
example: 2
due_date:
description: The day this task is due, in format YYYY-MM-DD. [Optional]
description: The day this task is due, in format YYYY-MM-DD (Optional).
example: "2018-04-01"
18 changes: 7 additions & 11 deletions homeassistant/components/camera/services.yaml
@@ -1,29 +1,25 @@
# Describes the format for available camera services

enable_motion_detection:
description: Enable the motion detection in a camera

description: Enable the motion detection in a camera.
fields:
entity_id:
description: Name(s) of entities to enable motion detection
description: Name(s) of entities to enable motion detection.
example: 'camera.living_room_camera'

disable_motion_detection:
description: Disable the motion detection in a camera

description: Disable the motion detection in a camera.
fields:
entity_id:
description: Name(s) of entities to disable motion detection
description: Name(s) of entities to disable motion detection.
example: 'camera.living_room_camera'

snapshot:
description: Take a snapshot from a camera

description: Take a snapshot from a camera.
fields:
entity_id:
description: Name(s) of entities to disable motion detection
description: Name(s) of entities to create snapshots from.
example: 'camera.living_room_camera'

filename:
description: Template of a Filename. Variable is entity_id
description: Template of a Filename. Variable is entity_id.
example: '/tmp/snapshot_{{ entity_id }}'
94 changes: 32 additions & 62 deletions homeassistant/components/climate/services.yaml
@@ -1,132 +1,102 @@
set_aux_heat:
description: Turn auxiliary heater on/off for climate device
# Describes the format for available climate services

set_aux_heat:
description: Turn auxiliary heater on/off for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'

aux_heat:
description: New value of axillary heater
description: New value of axillary heater.
example: true

set_away_mode:
description: Turn away mode on/off for climate device

description: Turn away mode on/off for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'

away_mode:
description: New value of away mode
description: New value of away mode.
example: true

set_hold_mode:
description: Turn hold mode for climate device

description: Turn hold mode for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'

hold_mode:
description: New value of hold mode
example: 'away'

set_temperature:
description: Set target temperature of climate device

description: Set target temperature of climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'

temperature:
description: New target temperature for hvac
description: New target temperature for HVAC.
example: 25

target_temp_high:
description: New target high tempereature for hvac
description: New target high tempereature for HVAC.
example: 26

target_temp_low:
description: New target low temperature for hvac
description: New target low temperature for HVAC.
example: 20

operation_mode:
description: Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly.
example: 'Heat'

set_humidity:
description: Set target humidity of climate device

description: Set target humidity of climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'

humidity:
description: New target humidity for climate device
description: New target humidity for climate device.
example: 60

set_fan_mode:
description: Set fan operation for climate device

description: Set fan operation for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.nest'

fan_mode:
description: New value of fan mode
description: New value of fan mode.
example: On Low

set_operation_mode:
description: Set operation mode for climate device

description: Set operation mode for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.nest'

operation_mode:
description: New value of operation mode
description: New value of operation mode.
example: Heat


set_swing_mode:
description: Set swing operation for climate device

description: Set swing operation for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.nest'

swing_mode:
description: New value of swing mode
description: New value of swing mode.
example: 1

ecobee_set_fan_min_on_time:
description: Set the minimum fan on time

description: Set the minimum fan on time.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'

fan_min_on_time:
description: New value of fan min on time
description: New value of fan min on time.
example: 5

ecobee_resume_program:
description: Resume the programmed schedule

description: Resume the programmed schedule.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'

resume_all:
description: Resume all events and return to the scheduled program. This default to false which removes only the top event.
example: true