Add targets and selectors to services (A) (#49818)

This commit is contained in:
tkdrob 2021-05-08 20:21:00 -04:00 committed by GitHub
parent 6665a62557
commit e92516c072
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 294 additions and 40 deletions

View File

@ -1,21 +1,46 @@
capture_image: capture_image:
name: Capture image
description: Request a new image capture from a camera device. description: Request a new image capture from a camera device.
fields: fields:
entity_id: entity_id:
name: Entity
description: Entity id of the camera to request an image. description: Entity id of the camera to request an image.
required: true
example: camera.downstairs_motion_camera example: camera.downstairs_motion_camera
selector:
entity:
integration: abode
domain: camera
change_setting: change_setting:
name: Change setting
description: Change an Abode system setting. description: Change an Abode system setting.
fields: fields:
setting: setting:
name: Setting
description: Setting to change. description: Setting to change.
required: true
example: beeper_mute example: beeper_mute
selector:
text:
value: value:
name: Value
description: Value of the setting. description: Value of the setting.
required: true
example: "1" example: "1"
selector:
text:
trigger_automation: trigger_automation:
name: Trigger automation
description: Trigger an Abode automation. description: Trigger an Abode automation.
fields: fields:
entity_id: entity_id:
name: Entity
description: Entity id of the automation to trigger. description: Entity id of the automation to trigger.
required: true
example: switch.my_automation example: switch.my_automation
selector:
entity:
integration: abode
domain: switch

View File

@ -1,37 +1,66 @@
add_url: add_url:
name: Add url
description: Add a new filter subscription to AdGuard Home. description: Add a new filter subscription to AdGuard Home.
fields: fields:
name: name:
name: Name
description: The name of the filter subscription. description: The name of the filter subscription.
required: true
example: Example example: Example
selector:
text:
url: url:
name: Url
description: The filter URL to subscribe to, containing the filter rules. description: The filter URL to subscribe to, containing the filter rules.
required: true
example: https://www.example.com/filter/1.txt example: https://www.example.com/filter/1.txt
selector:
text:
remove_url: remove_url:
name: Remove url
description: Removes a filter subscription from AdGuard Home. description: Removes a filter subscription from AdGuard Home.
fields: fields:
url: url:
name: Url
description: The filter subscription URL to remove. description: The filter subscription URL to remove.
required: true
example: https://www.example.com/filter/1.txt example: https://www.example.com/filter/1.txt
selector:
text:
enable_url: enable_url:
name: Enable url
description: Enables a filter subscription in AdGuard Home. description: Enables a filter subscription in AdGuard Home.
fields: fields:
url: url:
name: Url
description: The filter subscription URL to enable. description: The filter subscription URL to enable.
required: true
example: https://www.example.com/filter/1.txt example: https://www.example.com/filter/1.txt
selector:
text:
disable_url: disable_url:
name: Disable url
description: Disables a filter subscription in AdGuard Home. description: Disables a filter subscription in AdGuard Home.
fields: fields:
url: url:
name: Url
description: The filter subscription URL to disable. description: The filter subscription URL to disable.
required: true
example: https://www.example.com/filter/1.txt example: https://www.example.com/filter/1.txt
selector:
text:
refresh: refresh:
name: Refresh
description: Refresh all filter subscriptions in AdGuard Home. description: Refresh all filter subscriptions in AdGuard Home.
fields: fields:
force: force:
name: Force
description: Force update (by passes AdGuard Home throttling). description: Force update (by passes AdGuard Home throttling).
example: '"true" to force, "false" or omit for a regular refresh.' example: '"true" to force, "false" or omit for a regular refresh.'
default: false
selector:
boolean:

View File

@ -1,15 +1,36 @@
# Describes the format for available ADS services # Describes the format for available ADS services
write_data_by_name: write_data_by_name:
name: Write data by name
description: Write a value to the connected ADS device. description: Write a value to the connected ADS device.
fields: fields:
adsvar: adsvar:
name: ADS variable
description: The name of the variable to write to. description: The name of the variable to write to.
required: true
example: ".global_var" example: ".global_var"
selector:
text:
adstype: adstype:
name: ADS type
description: The data type of the variable to write to. description: The data type of the variable to write to.
required: true
example: "int" example: "int"
selector:
select:
options:
- 'bool'
- 'byte'
- 'dint'
- 'int'
- 'udint'
- 'uint'
value: value:
name: Value
description: The value to write to the variable. description: The value to write to the variable.
required: true
example: 1 example: 1
selector:
number:
min: 0
max: 10000

View File

@ -7,8 +7,16 @@ set_time_to:
domain: sensor domain: sensor
fields: fields:
minutes: minutes:
name: Minutes
description: Minutes until action description: Minutes until action
required: true
example: "60" example: "60"
selector:
number:
min: 0
max: 1440
unit_of_measurement: minutes
set_myzone: set_myzone:
name: Set MyZone name: Set MyZone
description: Change which zone is set as the reference for temperature control description: Change which zone is set as the reference for temperature control

View File

@ -1,24 +1,43 @@
# Describes the format for available aftership services # Describes the format for available aftership services
add_tracking: add_tracking:
name: Add tracking
description: Add new tracking to Aftership. description: Add new tracking to Aftership.
fields: fields:
tracking_number: tracking_number:
name: Tracking number
description: Tracking number for the new tracking description: Tracking number for the new tracking
required: true
example: "123456789" example: "123456789"
selector:
text:
title: title:
name: Title
description: A custom title for the new tracking description: A custom title for the new tracking
example: "Laptop" example: "Laptop"
selector:
text:
slug: slug:
name: Slug
description: Slug (carrier) of the new tracking description: Slug (carrier) of the new tracking
example: "USPS" example: "USPS"
selector:
text:
remove_tracking: remove_tracking:
name: Remove tracking
description: Remove a tracking from Aftership. description: Remove a tracking from Aftership.
fields: fields:
tracking_number: tracking_number:
name: Tracking number
description: Tracking number of the tracking to remove description: Tracking number of the tracking to remove
required: true
example: "123456789" example: "123456789"
selector:
text:
slug: slug:
name: Slug
description: Slug (carrier) of the tracking to remove description: Slug (carrier) of the tracking to remove
example: "USPS" example: "USPS"
selector:
text:

View File

@ -1,34 +1,39 @@
start_recording: start_recording:
name: Start recording
description: Enable continuous recording. description: Enable continuous recording.
fields: target:
entity_id: entity:
description: "Name(s) of the entity to start recording." integration: agent_dvr
example: "camera.camera_1" domain: camera
stop_recording: stop_recording:
name: Stop recording
description: Disable continuous recording. description: Disable continuous recording.
fields: target:
entity_id: entity:
description: "Name(s) of the entity to stop recording." integration: agent_dvr
example: "camera.camera_1" domain: camera
enable_alerts: enable_alerts:
name: Enable alerts
description: Enable alerts description: Enable alerts
fields: target:
entity_id: entity:
description: "Name(s) of the entity to enable alerts." integration: agent_dvr
example: "camera.camera_1" domain: camera
disable_alerts: disable_alerts:
name: Disable alerts
description: Disable alerts description: Disable alerts
fields: target:
entity_id: entity:
description: "Name(s) of the entity to disable alerts." integration: agent_dvr
example: "camera.camera_1" domain: camera
snapshot: snapshot:
name: Snapshot
description: Take a photo description: Take a photo
fields: target:
entity_id: entity:
description: "Name(s) of the entity to take a snapshot." integration: agent_dvr
example: "camera.camera_1" domain: camera

View File

@ -1,19 +1,31 @@
alarm_keypress: alarm_keypress:
name: Key press
description: Send custom keypresses to the alarm. description: Send custom keypresses to the alarm.
target:
entity:
integration: alarmdecoder
domain: alarm_control_panel
fields: fields:
entity_id:
description: Name of alarm control panel to deliver keypress.
example: "alarm_control_panel.main"
keypress: keypress:
name: Key press
description: "String to send to the alarm panel." description: "String to send to the alarm panel."
required: true
example: "*71" example: "*71"
selector:
text:
alarm_toggle_chime: alarm_toggle_chime:
name: Toggle Chime
description: Send the alarm the toggle chime command. description: Send the alarm the toggle chime command.
target:
entity:
integration: alarmdecoder
domain: alarm_control_panel
fields: fields:
entity_id:
description: Name of alarm control panel to toggle chime.
example: "alarm_control_panel.main"
code: code:
description: A required code to toggle the alarm control panel chime with. name: Code
description: A code to toggle the alarm control panel chime with.
required: true
example: 1234 example: 1234
selector:
text:

View File

@ -1,36 +1,54 @@
# Describes the format for available services for ambiclimate # Describes the format for available services for ambiclimate
set_comfort_mode: set_comfort_mode:
name: Set comfort mode
description: > description: >
Enable comfort mode on your AC Enable comfort mode on your AC.
fields: fields:
Name: Name:
description: > description: >
String with device name. String with device name.
required: true
example: Bedroom example: Bedroom
selector:
text:
send_comfort_feedback: send_comfort_feedback:
name: Send comfort feedback
description: > description: >
Send feedback for comfort mode Send feedback for comfort mode.
fields: fields:
Name: Name:
description: > description: >
String with device name. String with device name.
required: true
example: Bedroom example: Bedroom
selector:
text:
Value: Value:
description: > description: >
Send any of the following comfort values: too_hot, too_warm, bit_warm, comfortable, bit_cold, too_cold, freezing Send any of the following comfort values: too_hot, too_warm, bit_warm, comfortable, bit_cold, too_cold, freezing
required: true
example: bit_warm example: bit_warm
selector:
text:
set_temperature_mode: set_temperature_mode:
name: Set temperature mode
description: > description: >
Enable temperature mode on your AC Enable temperature mode on your AC.
fields: fields:
Name: Name:
description: > description: >
String with device name. String with device name.
required: true
example: Bedroom example: Bedroom
selector:
text:
Value: Value:
description: > description: >
Target value in celsius Target value in celsius
required: true
example: 22 example: 22
selector:
text:

View File

@ -1,88 +1,165 @@
enable_recording: enable_recording:
name: Enable recording
description: Enable continuous recording to camera storage. description: Enable continuous recording to camera storage.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
disable_recording: disable_recording:
name: Disable recording
description: Disable continuous recording to camera storage. description: Disable continuous recording to camera storage.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
enable_audio: enable_audio:
name: Enable audio
description: Enable audio stream. description: Enable audio stream.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
disable_audio: disable_audio:
name: Disable audio
description: Disable audio stream. description: Disable audio stream.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
enable_motion_recording: enable_motion_recording:
name: Enable motion recording
description: Enable recording a clip to camera storage when motion is detected. description: Enable recording a clip to camera storage when motion is detected.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
disable_motion_recording: disable_motion_recording:
name: Disable motion recording
description: Disable recording a clip to camera storage when motion is detected. description: Disable recording a clip to camera storage when motion is detected.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
goto_preset: goto_preset:
name: Go to preset
description: Move camera to PTZ preset. description: Move camera to PTZ preset.
fields: fields:
entity_id: entity_id:
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
preset: preset:
description: Preset number, starting from 1. name: Preset
description: Preset number.
required: true
example: 1 example: 1
selector:
number:
min: 1
max: 1000
set_color_bw: set_color_bw:
name: Set color
description: Set camera color mode. description: Set camera color mode.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
color_bw: color_bw:
description: Color mode, one of 'auto', 'color' or 'bw'. name: Color
description: Color mode.
example: auto example: auto
selector:
select:
options:
- 'auto'
- 'bw'
- 'color'
start_tour: start_tour:
name: Start tour
description: Start camera's PTZ tour function. description: Start camera's PTZ tour function.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
stop_tour: stop_tour:
name: Stop tour
description: Stop camera's PTZ tour function. description: Stop camera's PTZ tour function.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name(s) of the cameras, or 'all' for all cameras." description: "Name(s) of the cameras, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
ptz_control: ptz_control:
description: Move (Pan/Tilt) and/or Zoom a PTZ camera name: PTZ control
description: Move (Pan/Tilt) and/or Zoom a PTZ camera.
fields: fields:
entity_id: entity_id:
name: Entity
description: "Name of the camera, or 'all' for all cameras." description: "Name of the camera, or 'all' for all cameras."
example: "camera.house_front" example: "camera.house_front"
selector:
text:
movement: movement:
description: "up, down, right, left, right_up, right_down, left_up, left_down, zoom_in, zoom_out" name: Movement
description: "Direction to move the camera."
required: true
example: "right" example: "right"
selector:
select:
options:
- 'down'
- 'left'
- 'left_down'
- 'left_up'
- 'right'
- 'right_down'
- 'right_up'
- 'up'
- 'zoom_in'
- 'zoom_out'
travel_time: travel_time:
description: "(optional) Travel time in fractional seconds: from 0 to 1. Default: .2" name: Travel time
description: "Travel time in fractional seconds: from 0 to 1."
example: ".5" example: ".5"
default: .2
selector:
number:
min: 0
max: 1
step: 0.01
unit_of_measurement: seconds

View File

@ -1,41 +1,80 @@
# Describes the format for available Android TV and Fire TV services # Describes the format for available Android TV and Fire TV services
adb_command: adb_command:
name: ADB command
description: Send an ADB command to an Android TV / Fire TV device. description: Send an ADB command to an Android TV / Fire TV device.
fields: fields:
entity_id: entity_id:
description: Name(s) of Android TV / Fire TV entities. description: Name(s) of Android TV / Fire TV entities.
required: true
example: "media_player.android_tv_living_room" example: "media_player.android_tv_living_room"
selector:
entity:
integration: androidtv
domain: media_player
command: command:
name: Command
description: Either a key command or an ADB shell command. description: Either a key command or an ADB shell command.
required: true
example: "HOME" example: "HOME"
selector:
text:
download: download:
name: Download
description: Download a file from your Android TV / Fire TV device to your Home Assistant instance. description: Download a file from your Android TV / Fire TV device to your Home Assistant instance.
fields: fields:
entity_id: entity_id:
description: Name of Android TV / Fire TV entity. description: Name of Android TV / Fire TV entity.
required: true
example: "media_player.android_tv_living_room" example: "media_player.android_tv_living_room"
selector:
entity:
integration: androidtv
domain: media_player
device_path: device_path:
name: Device path
description: The filepath on the Android TV / Fire TV device. description: The filepath on the Android TV / Fire TV device.
required: true
example: "/storage/emulated/0/Download/example.txt" example: "/storage/emulated/0/Download/example.txt"
selector:
text:
local_path: local_path:
name: Local path
description: The filepath on your Home Assistant instance. description: The filepath on your Home Assistant instance.
required: true
example: "/config/www/example.txt" example: "/config/www/example.txt"
selector:
text:
upload: upload:
name: Upload
description: Upload a file from your Home Assistant instance to an Android TV / Fire TV device. description: Upload a file from your Home Assistant instance to an Android TV / Fire TV device.
fields: fields:
entity_id: entity_id:
description: Name(s) of Android TV / Fire TV entities. description: Name(s) of Android TV / Fire TV entities.
required: true
example: "media_player.android_tv_living_room" example: "media_player.android_tv_living_room"
selector:
entity:
integration: androidtv
domain: media_player
device_path: device_path:
name: Device path
description: The filepath on the Android TV / Fire TV device. description: The filepath on the Android TV / Fire TV device.
required: true
example: "/storage/emulated/0/Download/example.txt" example: "/storage/emulated/0/Download/example.txt"
selector:
text:
local_path: local_path:
name: Local path
description: The filepath on your Home Assistant instance. description: The filepath on your Home Assistant instance.
required: true
example: "/config/www/example.txt" example: "/config/www/example.txt"
selector:
text:
learn_sendevent: learn_sendevent:
name: Learn sendevent
description: Translate a key press on a remote into ADB 'sendevent' commands. You must press one button on the remote within 8 seconds of calling this service. description: Translate a key press on a remote into ADB 'sendevent' commands. You must press one button on the remote within 8 seconds of calling this service.
fields: target:
entity_id: entity:
description: Name(s) of Android TV / Fire TV entities. integration: androidtv
example: "media_player.android_tv_living_room" domain: media_player

View File

@ -1,4 +1,5 @@
# Describes the format for available arlo services # Describes the format for available arlo services
update: update:
name: Update
description: Update the state for all cameras and the base station. description: Update the state for all cameras and the base station.