Home

Installation

Prerequisites

Mushroom dashboard strategy and dependencies are available in HACS (Home Assistant Community Store).
Install HACS if you don't have it already. For assistance, you can follow the HACS Installation Guide.

You need to install the following HACS integrations before you can use this strategy.
Open the links below and follow the installation instructions or use the badges to open the HACS repository at your Home Assistant instance directly.

• Mushroom cards

  

• Mini graph card

  

HACS

Click the badge below.

or ...

1. Open HACS in Home Assistant.
2. Go to the "Frontend" section.
3. Click the button with the + icon.
4. Search for "Mushroom dashboard" and install.

Manual

1. Download mushroom-strategy.js file from the dist directory.

2. Save this file into your config/www folder.

3. Add a reference to mushroom-strategy.js in Dashboard. There are two ways to do that:

Note

If you do not see the Resources menu, you will need to enable Advanced Mode in your User Profile.

1. Using UI:: Click the badge...

   

   or...

   • Go to Settings → Dashboards → More Options icon → Resources → Add Resource → Set Url to /local/mushroom-strategy.js → Set Resource type to JavaScript Module.

2. Using YAML: Add the following code to the lovelace section.

   resources:
     - url: /local/mushroom-strategy.js
       type: module

Basic Setup

To add Mushroom Strategy to a dashboard:

1. In the UI of the dashboard, click the pencil in the top right corner.
2. Click 3 dots again.
3. Click Raw configuration editor.
4. Add the following lines:

   strategy:
     type: custom:mushroom-strategy
   views: []

Note

You may see the following error:

 Error loading the dashboard strategy:
     Error: Timeout waiting for strategy
     element ||-strategy-mushroom-strategy to
     be registered

This is mainly because of cache or HACS didn't create a reference. Try clearing the cache on your browser and re-downloading from HACS.

If it still doesn't work, please consult guide How to solve: Error loading the dashboard strategy.