diff --git a/homeassistant/components/abode/services.yaml b/homeassistant/components/abode/services.yaml index f694afc0298..9b5362c0929 100644 --- a/homeassistant/components/abode/services.yaml +++ b/homeassistant/components/abode/services.yaml @@ -1,21 +1,46 @@ capture_image: + name: Capture image description: Request a new image capture from a camera device. fields: entity_id: + name: Entity description: Entity id of the camera to request an image. + required: true example: camera.downstairs_motion_camera + selector: + entity: + integration: abode + domain: camera + change_setting: + name: Change setting description: Change an Abode system setting. fields: setting: + name: Setting description: Setting to change. + required: true example: beeper_mute + selector: + text: value: + name: Value description: Value of the setting. + required: true example: "1" + selector: + text: + trigger_automation: + name: Trigger automation description: Trigger an Abode automation. fields: entity_id: + name: Entity description: Entity id of the automation to trigger. + required: true example: switch.my_automation + selector: + entity: + integration: abode + domain: switch diff --git a/homeassistant/components/adguard/services.yaml b/homeassistant/components/adguard/services.yaml index 736acdd923c..2e97d164e3a 100644 --- a/homeassistant/components/adguard/services.yaml +++ b/homeassistant/components/adguard/services.yaml @@ -1,37 +1,66 @@ add_url: + name: Add url description: Add a new filter subscription to AdGuard Home. fields: name: + name: Name description: The name of the filter subscription. + required: true example: Example + selector: + text: url: + name: Url description: The filter URL to subscribe to, containing the filter rules. + required: true example: https://www.example.com/filter/1.txt + selector: + text: remove_url: + name: Remove url description: Removes a filter subscription from AdGuard Home. fields: url: + name: Url description: The filter subscription URL to remove. + required: true example: https://www.example.com/filter/1.txt + selector: + text: enable_url: + name: Enable url description: Enables a filter subscription in AdGuard Home. fields: url: + name: Url description: The filter subscription URL to enable. + required: true example: https://www.example.com/filter/1.txt + selector: + text: disable_url: + name: Disable url description: Disables a filter subscription in AdGuard Home. fields: url: + name: Url description: The filter subscription URL to disable. + required: true example: https://www.example.com/filter/1.txt + selector: + text: refresh: + name: Refresh description: Refresh all filter subscriptions in AdGuard Home. fields: force: + name: Force description: Force update (by passes AdGuard Home throttling). example: '"true" to force, "false" or omit for a regular refresh.' + default: false + selector: + boolean: diff --git a/homeassistant/components/ads/services.yaml b/homeassistant/components/ads/services.yaml index 1e7b664b674..5139662a522 100644 --- a/homeassistant/components/ads/services.yaml +++ b/homeassistant/components/ads/services.yaml @@ -1,15 +1,36 @@ # Describes the format for available ADS services write_data_by_name: + name: Write data by name description: Write a value to the connected ADS device. - fields: adsvar: + name: ADS variable description: The name of the variable to write to. + required: true example: ".global_var" + selector: + text: adstype: + name: ADS type description: The data type of the variable to write to. + required: true example: "int" + selector: + select: + options: + - 'bool' + - 'byte' + - 'dint' + - 'int' + - 'udint' + - 'uint' value: + name: Value description: The value to write to the variable. + required: true example: 1 + selector: + number: + min: 0 + max: 10000 diff --git a/homeassistant/components/advantage_air/services.yaml b/homeassistant/components/advantage_air/services.yaml index e70208c4ac1..24088421c99 100644 --- a/homeassistant/components/advantage_air/services.yaml +++ b/homeassistant/components/advantage_air/services.yaml @@ -7,8 +7,16 @@ set_time_to: domain: sensor fields: minutes: + name: Minutes description: Minutes until action + required: true example: "60" + selector: + number: + min: 0 + max: 1440 + unit_of_measurement: minutes + set_myzone: name: Set MyZone description: Change which zone is set as the reference for temperature control diff --git a/homeassistant/components/aftership/services.yaml b/homeassistant/components/aftership/services.yaml index 5ad30d25d8b..e4d90646aa6 100644 --- a/homeassistant/components/aftership/services.yaml +++ b/homeassistant/components/aftership/services.yaml @@ -1,24 +1,43 @@ # Describes the format for available aftership services add_tracking: + name: Add tracking description: Add new tracking to Aftership. fields: tracking_number: + name: Tracking number description: Tracking number for the new tracking + required: true example: "123456789" + selector: + text: title: + name: Title description: A custom title for the new tracking example: "Laptop" + selector: + text: slug: + name: Slug description: Slug (carrier) of the new tracking example: "USPS" + selector: + text: remove_tracking: + name: Remove tracking description: Remove a tracking from Aftership. fields: tracking_number: + name: Tracking number description: Tracking number of the tracking to remove + required: true example: "123456789" + selector: + text: slug: + name: Slug description: Slug (carrier) of the tracking to remove example: "USPS" + selector: + text: diff --git a/homeassistant/components/agent_dvr/services.yaml b/homeassistant/components/agent_dvr/services.yaml index 8bf1e01269a..206b32cb526 100644 --- a/homeassistant/components/agent_dvr/services.yaml +++ b/homeassistant/components/agent_dvr/services.yaml @@ -1,34 +1,39 @@ start_recording: + name: Start recording description: Enable continuous recording. - fields: - entity_id: - description: "Name(s) of the entity to start recording." - example: "camera.camera_1" + target: + entity: + integration: agent_dvr + domain: camera stop_recording: + name: Stop recording description: Disable continuous recording. - fields: - entity_id: - description: "Name(s) of the entity to stop recording." - example: "camera.camera_1" + target: + entity: + integration: agent_dvr + domain: camera enable_alerts: + name: Enable alerts description: Enable alerts - fields: - entity_id: - description: "Name(s) of the entity to enable alerts." - example: "camera.camera_1" + target: + entity: + integration: agent_dvr + domain: camera disable_alerts: + name: Disable alerts description: Disable alerts - fields: - entity_id: - description: "Name(s) of the entity to disable alerts." - example: "camera.camera_1" + target: + entity: + integration: agent_dvr + domain: camera snapshot: + name: Snapshot description: Take a photo - fields: - entity_id: - description: "Name(s) of the entity to take a snapshot." - example: "camera.camera_1" + target: + entity: + integration: agent_dvr + domain: camera diff --git a/homeassistant/components/alarmdecoder/services.yaml b/homeassistant/components/alarmdecoder/services.yaml index 37c7ddf210c..9d50eae07e6 100644 --- a/homeassistant/components/alarmdecoder/services.yaml +++ b/homeassistant/components/alarmdecoder/services.yaml @@ -1,19 +1,31 @@ alarm_keypress: + name: Key press description: Send custom keypresses to the alarm. + target: + entity: + integration: alarmdecoder + domain: alarm_control_panel fields: - entity_id: - description: Name of alarm control panel to deliver keypress. - example: "alarm_control_panel.main" keypress: + name: Key press description: "String to send to the alarm panel." + required: true example: "*71" + selector: + text: alarm_toggle_chime: + name: Toggle Chime description: Send the alarm the toggle chime command. + target: + entity: + integration: alarmdecoder + domain: alarm_control_panel fields: - entity_id: - description: Name of alarm control panel to toggle chime. - example: "alarm_control_panel.main" 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 + selector: + text: diff --git a/homeassistant/components/ambiclimate/services.yaml b/homeassistant/components/ambiclimate/services.yaml index 19f47c6c35f..f75857e4d2e 100644 --- a/homeassistant/components/ambiclimate/services.yaml +++ b/homeassistant/components/ambiclimate/services.yaml @@ -1,36 +1,54 @@ # Describes the format for available services for ambiclimate set_comfort_mode: + name: Set comfort mode description: > - Enable comfort mode on your AC + Enable comfort mode on your AC. fields: Name: description: > String with device name. + required: true example: Bedroom + selector: + text: send_comfort_feedback: + name: Send comfort feedback description: > - Send feedback for comfort mode + Send feedback for comfort mode. fields: Name: description: > String with device name. + required: true example: Bedroom + selector: + text: Value: description: > Send any of the following comfort values: too_hot, too_warm, bit_warm, comfortable, bit_cold, too_cold, freezing + required: true example: bit_warm + selector: + text: set_temperature_mode: + name: Set temperature mode description: > - Enable temperature mode on your AC + Enable temperature mode on your AC. fields: Name: description: > String with device name. + required: true example: Bedroom + selector: + text: Value: description: > Target value in celsius + required: true example: 22 + selector: + text: diff --git a/homeassistant/components/amcrest/services.yaml b/homeassistant/components/amcrest/services.yaml index 10865586b6d..c4a12c59828 100644 --- a/homeassistant/components/amcrest/services.yaml +++ b/homeassistant/components/amcrest/services.yaml @@ -1,88 +1,165 @@ enable_recording: + name: Enable recording description: Enable continuous recording to camera storage. fields: entity_id: + name: Entity description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" + selector: + text: disable_recording: + name: Disable recording description: Disable continuous recording to camera storage. fields: entity_id: + name: Entity description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" + selector: + text: enable_audio: + name: Enable audio description: Enable audio stream. fields: entity_id: + name: Entity description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" + selector: + text: disable_audio: + name: Disable audio description: Disable audio stream. fields: entity_id: + name: Entity description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" + selector: + text: enable_motion_recording: + name: Enable motion recording description: Enable recording a clip to camera storage when motion is detected. fields: entity_id: + name: Entity description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" + selector: + text: disable_motion_recording: + name: Disable motion recording description: Disable recording a clip to camera storage when motion is detected. fields: entity_id: + name: Entity description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" + selector: + text: goto_preset: + name: Go to preset description: Move camera to PTZ preset. fields: entity_id: description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" preset: - description: Preset number, starting from 1. + name: Preset + description: Preset number. + required: true example: 1 + selector: + number: + min: 1 + max: 1000 set_color_bw: + name: Set color description: Set camera color mode. fields: entity_id: + name: Entity description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" + selector: + text: color_bw: - description: Color mode, one of 'auto', 'color' or 'bw'. + name: Color + description: Color mode. example: auto + selector: + select: + options: + - 'auto' + - 'bw' + - 'color' start_tour: + name: Start tour description: Start camera's PTZ tour function. fields: entity_id: + name: Entity description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" + selector: + text: stop_tour: + name: Stop tour description: Stop camera's PTZ tour function. fields: entity_id: + name: Entity description: "Name(s) of the cameras, or 'all' for all cameras." example: "camera.house_front" + selector: + text: 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: entity_id: + name: Entity description: "Name of the camera, or 'all' for all cameras." example: "camera.house_front" + selector: + text: 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" + selector: + select: + options: + - 'down' + - 'left' + - 'left_down' + - 'left_up' + - 'right' + - 'right_down' + - 'right_up' + - 'up' + - 'zoom_in' + - 'zoom_out' 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" + default: .2 + selector: + number: + min: 0 + max: 1 + step: 0.01 + unit_of_measurement: seconds diff --git a/homeassistant/components/androidtv/services.yaml b/homeassistant/components/androidtv/services.yaml index 65e83dfbe4f..55b871ff58f 100644 --- a/homeassistant/components/androidtv/services.yaml +++ b/homeassistant/components/androidtv/services.yaml @@ -1,41 +1,80 @@ # Describes the format for available Android TV and Fire TV services adb_command: + name: ADB command description: Send an ADB command to an Android TV / Fire TV device. fields: entity_id: description: Name(s) of Android TV / Fire TV entities. + required: true example: "media_player.android_tv_living_room" + selector: + entity: + integration: androidtv + domain: media_player command: + name: Command description: Either a key command or an ADB shell command. + required: true example: "HOME" + selector: + text: download: + name: Download description: Download a file from your Android TV / Fire TV device to your Home Assistant instance. fields: entity_id: description: Name of Android TV / Fire TV entity. + required: true example: "media_player.android_tv_living_room" + selector: + entity: + integration: androidtv + domain: media_player device_path: + name: Device path description: The filepath on the Android TV / Fire TV device. + required: true example: "/storage/emulated/0/Download/example.txt" + selector: + text: local_path: + name: Local path description: The filepath on your Home Assistant instance. + required: true example: "/config/www/example.txt" + selector: + text: upload: + name: Upload description: Upload a file from your Home Assistant instance to an Android TV / Fire TV device. fields: entity_id: description: Name(s) of Android TV / Fire TV entities. + required: true example: "media_player.android_tv_living_room" + selector: + entity: + integration: androidtv + domain: media_player device_path: + name: Device path description: The filepath on the Android TV / Fire TV device. + required: true example: "/storage/emulated/0/Download/example.txt" + selector: + text: local_path: + name: Local path description: The filepath on your Home Assistant instance. + required: true example: "/config/www/example.txt" + selector: + text: 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. - fields: - entity_id: - description: Name(s) of Android TV / Fire TV entities. - example: "media_player.android_tv_living_room" + target: + entity: + integration: androidtv + domain: media_player diff --git a/homeassistant/components/arlo/services.yaml b/homeassistant/components/arlo/services.yaml index a35fec8fb73..8481ffc4d53 100644 --- a/homeassistant/components/arlo/services.yaml +++ b/homeassistant/components/arlo/services.yaml @@ -1,4 +1,5 @@ # Describes the format for available arlo services update: + name: Update description: Update the state for all cameras and the base station.