forked from DigiLive/mushroom-strategy
Adds: - Strategy: - SceneCard: Support for Stateful scenes. Closes #190. - ValveCard: A card to control an entity of the valve domain. Closes #192. - LockView: A view for entities of the lock domain. Closes #171. - Modules: - RegistryFilter: Advanced filtering and sorting of Home Assistant registries. - Auxiliaries: Generic utility functions. - Debug: Centralized logging and debug level management. - Tooling: - ESLint configuration for linting. - Prettier configuration for code formatting. Removes: - Redundant types and interface annotations. - Redundant legacy and unused modules. - Localization constant from the `Helper` module in favor of a new `localize` utility. Refactors: - References regarding change of repository owner. - Auxiliary functions are moved from the `Helper` module to `Auxiliaries` module. - `Helper` module is renamed to `Registry` for centralized state and registry management. - `ControllerCard` is renamed to `HeaderCard`. - Doc-blocks and comments are updated for clarity and consistency. - The file tree is restructured for improved clarity, modularity, and scalability. - Third party type definitions are updated and cleaned up. - Issue and Pull Request templates. Optimizations: - Parallelization of dynamic imports for views and cards. - Improved error handling and logging throughout the codebase. - Sanitization of HASS registries after import. - Enforced stricter and simplified types and interfaces. - Localization now available at global scope. Fixes: - Wrong type in configuration of `HeaderCard`. - Translation files: Resolved key inconsistencies. - Removed unnecessary namespaces from types. - Typos and Grammar. - Explicit use of `any` types. - Turn off all entities of a domain with a chip tap action. - Rendering too small HASS area cards. - Count of active vacuums. Bumps: - Mushroom Strategy - home-assistant-js-websocket - superstruct - ts-loader - ts-node - typescript - webpack - webpack-cli
89 lines
2.6 KiB
Markdown
89 lines
2.6 KiB
Markdown
# Mushroom dashboard strategy
|
|
|
|
[![release][releaseBadge]][releaseUrl]
|
|
[![hacs][hacsBadge]][hacsUrl]
|
|
|
|

|
|
|
|
<details>
|
|
<summary>More images...</summary>
|
|
|
|

|
|
|
|

|
|
|
|

|
|
</details>
|
|
|
|
## What is the Mushroom Dashboard Strategy?
|
|
|
|
Mushroom Dashboard Strategy provides a strategy for Home Assistant to automatically generate a dashboard
|
|
using [Mushroom][mushroomUrl] cards.
|
|
|
|
Dashboard cards are generated for your Home Assistant's entities, devices and areas, divided over several views.
|
|
Starting at the Home view, you can enter an area subview.
|
|
For easy access, separate views are generated for entities which belong to specific domains.
|
|
|
|
### Features
|
|
|
|
- 🛠 Automatically create a dashboard with three lines of YAML.
|
|
- 😍 Built-in Views for device-specific controls.
|
|
- 🎨 Many options to customize to fit your needs.
|
|
- 📈 [Mini graph][miniGraphUrl] cards for sensor entities.
|
|
|
|
> [!TIP]
|
|
> If you like this package, please star the [project at GitHub][repositoryUrl]!
|
|
|
|
## Getting started
|
|
|
|
The strategy is easily installable from [HACS][hacsUrl] (Home Assistant Community Store).
|
|
Please visit [Installation Guide][installationUrl] at our Wiki.
|
|
|
|
## Need some help?
|
|
|
|
Visit the [Discussions][discussionsUrl] page or
|
|
the [Wiki][wikiUrl].
|
|
|
|
## Have an idea or want to report a bug?
|
|
|
|
Make sure your idea or bug isn't discussed already in our Discussions or Issues!
|
|
Visit the [issues][issuesUrl] page.
|
|
|
|
## Collaborators
|
|
|
|
* [DigiLive](https://github.com/DigiLive)
|
|
|
|
[![Sponsor DigiLive][sponsorBadge]](https://github.com/sponsors/DigiLive)
|
|
|
|
* [Aalian Khan](https://github.com/AalianKhan)
|
|
|
|
<!-- Badge References -->
|
|
|
|
[hacsBadge]: https://img.shields.io/badge/HACS-Default-blue
|
|
|
|
[sponsorBadge]: https://img.shields.io/badge/Sponsor_him-%E2%9D%A4-%23db61a2.svg?&logo=github&color=%23fe8e86
|
|
|
|
[releaseBadge]: https://img.shields.io/github/v/tag/digilive/mushroom-strategy?filter=v2.3.0&label=Release
|
|
|
|
<!-- Repository References -->
|
|
|
|
[repositoryUrl]: https://github.com/DigiLive/mushroom-strategy
|
|
|
|
[releaseUrl]: https://github.com/DigiLive/mushroom-strategy/releases/tag/v2.3.0
|
|
|
|
[issuesUrl]: https://github.com/DigiLive/mushroom-strategy/issues
|
|
|
|
[discussionsUrl]: https://github.com/DigiLive/mushroom-strategy/discussions
|
|
|
|
[wikiUrl]: https://github.com/DigiLive/mushroom-strategy/wiki
|
|
|
|
[installationUrl]: https://github.com/DigiLive/mushroom-strategy/wiki#installation
|
|
|
|
<!-- Other References -->
|
|
|
|
[hacsUrl]: https://hacs.xyz
|
|
|
|
[mushroomUrl]: https://github.com/piitaya/lovelace-mushroom
|
|
|
|
[miniGraphUrl]: https://github.com/kalkih/mini-graph-card
|