DigiLive/mushroom-strategy
1
0
Fork 1
mirror of https://github.com/DigiLive/mushroom-strategy.git synced 2025-07-31 18:34:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Strategy Options (markdown)

Aalian Khan
2023-11-07 21:00:18 -05:00
parent d1964e8456
commit 06bcbf3d15
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Strategy-Options.md

@@ -9,15 +9,15 @@ The options available are:
| Name | Type | Default | Description | | Name | Type | Default | Description |
|:---------------------|:--------------------------|:--------------------------------------------------------|:-----------------------------------------------------------------------| |:---------------------|:--------------------------|:--------------------------------------------------------|:-----------------------------------------------------------------------|
| `areas` | object (optional) | unset | One or more areas in a list, see [areas object](#area-object). | | `areas` | object (optional) | unset | One or more areas in a list, see [Areas](#areas). |
| `card_options` | object (optional) | unset | Card options for cards, see [Card Options](#card-options). | | `card_options` | object (optional) | unset | Card options for cards, see [Card Options](#card-options). |
| `views` | object (optional) | All default views | See available [Pre-built views](#pre-built-views). | | `views` | object (optional) | All default views | See available [Views](#views). |
| `chips` | object | All count chips enabled with auto selected weather card | See [chips](#chips). | | `chips` | object | All count chips enabled with auto selected weather card | See [Chips](#chips). |
| `quick_access_cards` | array of cards (optional) | unset | List of cards to show between welcome card and rooms cards. | | `quick_access_cards` | array of cards (optional) | unset | List of cards to show between welcome card and rooms cards. |
| `extra_cards` | array of cards (optional | unset | List of cards to show below room cards. | | `extra_cards` | array of cards (optional | unset | List of cards to show below room cards. |
| `extra_views` | array of views (optional) | unset | List of views to add to the dashboard. | | `extra_views` | array of views (optional) | unset | List of views to add to the dashboard. |
| `domains` | object (optional) | All supported domains | See [Supported domains](#supported-domains). | | `domains` | object (optional) | All supported domains | See [Domains](#domains). |
| `homeView` | object (optional) | unset | Options for the home view, see [Home View Options](#home-view-options) | | `homeView` | object (optional) | unset | Options for the home view, see [Home View](#home-view) |
#### Example #### Example
@@ -32,9 +32,9 @@ strategy:
icon_color: green icon_color: green
views: [] views: []
``` ```
# Area Object # Areas
The area object includes all options from the template mushroom card and `extra_cards` which is a list of cards to show The areas option includes all options from the template mushroom card plus `extra_cards` which is a list of cards to show
at the top of the area subview. at the top of the area subview.
| Name | Type | Default | Description | | Name | Type | Default | Description |
@@ -139,7 +139,7 @@ strategy:
views: [] views: []
``` ```
# Pre-built views # Views
![Light Views](https://github.com/AalianKhan/mushroom-strategy/blob/main/docs/light_view.png) ![Light Views](https://github.com/AalianKhan/mushroom-strategy/blob/main/docs/light_view.png)
@@ -155,7 +155,7 @@ By default, all pre-built views below are shown:
| `cover` | object* | View to control all covers and covers of each area. | | `cover` | object* | View to control all covers and covers of each area. |
| `switch` | object* | View to control all switches and switches of each area. | | `switch` | object* | View to control all switches and switches of each area. |
| `climate` | object* | View to control climate devices such as thermostats. Seperated by each area. | | `climate` | object* | View to control climate devices such as thermostats. Seperated by each area. |
| `camera` | object* | View to show all cameras using WebRTC cards. Seperated by each area. | | `camera` | object* | View to show all cameras. Seperated by each area. |
## View Options ## View Options
@@ -231,9 +231,9 @@ The following domains are supported and enabled by default:
* number * number
* default (Miscellaneous) * default (Miscellaneous)
# Home View Options # Home View
The `homeView` options will let you configure the Home View. The `homeView` option will let you configure the Home View.
| Option | type | Description | | Option | type | Description |
|:---------|:------|:----------------------------------------------| |:---------|:------|:----------------------------------------------|