From 24fd850d0afb7d19e1f4c41fc9e9ad513a2920cd Mon Sep 17 00:00:00 2001 From: Paul Bottein Date: Tue, 28 Nov 2023 20:53:07 +0100 Subject: [PATCH] Adjust card feature documentation (#30036) Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_dashboards/humidifier.markdown | 4 + source/_dashboards/thermostat.markdown | 6 +- source/_dashboards/tile.markdown | 333 +--------------- .../asides/dashboards_navigation.html | 1 + source/dashboards/features.markdown | 356 ++++++++++++++++++ .../alarm_modes.png | Bin .../climate_hvac_modes.png | Bin .../cover_open_close.png | Bin .../cover_position.png | Bin .../cover_tilt.png | Bin .../cover_tilt_position.png | Bin .../{tile-features => features}/fan_speed.png | Bin .../dashboards/features/humidifier_modes.png | Bin 0 -> 8246 bytes .../lawn_mower_commands.png | Bin .../light_brightness.png | Bin .../light_color_temp.png | Bin .../features/screenshot-tile-feature-grid.png | Bin 0 -> 23817 bytes .../target_temperature.png | Bin .../vacuum_commands.png | Bin .../water_heater_operation_modes.png | Bin source/images/dashboards/humidifier_card.png | Bin 13504 -> 112982 bytes source/images/dashboards/thermostat_card.gif | Bin 161002 -> 0 bytes source/images/dashboards/thermostat_card.png | Bin 0 -> 116334 bytes 23 files changed, 368 insertions(+), 332 deletions(-) create mode 100644 source/dashboards/features.markdown rename source/images/dashboards/{tile-features => features}/alarm_modes.png (100%) rename source/images/dashboards/{tile-features => features}/climate_hvac_modes.png (100%) rename source/images/dashboards/{tile-features => features}/cover_open_close.png (100%) rename source/images/dashboards/{tile-features => features}/cover_position.png (100%) rename source/images/dashboards/{tile-features => features}/cover_tilt.png (100%) rename source/images/dashboards/{tile-features => features}/cover_tilt_position.png (100%) rename source/images/dashboards/{tile-features => features}/fan_speed.png (100%) create mode 100644 source/images/dashboards/features/humidifier_modes.png rename source/images/dashboards/{tile-features => features}/lawn_mower_commands.png (100%) rename source/images/dashboards/{tile-features => features}/light_brightness.png (100%) rename source/images/dashboards/{tile-features => features}/light_color_temp.png (100%) create mode 100644 source/images/dashboards/features/screenshot-tile-feature-grid.png rename source/images/dashboards/{tile-features => features}/target_temperature.png (100%) rename source/images/dashboards/{tile-features => features}/vacuum_commands.png (100%) rename source/images/dashboards/{tile-features => features}/water_heater_operation_modes.png (100%) delete mode 100644 source/images/dashboards/thermostat_card.gif create mode 100644 source/images/dashboards/thermostat_card.png diff --git a/source/_dashboards/humidifier.markdown b/source/_dashboards/humidifier.markdown index 4b1810d5d69..b56470935d6 100644 --- a/source/_dashboards/humidifier.markdown +++ b/source/_dashboards/humidifier.markdown @@ -38,6 +38,10 @@ theme: required: false description: Override the used theme for this card with any loaded theme. For more information about themes, see the [frontend documentation](/integrations/frontend/). type: string +features: + required: false + description: Additional widgets to control your entity. See [available features](/dashboards/features). Only humidifier related features are supported. + type: list {% endconfiguration %} ### Example diff --git a/source/_dashboards/thermostat.markdown b/source/_dashboards/thermostat.markdown index 1007d5a4c55..8ec287f317c 100644 --- a/source/_dashboards/thermostat.markdown +++ b/source/_dashboards/thermostat.markdown @@ -8,7 +8,7 @@ description: "The Thermostat card gives control of your climate entity, allowing The Thermostat card gives control of your [climate](/integrations/#climate) entity, allowing you to change the temperature and mode of the entity.

- Screenshot of the thermostat card + Screenshot of the thermostat card Screenshot of the Thermostat card.

@@ -38,6 +38,10 @@ theme: required: false description: Override the used theme for this card with any loaded theme. For more information about themes, see the [frontend documentation](/integrations/frontend/). type: string +features: + required: false + description: Additional widgets to control your entity. See [available features](/dashboards/features). Only climate related features are supported. + type: list {% endconfiguration %} ### Example diff --git a/source/_dashboards/tile.markdown b/source/_dashboards/tile.markdown index e8791423cf4..88c19191ed7 100644 --- a/source/_dashboards/tile.markdown +++ b/source/_dashboards/tile.markdown @@ -66,7 +66,7 @@ icon_tap_action: type: map features: required: false - description: Additional widgets to control your entity. See [available features](/dashboards/tile/#tile-features). + description: Additional widgets to control your entity. See [available features](/dashboards/features). type: list {% endconfiguration %} @@ -120,333 +120,4 @@ features: ## Available color tokens -Some color tokens are available to colorize the tile card : `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black` and `white`. - -## Tile features - -Some entities have support for "features". These widgets add quick controls to the tile card. - -### Alarm modes - -Widget that display buttons to arm and disarm an [alarm](/integrations/alarm_control_panel). - -

- Screenshot of the tile card with alarm modes feature - Screenshot of the tile card with alarm modes feature -

- -```yaml -features: - - type: "alarm-modes" - modes: - - armed_home - - armed_away - - armed_night - - armed_vacation - - armed_custom_bypass - - disarmed -``` - -{% configuration %} -type: - required: true - description: "`alarm-modes`" - type: string -modes: - required: true - description: List of modes to show on the card. The list can contain `armed_home`, `armed_away`, `armed_night`, `armed_vacation`, `armed_custom_bypass` and `disarmed`. - type: list -{% endconfiguration %} - -### Climate HVAC modes - -Widget that displays buttons to control the HVAC mode for a [climate](/integrations/climate). - -

- Screenshot of the tile card with the climate HVAC modes feature - Screenshot of the tile card with the climate HVAC modes feature -

- -```yaml -features: - - type: "climate-hvac-modes" - hvac_modes: - - auto - - heat_cool - - heat - - cool - - dry - - fan_only - - "off" -``` - -{% configuration %} -type: - required: true - description: "`climate-hvac-modes`" - type: string -hvac_modes: - required: true - description: List of modes to show on the card. The list can contain `auto`, `heat_cool`, `heat`, `cool`, `dry`, `fan_only` and `off`. - type: list -{% endconfiguration %} - -### Cover open/close - -Widget that displays buttons to open, close, or stop a [cover](/integrations/cover). - -

- Screenshot of the tile card with open/close feature - Screenshot of the tile card with cover open/close feature -

- -```yaml -features: - - type: "cover-open-close" -``` - -{% configuration %} -type: - required: true - description: "`cover-open-close`" - type: string -{% endconfiguration %} - -### Cover position - -Widget that displays a slider to control the position for a [cover](/integrations/cover). - -

- Screenshot of the tile card with the cover position feature - Screenshot of the tile card with the cover position feature -

- -```yaml -features: - - type: "cover-position" -``` - -{% configuration %} -type: - required: true - description: "`cover-position`" - type: string -{% endconfiguration %} - -### Cover tilt - -Widget that displays buttons to open, close, or stop a [cover](/integrations/cover). - -

- Screenshot of the tile card with tilt feature - Screenshot of the tile card with cover tilt feature -

- -```yaml -features: - - type: "cover-tilt" -``` - -{% configuration %} -type: - required: true - description: "`cover-tilt`" - type: string -{% endconfiguration %} - -### Cover tilt position - -Widget that displays a slider to control the tilt position for a [cover](/integrations/cover). - -

- Screenshot of the tile card with the cover tilt position feature - Screenshot of the tile card with the cover tilt position feature -

- -```yaml -features: - - type: "cover-tilt-position" -``` - -{% configuration %} -type: - required: true - description: "`cover-tilt-position`" - type: string -{% endconfiguration %} - -### Fan speed - -Widget that displays speed controls for a [fan](/integrations/fan). - -

- Screenshot of the tile card with fan speed feature - Screenshot of the tile card with fan speed feature -

- -```yaml -features: - - type: "fan-speed" -``` - -{% configuration %} -type: - required: true - description: "`fan-speed`" - type: string -{% endconfiguration %} - -### Lawn mower commands - -Widget that displays buttons to control a [lawn mower](/integrations/lawn_mower). - -

- Screenshot of the tile card with the lawn mower commands feature - Screenshot of the tile card with the lawn mower commands feature -

- -```yaml -features: - - type: "lawn-mower-commands" - commands: - - start_pause - - dock -``` - -{% configuration %} -type: - required: true - description: "`lawn-mower-commands`" - type: string -commands: - required: true - description: List of commands to show on the card. The list can contain `start_pause` and `dock`. - type: list -{% endconfiguration %} - -### Light brightness - -Widget that displays a slider to select the brightness for a [light](/integrations/light). - -

- Screenshot of the tile card with light brightness feature - Screenshot of the tile card with light brightness feature -

- -```yaml -features: - - type: "light-brightness" -``` - -{% configuration %} -type: - required: true - description: "`light-brightness`" - type: string -{% endconfiguration %} - -### Light color temp - -Widget that displays a slider to select the color temperature for a [light](/integrations/light). - -

- Screenshot of the tile card with the light color temperature feature - Screenshot of the tile card with the light color temperature feature -

- -```yaml -features: - - type: "light-color-temp" -``` - -{% configuration %} -type: - required: true - description: "`light-color-temp`" - type: string -{% endconfiguration %} - -### Target temperature - -Widget that displays buttons to select the target temperature for a [climate](/integrations/climate) or a [water heater](/integrations/water_heater). - -

- Screenshot of the tile card with the target temperature feature - Screenshot of the tile card with the target temperature feature -

- -```yaml -features: - - type: "target-temperature" -``` - -{% configuration %} -type: - required: true - description: "`target-temperature`" - type: string -{% endconfiguration %} - -### Vacuum commands - -Widget that displays buttons to control a [vacuum](/integrations/vacuum). - -

- Screenshot of the tile card with vacuum commands feature - Screenshot of the tile card with vacuum commands feature -

- -```yaml -features: - - type: "vacuum-commands" - commands: - - start_pause - - stop - - clean_spot - - locate - - return_home -``` - -{% configuration %} -type: - required: true - description: "`vacuum-commands`" - type: string -commands: - required: true - description: List of commands to show on the card. The list can contain `start_pause`, `stop`, `clean_spot`, `locate` and `return_home`. - type: list -{% endconfiguration %} - -### Water heater operation modes - -Widget that displays buttons to control the operation mode of a [water heater](/integrations/water_heater). - -

- Screenshot of the tile card with the water heater operation modes feature - Screenshot of the tile card with the water heater operation modes feature -

- -```yaml -features: - - type: "water-heater-operation-modes" - operation_modes: - - electric - - gas - - heat_pump - - eco - - performance - - high_demand - - "off" -``` - -{% configuration %} -type: - required: true - description: "`water-heater-operation-modes`" - type: string -operation_modes: - required: true - description: List of modes to show on the card. The list can contain `electric`, `gas`, `heat_pump`, `eco`, `performance`, `high_demand` and `off`. - type: list -{% endconfiguration %} +Some color tokens are available to colorize the tile card : `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black` and `white`. \ No newline at end of file diff --git a/source/_includes/asides/dashboards_navigation.html b/source/_includes/asides/dashboards_navigation.html index 52cc8d44da3..016aacfaf61 100644 --- a/source/_includes/asides/dashboards_navigation.html +++ b/source/_includes/asides/dashboards_navigation.html @@ -45,6 +45,7 @@

Advanced