DigiLive/mushroom-strategy
1
0
Fork 1
mirror of https://github.com/DigiLive/mushroom-strategy.git synced 2025-06-24 17:11:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Page: Home
Pages
Entities and devices notes Full Example Home Strategy Options
Clone
13
Home
Ferry Cools edited this page 2025-05-28 08:00:20 +02:00
Table of Contents

Important

Our Documentation is Moving to GitHub Pages!
Please update your bookmarks! You can find the complete and official documentation here:

👉 https://digilive.github.io/mushroom-strategy/

This wiki will be officially closed shortly. We encourage you to start using the new site immediately to get acquainted with its features.

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 installation guide.

Once you have HACS installed, you can install custom integration and plug-ins.
This guide offers you badges to open your Home Assistant on the correct page.
If the badges don't work, try installing from HACS manually:

  1. Open HACS in Home Assistant (Usually in the menu on the left side).
  2. At the top, search for the component you want to install.
  3. Select the three-dot menu on the right side of the component and select Download.
  4. Choose the desired version and select Download again.

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

Open in HACS at your Home Assistant instance. to install Mushroom.
Open in HACS at your Home Assistant instance. to install Mini graph card.

Mushroom Strategy

If you meet all the prerequisites, click the badge below to install the strategy.

Open in HACS at your Home Assistant instance.

Manual

Please install the strategy with HACS as described above.
If you require testing a custom build for debug purposes, follow these steps:

  1. Build the strategy with npm build or npm build-dev.
  2. Copy the build file(s) to folder .../homeassistant/www/community/mushroom-strategy.
  3. If file mushroom-strategy.js.gz exists in that folder, rename or delete it.

Note

Refresh the cache of the client you use to access Home Assistant.

Basic Setup

To apply the Mushroom Strategy to a dashboard:

  1. In the UI of the dashboard, click the pencil in the top right corner.

  2. If not taken to a Raw Configuration editor, click the three-dot menu in the top right corner.

  3. Select Raw configuration editor.

  4. Empty the configuration and 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 issues or HACS didn't create a reference.
Try clearing the cache of your client and/or re-downloading the strategy from HACS.

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