Skip to content

Strategy Options

Jump to bottom
Ferry Cools edited this page Feb 7, 2024 · 10 revisions

All Options

You can set strategy options to further customize the dashboard.
By default, all views are enabled which include lights, fans, covers, switches, climates and cameras. All chips are also enabled which count the number of devices on for the platform light, fan, cover and climate. It also auto-selects a weather entity for the weather chip.

The options available are:

Name Type Default Description
areas object (optional) unset One or more areas in a list, see Areas.
card_options object (optional) unset Card options for cards, see Card Options.
views object (optional) All default views See available Views.
chips object All count chips enabled with auto selected weather card See Chips.
quick_access_cards array of cards (optional) unset List of cards to show between the Welcome card and the Rooms cards.
extra_cards array of cards (optional unset List of cards to show below the Room cards.
extra_views array of views (optional) unset List of user defined views to add to the dashboard.
domains object (optional) All supported domains See Domains.
home_view object (optional) unset Options for the home view, see Home View

Example

strategy:
  type: custom:mushroom-strategy
  options:
    areas:
      family_room_id:
        name: Family Room
        icon: mdi:sofa
        icon_color: green
views: []

Areas

Name Type Default Description
name string N.A. The name of the area.
hidden boolean false Set to true to exclude the area from the dashboard and views.
order number Infinity Ordering position of the area in the list of available areas.
extra_cards array of cards unset or empty A list of cards to show on the top of the area sub-view.
type string default Set to a type of area card. (Currently supported: default & HaAreaCard

Also, all options from the Template mushroom card and/or Home Assistant Area card are supported.
Please follow the links below to see the additional options per card type.

Example

strategy:
  type: custom:mushroom-strategy
  options:
    areas:
      family_room_id:
        name: Family Room
        icon: mdi:television
        icon_color: green
        order: 1
        extra_cards:
          - type: custom:mushroom-chips-card
            chips:
              - type: entity
                entity: sensor.family_room_temperature
                icon: mdi:thermometer
                icon_color: pink
            alignment: center
      kitchen_id:
        name: Kitchen
        icon: mdi:silverware-fork-knife
        icon_color: red
        order: 2
      garage_id:
        hidden: true
      hallway_id:
        type: HaAreaCard
views: []

Undisclosed Area

The strategy has a special area, named undisclosed. This area is enabled by default and includes the entities that aren't linked to any Home Assistant area.

The area can be configured like any other area as described above. To exclude this area from the dashboard and views, set its property hidden to true.

Setting options for all areas

Use _ as an identifier to set the options for all areas.
The following example sets the type of all area-cards to the one of Home Assistant:

Example

strategy:
  type: custom:mushroom-strategy
  options:
    areas:
      _:
        type: HaAreaCard
views: []

Card Options

name type description
type string The type for card to apply.
hidden boolean Set to true to exclude the card from the dashboard.

The card_options entry enables you to specify the type of card for an entity or to hide the entity.

You can also provide a device ID and hide all entities linked to that device. See Instructions on to find a device ID.

Example

strategy:
  type: custom:mushroom-strategy
  options:
    card_options:
      fan.master_bedroom_fan:
        type: custom:mushroom-fan-card
      remote.harmony_hub_wk:
        hidden: true
      077ba0492c9bb3b31ffac34f1f3a626a:
        hidden: true

views: []

Views

Light Views

Mushroom strategy includes pre-built views to control/view specific domains.

Devices of a hidden area are excluded from the view. See Areas.

By default, all pre-built views below are shown:

Available views type Description
camera object View to control cameras.
climate object View to control climates.
cover object View to control covers.
fan object View to control fans.
home object An overview of several entities and areas.
light object View to control lights.
switch object View to control switches.
vacuum object View to control vacuums.

View Options

For each of the pre-built views, the following options are available:

name type description
title string Title of the view in the navigation bar. (Shown when no icon is defined or hovering above it.)
icon string Icon of the view in the navigation bar.
order string Ordering position of the view in the navigation bar.
hidden boolean Set to true to exclude the view from the dashboard

Example

strategy:
  type: custom:mushroom-strategy
  options:
    views:
      light:
        order: 0
        title: illumination
      switch:
        order: 1
        hidden: true
        icon: mdi:toggle-switch
views: []

Domains

You can configure how the various domains are shown using the domains option.
The following options are supported:

Option type Description
title string Title of the domain in a view.
showControls boolean Weather to show controls in a view, to switch all entities of the domain.
hidden boolean Set to true to exclude the domain from the dashboard.
hide_config_entities boolean Set to true to exclude config-entities from the dashboard.*
order number Ordering position of the domain entities in a view.

Setting options for all domains

Use _ as an identifier to set the hide_config_entities option for all domains.

Example

strategy:
  type: custom:mushroom-strategy
  options:
    domains:
      _:
        hide_config_entities: true
      light:
        title: "My cool lights"
        order: 1
      switch:
        showControls: false
      default:
        hidden: true
views: []

The following domains are supported and enabled by default:

  • binary_sensor
  • camera
  • climate
  • cover
  • fan
  • light
  • lock
  • media_player
  • number
  • sensor
  • switch
  • vacuum
  • default (Miscellaneous)

Home View

The home_view option will let you configure the Home View.

Option type Description
hidden array Array of elements to hide from the home view.

The following elements are supported:

  • chips
  • persons
  • greeting
  • areasTitle
  • areas

Example

strategy:
  type: custom:mushroom-strategy
  options:
    home_view:
      hidden:
        - greeting
        - areasTitle
views: []

Chips

Chips

The mushroom strategy has chips that indicate the number of devices which are on/active for a specific domain. Devices of a hidden area are excluded from the count.

The weather chip automatically uses weather.forecast if available or you can manually configure a weather entity-id.

To add chips, you can define them in extra_chips.
See Mushroom Chips for all available chips.

By default, all chips are enabled.

Note

To hide the weather chip, you should hide or disable the entity itself.

Available chips type Description
light_count boolean Chip to display the number of lights on, tapping turns off all lights, holding navigates to lights view.
fan_count boolean Chip to display the number of fans on, tapping turns off all fans, holding navigates to fans view.
cover_count boolean Chip to display the number of covers not closed, holding navigates to covers view.
switch_count boolean Chip to display the number of switches on, tapping turns off all switches, holding navigates to switches view.
climate_count boolean Chip to display the number of climate not off, holding navigates to climates view.
weather_entity string (optional) Entity ID for the weather chip to use, accepts weather. only.
extra_chips array (optional) List of extra chips to display, see [Mushroom Chips][mushroom-chipsUrl].

Example

strategy:
  type: custom:mushroom-strategy
  options:
    chips:
      climate_count: false
      cover_count: false
      weather_entity: weather.forecast_home
      extra_chips:
        - type: conditional
          conditions:
            - entity: lock.front_door
              state: unlocked
          chip:
            type: entity
            entity: lock.front_door
            icon_color: red
            content_info: none
            tap_action:
              action: toggle
Clone this wiki locally