From 028a07d86fd56bf101af4717e050750bb5fa6ae0 Mon Sep 17 00:00:00 2001 From: tkdrob Date: Tue, 25 May 2021 08:45:17 -0400 Subject: [PATCH] Wrap up selectors (#50794) Co-authored-by: Franck Nijhof --- homeassistant/components/abode/services.yaml | 2 - .../components/adguard/services.yaml | 3 +- homeassistant/components/ads/services.yaml | 2 - .../components/advantage_air/services.yaml | 1 - .../components/aftership/services.yaml | 4 +- .../components/amcrest/services.yaml | 9 +- .../components/androidtv/services.yaml | 3 - .../components/automation/services.yaml | 2 - .../components/bluesound/services.yaml | 5 -- homeassistant/components/camera/services.yaml | 8 -- homeassistant/components/cast/services.yaml | 1 - .../components/channels/services.yaml | 1 - .../components/climate/services.yaml | 9 -- .../components/counter/services.yaml | 5 -- homeassistant/components/cover/services.yaml | 6 -- homeassistant/components/deconz/services.yaml | 31 ++++--- .../components/denonavr/services.yaml | 1 - .../components/device_tracker/services.yaml | 3 +- .../components/dynalite/services.yaml | 4 - homeassistant/components/dyson/services.yaml | 7 -- homeassistant/components/ecobee/services.yaml | 13 --- .../components/eight_sleep/services.yaml | 3 - homeassistant/components/elkm1/services.yaml | 5 -- .../components/envisalink/services.yaml | 2 - .../components/evohome/services.yaml | 2 - .../components/facebox/services.yaml | 1 - homeassistant/components/fan/services.yaml | 16 +--- homeassistant/components/ffmpeg/services.yaml | 3 - homeassistant/components/flo/services.yaml | 2 - homeassistant/components/foscam/services.yaml | 2 - .../components/frontend/services.yaml | 3 +- .../components/geniushub/services.yaml | 4 - homeassistant/components/group/services.yaml | 1 - .../components/harmony/services.yaml | 1 - .../components/hdmi_cec/services.yaml | 3 - homeassistant/components/hive/services.yaml | 7 -- .../components/homematic/services.yaml | 5 -- .../homematicip_cloud/services.yaml | 11 +-- .../components/humidifier/services.yaml | 1 - homeassistant/components/icloud/services.yaml | 1 - homeassistant/components/ifttt/services.yaml | 1 - homeassistant/components/ihc/services.yaml | 19 +--- .../components/input_datetime/services.yaml | 1 - .../components/input_number/services.yaml | 1 - .../components/input_select/services.yaml | 2 - .../components/insteon/services.yaml | 10 --- homeassistant/components/isy994/services.yaml | 15 +--- homeassistant/components/izone/services.yaml | 8 +- homeassistant/components/keba/services.yaml | 28 +++--- homeassistant/components/kef/services.yaml | 20 +---- homeassistant/components/knx/services.yaml | 1 - homeassistant/components/lcn/services.yaml | 42 +++------ homeassistant/components/lifx/services.yaml | 13 --- homeassistant/components/light/services.yaml | 90 ++++--------------- .../components/litterrobot/services.yaml | 6 -- .../components/local_file/services.yaml | 1 - homeassistant/components/lock/services.yaml | 6 -- .../components/logbook/services.yaml | 1 - homeassistant/components/logger/services.yaml | 5 -- .../components/logi_circle/services.yaml | 6 -- .../components/media_extractor/services.yaml | 1 - .../components/media_player/services.yaml | 6 -- homeassistant/components/mill/services.yaml | 3 - homeassistant/components/modbus/services.yaml | 4 - .../components/motion_blinds/services.yaml | 2 - homeassistant/components/mqtt/services.yaml | 9 -- .../components/mysensors/services.yaml | 1 - homeassistant/components/neato/services.yaml | 3 - .../components/ness_alarm/services.yaml | 2 - homeassistant/components/nest/services.yaml | 3 - .../components/netatmo/services.yaml | 5 +- .../components/netgear_lte/services.yaml | 2 - homeassistant/components/nexia/services.yaml | 2 - homeassistant/components/notify/services.yaml | 8 +- homeassistant/components/nuki/services.yaml | 3 +- homeassistant/components/nx584/services.yaml | 2 - homeassistant/components/nzbget/services.yaml | 1 - homeassistant/components/ombi/services.yaml | 1 - .../components/omnilogic/services.yaml | 1 - homeassistant/components/onvif/services.yaml | 7 -- .../components/openhome/services.yaml | 1 - .../components/opentherm_gw/services.yaml | 20 ++--- homeassistant/components/ozw/services.yaml | 5 -- .../components/profiler/services.yaml | 3 - homeassistant/components/ps4/services.yaml | 2 - homeassistant/components/rachio/services.yaml | 4 - .../components/rainbird/services.yaml | 7 +- .../components/rainmachine/services.yaml | 15 ++-- .../components/recorder/services.yaml | 5 -- homeassistant/components/remote/services.yaml | 31 +++---- homeassistant/components/scene/services.yaml | 10 +-- .../components/screenlogic/services.yaml | 33 ++++--- .../components/sensibo/services.yaml | 1 - .../components/simplisafe/services.yaml | 13 +-- .../components/snapcast/services.yaml | 3 +- homeassistant/components/snips/services.yaml | 1 - homeassistant/components/sonos/services.yaml | 19 ---- .../components/starline/services.yaml | 2 - .../components/surepetcare/services.yaml | 1 - .../components/switcher_kis/services.yaml | 1 - .../components/system_bridge/services.yaml | 2 - .../components/system_log/services.yaml | 3 +- homeassistant/components/tado/services.yaml | 3 - .../components/telegram_bot/services.yaml | 15 ++-- .../components/todoist/services.yaml | 1 - homeassistant/components/tts/services.yaml | 4 +- .../components/wake_on_lan/services.yaml | 2 +- .../components/webostv/services.yaml | 1 - homeassistant/components/wink/services.yaml | 7 +- homeassistant/components/wled/services.yaml | 10 +-- .../components/yeelight/services.yaml | 5 +- homeassistant/components/zha/services.yaml | 36 +++----- homeassistant/components/zwave/services.yaml | 7 +- .../components/zwave_js/services.yaml | 3 - 114 files changed, 183 insertions(+), 628 deletions(-) diff --git a/homeassistant/components/abode/services.yaml b/homeassistant/components/abode/services.yaml index 9b5362c0929..843cc123c69 100644 --- a/homeassistant/components/abode/services.yaml +++ b/homeassistant/components/abode/services.yaml @@ -6,7 +6,6 @@ capture_image: name: Entity description: Entity id of the camera to request an image. required: true - example: camera.downstairs_motion_camera selector: entity: integration: abode @@ -39,7 +38,6 @@ trigger_automation: name: Entity description: Entity id of the automation to trigger. required: true - example: switch.my_automation selector: entity: integration: abode diff --git a/homeassistant/components/adguard/services.yaml b/homeassistant/components/adguard/services.yaml index 2e97d164e3a..5e4c2a157de 100644 --- a/homeassistant/components/adguard/services.yaml +++ b/homeassistant/components/adguard/services.yaml @@ -59,8 +59,7 @@ refresh: fields: force: name: Force - description: Force update (by passes AdGuard Home throttling). - example: '"true" to force, "false" or omit for a regular refresh.' + description: Force update (bypasses AdGuard Home throttling). "true" to force, or "false" to omit for a regular refresh. default: false selector: boolean: diff --git a/homeassistant/components/ads/services.yaml b/homeassistant/components/ads/services.yaml index 5139662a522..f6458029fb4 100644 --- a/homeassistant/components/ads/services.yaml +++ b/homeassistant/components/ads/services.yaml @@ -15,7 +15,6 @@ write_data_by_name: name: ADS type description: The data type of the variable to write to. required: true - example: "int" selector: select: options: @@ -29,7 +28,6 @@ write_data_by_name: name: Value description: The value to write to the variable. required: true - example: 1 selector: number: min: 0 diff --git a/homeassistant/components/advantage_air/services.yaml b/homeassistant/components/advantage_air/services.yaml index 24088421c99..33f39065f8a 100644 --- a/homeassistant/components/advantage_air/services.yaml +++ b/homeassistant/components/advantage_air/services.yaml @@ -10,7 +10,6 @@ set_time_to: name: Minutes description: Minutes until action required: true - example: "60" selector: number: min: 0 diff --git a/homeassistant/components/aftership/services.yaml b/homeassistant/components/aftership/services.yaml index e4d90646aa6..62e339dbda8 100644 --- a/homeassistant/components/aftership/services.yaml +++ b/homeassistant/components/aftership/services.yaml @@ -2,7 +2,7 @@ add_tracking: name: Add tracking - description: Add new tracking to Aftership. + description: Add new tracking number to Aftership. fields: tracking_number: name: Tracking number @@ -26,7 +26,7 @@ add_tracking: remove_tracking: name: Remove tracking - description: Remove a tracking from Aftership. + description: Remove a tracking number from Aftership. fields: tracking_number: name: Tracking number diff --git a/homeassistant/components/amcrest/services.yaml b/homeassistant/components/amcrest/services.yaml index c4a12c59828..7baad96d6d5 100644 --- a/homeassistant/components/amcrest/services.yaml +++ b/homeassistant/components/amcrest/services.yaml @@ -70,12 +70,14 @@ goto_preset: fields: entity_id: description: "Name(s) of the cameras, or 'all' for all cameras." - example: "camera.house_front" + selector: + entity: + integration: amcrest + domain: camera preset: name: Preset description: Preset number. required: true - example: 1 selector: number: min: 1 @@ -94,7 +96,6 @@ set_color_bw: color_bw: name: Color description: Color mode. - example: auto selector: select: options: @@ -138,7 +139,6 @@ ptz_control: name: Movement description: "Direction to move the camera." required: true - example: "right" selector: select: options: @@ -155,7 +155,6 @@ ptz_control: travel_time: name: Travel time description: "Travel time in fractional seconds: from 0 to 1." - example: ".5" default: .2 selector: number: diff --git a/homeassistant/components/androidtv/services.yaml b/homeassistant/components/androidtv/services.yaml index 55b871ff58f..6c8469f46c0 100644 --- a/homeassistant/components/androidtv/services.yaml +++ b/homeassistant/components/androidtv/services.yaml @@ -7,7 +7,6 @@ adb_command: entity_id: description: Name(s) of Android TV / Fire TV entities. required: true - example: "media_player.android_tv_living_room" selector: entity: integration: androidtv @@ -26,7 +25,6 @@ download: entity_id: description: Name of Android TV / Fire TV entity. required: true - example: "media_player.android_tv_living_room" selector: entity: integration: androidtv @@ -52,7 +50,6 @@ upload: entity_id: description: Name(s) of Android TV / Fire TV entities. required: true - example: "media_player.android_tv_living_room" selector: entity: integration: androidtv diff --git a/homeassistant/components/automation/services.yaml b/homeassistant/components/automation/services.yaml index dec5793d1e7..62d0988d770 100644 --- a/homeassistant/components/automation/services.yaml +++ b/homeassistant/components/automation/services.yaml @@ -17,7 +17,6 @@ turn_off: name: Stop actions description: Stop currently running actions. default: true - example: true selector: boolean: @@ -39,7 +38,6 @@ trigger: name: Skip conditions description: Whether or not the conditions will be skipped. default: true - example: true selector: boolean: diff --git a/homeassistant/components/bluesound/services.yaml b/homeassistant/components/bluesound/services.yaml index 992fd34a0bc..7c04cc00f39 100644 --- a/homeassistant/components/bluesound/services.yaml +++ b/homeassistant/components/bluesound/services.yaml @@ -6,7 +6,6 @@ join: name: Master description: Entity ID of the player that should become the master of the group. required: true - example: "media_player.bluesound_livingroom" selector: entity: integration: bluesound @@ -14,7 +13,6 @@ join: entity_id: name: Entity description: Name of entity that will coordinate the grouping. Platform dependent. - example: "media_player.bluesound_livingroom" selector: entity: integration: bluesound @@ -27,7 +25,6 @@ unjoin: entity_id: name: Entity description: Name of entity that will be unjoined from their group. Platform dependent. - example: "media_player.bluesound_livingroom" selector: entity: integration: bluesound @@ -40,7 +37,6 @@ set_sleep_timer: entity_id: name: Entity description: Name(s) of entities that will have a timer set. - example: "media_player.bluesound_livingroom" selector: entity: integration: bluesound @@ -53,7 +49,6 @@ clear_sleep_timer: entity_id: name: Entity description: Name(s) of entities that will have the timer cleared. - example: "media_player.bluesound_livingroom" selector: entity: integration: bluesound diff --git a/homeassistant/components/camera/services.yaml b/homeassistant/components/camera/services.yaml index 61b6e624b12..024bb927508 100644 --- a/homeassistant/components/camera/services.yaml +++ b/homeassistant/components/camera/services.yaml @@ -54,7 +54,6 @@ play_stream: name: Media Player description: Name(s) of media player to stream to. required: true - example: "media_player.living_room_tv" selector: entity: domain: media_player @@ -62,7 +61,6 @@ play_stream: name: Format description: Stream format supported by media player. default: "hls" - example: "hls" selector: select: options: @@ -86,25 +84,19 @@ record: name: Duration description: Target recording length. default: 30 - example: 30 selector: number: min: 1 max: 3600 - step: 1 unit_of_measurement: seconds - mode: slider lookback: name: Lookback description: Target lookback period to include in addition to duration. Only available if there is currently an active HLS stream. default: 0 - example: 4 selector: number: min: 0 max: 300 - step: 1 unit_of_measurement: seconds - mode: slider diff --git a/homeassistant/components/cast/services.yaml b/homeassistant/components/cast/services.yaml index 9b2b0a739b0..f0fbcf4a8d7 100644 --- a/homeassistant/components/cast/services.yaml +++ b/homeassistant/components/cast/services.yaml @@ -6,7 +6,6 @@ show_lovelace_view: name: Entity description: Media Player entity to show the Lovelace view on. required: true - example: "media_player.kitchen" selector: entity: integration: cast diff --git a/homeassistant/components/channels/services.yaml b/homeassistant/components/channels/services.yaml index f5b4639817e..5aa2f1ebda7 100644 --- a/homeassistant/components/channels/services.yaml +++ b/homeassistant/components/channels/services.yaml @@ -26,7 +26,6 @@ seek_by: name: Seconds description: Number of seconds to seek by. Negative numbers seek backwards. required: true - example: 120 selector: number: min: -3600 diff --git a/homeassistant/components/climate/services.yaml b/homeassistant/components/climate/services.yaml index 001f35726ad..7b9d7fe4a72 100644 --- a/homeassistant/components/climate/services.yaml +++ b/homeassistant/components/climate/services.yaml @@ -11,7 +11,6 @@ set_aux_heat: name: Auxiliary heating description: New value of auxiliary heater. required: true - example: true selector: boolean: @@ -40,7 +39,6 @@ set_temperature: temperature: name: Temperature description: New target temperature for HVAC. - example: 25 selector: number: min: 0 @@ -51,7 +49,6 @@ set_temperature: name: Target temperature high description: New target high temperature for HVAC. advanced: true - example: 26 selector: number: min: 0 @@ -62,7 +59,6 @@ set_temperature: name: Target temperature low description: New target low temperature for HVAC. advanced: true - example: 20 selector: number: min: 0 @@ -72,7 +68,6 @@ set_temperature: hvac_mode: name: HVAC mode description: HVAC operation mode to set temperature to. - example: "heat" selector: select: options: @@ -95,14 +90,11 @@ set_humidity: name: Humidity description: New target humidity for climate device. required: true - example: 60 selector: number: min: 30 max: 99 - step: 1 unit_of_measurement: "%" - mode: slider set_fan_mode: name: Set fan mode @@ -129,7 +121,6 @@ set_hvac_mode: hvac_mode: name: HVAC mode description: New value of operation mode. - example: "heat" selector: select: options: diff --git a/homeassistant/components/counter/services.yaml b/homeassistant/components/counter/services.yaml index cc26541def5..1930ba0d45b 100644 --- a/homeassistant/components/counter/services.yaml +++ b/homeassistant/components/counter/services.yaml @@ -31,7 +31,6 @@ configure: minimum: name: Minimum description: New minimum value for the counter or None to remove minimum. - example: 0 selector: number: min: -9223372036854775807 @@ -40,7 +39,6 @@ configure: maximum: name: Maximum description: New maximum value for the counter or None to remove maximum. - example: 100 selector: number: min: -9223372036854775807 @@ -49,7 +47,6 @@ configure: step: name: Step description: New value for step. - example: 2 selector: number: min: 1 @@ -58,7 +55,6 @@ configure: initial: name: Initial description: New value for initial. - example: 6 selector: number: min: 0 @@ -67,7 +63,6 @@ configure: value: name: Value description: New state value. - example: 3 selector: number: min: 0 diff --git a/homeassistant/components/cover/services.yaml b/homeassistant/components/cover/services.yaml index f903463bd33..2f8e20464f3 100644 --- a/homeassistant/components/cover/services.yaml +++ b/homeassistant/components/cover/services.yaml @@ -32,14 +32,11 @@ set_cover_position: name: Position description: Position of the cover required: true - example: 30 selector: number: min: 0 max: 100 - step: 1 unit_of_measurement: "%" - mode: slider stop_cover: name: Stop @@ -80,14 +77,11 @@ set_cover_tilt_position: name: Tilt position description: Tilt position of the cover. required: true - example: 30 selector: number: min: 0 max: 100 - step: 1 unit_of_measurement: "%" - mode: slider stop_cover_tilt: name: Stop tilt diff --git a/homeassistant/components/deconz/services.yaml b/homeassistant/components/deconz/services.yaml index cd234376e22..fbaf47b009c 100644 --- a/homeassistant/components/deconz/services.yaml +++ b/homeassistant/components/deconz/services.yaml @@ -7,35 +7,34 @@ configure: entity: name: Entity description: Represents a specific device endpoint in deCONZ. - example: "light.rgb_light" selector: entity: integration: deconz field: name: Path - selector: - text: description: >- String representing a full path to deCONZ endpoint (when entity is not specified) or a subpath of the device path for the entity (when entity is specified). example: '"/lights/1/state" or "/state"' - data: - name: Configuration payload - required: true - selector: - object: - description: JSON object with what data you want to alter. - example: '{"on": true}' - bridgeid: - name: Bridge identifier selector: text: + data: + name: Configuration payload + description: JSON object with what data you want to alter. + required: true + example: '{"on": true}' + selector: + object: + bridgeid: + name: Bridge identifier description: >- Unique string for each deCONZ hardware. It can be found as part of the integration name. Useful if you run multiple deCONZ integrations. example: "00212EFFFF012345" + selector: + text: device_refresh: name: Device refresh @@ -43,13 +42,13 @@ device_refresh: fields: bridgeid: name: Bridge identifier - selector: - text: description: >- Unique string for each deCONZ hardware. It can be found as part of the integration name. Useful if you run multiple deCONZ integrations. example: "00212EFFFF012345" + selector: + text: remove_orphaned_entries: name: Remove orphaned entries @@ -57,13 +56,13 @@ remove_orphaned_entries: fields: bridgeid: name: Bridge identifier - selector: - text: description: >- Unique string for each deCONZ hardware. It can be found as part of the integration name. Useful if you run multiple deCONZ integrations. example: "00212EFFFF012345" + selector: + text: alarm_panel_state: name: Alarm panel state diff --git a/homeassistant/components/denonavr/services.yaml b/homeassistant/components/denonavr/services.yaml index cea14a8b361..ee35732e311 100644 --- a/homeassistant/components/denonavr/services.yaml +++ b/homeassistant/components/denonavr/services.yaml @@ -26,7 +26,6 @@ set_dynamic_eq: dynamic_eq: description: "True/false for enable/disable." default: true - example: true selector: boolean: update_audyssey: diff --git a/homeassistant/components/device_tracker/services.yaml b/homeassistant/components/device_tracker/services.yaml index 9e27a04fabf..c6c2d212e2d 100644 --- a/homeassistant/components/device_tracker/services.yaml +++ b/homeassistant/components/device_tracker/services.yaml @@ -37,15 +37,14 @@ see: gps_accuracy: name: GPS accuracy description: Accuracy of GPS coordinates. - example: "80" selector: number: min: 1 max: 100 + unit_of_measurement: "%" battery: name: Battery level description: Battery level of device. - example: "100" selector: number: min: 0 diff --git a/homeassistant/components/dynalite/services.yaml b/homeassistant/components/dynalite/services.yaml index 7aee7627f14..d34335ca1d3 100644 --- a/homeassistant/components/dynalite/services.yaml +++ b/homeassistant/components/dynalite/services.yaml @@ -10,14 +10,12 @@ request_area_preset: area: description: "Area to request the preset reported" required: true - example: 2 selector: number: min: 1 max: 9999 channel: description: "Channel to request the preset to be reported from." - example: 1 default: 1 selector: number: @@ -38,7 +36,6 @@ request_channel_level: name: Area description: "Area for the requested channel" required: true - example: 2 selector: number: min: 1 @@ -47,7 +44,6 @@ request_channel_level: name: Channel description: "Channel to request the level for." required: true - example: 1 selector: number: min: 1 diff --git a/homeassistant/components/dyson/services.yaml b/homeassistant/components/dyson/services.yaml index 6f6bc2d9c8a..10b27c1c5e6 100644 --- a/homeassistant/components/dyson/services.yaml +++ b/homeassistant/components/dyson/services.yaml @@ -12,7 +12,6 @@ set_night_mode: name: Night mode description: Night mode status required: true - example: true selector: boolean: @@ -28,7 +27,6 @@ set_auto_mode: name: Auto Mode description: Auto mode status required: true - example: true selector: boolean: @@ -44,7 +42,6 @@ set_angle: name: Angle low description: The angle at which the oscillation should start required: true - example: 1 selector: number: min: 5 @@ -54,7 +51,6 @@ set_angle: name: Angle high description: The angle at which the oscillation should end required: true - example: 255 selector: number: min: 5 @@ -73,7 +69,6 @@ set_flow_direction_front: name: Flow direction front description: Frontal flow direction required: true - example: true selector: boolean: @@ -89,7 +84,6 @@ set_timer: name: Timer description: The value in minutes to set the timer to, 0 to disable it required: true - example: 30 selector: number: min: 0 @@ -108,7 +102,6 @@ set_speed: name: Speed description: Speed required: true - example: 1 selector: number: min: 1 diff --git a/homeassistant/components/ecobee/services.yaml b/homeassistant/components/ecobee/services.yaml index d88088849b1..aba57989119 100644 --- a/homeassistant/components/ecobee/services.yaml +++ b/homeassistant/components/ecobee/services.yaml @@ -9,7 +9,6 @@ create_vacation: name: Entity description: ecobee thermostat on which to create the vacation. required: true - example: "climate.kitchen" selector: entity: integration: ecobee @@ -25,7 +24,6 @@ create_vacation: name: Cool temperature description: Cooling temperature during the vacation. required: true - example: 23 selector: number: min: 7 @@ -36,7 +34,6 @@ create_vacation: name: Heat temperature description: Heating temperature during the vacation. required: true - example: 25 selector: number: min: 7 @@ -74,7 +71,6 @@ create_vacation: fan_mode: name: Fan mode description: Fan mode of the thermostat during the vacation. - example: "on" default: "auto" selector: select: @@ -84,7 +80,6 @@ create_vacation: fan_min_on_time: name: Fan minimum on time description: Minimum number of minutes to run the fan each hour (0 to 60) during the vacation. - example: 30 default: 0 selector: number: @@ -121,7 +116,6 @@ resume_program: entity_id: name: Entity description: Name(s) of entities to change. - example: "climate.kitchen" selector: entity: integration: ecobee @@ -129,7 +123,6 @@ resume_program: resume_all: name: Resume all description: Resume all events and return to the scheduled program. - example: true default: false selector: boolean: @@ -141,7 +134,6 @@ set_fan_min_on_time: entity_id: name: Entity description: Name(s) of entities to change. - example: "climate.kitchen" selector: entity: integration: ecobee @@ -150,7 +142,6 @@ set_fan_min_on_time: name: Fan minimum on time description: New value of fan min on time. required: true - example: 5 selector: number: min: 0 @@ -169,7 +160,6 @@ set_dst_mode: name: Daylight savings time enabled description: Enable automatic daylight savings time. required: true - example: "true" selector: boolean: @@ -185,7 +175,6 @@ set_mic_mode: name: Mic enabled description: Enable Alexa mic. required: true - example: "true" selector: boolean: @@ -200,12 +189,10 @@ set_occupancy_modes: auto_away: name: Auto away description: Enable Smart Home/Away mode. - example: "true" selector: boolean: follow_me: name: Follow me description: Enable Follow Me mode. - example: "true" selector: boolean: diff --git a/homeassistant/components/eight_sleep/services.yaml b/homeassistant/components/eight_sleep/services.yaml index 7ef2f22d298..537f04bd306 100644 --- a/homeassistant/components/eight_sleep/services.yaml +++ b/homeassistant/components/eight_sleep/services.yaml @@ -6,7 +6,6 @@ heat_set: name: Duration description: Duration to heat/cool at the target level in seconds. required: true - example: 3600 selector: number: min: 0 @@ -16,7 +15,6 @@ heat_set: name: Entity description: Entity id of the bed state to adjust. required: true - example: sensor.eight_left_bed_state selector: entity: integration: eight_sleep @@ -25,7 +23,6 @@ heat_set: name: Target description: Target cooling/heating level from -100 to 100. required: true - example: 35 selector: number: min: -100 diff --git a/homeassistant/components/elkm1/services.yaml b/homeassistant/components/elkm1/services.yaml index f380e4f4b18..18608f3a476 100644 --- a/homeassistant/components/elkm1/services.yaml +++ b/homeassistant/components/elkm1/services.yaml @@ -89,7 +89,6 @@ alarm_display_message: clear: name: Clear description: 0=clear message, 1=clear message with * key, 2=Display until timeout - example: 1 default: 2 selector: number: @@ -98,14 +97,12 @@ alarm_display_message: beep: name: Beep description: 0=no beep, 1=beep - example: 1 default: 0 selector: boolean: timeout: name: Timeout description: Time to display message, 0=forever, max 65535 - example: 4242 default: 0 selector: number: @@ -164,7 +161,6 @@ speak_word: name: Word number description: Word number to speak. required: true - example: 142 selector: number: min: 1 @@ -197,7 +193,6 @@ sensor_counter_set: name: Value description: Value to set the counter to. required: true - example: 4242 selector: number: min: 0 diff --git a/homeassistant/components/envisalink/services.yaml b/homeassistant/components/envisalink/services.yaml index 57c64e0c54a..b15a3b94e01 100644 --- a/homeassistant/components/envisalink/services.yaml +++ b/homeassistant/components/envisalink/services.yaml @@ -8,7 +8,6 @@ alarm_keypress: name: Entity description: Name of the alarm control panel to trigger. required: true - example: "alarm_control_panel.downstairs" selector: entity: integration: envisalink @@ -40,7 +39,6 @@ invoke_custom_function: name: PGM description: The PGM number to trigger on the alarm panel. required: true - example: "2" selector: number: min: 1 diff --git a/homeassistant/components/evohome/services.yaml b/homeassistant/components/evohome/services.yaml index 5a6993f6ad7..bdcb116e4e3 100644 --- a/homeassistant/components/evohome/services.yaml +++ b/homeassistant/components/evohome/services.yaml @@ -66,7 +66,6 @@ set_zone_override: name: Setpoint description: The temperature to be used instead of the scheduled setpoint. required: true - example: 5.0 selector: number: min: 4.0 @@ -89,7 +88,6 @@ clear_zone_override: name: Entity description: The entity_id of the zone. required: true - example: climate.bathroom selector: entity: integration: evohome diff --git a/homeassistant/components/facebox/services.yaml b/homeassistant/components/facebox/services.yaml index 9c89c5e5c41..3f968cf385a 100644 --- a/homeassistant/components/facebox/services.yaml +++ b/homeassistant/components/facebox/services.yaml @@ -5,7 +5,6 @@ teach_face: entity_id: name: Entity description: The facebox entity to teach. - example: "image_processing.facebox" selector: entity: integration: facebox diff --git a/homeassistant/components/fan/services.yaml b/homeassistant/components/fan/services.yaml index 06245e68395..ee39229699d 100644 --- a/homeassistant/components/fan/services.yaml +++ b/homeassistant/components/fan/services.yaml @@ -40,14 +40,11 @@ set_percentage: name: Percentage description: Percentage speed setting. required: true - example: 25 selector: number: min: 0 max: 100 - step: 1 unit_of_measurement: "%" - mode: slider turn_on: name: Turn on @@ -60,17 +57,16 @@ turn_on: name: Speed description: Speed setting. example: "high" + selector: + text: percentage: name: Percentage description: Percentage speed setting. - example: 75 selector: number: min: 0 max: 100 - step: 1 unit_of_measurement: "%" - mode: slider preset_mode: name: Preset mode description: Preset mode setting. @@ -96,7 +92,6 @@ oscillate: name: Oscillating description: Flag to turn on/off oscillation. required: true - example: true selector: boolean: @@ -118,7 +113,6 @@ set_direction: name: Direction description: The direction to rotate. required: true - example: "forward" selector: select: options: @@ -136,14 +130,11 @@ increase_speed: advanced: true required: false description: Increase speed by a percentage. - example: 50 selector: number: min: 0 max: 100 - step: 1 unit_of_measurement: "%" - mode: slider decrease_speed: name: Decrease speed @@ -156,11 +147,8 @@ decrease_speed: advanced: true required: false description: Decrease speed by a percentage. - example: 50 selector: number: min: 0 max: 100 - step: 1 unit_of_measurement: "%" - mode: slider diff --git a/homeassistant/components/ffmpeg/services.yaml b/homeassistant/components/ffmpeg/services.yaml index a00a820ebc8..1fdde46e55c 100644 --- a/homeassistant/components/ffmpeg/services.yaml +++ b/homeassistant/components/ffmpeg/services.yaml @@ -5,7 +5,6 @@ restart: entity_id: name: Entity description: Name of entity that will restart. Platform dependent. - example: binary_sensor.ffmpeg_noise selector: entity: integration: ffmpeg @@ -17,7 +16,6 @@ start: entity_id: name: Entity description: Name of entity that will start. Platform dependent. - example: binary_sensor.ffmpeg_noise selector: entity: integration: ffmpeg @@ -29,7 +27,6 @@ stop: entity_id: name: Entity description: Name of entity that will stop. Platform dependent. - example: binary_sensor.ffmpeg_noise selector: entity: integration: ffmpeg diff --git a/homeassistant/components/flo/services.yaml b/homeassistant/components/flo/services.yaml index 237fb4a7bf9..fb3dbb3ee0a 100644 --- a/homeassistant/components/flo/services.yaml +++ b/homeassistant/components/flo/services.yaml @@ -12,7 +12,6 @@ set_sleep_mode: name: Sleep minutes description: The time to sleep in minutes. default: true - example: 120 selector: select: options: @@ -23,7 +22,6 @@ set_sleep_mode: name: Revert to mode description: The mode to revert to after sleep_minutes has elapsed. default: true - example: "home" selector: select: options: diff --git a/homeassistant/components/foscam/services.yaml b/homeassistant/components/foscam/services.yaml index 61326d0e8b6..04dba8ccbaa 100644 --- a/homeassistant/components/foscam/services.yaml +++ b/homeassistant/components/foscam/services.yaml @@ -9,7 +9,6 @@ ptz: movement: description: "Direction of the movement." required: true - example: "up" selector: select: options: @@ -23,7 +22,6 @@ ptz: - 'up' travel_time: description: "Travel time in seconds." - example: 0.125 default: 0.125 selector: number: diff --git a/homeassistant/components/frontend/services.yaml b/homeassistant/components/frontend/services.yaml index 0f4948f4bf9..478202a4a0a 100644 --- a/homeassistant/components/frontend/services.yaml +++ b/homeassistant/components/frontend/services.yaml @@ -13,9 +13,8 @@ set_theme: text: mode: name: Mode - description: The mode the theme is for, either 'dark' or 'light'. + description: The mode the theme is for. default: "light" - example: "dark" selector: select: options: diff --git a/homeassistant/components/geniushub/services.yaml b/homeassistant/components/geniushub/services.yaml index 27d7189f953..1edcf243cc0 100644 --- a/homeassistant/components/geniushub/services.yaml +++ b/homeassistant/components/geniushub/services.yaml @@ -10,7 +10,6 @@ set_zone_mode: name: Entity description: The zone's entity_id. required: true - example: climate.kitchen selector: entity: integration: geniushub @@ -19,7 +18,6 @@ set_zone_mode: name: Mode description: "One of: off, timer or footprint." required: true - example: timer selector: select: options: @@ -36,7 +34,6 @@ set_zone_override: name: Entity description: The zone's entity_id. required: true - example: climate.bathroom selector: entity: integration: geniushub @@ -45,7 +42,6 @@ set_zone_override: name: Temperature description: The target temperature. required: true - example: 19.2 selector: number: min: 4 diff --git a/homeassistant/components/group/services.yaml b/homeassistant/components/group/services.yaml index f1e64a60022..3e7f1eb203d 100644 --- a/homeassistant/components/group/services.yaml +++ b/homeassistant/components/group/services.yaml @@ -41,7 +41,6 @@ set: all: name: All description: Enable this option if the group should only turn on when all entities are on. - example: true selector: boolean: diff --git a/homeassistant/components/harmony/services.yaml b/homeassistant/components/harmony/services.yaml index e548285ae83..fd53912397a 100644 --- a/homeassistant/components/harmony/services.yaml +++ b/homeassistant/components/harmony/services.yaml @@ -18,7 +18,6 @@ change_channel: name: Channel description: Channel number to change to required: true - example: "200" selector: number: min: 1 diff --git a/homeassistant/components/hdmi_cec/services.yaml b/homeassistant/components/hdmi_cec/services.yaml index e5ee0d0a95a..943450a6796 100644 --- a/homeassistant/components/hdmi_cec/services.yaml +++ b/homeassistant/components/hdmi_cec/services.yaml @@ -62,7 +62,6 @@ volume: down: name: Down description: Decreases volume x levels. - example: 3 selector: number: min: 1 @@ -70,7 +69,6 @@ volume: mute: name: Mute description: Mutes audio system. - example: toggle selector: select: options: @@ -80,7 +78,6 @@ volume: up: name: Up description: Increases volume x levels. - example: 3 selector: number: min: 1 diff --git a/homeassistant/components/hive/services.yaml b/homeassistant/components/hive/services.yaml index f69e9efa19f..d0de9645c6a 100644 --- a/homeassistant/components/hive/services.yaml +++ b/homeassistant/components/hive/services.yaml @@ -16,7 +16,6 @@ boost_heating: temperature: name: Temperature description: Set the target temperature for the boost period. - example: 20.5 default: 25.0 selector: number: @@ -24,7 +23,6 @@ boost_heating: max: 35 step: 0.5 unit_of_measurement: ° - mode: slider boost_heating_on: name: Boost Heating On description: Set the boost mode ON defining the period of time and the desired target temperature for the boost. @@ -43,7 +41,6 @@ boost_heating_on: temperature: name: Temperature description: Set the target temperature for the boost period. - example: 20.5 default: 25.0 selector: number: @@ -51,7 +48,6 @@ boost_heating_on: max: 35 step: 0.5 unit_of_measurement: ° - mode: slider boost_heating_off: name: Boost Heating Off description: Set the boost mode OFF. @@ -60,7 +56,6 @@ boost_heating_off: name: Entity ID description: Select entity_id to turn boost off. required: true - example: climate.heating selector: entity: integration: hive @@ -73,7 +68,6 @@ boost_hot_water: name: Entity ID description: Select entity_id to boost. required: true - example: water_heater.hot_water selector: entity: integration: hive @@ -89,7 +83,6 @@ boost_hot_water: name: Mode description: Set the boost function on or off. required: true - example: "on" selector: select: options: diff --git a/homeassistant/components/homematic/services.yaml b/homeassistant/components/homematic/services.yaml index c1afa3cf1a8..15099c790fb 100644 --- a/homeassistant/components/homematic/services.yaml +++ b/homeassistant/components/homematic/services.yaml @@ -15,7 +15,6 @@ virtualkey: name: Channel description: Channel for calling a keypress. required: true - example: 1 selector: number: min: 1 @@ -41,7 +40,6 @@ set_variable_value: entity_id: name: Entity description: Name(s) of homematic central to set value. - example: "homematic.ccu2" selector: entity: domain: homematic @@ -75,7 +73,6 @@ set_device_value: name: Channel description: Channel for calling a keypress required: true - example: 1 selector: number: min: 1 @@ -130,7 +127,6 @@ set_install_mode: mode: name: Mode description: 1= Normal mode / 2= Remove exists old links - example: 1 default: 1 selector: number: @@ -139,7 +135,6 @@ set_install_mode: time: name: Time description: Time to run in install mode - example: 1 default: 60 selector: number: diff --git a/homeassistant/components/homematicip_cloud/services.yaml b/homeassistant/components/homematicip_cloud/services.yaml index 3f493ef11a9..ae8a6f34049 100644 --- a/homeassistant/components/homematicip_cloud/services.yaml +++ b/homeassistant/components/homematicip_cloud/services.yaml @@ -8,7 +8,11 @@ activate_eco_mode_with_duration: name: Duration description: The duration of eco mode in minutes. required: true - example: 60 + selector: + number: + min: 1 + max: 1440 + unit_of_measurement: "minutes" accesspoint_id: name: Accesspoint ID description: The ID of the Homematic IP Access Point @@ -49,7 +53,6 @@ activate_vacation: name: Temperature description: the set temperature during the vacation mode. required: true - example: 18.5 default: 18 selector: number: @@ -99,9 +102,8 @@ set_active_climate_profile: text: climate_profile_index: name: Climate profile index - description: The index of the climate profile (1 based) + description: The index of the climate profile. required: true - example: 1 selector: number: min: 1 @@ -127,7 +129,6 @@ dump_hap_config: anonymize: name: Anonymize description: Should the Configuration be anonymized? - example: true default: true selector: boolean: diff --git a/homeassistant/components/humidifier/services.yaml b/homeassistant/components/humidifier/services.yaml index a11c5fb1198..c05dad680a3 100644 --- a/homeassistant/components/humidifier/services.yaml +++ b/homeassistant/components/humidifier/services.yaml @@ -24,7 +24,6 @@ set_humidity: humidity: description: New target humidity for humidifier device. required: true - example: 50 selector: number: min: 0 diff --git a/homeassistant/components/icloud/services.yaml b/homeassistant/components/icloud/services.yaml index 60410701da0..ddeae448f8a 100644 --- a/homeassistant/components/icloud/services.yaml +++ b/homeassistant/components/icloud/services.yaml @@ -57,7 +57,6 @@ display_message: sound: name: Sound description: To make a sound when displaying the message. - example: "true" selector: boolean: diff --git a/homeassistant/components/ifttt/services.yaml b/homeassistant/components/ifttt/services.yaml index e81faca1acd..9c02284d4f8 100644 --- a/homeassistant/components/ifttt/services.yaml +++ b/homeassistant/components/ifttt/services.yaml @@ -7,7 +7,6 @@ push_alarm_state: entity_id: description: Name of the alarm control panel which state has to be updated. required: true - example: "alarm_control_panel.downstairs" selector: entity: domain: alarm_control_panel diff --git a/homeassistant/components/ihc/services.yaml b/homeassistant/components/ihc/services.yaml index 06ef0930e97..33f6c8ca31d 100644 --- a/homeassistant/components/ihc/services.yaml +++ b/homeassistant/components/ihc/services.yaml @@ -8,8 +8,7 @@ set_runtime_value_bool: name: Controller ID description: | If you have multiple controller, this is the index of you controller - starting with 0 - example: 0 + starting with 0. default: 0 selector: number: @@ -19,7 +18,6 @@ set_runtime_value_bool: name: IHC ID description: The integer IHC resource ID. required: true - example: 123456 selector: number: min: 0 @@ -29,7 +27,6 @@ set_runtime_value_bool: name: Value description: The boolean value to set. required: true - example: true selector: boolean: @@ -41,8 +38,7 @@ set_runtime_value_int: name: Controller ID description: | If you have multiple controller, this is the index of you controller - starting with 0 - example: 0 + starting with 0. default: 0 selector: number: @@ -52,7 +48,6 @@ set_runtime_value_int: name: IHC ID description: The integer IHC resource ID. required: true - example: 123456 selector: number: min: 0 @@ -62,7 +57,6 @@ set_runtime_value_int: name: Value description: The integer value to set. required: true - example: 50 selector: number: min: 0 @@ -77,8 +71,7 @@ set_runtime_value_float: name: Controller ID description: | If you have multiple controller, this is the index of you controller - starting with 0 - example: 0 + starting with 0. default: 0 selector: number: @@ -88,7 +81,6 @@ set_runtime_value_float: name: IHC ID description: The integer IHC resource ID. required: true - example: 123456 selector: number: min: 0 @@ -98,7 +90,6 @@ set_runtime_value_float: name: Value description: The float value to set. required: true - example: 1.47 selector: number: min: 0 @@ -114,8 +105,7 @@ pulse: name: Controller ID description: | If you have multiple controller, this is the index of you controller - starting with 0 - example: 0 + starting with 0. default: 0 selector: number: @@ -125,7 +115,6 @@ pulse: name: IHC ID description: The integer IHC resource ID. required: true - example: 123456 selector: number: min: 0 diff --git a/homeassistant/components/input_datetime/services.yaml b/homeassistant/components/input_datetime/services.yaml index 519b4a085ad..51b1d6b00c1 100644 --- a/homeassistant/components/input_datetime/services.yaml +++ b/homeassistant/components/input_datetime/services.yaml @@ -28,7 +28,6 @@ set_datetime: description: The target date & time the entity should be set to as expressed by a UNIX timestamp. - example: 1598027400 selector: number: min: 0 diff --git a/homeassistant/components/input_number/services.yaml b/homeassistant/components/input_number/services.yaml index 477adbb0dbe..41164a7ccf5 100644 --- a/homeassistant/components/input_number/services.yaml +++ b/homeassistant/components/input_number/services.yaml @@ -23,7 +23,6 @@ set_value: name: Value description: The target value the entity should be set to. required: true - example: 42 selector: number: min: 0 diff --git a/homeassistant/components/input_select/services.yaml b/homeassistant/components/input_select/services.yaml index b42497e12bf..8b8828eaa92 100644 --- a/homeassistant/components/input_select/services.yaml +++ b/homeassistant/components/input_select/services.yaml @@ -9,7 +9,6 @@ select_next: name: Cycle description: If the option should cycle from the last to the first. default: true - example: true selector: boolean: @@ -39,7 +38,6 @@ select_previous: name: Cycle description: If the option should cycle from the first to the last. default: true - example: true selector: boolean: diff --git a/homeassistant/components/insteon/services.yaml b/homeassistant/components/insteon/services.yaml index b2f8467475e..21bc0f535f6 100644 --- a/homeassistant/components/insteon/services.yaml +++ b/homeassistant/components/insteon/services.yaml @@ -6,7 +6,6 @@ add_all_link: name: Group description: All-Link group number. required: true - example: 1 selector: number: min: 0 @@ -15,7 +14,6 @@ add_all_link: name: Mode description: Linking mode controller - IM is controller responder - IM is responder required: true - example: "controller" selector: select: options: @@ -29,7 +27,6 @@ delete_all_link: name: Group description: All-Link group number. required: true - example: 1 selector: number: min: 0 @@ -48,7 +45,6 @@ load_all_link_database: reload: name: Reload description: Reload all records. If true the current records are cleared from memory (does not effect the device) and the records are reloaded. If false the existing records are left in place and only missing records are added. Default is false. - example: "true" default: false selector: boolean: @@ -60,7 +56,6 @@ print_all_link_database: name: Entity description: Name of the device to print required: true - example: "light.1a2b3c" selector: entity: integration: insteon @@ -75,7 +70,6 @@ x10_all_units_off: name: Housecode description: X10 house code required: true - example: c selector: select: options: @@ -103,7 +97,6 @@ x10_all_lights_on: name: Housecode description: X10 house code required: true - example: c selector: select: options: @@ -131,7 +124,6 @@ x10_all_lights_off: name: Housecode description: X10 house code required: true - example: c selector: select: options: @@ -159,7 +151,6 @@ scene_on: name: Group description: INSTEON group or scene number required: true - example: 26 selector: number: min: 0 @@ -172,7 +163,6 @@ scene_off: name: Group description: INSTEON group or scene number required: true - example: 26 selector: number: min: 0 diff --git a/homeassistant/components/isy994/services.yaml b/homeassistant/components/isy994/services.yaml index 73e0a675e49..923dfe1fd6f 100644 --- a/homeassistant/components/isy994/services.yaml +++ b/homeassistant/components/isy994/services.yaml @@ -20,7 +20,6 @@ send_raw_node_command: value: name: Value description: The integer value to be sent with the command. - example: 255 selector: number: min: 0 @@ -35,7 +34,6 @@ send_raw_node_command: unit_of_measurement: name: Unit of measurement description: The ISY Unit of Measurement (UOM) to send with the command, if required. - example: 67 selector: number: min: 0 @@ -53,7 +51,6 @@ send_node_command: name: Command description: The command to be sent to the device. required: true - example: "fast_on" selector: select: options: @@ -150,7 +147,6 @@ set_on_level: name: Value description: integer value to set. required: true - example: 255 selector: number: min: 0 @@ -167,7 +163,6 @@ set_ramp_rate: name: Value description: Integer value to set, see PyISY/ISY documentation for values to actual ramp times. required: true - example: 30 selector: number: min: 0 @@ -195,7 +190,6 @@ set_variable: address: name: Address description: The address of the variable for which to set the value. - example: 5 selector: number: min: 0 @@ -203,7 +197,6 @@ set_variable: type: name: Type description: The variable type, 1 = Integer, 2 = State. - example: 2 selector: number: min: 1 @@ -217,7 +210,6 @@ set_variable: init: name: Init description: If True, the initial (init) value will be updated instead of the current value. - example: false default: false selector: boolean: @@ -225,7 +217,6 @@ set_variable: name: Value description: The integer value to be sent. required: true - example: 255 selector: number: min: 0 @@ -246,15 +237,18 @@ send_program_command: name: Address description: The address of the program to control (use either address or name). example: "04B1" + selector: + text: name: name: Name description: The name of the program to control (use either address or name). example: "My Program" + selector: + text: command: name: Command description: The ISY Program Command to be sent. required: true - example: "run" selector: select: options: @@ -279,7 +273,6 @@ run_network_resource: address: name: Address description: The address of the network resource to execute (use either address or name). - example: 121 selector: number: min: 0 diff --git a/homeassistant/components/izone/services.yaml b/homeassistant/components/izone/services.yaml index d03ad66421a..5cecbb68a9f 100644 --- a/homeassistant/components/izone/services.yaml +++ b/homeassistant/components/izone/services.yaml @@ -8,16 +8,14 @@ airflow_min: fields: airflow: name: Percent - description: Airflow percent in 5% increments + description: Airflow percent. required: true - example: 95 selector: number: min: 0 max: 100 step: 5 unit_of_measurement: "%" - mode: slider airflow_max: name: Set maximum airflow description: Set the airflow maximum percent for a zone @@ -28,13 +26,11 @@ airflow_max: fields: airflow: name: Percent - description: Airflow percent in 5% increments + description: Airflow percent. required: true - example: 95 selector: number: min: 0 max: 100 step: 5 unit_of_measurement: "%" - mode: slider diff --git a/homeassistant/components/keba/services.yaml b/homeassistant/components/keba/services.yaml index 10e03f83b08..8e5e8cd91f8 100644 --- a/homeassistant/components/keba/services.yaml +++ b/homeassistant/components/keba/services.yaml @@ -22,13 +22,13 @@ set_energy: energy: name: Energy description: > - The energy target to stop charging in kWh. Setting 0 disables the limit. - example: 10.0 + The energy target to stop charging. Setting 0 disables the limit. selector: number: min: 0 max: 100 step: 0.1 + unit_of_measurement: "kWh" set_current: name: Set current @@ -37,16 +37,16 @@ set_current: current: name: Current description: > - The maximum current used for the charging process in A. Allowed are values between - 6 A and 63 A. Invalid values are discardedand the default is set to 6 A. - The value is also depending on the DIP-switchsettings and the used cable of the - charging station - example: 16 + The maximum current used for the charging process. + The value is depending on the DIP-switch settings and the used cable of the + charging station. + default: 6 selector: number: - min: 0 - max: 100 + min: 6 + max: 63 step: 0.1 + unit_of_measurement: "A" enable: name: Enable @@ -67,7 +67,6 @@ set_failsafe: name: Failsafe timeout description: > Timeout after which the failsafe mode is triggered, if set_current was not executed during this time. - example: 30 default: 30 selector: number: @@ -77,19 +76,18 @@ set_failsafe: failsafe_fallback: name: Failsafe fallback description: > - Fallback current in A to be set after timeout. - example: 6 + Fallback current to be set after timeout. default: 6 selector: number: - min: 0 - max: 100 + min: 6 + max: 63 step: 0.1 + unit_of_measurement: "A" failsafe_persist: name: Failsafe persist description: > If failsafe_persist is 0, the failsafe option is only until charging station reboot. If failsafe_persist is 1, the failsafe option will survive a reboot. - example: 0 default: 0 selector: number: diff --git a/homeassistant/components/kef/services.yaml b/homeassistant/components/kef/services.yaml index 6822c41dbc1..291a8f45cdb 100644 --- a/homeassistant/components/kef/services.yaml +++ b/homeassistant/components/kef/services.yaml @@ -18,31 +18,26 @@ set_mode: desk_mode: name: Desk mode description: Desk mode. - example: true selector: boolean: wall_mode: name: Wall mode description: Wall mode. - example: true selector: boolean: phase_correction: name: Phase correction description: Phase correction. - example: true selector: boolean: high_pass: name: High pass description: High-pass mode". - example: true selector: boolean: sub_polarity: name: Subwoofer polarity description: Sub polarity. - example: "+" selector: select: options: @@ -51,7 +46,6 @@ set_mode: bass_extension: name: Base extension description: Bass extension. - example: "Extra" selector: select: options: @@ -62,11 +56,11 @@ set_mode: set_desk_db: name: Set desk dB description: Set the "Desk mode" slider of the speaker in dB. + target: + entity: + integration: kef + domain: media_player fields: - entity_id: - name: Entity - description: The entity_id of the KEF speaker. - example: media_player.kef_lsx db_value: name: dB value description: Value of the slider @@ -89,7 +83,6 @@ set_wall_db: db_value: name: dB value description: Value of the slider. - example: 0.0 selector: number: min: -6 @@ -108,7 +101,6 @@ set_treble_db: db_value: name: dB value description: Value of the slider. - example: 0.0 selector: number: min: -2 @@ -127,7 +119,6 @@ set_high_hz: hz_value: name: Hertz value description: Value of the slider. - example: 95 selector: number: min: 50 @@ -146,7 +137,6 @@ set_low_hz: hz_value: name: Hertz value description: Value of the slider. - example: 80 selector: number: min: 40 @@ -165,10 +155,8 @@ set_sub_db: db_value: name: dB value description: Value of the slider. - example: 0 selector: number: min: -10 max: 10 - step: 1 unit_of_measurement: dB diff --git a/homeassistant/components/knx/services.yaml b/homeassistant/components/knx/services.yaml index 6090057feca..1ea5d9b6faa 100644 --- a/homeassistant/components/knx/services.yaml +++ b/homeassistant/components/knx/services.yaml @@ -73,7 +73,6 @@ exposure_register: name: "Entity" description: "Entity id whose state or attribute shall be exposed." required: true - example: "light.kitchen" selector: entity: attribute: diff --git a/homeassistant/components/lcn/services.yaml b/homeassistant/components/lcn/services.yaml index 299e1df5777..52aa8863872 100644 --- a/homeassistant/components/lcn/services.yaml +++ b/homeassistant/components/lcn/services.yaml @@ -15,7 +15,6 @@ output_abs: name: Output description: Output port required: true - example: "output1" selector: select: options: @@ -25,17 +24,16 @@ output_abs: - "output4" brightness: name: Brightness - description: Absolute brightness in percent. + description: Absolute brightness. required: true - example: 50 selector: number: min: 0 max: 100 + unit_of_measurement: "%" transition: name: Transition description: Transition time. - example: 5 default: 0 selector: number: @@ -59,7 +57,6 @@ output_rel: name: Output description: Output port required: true - example: "output1" selector: select: options: @@ -69,9 +66,8 @@ output_rel: - "output4" brightness: name: Brightness - description: Relative brightness in percent. + description: Relative brightness. required: true - example: 50 selector: number: min: -100 @@ -93,7 +89,6 @@ output_toggle: name: Output description: Output port required: true - example: "output1" selector: select: options: @@ -104,7 +99,6 @@ output_toggle: transition: name: Transition description: Transition time. - example: 5 default: 0 selector: number: @@ -126,7 +120,7 @@ relays: text: state: name: State - description: Relays states as string (1=on, 2=off, t=toggle, -=nochange) + description: Relays states as string (1=on, 2=off, t=toggle, -=no change) required: true example: "t---001-" selector: @@ -147,7 +141,6 @@ led: name: LED description: Led required: true - example: "led6" selector: select: options: @@ -167,7 +160,6 @@ led: name: State description: Led state required: true - example: "blink" selector: select: options: @@ -191,7 +183,6 @@ var_abs: name: Variable description: Variable or setpoint name required: true - example: "var1" default: native selector: select: @@ -218,8 +209,7 @@ var_abs: - "var12" value: name: Value - description: Value to set - example: "50" + description: Value to set. default: 0 selector: number: @@ -227,8 +217,7 @@ var_abs: max: 100000 unit_of_measurement: name: Unit of measurement - description: Unit of value - example: "celsius" + description: Unit of value. selector: select: options: @@ -265,11 +254,12 @@ var_reset: description: Module address required: true example: "myhome.s0.m7" + selector: + text: variable: name: Variable - description: Variable or setpoint name + description: Variable or setpoint name. required: true - example: "var1" selector: select: options: @@ -309,7 +299,6 @@ var_rel: name: Variable description: Variable or setpoint name required: true - example: "var1" selector: select: options: @@ -353,7 +342,6 @@ var_rel: value: name: Value description: Shift value - example: "50" default: 0 selector: number: @@ -362,7 +350,6 @@ var_rel: unit_of_measurement: name: Unit of measurement description: Unit of value - example: "celsius" default: native selector: select: @@ -393,7 +380,6 @@ var_rel: value_reference: name: Reference value description: Reference value for setpoint and threshold - example: "current" default: current selector: select: @@ -416,7 +402,6 @@ lock_regulator: name: Setpoint description: Setpoint name required: true - example: "r1varsetpoint" selector: select: options: @@ -440,7 +425,6 @@ lock_regulator: state: name: State description: New setpoint state - example: true default: false selector: boolean: @@ -465,8 +449,7 @@ send_keys: text: state: name: State - description: "Key state upon sending (optional, must be hit for deferred)" - example: "hit" + description: "Key state upon sending (must be hit for deferred)" default: hit selector: select: @@ -478,7 +461,6 @@ send_keys: time: name: Time description: Send delay. - example: 10 default: 0 selector: number: @@ -487,7 +469,6 @@ send_keys: time_unit: name: Time unit description: Time unit of send delay. - example: "s" default: s selector: select: @@ -535,7 +516,6 @@ lock_keys: time: name: Time description: Lock interval. - example: 10 default: 0 selector: number: @@ -544,7 +524,6 @@ lock_keys: time_unit: name: Time unit description: Time unit of lock interval. - example: "s" default: s selector: select: @@ -579,7 +558,6 @@ dyn_text: name: Row description: Text row. required: true - example: 1 selector: number: min: 1 diff --git a/homeassistant/components/lifx/services.yaml b/homeassistant/components/lifx/services.yaml index 5f4784630aa..e5a1cf4b5d8 100644 --- a/homeassistant/components/lifx/services.yaml +++ b/homeassistant/components/lifx/services.yaml @@ -9,7 +9,6 @@ set_state: infrared: name: infrared description: Automatic infrared level when light brightness is low. - example: 255 selector: number: min: 0 @@ -23,7 +22,6 @@ set_state: transition: name: Transition description: Duration it takes to get to the final state. - example: 10 selector: number: min: 0 @@ -32,7 +30,6 @@ set_state: power: name: Power description: Turn the light on or off. Leave out to keep the power as it is. - example: false selector: boolean: @@ -47,7 +44,6 @@ effect_pulse: mode: name: Mode description: "Decides how colors are changed." - example: strobe selector: select: options: @@ -59,7 +55,6 @@ effect_pulse: brightness: name: Brightness description: Number indicating brightness of the temporary color. - example: 120 selector: number: min: 0 @@ -79,7 +74,6 @@ effect_pulse: period: name: Period description: Duration of the effect. - example: 3 default: 1.0 selector: number: @@ -90,7 +84,6 @@ effect_pulse: cycles: name: Cycles description: Number of times the effect should run. - example: 2 default: 1 selector: number: @@ -99,7 +92,6 @@ effect_pulse: power_on: name: Power on description: Powered off lights are temporarily turned on during the effect. - example: false default: true selector: boolean: @@ -115,7 +107,6 @@ effect_colorloop: brightness: name: Brightness description: Number indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light. - example: 120 selector: number: min: 0 @@ -123,7 +114,6 @@ effect_colorloop: period: name: Period description: Duration between color changes. - example: 180 default: 60 selector: number: @@ -134,7 +124,6 @@ effect_colorloop: change: name: Change description: Hue movement per period, in degrees on a color wheel. - example: 45 default: 20 selector: number: @@ -144,7 +133,6 @@ effect_colorloop: spread: name: Spread description: Maximum hue difference between participating lights, in degrees on a color wheel. - example: 0 default: 30 selector: number: @@ -154,7 +142,6 @@ effect_colorloop: power_on: name: Power on description: Powered off lights are temporarily turned on during the effect. - example: false default: true selector: boolean: diff --git a/homeassistant/components/light/services.yaml b/homeassistant/components/light/services.yaml index 8ad01bcdd8c..e2a8a94a74a 100644 --- a/homeassistant/components/light/services.yaml +++ b/homeassistant/components/light/services.yaml @@ -11,15 +11,12 @@ turn_on: fields: transition: name: Transition - description: Duration in seconds it takes to get to next state. - example: 60 + description: Duration it takes to get to next state. selector: number: min: 0 max: 300 - step: 1 unit_of_measurement: seconds - mode: slider rgb_color: name: RGB-color description: A list containing three integers between 0 and 255 representing the RGB (red, green, blue) color for the light. @@ -45,7 +42,6 @@ turn_on: name: Color name description: A human readable color name. advanced: true - example: "red" selector: select: options: @@ -216,76 +212,59 @@ turn_on: name: Color temperature (mireds) description: Color temperature for the light in mireds. advanced: true - example: 250 selector: number: min: 153 max: 500 - step: 1 unit_of_measurement: mireds - mode: slider kelvin: name: Color temperature (Kelvin) description: Color temperature for the light in Kelvin. advanced: true - example: 4000 selector: number: min: 2000 max: 6500 step: 100 unit_of_measurement: K - mode: slider brightness: name: Brightness value description: - Number between 0..255 indicating brightness, where 0 turns the light + Number indicating brightness, where 0 turns the light off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light. advanced: true - example: 120 selector: number: min: 0 max: 255 - step: 1 - mode: slider brightness_pct: name: Brightness description: - Number between 0..100 indicating percentage of full brightness, where 0 + Number indicating percentage of full brightness, where 0 turns the light off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light. - example: 47 selector: number: min: 0 max: 100 - step: 1 unit_of_measurement: "%" - mode: slider brightness_step: name: Brightness step value - description: Change brightness by an amount. Should be between -255..255. + description: Change brightness by an amount. advanced: true - example: -25.5 selector: number: min: -225 max: 255 - step: 1 - mode: slider brightness_step_pct: name: Brightness step - description: Change brightness by a percentage. Should be between -100..100. - example: -10 + description: Change brightness by a percentage. selector: number: min: -100 max: 100 - step: 1 unit_of_measurement: "%" - mode: slider profile: name: Profile description: Name of a light profile to use. @@ -295,12 +274,8 @@ turn_on: text: flash: name: Flash - description: If the light should flash. Valid values are short and long. + description: If the light should flash. advanced: true - example: short - values: - - short - - long selector: select: options: @@ -309,12 +284,12 @@ turn_on: effect: name: Effect description: Light effect. - example: random - values: - - colorloop - - random selector: - text: + select: + options: + - colorloop + - random + - white turn_off: name: Turn off @@ -325,23 +300,16 @@ turn_off: fields: transition: name: Transition - description: Duration in seconds it takes to get to next state. - example: 60 + description: Duration it takes to get to next state. selector: number: min: 0 max: 300 - step: 1 unit_of_measurement: seconds - mode: slider flash: name: Flash - description: If the light should flash. Valid values are short and long. + description: If the light should flash. advanced: true - example: short - values: - - short - - long selector: select: options: @@ -359,15 +327,12 @@ toggle: fields: transition: name: Transition - description: Duration in seconds it takes to get to next state. - example: 60 + description: Duration it takes to get to next state. selector: number: min: 0 max: 300 - step: 1 unit_of_measurement: seconds - mode: slider rgb_color: name: RGB-color description: Color for the light in RGB-format. @@ -379,7 +344,6 @@ toggle: name: Color name description: A human readable color name. advanced: true - example: "red" selector: select: options: @@ -550,64 +514,50 @@ toggle: name: Color temperature (mireds) description: Color temperature for the light in mireds. advanced: true - example: 250 selector: number: min: 153 max: 500 - step: 1 unit_of_measurement: mireds - mode: slider kelvin: name: Color temperature (Kelvin) description: Color temperature for the light in Kelvin. advanced: true - example: 4000 selector: number: min: 2000 max: 6500 step: 100 unit_of_measurement: K - mode: slider white_value: name: White level description: Number indicating level of white. advanced: true - example: "250" selector: number: min: 0 max: 255 - step: 1 - mode: slider brightness: name: Brightness value description: Number indicating brightness, where 0 turns the light off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light. advanced: true - example: 120 selector: number: min: 0 max: 255 - step: 1 - mode: slider brightness_pct: name: Brightness description: - Number between 0..100 indicating percentage of full brightness, where 0 + Number indicating percentage of full brightness, where 0 turns the light off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light. - example: 47 selector: number: min: 0 max: 100 - step: 1 unit_of_measurement: "%" - mode: slider profile: name: Profile description: Name of a light profile to use. @@ -617,12 +567,8 @@ toggle: text: flash: name: Flash - description: If the light should flash. Valid values are short and long. + description: If the light should flash. advanced: true - example: short - values: - - short - - long selector: select: options: @@ -631,9 +577,5 @@ toggle: effect: name: Effect description: Light effect. - example: random - values: - - colorloop - - random selector: text: diff --git a/homeassistant/components/litterrobot/services.yaml b/homeassistant/components/litterrobot/services.yaml index 8caf0fcb73c..0071c525567 100644 --- a/homeassistant/components/litterrobot/services.yaml +++ b/homeassistant/components/litterrobot/services.yaml @@ -18,7 +18,6 @@ set_sleep_mode: name: Enabled description: Whether sleep mode should be enabled. required: true - example: true selector: boolean: start_time: @@ -40,11 +39,6 @@ set_wait_time: name: Minutes description: Minutes to wait. required: true - example: 7 - values: - - 3 - - 7 - - 15 default: 7 selector: select: diff --git a/homeassistant/components/local_file/services.yaml b/homeassistant/components/local_file/services.yaml index 08a954594a9..f4382decb0f 100644 --- a/homeassistant/components/local_file/services.yaml +++ b/homeassistant/components/local_file/services.yaml @@ -6,7 +6,6 @@ update_file_path: name: Entity description: Name of the entity_id of the camera to update. required: true - example: "camera.local_file" selector: entity: domain: camera diff --git a/homeassistant/components/lock/services.yaml b/homeassistant/components/lock/services.yaml index 5d5e05240e8..5e371f29ab8 100644 --- a/homeassistant/components/lock/services.yaml +++ b/homeassistant/components/lock/services.yaml @@ -7,7 +7,6 @@ clear_usercode: node_id: name: Node ID description: Node id of the lock. - example: 18 selector: number: min: 1 @@ -15,7 +14,6 @@ clear_usercode: code_slot: name: Code slot description: Code slot to clear code from. - example: 1 selector: number: min: 1 @@ -28,7 +26,6 @@ get_usercode: node_id: name: Node ID description: Node id of the lock. - example: 18 selector: number: min: 1 @@ -36,7 +33,6 @@ get_usercode: code_slot: name: Code slot description: Code slot to retrieve a code from. - example: 1 selector: number: min: 1 @@ -76,14 +72,12 @@ set_usercode: fields: node_id: description: Node id of the lock. - example: 18 selector: number: min: 1 max: 255 code_slot: description: Code slot to set the code. - example: 1 selector: number: min: 1 diff --git a/homeassistant/components/logbook/services.yaml b/homeassistant/components/logbook/services.yaml index e72d4c0a01f..3f688628032 100644 --- a/homeassistant/components/logbook/services.yaml +++ b/homeassistant/components/logbook/services.yaml @@ -19,7 +19,6 @@ log: entity_id: name: Entity ID description: Entity to reference in custom logbook entry. - example: "light.kitchen" selector: entity: domain: diff --git a/homeassistant/components/logger/services.yaml b/homeassistant/components/logger/services.yaml index 51fe5fe331c..1995a027b0b 100644 --- a/homeassistant/components/logger/services.yaml +++ b/homeassistant/components/logger/services.yaml @@ -5,7 +5,6 @@ set_default_level: level: name: Level description: Default severity level for all integrations. - example: debug selector: select: options: @@ -25,7 +24,6 @@ set_level: description: "Example on how to change the logging level for a Home Assistant Core integrations." - example: debug selector: select: options: @@ -40,7 +38,6 @@ set_level: name: Home Assistant components mqtt description: "Example on how to change the logging level for an Integration." - example: warning selector: select: options: @@ -55,7 +52,6 @@ set_level: name: Custom components "my_integation" description: "Example on how to change the logging level for a Custom Integration." - example: debug selector: select: options: @@ -70,7 +66,6 @@ set_level: name: aioHttp description: "Example on how to change the logging level for a Python module." - example: error selector: select: options: diff --git a/homeassistant/components/logi_circle/services.yaml b/homeassistant/components/logi_circle/services.yaml index 00f2a7090fe..248701a5d45 100644 --- a/homeassistant/components/logi_circle/services.yaml +++ b/homeassistant/components/logi_circle/services.yaml @@ -7,7 +7,6 @@ set_config: entity_id: name: Entity description: Name(s) of entities to apply the operation mode to. - example: "camera.living_room_camera" selector: entity: integration: logi_circle @@ -16,7 +15,6 @@ set_config: name: Mode description: "Operation mode. Allowed values: LED, RECORDING_MODE." required: true - example: "RECORDING_MODE" selector: select: options: @@ -26,7 +24,6 @@ set_config: name: Value description: "Operation value." required: true - example: true selector: boolean: @@ -37,7 +34,6 @@ livestream_snapshot: entity_id: name: Entity description: Name(s) of entities to create snapshots from. - example: "camera.living_room_camera" selector: entity: integration: logi_circle @@ -57,7 +53,6 @@ livestream_record: entity_id: name: Entity description: Name(s) of entities to create recordings from. - example: "camera.living_room_camera" selector: entity: integration: logi_circle @@ -73,7 +68,6 @@ livestream_record: name: Duration description: Recording duration. required: true - example: 60 selector: number: min: 1 diff --git a/homeassistant/components/media_extractor/services.yaml b/homeassistant/components/media_extractor/services.yaml index b3ef02c74e3..5b1f86e9dfe 100644 --- a/homeassistant/components/media_extractor/services.yaml +++ b/homeassistant/components/media_extractor/services.yaml @@ -16,7 +16,6 @@ play_media: name: Media content type description: The type of the content to play. Must be one of MUSIC, TVSHOW, VIDEO, EPISODE, CHANNEL or PLAYLIST MUSIC. required: true - example: "music" selector: select: options: diff --git a/homeassistant/components/media_player/services.yaml b/homeassistant/components/media_player/services.yaml index 6136580ff2c..f897ae8ad7f 100644 --- a/homeassistant/components/media_player/services.yaml +++ b/homeassistant/components/media_player/services.yaml @@ -46,7 +46,6 @@ volume_mute: name: Muted description: True/false for mute/unmute. required: true - example: true selector: boolean: @@ -61,13 +60,11 @@ volume_set: name: Level description: Volume level to set as float. required: true - example: 0.6 selector: number: min: 0 max: 1 step: 0.01 - mode: slider media_play_pause: name: Play/Pause @@ -122,7 +119,6 @@ media_seek: name: Position description: Position to seek to. The format is platform dependent. required: true - example: 100 selector: number: min: 0 @@ -202,7 +198,6 @@ shuffle_set: name: Shuffle description: True/false for enabling/disabling shuffle. required: true - example: true selector: boolean: @@ -217,7 +212,6 @@ repeat_set: name: Repeat mode description: Repeat mode to set. required: true - example: "off" selector: select: options: diff --git a/homeassistant/components/mill/services.yaml b/homeassistant/components/mill/services.yaml index 37b878580c9..6d475243dd5 100644 --- a/homeassistant/components/mill/services.yaml +++ b/homeassistant/components/mill/services.yaml @@ -12,7 +12,6 @@ set_room_temperature: away_temp: name: Away temperature description: Away temp. - example: 12 selector: number: min: 0 @@ -21,7 +20,6 @@ set_room_temperature: comfort_temp: name: Comfort temperature description: Comfort temp. - example: 22 selector: number: min: 0 @@ -30,7 +28,6 @@ set_room_temperature: sleep_temp: name: Sleep temperature description: Sleep temp. - example: 17 selector: number: min: 0 diff --git a/homeassistant/components/modbus/services.yaml b/homeassistant/components/modbus/services.yaml index a3aa26a1a41..855303aef07 100644 --- a/homeassistant/components/modbus/services.yaml +++ b/homeassistant/components/modbus/services.yaml @@ -6,7 +6,6 @@ write_coil: name: Address description: Address of the register to write to. required: true - example: 0 selector: number: min: 1 @@ -22,7 +21,6 @@ write_coil: name: Unit description: Address of the modbus unit. required: true - example: 21 selector: number: min: 1 @@ -42,7 +40,6 @@ write_register: name: Address description: Address of the holding register to write to. required: true - example: 0 selector: number: min: 1 @@ -51,7 +48,6 @@ write_register: name: Unit description: Address of the modbus unit. required: true - example: 21 selector: number: min: 1 diff --git a/homeassistant/components/motion_blinds/services.yaml b/homeassistant/components/motion_blinds/services.yaml index 08ee4098e27..1ee60923332 100644 --- a/homeassistant/components/motion_blinds/services.yaml +++ b/homeassistant/components/motion_blinds/services.yaml @@ -12,7 +12,6 @@ set_absolute_position: name: Absolute position description: Absolute position to move to. required: true - example: 70 selector: number: min: 1 @@ -20,7 +19,6 @@ set_absolute_position: width: name: Width description: Specify the width that is covered, only for TDBU Combined entities. - example: 30 selector: number: min: 1 diff --git a/homeassistant/components/mqtt/services.yaml b/homeassistant/components/mqtt/services.yaml index 21d3915628a..7b57570a3ef 100644 --- a/homeassistant/components/mqtt/services.yaml +++ b/homeassistant/components/mqtt/services.yaml @@ -29,11 +29,6 @@ publish: name: QoS description: Quality of Service to use. advanced: true - example: 2 - values: - - 0 - - 1 - - 2 default: 0 selector: select: @@ -45,7 +40,6 @@ publish: name: Retain description: If message should have the retain flag set. default: false - example: true selector: boolean: @@ -64,15 +58,12 @@ dump: duration: name: Duration description: how long we should listen for messages in seconds - example: 5 default: 5 selector: number: min: 1 max: 300 - step: 1 unit_of_measurement: "seconds" - mode: slider reload: name: Reload diff --git a/homeassistant/components/mysensors/services.yaml b/homeassistant/components/mysensors/services.yaml index e0fa5bf8e89..7293a676a76 100644 --- a/homeassistant/components/mysensors/services.yaml +++ b/homeassistant/components/mysensors/services.yaml @@ -5,7 +5,6 @@ send_ir_code: entity_id: name: Entity description: Name of entity that should have the IR code set and be turned on. Platform dependent. - example: "switch.living_room_1_1" selector: entity: integration: mysensors diff --git a/homeassistant/components/neato/services.yaml b/homeassistant/components/neato/services.yaml index eb0c7bffba9..cbfff7808ee 100644 --- a/homeassistant/components/neato/services.yaml +++ b/homeassistant/components/neato/services.yaml @@ -10,7 +10,6 @@ custom_cleaning: name: Set cleaning mode description: "Set the cleaning mode: 1 for eco and 2 for turbo. Defaults to turbo if not set." default: 2 - example: 2 selector: number: min: 1 @@ -20,7 +19,6 @@ custom_cleaning: name: Set navigation mode description: "Set the navigation mode: 1 for normal, 2 for extra care, 3 for deep. Defaults to normal if not set." default: 1 - example: 1 selector: number: min: 1 @@ -30,7 +28,6 @@ custom_cleaning: name: Use cleaning map description: "Whether to use a persistent map or not for cleaning (i.e. No go lines): 2 for no map, 4 for map. Default to using map if not set (and fallback to no map if no map is found)." default: 4 - example: 2 selector: number: min: 2 diff --git a/homeassistant/components/ness_alarm/services.yaml b/homeassistant/components/ness_alarm/services.yaml index 8e4219a7921..ad320285d5b 100644 --- a/homeassistant/components/ness_alarm/services.yaml +++ b/homeassistant/components/ness_alarm/services.yaml @@ -8,7 +8,6 @@ aux: name: Output ID description: The aux output you wish to change. required: true - example: 1 selector: number: min: 1 @@ -16,7 +15,6 @@ aux: state: name: State description: The On/Off State. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E. - example: true default: true selector: boolean: diff --git a/homeassistant/components/nest/services.yaml b/homeassistant/components/nest/services.yaml index b2ae06c3430..98aacf60524 100644 --- a/homeassistant/components/nest/services.yaml +++ b/homeassistant/components/nest/services.yaml @@ -7,7 +7,6 @@ set_away_mode: away_mode: name: Away mode description: New mode to set. - example: "away" required: true selector: select: @@ -28,14 +27,12 @@ set_eta: eta: name: ETA description: Estimated time of arrival from now. - example: "00:10:30" required: true selector: time: eta_window: name: ETA window description: Estimated time of arrival window. - example: "00:05" default: "00:01" selector: time: diff --git a/homeassistant/components/netatmo/services.yaml b/homeassistant/components/netatmo/services.yaml index 4cbb7cba2ba..e61e893e199 100644 --- a/homeassistant/components/netatmo/services.yaml +++ b/homeassistant/components/netatmo/services.yaml @@ -9,8 +9,7 @@ set_camera_light: fields: camera_light_mode: name: Camera light mode - description: Outdoor camera light mode (on/off/auto) - example: auto + description: Outdoor camera light mode. required: true selector: select: @@ -65,7 +64,7 @@ set_person_away: domain: camera fields: person: - description: Person's name (optional) + description: Person's name. example: Bob selector: text: diff --git a/homeassistant/components/netgear_lte/services.yaml b/homeassistant/components/netgear_lte/services.yaml index 116c2f61a2e..a708287612b 100644 --- a/homeassistant/components/netgear_lte/services.yaml +++ b/homeassistant/components/netgear_lte/services.yaml @@ -29,7 +29,6 @@ set_option: failover: name: Failover description: Failover mode. - example: auto selector: select: options: @@ -39,7 +38,6 @@ set_option: autoconnect: name: Auto-connect description: Auto-connect mode. - example: home selector: select: options: diff --git a/homeassistant/components/nexia/services.yaml b/homeassistant/components/nexia/services.yaml index 0b822dce186..740c865e274 100644 --- a/homeassistant/components/nexia/services.yaml +++ b/homeassistant/components/nexia/services.yaml @@ -10,7 +10,6 @@ set_aircleaner_mode: name: Air cleaner mode description: 'The air cleaner mode to set.' required: true - example: allergy selector: select: options: @@ -30,7 +29,6 @@ set_humidify_setpoint: name: Humidify description: "The humidification setpoint." required: true - example: 45 selector: number: min: 35 diff --git a/homeassistant/components/notify/services.yaml b/homeassistant/components/notify/services.yaml index 6bbd15c94ca..a4ac45e9df8 100644 --- a/homeassistant/components/notify/services.yaml +++ b/homeassistant/components/notify/services.yaml @@ -56,11 +56,17 @@ apns_register: Notification Service). fields: push_id: + name: Push ID description: The device token, a 64 character hex string (256 bits). The device token is provided to you by your client app, which receives the token after registering itself with the remote notification service. example: "72f2a8633655c5ce574fdc9b2b34ff8abdfc3b739b6ceb7a9ff06c1cbbf99f62" + selector: + text: name: - description: A friendly name for the device (optional). + name: Name + description: A friendly name for the device. example: "Sam's iPhone" + selector: + text: diff --git a/homeassistant/components/nuki/services.yaml b/homeassistant/components/nuki/services.yaml index 85e0e67ea50..d923885efc6 100644 --- a/homeassistant/components/nuki/services.yaml +++ b/homeassistant/components/nuki/services.yaml @@ -7,9 +7,8 @@ lock_n_go: domain: lock fields: unlatch: - name: unlatch + name: Unlatch description: Whether to unlatch the lock. - example: false default: false selector: boolean: diff --git a/homeassistant/components/nx584/services.yaml b/homeassistant/components/nx584/services.yaml index 25ef4c20702..a5c49f6d6a6 100644 --- a/homeassistant/components/nx584/services.yaml +++ b/homeassistant/components/nx584/services.yaml @@ -12,7 +12,6 @@ bypass_zone: name: Zone description: The number of the zone to be bypassed. required: true - example: "1" selector: number: min: 1 @@ -30,7 +29,6 @@ unbypass_zone: name: Zone description: The number of the zone to be un-bypassed. required: true - example: "1" selector: number: min: 1 diff --git a/homeassistant/components/nzbget/services.yaml b/homeassistant/components/nzbget/services.yaml index 290b3761ab8..8fe8780dce9 100644 --- a/homeassistant/components/nzbget/services.yaml +++ b/homeassistant/components/nzbget/services.yaml @@ -15,7 +15,6 @@ set_speed: speed: name: Speed description: Speed limit. 0 is unlimited. - example: 1000 default: 1000 selector: number: diff --git a/homeassistant/components/ombi/services.yaml b/homeassistant/components/ombi/services.yaml index c6f154d073e..5a44c7bba02 100644 --- a/homeassistant/components/ombi/services.yaml +++ b/homeassistant/components/ombi/services.yaml @@ -25,7 +25,6 @@ submit_tv_request: season: name: Season description: Which season(s) to request. - example: "latest" default: latest selector: select: diff --git a/homeassistant/components/omnilogic/services.yaml b/homeassistant/components/omnilogic/services.yaml index b886fe7f7f7..94ba0d2982e 100644 --- a/homeassistant/components/omnilogic/services.yaml +++ b/homeassistant/components/omnilogic/services.yaml @@ -10,7 +10,6 @@ set_pump_speed: name: Speed description: Speed for the VSP between min and max speed. required: true - example: 85 selector: number: min: 0 diff --git a/homeassistant/components/onvif/services.yaml b/homeassistant/components/onvif/services.yaml index ee5af2ae77e..83b2d112d2d 100644 --- a/homeassistant/components/onvif/services.yaml +++ b/homeassistant/components/onvif/services.yaml @@ -9,7 +9,6 @@ ptz: tilt: name: Tilt description: "Tilt direction." - example: "UP" selector: select: options: @@ -18,7 +17,6 @@ ptz: pan: name: Pan description: "Pan direction." - example: "RIGHT" selector: select: options: @@ -27,7 +25,6 @@ ptz: zoom: name: Zoom description: "Zoom." - example: "ZOOM_IN" selector: select: options: @@ -37,7 +34,6 @@ ptz: name: Distance description: "Distance coefficient. Sets how much PTZ should be executed in one request." default: 0.1 - example: 0.1 selector: number: min: 0 @@ -47,7 +43,6 @@ ptz: name: Speed description: "Speed coefficient. Sets how fast PTZ will be executed." default: 0.5 - example: 0.5 selector: number: min: 0 @@ -57,7 +52,6 @@ ptz: name: Continuous duration description: "Set ContinuousMove delay in seconds before stopping the move" default: 0.5 - example: 0.5 selector: number: min: 0 @@ -74,7 +68,6 @@ ptz: name: Move Mode description: "PTZ moving mode." default: "RelativeMove" - example: "ContinuousMove" selector: select: options: diff --git a/homeassistant/components/openhome/services.yaml b/homeassistant/components/openhome/services.yaml index 29b07500c3f..0fa95145287 100644 --- a/homeassistant/components/openhome/services.yaml +++ b/homeassistant/components/openhome/services.yaml @@ -12,7 +12,6 @@ invoke_pin: name: PIN description: Which pin to invoke required: true - example: 4 selector: number: min: 0 diff --git a/homeassistant/components/opentherm_gw/services.yaml b/homeassistant/components/opentherm_gw/services.yaml index fe3ecc157c5..02f2e71053f 100644 --- a/homeassistant/components/opentherm_gw/services.yaml +++ b/homeassistant/components/opentherm_gw/services.yaml @@ -26,12 +26,13 @@ set_central_heating_ovrd: description: The gateway_id of the OpenTherm Gateway. required: true example: "opentherm_gateway" + selector: + text: ch_override: name: Central heating override description: > The desired boolean value for the central heating override. required: true - example: "on" selector: boolean: @@ -44,6 +45,8 @@ set_clock: description: The gateway_id of the OpenTherm Gateway. required: true example: "opentherm_gateway" + selector: + text: date: name: Date description: Optional date from which the day of the week will be extracted. Defaults to today. @@ -77,7 +80,6 @@ set_control_setpoint: Values between 0 and 90 are accepted, but not all boilers support this range. A value of 0 disables the central heating setpoint override. required: true - example: "37.5" selector: number: min: 0 @@ -129,7 +131,6 @@ set_hot_water_setpoint: The domestic hot water setpoint to set on the gateway. Not all boilers support this feature. Values between 0 and 90 are accepted, but not all boilers support this range. Check the values of the slave_dhw_min_setp and slave_dhw_max_setp sensors to see the supported range on your boiler. - example: "60" selector: number: min: 0 @@ -152,7 +153,6 @@ set_gpio_mode: name: ID description: The ID of the GPIO pin. required: true - example: "B" selector: select: options: @@ -164,7 +164,6 @@ set_gpio_mode: Mode to set on the GPIO pin. Values 0 through 6 are accepted for both GPIOs, 7 is only accepted for GPIO "B". See https://www.home-assistant.io/integrations/opentherm_gw/#gpio-modes for an explanation of the values. required: true - example: "5" selector: number: min: 0 @@ -185,7 +184,6 @@ set_led_mode: name: ID description: The ID of the LED. required: true - example: "C" selector: select: options: @@ -198,10 +196,9 @@ set_led_mode: mode: name: Mode description: > - The function to assign to the LED. One of "R", "X", "T", "B", "O", "F", "H", "W", "C", "E", "M" or "P". + The function to assign to the LED. See https://www.home-assistant.io/integrations/opentherm_gw/#led-modes for an explanation of the values. required: true - example: "F" selector: select: options: @@ -237,7 +234,6 @@ set_max_modulation: The modulation level to provide to the gateway. Provide a value of -1 to clear the override and forward the value from the thermostat again. required: true - example: "42" selector: number: min: -1 @@ -263,11 +259,11 @@ set_outside_temperature: Values between -40.0 and 64.0 will be accepted, but not all thermostats can display the full range. Any value above 64.0 will clear a previously configured value (suggestion: 99) required: true - example: "-2.3" selector: number: min: -40 max: 99 + unit_of_measurement: "°" set_setback_temperature: name: Set setback temperature @@ -282,11 +278,11 @@ set_setback_temperature: text: temperature: name: Temperature - description: The setback temperature to configure on the gateway. Values between 0.0 and 30.0 are accepted. + description: The setback temperature to configure on the gateway. required: true - example: "16.0" selector: number: min: 0 max: 30 step: 0.1 + unit_of_measurement: "°" diff --git a/homeassistant/components/ozw/services.yaml b/homeassistant/components/ozw/services.yaml index 2919aceceb6..c9c23023134 100644 --- a/homeassistant/components/ozw/services.yaml +++ b/homeassistant/components/ozw/services.yaml @@ -12,7 +12,6 @@ add_node: instance_id: name: Instance ID description: The OZW Instance/Controller to use. - default: 1 selector: number: min: 1 @@ -52,7 +51,6 @@ set_config_parameter: name: Node ID description: Node id of the device to set config parameter to. required: true - example: 10 selector: number: min: 1 @@ -61,7 +59,6 @@ set_config_parameter: name: Parameter description: Parameter number to set. required: true - example: 8 selector: number: min: 1 @@ -94,7 +91,6 @@ clear_usercode: name: Code slot description: Code slot to clear code from. required: true - example: 1 selector: number: min: 1 @@ -112,7 +108,6 @@ set_usercode: name: Code slot description: Code slot to set the code. required: true - example: 1 selector: number: min: 1 diff --git a/homeassistant/components/profiler/services.yaml b/homeassistant/components/profiler/services.yaml index ff634e02ac5..8d9ae35ed10 100644 --- a/homeassistant/components/profiler/services.yaml +++ b/homeassistant/components/profiler/services.yaml @@ -5,7 +5,6 @@ start: seconds: name: Seconds description: The number of seconds to run the profiler. - example: 60.0 default: 60.0 selector: number: @@ -19,7 +18,6 @@ memory: seconds: name: Seconds description: The number of seconds to run the memory profiler. - example: 60.0 default: 60.0 selector: number: @@ -33,7 +31,6 @@ start_log_objects: scan_interval: name: Scan interval description: The number of seconds between logging objects. - example: 60.0 default: 30.0 selector: number: diff --git a/homeassistant/components/ps4/services.yaml b/homeassistant/components/ps4/services.yaml index fe7641357bf..f1f20506edb 100644 --- a/homeassistant/components/ps4/services.yaml +++ b/homeassistant/components/ps4/services.yaml @@ -6,7 +6,6 @@ send_command: name: Entity description: Name of entity to send command. required: true - example: "media_player.playstation_4" selector: entity: integration: ps4 @@ -15,7 +14,6 @@ send_command: name: Command description: Button to press. required: true - example: "ps" selector: select: options: diff --git a/homeassistant/components/rachio/services.yaml b/homeassistant/components/rachio/services.yaml index 93f63fcb9c3..bcd853b3ded 100644 --- a/homeassistant/components/rachio/services.yaml +++ b/homeassistant/components/rachio/services.yaml @@ -10,12 +10,10 @@ set_zone_moisture_percent: name: Percent description: Set the desired zone moisture percentage. required: true - example: 50 selector: number: min: 0 max: 100 - mode: slider unit_of_measurement: "%" start_multiple_zone_schedule: name: Start multiple zones @@ -45,13 +43,11 @@ pause_watering: duration: name: Duration description: The time to pause running schedules. - example: 30 default: 60 selector: number: min: 1 max: 60 - mode: slider unit_of_measurement: "minutes" resume_watering: name: Resume watering diff --git a/homeassistant/components/rainbird/services.yaml b/homeassistant/components/rainbird/services.yaml index 795fe5343d2..e1fa1879549 100644 --- a/homeassistant/components/rainbird/services.yaml +++ b/homeassistant/components/rainbird/services.yaml @@ -6,7 +6,6 @@ start_irrigation: name: Entity description: Name of a single irrigation to turn on required: true - example: "switch.sprinkler_1" selector: entity: integration: rainbird @@ -15,4 +14,8 @@ start_irrigation: name: Duration description: Duration for this sprinkler to be turned on required: true - example: 1 + selector: + number: + min: 1 + max: 1440 + unit_of_measurement: "minutes" diff --git a/homeassistant/components/rainmachine/services.yaml b/homeassistant/components/rainmachine/services.yaml index fa270692142..c12e0938059 100644 --- a/homeassistant/components/rainmachine/services.yaml +++ b/homeassistant/components/rainmachine/services.yaml @@ -11,7 +11,6 @@ disable_program: name: Program ID description: The program to disable. required: true - example: 3 selector: number: min: 1 @@ -28,7 +27,6 @@ disable_zone: name: Zone ID description: The zone to disable. required: true - example: 3 selector: number: min: 1 @@ -45,7 +43,6 @@ enable_program: name: Program ID description: The program to enable. required: true - example: 3 selector: number: min: 1 @@ -62,7 +59,6 @@ enable_zone: name: Zone ID description: The zone to enable. required: true - example: 3 selector: number: min: 1 @@ -79,7 +75,6 @@ pause_watering: name: Seconds description: The time to pause. required: true - example: 30 selector: number: min: 1 @@ -97,7 +92,6 @@ start_program: name: Program ID description: The program to start. required: true - example: 3 selector: number: min: 1 @@ -114,7 +108,6 @@ start_zone: name: Zone ID description: The zone to start. required: true - example: 3 selector: number: min: 1 @@ -122,8 +115,12 @@ start_zone: zone_run_time: name: Zone run time description: The number of seconds to run the zone. - example: 120 default: 600 + selector: + number: + min: 1 + max: 86400 + mode: box stop_all: name: Stop all description: Stop all watering activities. @@ -143,7 +140,6 @@ stop_program: name: Program ID description: The program to stop. required: true - example: 3 selector: number: min: 1 @@ -160,7 +156,6 @@ stop_zone: name: Zone ID description: The zone to stop. required: true - example: 3 selector: number: min: 1 diff --git a/homeassistant/components/recorder/services.yaml b/homeassistant/components/recorder/services.yaml index 67879867cc7..b2ea33fe2dd 100644 --- a/homeassistant/components/recorder/services.yaml +++ b/homeassistant/components/recorder/services.yaml @@ -7,19 +7,15 @@ purge: keep_days: name: Days to keep description: Number of history days to keep in database after purge. - example: 2 selector: number: min: 0 max: 365 - step: 1 unit_of_measurement: days - mode: slider repack: name: Repack description: Attempt to save disk space by rewriting the entire database file. - example: true default: false selector: boolean: @@ -27,7 +23,6 @@ purge: apply_filter: name: Apply filter description: Apply entity_id and event_type filter in addition to time based purge. - example: true default: false selector: boolean: diff --git a/homeassistant/components/remote/services.yaml b/homeassistant/components/remote/services.yaml index a36e33aa77d..3130484d10b 100644 --- a/homeassistant/components/remote/services.yaml +++ b/homeassistant/components/remote/services.yaml @@ -8,6 +8,7 @@ turn_on: domain: remote fields: activity: + name: Activity description: Activity ID or Activity Name to start. example: "BedroomTV" selector: @@ -38,6 +39,8 @@ send_command: name: Device description: Device ID to send command to. example: "32756745" + selector: + text: command: name: Command description: A single command or a list of commands to send. @@ -47,37 +50,32 @@ send_command: text: num_repeats: name: Repeats - description: An optional value that specifies the number of times you want to repeat the command(s). - example: "5" + description: The number of times you want to repeat the command(s). default: 1 selector: number: min: 0 max: 255 - step: 1 - mode: slider delay_secs: name: Delay Seconds - description: Specify the number of seconds you want to wait in between repeated commands. - example: "0.75" + description: The time you want to wait in between repeated commands. default: 0.4 selector: number: min: 0 max: 60 step: 0.1 - mode: slider + unit_of_measurement: seconds hold_secs: name: Hold Seconds - description: An optional value that specifies the number of seconds you want to have it held before the release is send. - example: "2.5" + description: The time you want to have it held before the release is send. default: 0 selector: number: min: 0 max: 60 step: 0.1 - mode: slider + unit_of_measurement: seconds learn_command: name: Learn Command @@ -87,8 +85,11 @@ learn_command: domain: remote fields: device: + name: Device description: Device ID to learn command from. example: "television" + selector: + text: command: name: Command description: A single command or a list of commands to learn. @@ -98,7 +99,6 @@ learn_command: command_type: name: Command Type description: The type of command to be learned. - example: "rf" default: "ir" selector: select: @@ -108,19 +108,17 @@ learn_command: alternative: name: Alternative description: If code must be stored as alternative (useful for discrete remotes). - example: "True" selector: boolean: timeout: name: Timeout - description: Timeout, in seconds, for the command to be learned. - example: "30" + description: Timeout for the command to be learned. selector: number: min: 0 max: 60 step: 5 - mode: slider + unit_of_measurement: seconds delete_command: name: Delete Command @@ -130,8 +128,11 @@ delete_command: domain: remote fields: device: + name: Device description: Name of the device from which commands will be deleted. example: "television" + selector: + text: command: name: Command description: A single command or a list of commands to delete. diff --git a/homeassistant/components/scene/services.yaml b/homeassistant/components/scene/services.yaml index eb7d6bb2ed3..3b780a939cc 100644 --- a/homeassistant/components/scene/services.yaml +++ b/homeassistant/components/scene/services.yaml @@ -10,16 +10,13 @@ turn_on: transition: name: Transition description: - Transition duration in seconds it takes to bring devices to the state + Transition duration it takes to bring devices to the state defined in the scene. - example: 2.5 selector: number: min: 0 max: 300 - step: 1 unit_of_measurement: seconds - mode: slider reload: name: Reload @@ -43,16 +40,13 @@ apply: transition: name: Transition description: - Transition duration in seconds it takes to bring devices to the state + Transition duration it takes to bring devices to the state defined in the scene. - example: 2.5 selector: number: min: 0 max: 300 - step: 1 unit_of_measurement: seconds - mode: slider create: name: Create diff --git a/homeassistant/components/screenlogic/services.yaml b/homeassistant/components/screenlogic/services.yaml index 7b54b9541d2..439d020a432 100644 --- a/homeassistant/components/screenlogic/services.yaml +++ b/homeassistant/components/screenlogic/services.yaml @@ -10,29 +10,28 @@ set_color_mode: name: Color Mode description: The ScreenLogic color mode to set required: true - example: "romance" selector: select: options: - all_off - all_on - - color_set - - color_sync - - color_swim - - party - - romance - - caribbean - american - - sunset + - blue + - caribbean + - color_set + - color_swim + - color_sync + - green + - hold + - magenta + - next_mode + - party + - recall + - red + - reset + - romance - royal - save - - recall - - blue - - green - - red - - white - - magenta + - sunset - thumper - - next_mode - - reset - - hold + - white diff --git a/homeassistant/components/sensibo/services.yaml b/homeassistant/components/sensibo/services.yaml index 23a53313dc5..586ad3b4168 100644 --- a/homeassistant/components/sensibo/services.yaml +++ b/homeassistant/components/sensibo/services.yaml @@ -5,7 +5,6 @@ assume_state: entity_id: name: Entity description: Name(s) of entities to change. - example: "climate.kitchen" selector: entity: integration: sensibo diff --git a/homeassistant/components/simplisafe/services.yaml b/homeassistant/components/simplisafe/services.yaml index 865ba4c8b2c..b9ee798f464 100644 --- a/homeassistant/components/simplisafe/services.yaml +++ b/homeassistant/components/simplisafe/services.yaml @@ -49,7 +49,6 @@ set_system_properties: alarm_duration: name: Alarm duration description: The length of a triggered alarm - example: 300 selector: number: min: 30 @@ -58,7 +57,6 @@ set_system_properties: alarm_volume: name: Alarm volume description: The volume level of a triggered alarm - example: 2 selector: select: options: @@ -69,7 +67,6 @@ set_system_properties: chime_volume: name: Chime volume description: The volume level of the door chime - example: 2 selector: select: options: @@ -80,45 +77,43 @@ set_system_properties: entry_delay_away: name: Entry delay away description: How long to delay when entering while "away" - example: 45 selector: number: min: 30 max: 255 + unit_of_measurement: seconds entry_delay_home: name: Entry delay home description: How long to delay when entering while "home" - example: 45 selector: number: min: 0 max: 255 + unit_of_measurement: seconds exit_delay_away: name: Exit delay away description: How long to delay when exiting while "away" - example: 45 selector: number: min: 45 max: 255 + unit_of_measurement: seconds exit_delay_home: name: Exit delay home description: How long to delay when exiting while "home" - example: 45 selector: number: min: 0 max: 255 + unit_of_measurement: seconds light: name: Light description: Whether the armed light should be visible - example: true selector: boolean: voice_prompt_volume: name: Voice prompt volume description: The volume level of the voice prompt - example: 2 selector: select: options: diff --git a/homeassistant/components/snapcast/services.yaml b/homeassistant/components/snapcast/services.yaml index 79839c33df2..f80b22dba7e 100644 --- a/homeassistant/components/snapcast/services.yaml +++ b/homeassistant/components/snapcast/services.yaml @@ -6,7 +6,6 @@ join: name: Master description: Entity ID of the player to synchronize to. required: true - example: "media_player.living_room" selector: entity: integration: snapcast @@ -56,8 +55,8 @@ set_latency: name: Latency description: Latency in master required: true - example: 14 selector: number: min: 1 max: 1000 + unit_of_measurement: "ms" diff --git a/homeassistant/components/snips/services.yaml b/homeassistant/components/snips/services.yaml index f4a36b6e781..407eab996c7 100644 --- a/homeassistant/components/snips/services.yaml +++ b/homeassistant/components/snips/services.yaml @@ -52,7 +52,6 @@ say_action: can_be_enqueued: name: Can be enqueued description: If True, session waits for an open session to end, if False session is dropped if one is running - example: true default: true selector: boolean: diff --git a/homeassistant/components/sonos/services.yaml b/homeassistant/components/sonos/services.yaml index 09197fb87ae..365bdc29b37 100644 --- a/homeassistant/components/sonos/services.yaml +++ b/homeassistant/components/sonos/services.yaml @@ -7,7 +7,6 @@ join: description: Entity ID of the player that should become the coordinator of the group. required: true - example: "media_player.living_room_sonos" selector: entity: integration: sonos @@ -16,7 +15,6 @@ join: name: Entity description: Name of entity that will join the master. required: true - example: "media_player.living_room_sonos" selector: entity: integration: sonos @@ -37,7 +35,6 @@ snapshot: entity_id: name: Entity description: Name of entity that will be snapshot. - example: "media_player.living_room_sonos" selector: entity: integration: sonos @@ -45,7 +42,6 @@ snapshot: with_group: name: With group description: True or False. Also snapshot the group layout. - example: "true" default: true selector: boolean: @@ -57,7 +53,6 @@ restore: entity_id: name: Entity description: Name of entity that will be restored. - example: "media_player.living_room_sonos" selector: entity: integration: sonos @@ -65,7 +60,6 @@ restore: with_group: name: With group description: True or False. Also restore the group layout. - example: "true" default: true selector: boolean: @@ -80,14 +74,11 @@ set_sleep_timer: sleep_time: name: Sleep Time description: Number of seconds to set the timer. - example: "900" selector: number: min: 0 max: 7200 - step: 1 unit_of_measurement: seconds - mode: slider clear_sleep_timer: name: Clear timer @@ -112,19 +103,16 @@ set_option: night_sound: name: Night sound description: Enable Night Sound mode - example: "true" selector: boolean: speech_enhance: name: Speech enhance description: Enable Speech Enhancement mode - example: "true" selector: boolean: status_light: name: Status light description: Enable Status (LED) Light - example: "true" selector: boolean: @@ -138,7 +126,6 @@ play_queue: queue_position: name: Queue position description: Position of the song in the queue to start playing from. - example: "0" selector: number: min: 0 @@ -155,7 +142,6 @@ remove_from_queue: queue_position: name: Queue position description: Position in the queue to remove. - example: "0" selector: number: min: 0 @@ -172,7 +158,6 @@ update_alarm: alarm_id: name: Alarm ID description: ID for the alarm to be updated. - example: "1" required: true selector: number: @@ -188,22 +173,18 @@ update_alarm: volume: name: Volume description: Set alarm volume level. - example: "0.75" selector: number: min: 0 max: 1 step: 0.01 - mode: slider enabled: name: Alarm enabled description: Enable or disable the alarm. - example: "true" selector: boolean: include_linked_zones: name: Include linked zones description: Enable or disable including grouped rooms. - example: "true" selector: boolean: diff --git a/homeassistant/components/starline/services.yaml b/homeassistant/components/starline/services.yaml index 970010ffea0..4c3e4d360e8 100644 --- a/homeassistant/components/starline/services.yaml +++ b/homeassistant/components/starline/services.yaml @@ -10,7 +10,6 @@ set_scan_interval: scan_interval: name: Scan interval description: Update frequency. - example: 180 selector: number: min: 10 @@ -25,7 +24,6 @@ set_scan_obd_interval: scan_interval: name: Scan interval description: Update frequency. - example: 10800 selector: number: min: 180 diff --git a/homeassistant/components/surepetcare/services.yaml b/homeassistant/components/surepetcare/services.yaml index 6542cfce188..77887a18b87 100644 --- a/homeassistant/components/surepetcare/services.yaml +++ b/homeassistant/components/surepetcare/services.yaml @@ -13,7 +13,6 @@ set_lock_state: name: Lock state description: New lock state. required: true - example: "unlocked" selector: select: options: diff --git a/homeassistant/components/switcher_kis/services.yaml b/homeassistant/components/switcher_kis/services.yaml index eed3cac0268..b4b2728fc2e 100644 --- a/homeassistant/components/switcher_kis/services.yaml +++ b/homeassistant/components/switcher_kis/services.yaml @@ -26,7 +26,6 @@ turn_on_with_timer: name: Timer description: 'Time to turn on.' required: true - example: '30' selector: number: min: 1 diff --git a/homeassistant/components/system_bridge/services.yaml b/homeassistant/components/system_bridge/services.yaml index 0ee12b39846..3f79f441415 100644 --- a/homeassistant/components/system_bridge/services.yaml +++ b/homeassistant/components/system_bridge/services.yaml @@ -5,7 +5,6 @@ send_command: bridge: name: Bridge description: The server to send the command to. - example: "" required: true selector: device: @@ -32,7 +31,6 @@ open: bridge: name: Bridge description: The server to talk to. - example: "" required: true selector: device: diff --git a/homeassistant/components/system_log/services.yaml b/homeassistant/components/system_log/services.yaml index a762c31f205..b6444bcecc5 100644 --- a/homeassistant/components/system_log/services.yaml +++ b/homeassistant/components/system_log/services.yaml @@ -15,9 +15,8 @@ write: text: level: name: Level - description: "Log level: debug, info, warning, error, critical." + description: "Log level." default: error - example: debug selector: select: options: diff --git a/homeassistant/components/tado/services.yaml b/homeassistant/components/tado/services.yaml index f73eaa8a183..d3aaa71cbbc 100644 --- a/homeassistant/components/tado/services.yaml +++ b/homeassistant/components/tado/services.yaml @@ -18,7 +18,6 @@ set_climate_timer: name: Temperature description: Temperature to set climate entity to required: true - example: 25 selector: number: min: 0 @@ -45,7 +44,6 @@ set_water_heater_timer: temperature: name: Temperature description: Temperature to set heater to - example: 25 selector: number: min: 0 @@ -64,7 +62,6 @@ set_climate_temperature_offset: offset: name: Offset description: Offset you would like (depending on your device). - example: -1.2 default: 0 selector: number: diff --git a/homeassistant/components/telegram_bot/services.yaml b/homeassistant/components/telegram_bot/services.yaml index de537aac5ad..dc3e9dde2d3 100644 --- a/homeassistant/components/telegram_bot/services.yaml +++ b/homeassistant/components/telegram_bot/services.yaml @@ -44,8 +44,13 @@ send_message: boolean: timeout: name: Timeout - description: Timeout for send message. Will help with timeout errors (poor internet connection, etc) - example: "1000" + description: Timeout for send message. Will help with timeout errors (poor internet connection, etc)s + selector: + number: + min: 1 + max: 3600 + unit_of_measurement: seconds + keyboard: name: Keyboard description: List of rows of commands, comma-separated, to make a custom keyboard. Empty list clears a previously set keyboard. @@ -108,7 +113,6 @@ send_photo: parse_mode: name: Parse mode description: "Parser for the message text." - example: "html" selector: select: options: @@ -128,7 +132,6 @@ send_photo: timeout: name: Timeout description: Timeout for send photo. Will help with timeout errors (poor internet connection, etc) - example: "1000" selector: number: min: 1 @@ -276,13 +279,11 @@ send_animation: disable_notification: name: Disable notification description: Sends the message silently. iOS users and Web users will not receive a notification, Android users will receive a notification with no sound. - example: true selector: boolean: verify_ssl: name: Verify SSL description: Enable or disable SSL certificate verification. Set to false if you're downloading the file from a URL and you don't want to validate the SSL certificate of the server. - example: false selector: boolean: timeout: @@ -512,7 +513,6 @@ send_document: parse_mode: name: Parse mode description: "Parser for the message text." - example: "html" selector: select: options: @@ -651,7 +651,6 @@ edit_message: parse_mode: name: Parse mode description: "Parser for the message text." - example: "html" selector: select: options: diff --git a/homeassistant/components/todoist/services.yaml b/homeassistant/components/todoist/services.yaml index 7f2ddd0091d..85e975e94ff 100644 --- a/homeassistant/components/todoist/services.yaml +++ b/homeassistant/components/todoist/services.yaml @@ -25,7 +25,6 @@ new_task: priority: name: Priority description: The priority of this task, from 1 (normal) to 4 (urgent). - example: 2 selector: number: min: 1 diff --git a/homeassistant/components/tts/services.yaml b/homeassistant/components/tts/services.yaml index f5a5154a029..f93a81cf2b2 100644 --- a/homeassistant/components/tts/services.yaml +++ b/homeassistant/components/tts/services.yaml @@ -6,8 +6,7 @@ say: fields: entity_id: name: Entity - description: Name(s) of media player entities. - example: "media_player.floor" + description: Name(s) of media player entities.\ required: true selector: entity: @@ -22,7 +21,6 @@ say: cache: name: Cache description: Control file cache of this message. - example: "true" default: false selector: boolean: diff --git a/homeassistant/components/wake_on_lan/services.yaml b/homeassistant/components/wake_on_lan/services.yaml index 7540451d061..ea374a88b8f 100644 --- a/homeassistant/components/wake_on_lan/services.yaml +++ b/homeassistant/components/wake_on_lan/services.yaml @@ -18,7 +18,7 @@ send_magic_packet: broadcast_port: name: Broadcast port description: Port where to send the magic packet. - example: 9 + default: 9 selector: number: min: 1 diff --git a/homeassistant/components/webostv/services.yaml b/homeassistant/components/webostv/services.yaml index 86e1c52aef6..f9d56cd1921 100644 --- a/homeassistant/components/webostv/services.yaml +++ b/homeassistant/components/webostv/services.yaml @@ -63,7 +63,6 @@ select_sound_output: name: Entity description: Name(s) of the webostv entities to change sound output on. required: true - example: "media_player.living_room_tv" selector: entity: integration: webostv diff --git a/homeassistant/components/wink/services.yaml b/homeassistant/components/wink/services.yaml index f7f21125f27..851f3bb9a43 100644 --- a/homeassistant/components/wink/services.yaml +++ b/homeassistant/components/wink/services.yaml @@ -147,8 +147,7 @@ siren_set_auto_shutoff: auto_shutoff: name: Auto shutoff description: >- - The time in seconds to sound the siren. One of [None, -1, 30, 60, 120] - (None and -1 are forever. Use None for gocontrol, and -1 for Dome) + The time in seconds to sound the siren. (None and -1 are forever. Use None for gocontrol, and -1 for Dome) required: true selector: select: @@ -382,7 +381,7 @@ set_lock_alarm_state: domain: lock enabled: name: Enabled - description: enable or disable. true or false. + description: enable or disable. required: true selector: boolean: @@ -400,7 +399,7 @@ set_lock_beeper_state: domain: lock enabled: name: Enabled - description: enable or disable. true or false. + description: enable or disable. required: true selector: boolean: diff --git a/homeassistant/components/wled/services.yaml b/homeassistant/components/wled/services.yaml index 3ade18cb70e..f8d636686be 100644 --- a/homeassistant/components/wled/services.yaml +++ b/homeassistant/components/wled/services.yaml @@ -15,13 +15,10 @@ effect: intensity: name: Effect intensity description: Intensity of the effect. Number between 0 and 255. - example: 100 selector: number: min: 0 max: 255 - step: 1 - mode: slider palette: name: Color palette description: Name or ID of the WLED light palette. @@ -30,20 +27,16 @@ effect: text: speed: name: Effect speed - description: Speed of the effect. Number between 0 (slow) and 255 (fast). - example: 150 + description: Speed of the effect. selector: number: min: 0 max: 255 - step: 1 - mode: slider reverse: name: Reverse effect description: Reverse the effect. Either true to reverse or false otherwise. default: false - example: false selector: boolean: @@ -58,7 +51,6 @@ preset: preset: name: Preset ID description: ID of the WLED preset - example: 6 selector: number: min: -1 diff --git a/homeassistant/components/yeelight/services.yaml b/homeassistant/components/yeelight/services.yaml index 92b184d0497..b365f273e31 100644 --- a/homeassistant/components/yeelight/services.yaml +++ b/homeassistant/components/yeelight/services.yaml @@ -75,7 +75,6 @@ set_color_temp_scene: kelvin: name: Kelvin description: Color temperature for the light in Kelvin. - example: 4000 selector: number: min: 1700 @@ -89,6 +88,7 @@ set_color_temp_scene: number: min: 0 max: 100 + unit_of_measurement: "%" set_color_flow_scene: name: Set color flow scene description: starts a color flow. If the light is off, it will be turned on. @@ -108,7 +108,6 @@ set_color_flow_scene: action: name: Action description: The action to take after the flow stops. - example: "stay" default: 'recover' selector: select: @@ -133,7 +132,6 @@ set_auto_delay_off_scene: minutes: name: Minutes description: The time to wait before automatically turning the light off. - example: 5 selector: number: min: 1 @@ -146,6 +144,7 @@ set_auto_delay_off_scene: number: min: 0 max: 100 + unit_of_measurement: "%" start_flow: name: Start flow description: Start a custom flow, using transitions from https://yeelight.readthedocs.io/en/stable/yeelight.html#flow-objects diff --git a/homeassistant/components/zha/services.yaml b/homeassistant/components/zha/services.yaml index 63f30c2e3f1..0e645da365e 100644 --- a/homeassistant/components/zha/services.yaml +++ b/homeassistant/components/zha/services.yaml @@ -7,7 +7,6 @@ permit: duration: name: Duration description: Time to permit joins, in seconds - example: 60 default: 60 selector: number: @@ -77,24 +76,28 @@ set_zigbee_cluster_attribute: description: IEEE address for the device required: true example: "00:0d:6f:00:05:7d:2d:34" + selector: + text: endpoint_id: name: Endpoint ID description: Endpoint id for the cluster required: true - example: 1 + selector: + number: + min: 1 + max: 65535 + mode: box cluster_id: name: Cluster ID description: ZCL cluster to retrieve attributes for required: true - example: 6 selector: number: min: 1 max: 65535 cluster_type: name: Cluster Type - description: type of the cluster (in or out) - example: "out" + description: type of the cluster default: "in" selector: select: @@ -140,7 +143,6 @@ issue_zigbee_cluster_command: name: Endpoint ID description: Endpoint id for the cluster required: true - example: 1 selector: number: min: 1 @@ -149,15 +151,13 @@ issue_zigbee_cluster_command: name: Cluster ID description: ZCL cluster to retrieve attributes for required: true - example: 6 selector: number: min: 1 max: 65535 cluster_type: name: Cluster Type - description: type of the cluster (in or out) - example: "out" + description: type of the cluster default: "in" selector: select: @@ -168,16 +168,14 @@ issue_zigbee_cluster_command: name: Command description: id of the command to execute required: true - example: 0 selector: number: min: 1 max: 65535 command_type: name: Command Type - description: type of the command to execute (client or server) + description: type of the command to execute required: true - example: "server" selector: select: options: @@ -212,15 +210,13 @@ issue_zigbee_group_command: name: Cluster ID description: ZCL cluster to send command to required: true - example: 6 selector: number: min: 1 max: 65535 cluster_type: name: Cluster Type - description: type of the cluster (in or out) - example: "out" + description: type of the cluster default: "in" selector: select: @@ -231,7 +227,6 @@ issue_zigbee_group_command: name: Command description: id of the command to execute required: true - example: 0 selector: number: min: 1 @@ -265,7 +260,6 @@ warning_device_squawk: name: Mode description: >- The Squawk Mode field is used as a 4-bit enumeration, and can have one of the values shown in Table 8-24 of the ZCL spec - Squawk Mode Field. The exact operation of each mode (how the WD “squawks”) is implementation specific. - example: 1 default: 0 selector: number: @@ -276,7 +270,6 @@ warning_device_squawk: name: Strobe description: >- The strobe field is used as a Boolean, and determines if the visual indication is also required in addition to the audible squawk, as shown in Table 8-25 of the ZCL spec - Strobe Bit. - example: 1 default: 1 selector: number: @@ -287,7 +280,6 @@ warning_device_squawk: name: Level description: >- The squawk level field is used as a 2-bit enumeration, and determines the intensity of audible squawk sound as shown in Table 8-26 of the ZCL spec - Squawk Level Field Values. - example: 2 default: 2 selector: number: @@ -311,7 +303,6 @@ warning_device_warn: name: Mode description: >- The Warning Mode field is used as an 4-bit enumeration, can have one of the values 0-6 defined below in table 8-20 of the ZCL spec. The exact behavior of the WD device in each mode is according to the relevant security standards. - example: 1 default: 3 selector: number: @@ -322,7 +313,6 @@ warning_device_warn: name: Strobe description: >- The Strobe field is used as a 2-bit enumeration, and determines if the visual indication is required in addition to the audible siren, as indicated in Table 8-21 of the ZCL spec. "0" means no strobe, "1" means strobe. If the strobe field is “1” and the Warning Mode is “0” (“Stop”) then only the strobe is activated. - example: 1 default: 1 selector: number: @@ -333,7 +323,6 @@ warning_device_warn: name: Level description: >- The Siren Level field is used as a 2-bit enumeration, and indicates the intensity of audible squawk sound as shown in Table 8-22 of the ZCL spec. - example: 2 default: 2 selector: number: @@ -344,7 +333,6 @@ warning_device_warn: name: Duration description: >- Requested duration of warning, in seconds (16 bit). If both Strobe and Warning Mode are "0" this field SHALL be ignored. - example: 2 default: 5 selector: number: @@ -355,7 +343,6 @@ warning_device_warn: name: Duty cycle description: >- Indicates the length of the flash cycle. This provides a means of varying the flash duration for different alarm types (e.g., fire, police, burglar). Valid range is 0-100 in increments of 10. All other values SHALL be rounded to the nearest valid value. Strobe SHALL calculate duty cycle over a duration of one second. The ON state SHALL precede the OFF state. For example, if Strobe Duty Cycle Field specifies “40,” then the strobe SHALL flash ON for 4/10ths of a second and then turn OFF for 6/10ths of a second. - example: 50 default: 0 selector: number: @@ -366,7 +353,6 @@ warning_device_warn: name: Intensity description: >- Indicates the intensity of the strobe as shown in Table 8-23 of the ZCL spec. This attribute is designed to vary the output of the strobe (i.e., brightness) and not its frequency, which is detailed in section 8.4.2.3.1.6 of the ZCL spec. - example: 2 default: 2 selector: number: diff --git a/homeassistant/components/zwave/services.yaml b/homeassistant/components/zwave/services.yaml index db74292ff8a..d3063ef5d43 100644 --- a/homeassistant/components/zwave/services.yaml +++ b/homeassistant/components/zwave/services.yaml @@ -15,7 +15,6 @@ change_association: name: Node ID description: Node id of the node to set association for. required: true - example: 10 selector: number: min: 1 @@ -24,7 +23,6 @@ change_association: name: Target node ID description: Node id of the node to associate to. required: true - example: 42 selector: number: min: 1 @@ -197,7 +195,10 @@ set_poll_intensity: name: Node ID description: ID of the node to set polling to. required: true - example: 10 + selector: + number: + min: 1 + max: 255 value_id: name: Value ID description: ID of the value to set polling to. diff --git a/homeassistant/components/zwave_js/services.yaml b/homeassistant/components/zwave_js/services.yaml index f9d90f94779..84877189298 100644 --- a/homeassistant/components/zwave_js/services.yaml +++ b/homeassistant/components/zwave_js/services.yaml @@ -108,8 +108,6 @@ refresh_value: refresh_all_values: name: Refresh all values? description: Whether to refresh all values (true) or just the primary value (false) - required: false - example: true default: false selector: boolean: @@ -159,7 +157,6 @@ set_value: wait_for_result: name: Wait for result? description: Whether or not to wait for a response from the node. If not included in the payload, the integration will decide whether to wait or not. If set to `true`, note that the service call can take a while if setting a value on an asleep battery device. - example: false required: false selector: boolean: