Add wiki documents

This commit is contained in:
DigiLive committed 2025-05-26 15:03:23 +02:00
1 parent 2fd1be9fc3
commit 09d486359e
23 files changed
+1132 -4

No files matched your search

+30
View File
@@ -0,0 +1,30 @@
# Basic Setup
To apply the Mushroom Strategy to a dashboard:
1. In the UI of the dashboard, select :material-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:
```yaml
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](https://github.com/DigiLive/mushroom-strategy/discussions/90).
+71
View File
@@ -0,0 +1,71 @@
# Installation
## Prerequisites
Mushroom dashboard strategy and dependencies are available in [HACS][hacsUrl] (Home Assistant Community Store).
Install HACS if you don't have it already.
For assistance, you can follow the [installation guide][hacsInstallationGuideUrl].
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.][hacsBadge]][hacsMushroomUrl] to install [Mushroom][mushroomUrl].
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMiniGraphUrl] to
install [Mini graph card][miniGraphUrl].
## Dashboard Installation
If you meet all the prerequisites, click the badge below to install the strategy.
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsStrategyUrl]
## Local Installation
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 `<your-hass-directory>/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.
## Updating
By default, Home Assistant will notify you when an update of the strategy is available.
You can update the strategy by going to `Settings` found at the bottom of the sidebar.
!!! tip
You can enable notifications of pre-releases.
* Go to `Settings` > `Devices & services` > `Entities`.
* Search for `Mushroom Dashboard` and switch on the `Pre-release` entity.
<!-- References -->
[hacsUrl]: https://hacs.xyz
[hacsInstallationGuideUrl]: https://hacs.xyz/docs/setup/prerequisites
[hacsBadge]: https://img.shields.io/badge/Open%20my%20HACS%20Repository-%2318BCF2?logo=homeassistant&logoColor=%23FFFFFF&labelColor=%2318BCF2
[mushroomUrl]: https://github.com/piitaya/lovelace-mushroom
[hacsMushroomUrl]: https://my.home-assistant.io/redirect/hacs_repository/?owner=piitaya&repository=lovelace-mushroom&category=frontend
[miniGraphUrl]: https://github.com/kalkih/mini-graph-card
[hacsMiniGraphUrl]: https://my.home-assistant.io/redirect/hacs_repository/?owner=kalkih&repository=mini-graph-card&category=frontend
[hacsStrategyUrl]: https://my.home-assistant.io/redirect/hacs_repository/?owner=DigiLive&repository=mushroom-strategy&category=frontend