All views and domains are enabled.
All chips are also enabled and count the number of active entities.
For the weather chip, the entity is selected automatically unless you specify one.
All entities without an area are added to the undisclosed area.

The options are divided into groups as described below.

Name	Type	Default	Description
domains	object	All supported domains	See Domain Options.
views	object	All supported views	See View Options.
card_options	object	empty	See Card Options.
extra_views	array of views	empty	List of user defined views to add to the dashboard. See Extra Views
home_view	object	unset	See Home View Options
chips	object	All supported chips	See Chip Options.
quick_access_cards	array of cards	empty	List of cards to show between the Welcome card and the Rooms cards. See Quick Access Cards
areas	object	undisclosed	See Area Options.
extra_cards	array of cards	empty	List of cards to show below the Room cards. See extra Cards

Example

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

Domain Options

The domains group enables you to specify the configuration of the domain in a view. Each configuration is identified by a domain and can have the following options:

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

Note

Domain default represents any domain not supported by this strategy.

The showControls option will default to false for domain which can't be controlled.

The hide_config_entities and hide_diagnostic_entities options are only available as an "All domains" option.

Setting options for all domains

Use _ as the identifier to set options for all domains.

Example

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

The following domains are supported and enabled by default:

_ (All domains)
area
binary_sensor
camera
climate
cover
default (Miscellaneous)
fan
input_select
light
lock
media_player
number
person
scene
select
sensor
switch
vacuum
valve

View Options

Mushroom strategy includes views to control/view specific domains.
Hidden/Disabled entities or linked to a hidden area are excluded from the view.

The following views are supported and enabled by default:

View	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.
lock	object	View to control locks.
scene	object	View to control scenes.
switch	object	View to control switches.
vacuum	object	View to control vacuums.

The views group enables you to specify the configuration of a view. Each configuration is identified by a view name and can have the following options:

name	type	Default	description
title	string	`domain specific`	Title of the view in the navigation bar. (Shown when no icon is defined or hovering above it.)
icon	string	`unset`	Icon of the view in the navigation bar.
order	string	home, light, fan, cover, switch, climate, camera, vacuum, scene, lock	Ordering position of the view in the navigation bar.
hidden	boolean	`false`	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: []

Card Options

The card_options group enables you to specify the configuration of entity cards. Each configuration is identified by an entity id or a device id and can have the following options:

name	type	default	description
type	string	`domain specific`	The type for card to apply.
hidden	boolean	`false`	Set to `true` to exclude the card from the dashboard.
...	...	`type specific`	An option belonging to the given card type.

Depending on the type of card, you can also specify options belonging to that type.

Providing a device id will enable you to hide all the entities associated with that device. Follow these steps in a browser to get the id of a device:

Select Settings at the bottom of the sidebar.
Select Devices & services.
Select Devices at the top.
Select the device you want to get the id of.
The device id is shown as the last part of the url in the address bar. E.g.: https://.../config/devices/device/h55b6k54j76g56

Tip

You can build your card at another dashboard and copy the cards group from the YAML of that dashboard into group card_options of the strategy configuration.
The YAML can be found in the Raw configuration editor.

Example

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

views: []

Extra Views

The extra_views group enables you to specify the configuration of additional views. Each view can have the options as described in the Home Assistant documentation.

Tip

You can build your view in a temporary dashboard and copy the views group from the YAML of that dashboard into group extra_views of the strategy configuration.
The YAML can be found in the Raw configuration editor.

Example

strategy:
  type: custom:mushroom-strategy
  options:
    extra_views:
      - theme: Backend-selected
        title: cool view
        path: cool-view
        icon: mdi:emoticon-cool
        badges: []
        cards:
          - type: markdown
            content: I am cool
views: []

Home View Options

The home_view group enables you to specify the configuration of the Home view.

Option	type	default	Description
`hidden`	array	`[]`	Array of sections to hide from the home view.

The following sections can be hidden from the Home view:

areas
areasTitle
chips
greeting
persons

Example

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

Chip Options

The mushroom strategy has chips that indicate the number of entities which are in a state similar to on for a specific domain.
Hidden/Disabled entities are excluded from this count.

Tapping a chip will set corresponding entities to a state similar to off.
Tap and hold a chip, will navigate to the corresponding view.

The chips group enables you to specify the configuration of chips.

Name	type	default	Description
`light_count`	boolean	`false`	Number of lights on.
`fan_count`	boolean	`false`	Number of fans on.
`cover_count`	boolean	`false`	Number of covers not closed. No tap action.
`switch_count`	boolean	`false`	Number of switches on.
`climate_count`	boolean	`false`	Number of climate not off. No tap action.
`weather_entity`	string	`auto`	Entity id for the weather chip to use.
`extra_chips`	array	`[]`	List of extra chips to show.

If weather_entity is set to auto, the weather chip uses the first entity of the weather domain it finds.
You can define a custom entity to use by setting an entity id.

Note

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

Extra Chips

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

Tip

You can build your chips in a temporary card in another dashboard and copy the chips group from the YAML of that card into group extra_chips of the strategy configuration.
The YAML can be found in the Raw configuration editor.

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

Quick Access Cards

The quick_access_cards group enables you to specify the configuration of additional cards in the Home view. These cards will be shown between the greeting card and areas.

Each card can have the options as described at Card Options.

Tip

You can build your view in a temporary dashboard and copy the views group from the YAML of that dashboard into group extra_views of the strategy configuration.
The YAML can be found in the Raw configuration editor.

Example

strategy:
  type: custom:mushroom-strategy
  options:
    quick_access_cards:
      - type: custom:mushroom-title-card
        title: Security
      - type: custom:mushroom-cover-card
        entity: cover.garage_door
        show_buttons_control: true
      - type: horizontal-stack
        cards:
          - type: custom:mushroom-lock-card
            entity: lock.front_door
          - type: custom:mushroom-entity-card
            entity: sensor.front_door_lock_battery
            name: Battery

Extra Cards

The extra_cards group enables you to specify the configuration of additional cards in the Home view. These cards will be shown below the areas.

Each card can have the options as described at Card Options.

Tip

You can build your view in a temporary dashboard and copy the views group from the YAML of that dashboard into group extra_views of the strategy configuration.
The YAML can be found in the Raw configuration editor.

Example

strategy:
  type: custom:mushroom-strategy
  options:
    extra_cards:
      - type: custom:xiaomi-vacuum-map-card
        map_source:
          camera: camera.xiaomi_cloud_map_extractor
        calibration_source:
          camera: true
        entity: vacuum.robot_vacuum
        vacuum_platform: default
views: []

Area Options

The areas group enables you to specify the configuration of areas. Each configuration is identified by an area id and can have the following options:

Name	Type	Default	Description
`name`	string	`Area specific`	The name of the area.
`hidden`	boolean	`false`	Set to `true` to exclude the area from the dashboard and views.
`order`	number	`unset`	Ordering position of the area in the list of available areas.
`extra_cards`	array of cards	`[]`	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.

Extra Cards

The extra_cards group enables you to specify the configuration of additional cards an Area view. These cards will be shown last in the view.

See Home View Options → Extra Cards for more information.

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
        extra_cards:
          - type: custom:xiaomi-vacuum-map-card
            map_source:
              camera: camera.xiaomi_cloud_map_extractor
            calibration_source:
              camera: true
            entity: vacuum.robot_vacuum
            vacuum_platform: default
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: []