forked from DigiLive/mushroom-strategy
Document examples to be more readable.
This commit is contained in:
97
README.md
97
README.md
@@ -139,21 +139,25 @@ The area object includes all options from the template mushroom card and `extra_
|
|||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
areas:
|
strategy:
|
||||||
- name: Family Room
|
type: custom:mushroom-strategy
|
||||||
icon: mdi:television
|
options:
|
||||||
icon_color: green
|
areas:
|
||||||
extra_cards:
|
- name: Family Room
|
||||||
- type: custom:mushroom-chips-card
|
icon: mdi:television
|
||||||
chips:
|
icon_color: green
|
||||||
- type: entity
|
extra_cards:
|
||||||
entity: sensor.family_room_temperature
|
- type: custom:mushroom-chips-card
|
||||||
icon: mdi:thermometer
|
chips:
|
||||||
icon_color: pink
|
- type: entity
|
||||||
alignment: center
|
entity: sensor.family_room_temperature
|
||||||
- name: Kitchen
|
icon: mdi:thermometer
|
||||||
icon: mdi:silverware-fork-knife
|
icon_color: pink
|
||||||
icon_color: red
|
alignment: center
|
||||||
|
- name: Kitchen
|
||||||
|
icon: mdi:silverware-fork-knife
|
||||||
|
icon_color: red
|
||||||
|
views: []
|
||||||
```
|
```
|
||||||
|
|
||||||
### Entity Config
|
### Entity Config
|
||||||
@@ -162,9 +166,13 @@ The `entity_config` essentially enables you to give a specific entity any card y
|
|||||||
|
|
||||||
#### Example
|
#### Example
|
||||||
```yaml
|
```yaml
|
||||||
entity_config:
|
strategy:
|
||||||
- entity: fan.master_bedroom_fan
|
type: custom:mushroom-strategy
|
||||||
type: custom:mushroom-fan-card
|
options:
|
||||||
|
entity_config:
|
||||||
|
- entity: fan.master_bedroom_fan
|
||||||
|
type: custom:mushroom-fan-card
|
||||||
|
views: []
|
||||||
```
|
```
|
||||||
|
|
||||||
### Pre-built views
|
### Pre-built views
|
||||||
@@ -185,12 +193,16 @@ Mushroom strategy includes pre-built views to control/view specific domains. Onl
|
|||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
views:
|
strategy:
|
||||||
lights: true
|
type: custom:mushroom-strategy
|
||||||
switches: true
|
options:
|
||||||
covers: false
|
views:
|
||||||
cameras: true
|
lights: true
|
||||||
thermostats: false
|
switches: true
|
||||||
|
covers: false
|
||||||
|
cameras: true
|
||||||
|
thermostats: false
|
||||||
|
views: []
|
||||||
```
|
```
|
||||||
|
|
||||||
### Chips
|
### Chips
|
||||||
@@ -214,24 +226,25 @@ Mushroom strategy has chips that count the number of devices active for a specif
|
|||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
chips:
|
strategy:
|
||||||
climate_count: false
|
type: custom:mushroom-strategy
|
||||||
cover_count: false
|
options:
|
||||||
weather_entity: weather.forecast_home
|
chips:
|
||||||
extra_chips:
|
climate_count: false
|
||||||
- type: conditional
|
cover_count: false
|
||||||
conditions:
|
weather_entity: weather.forecast_home
|
||||||
- entity: lock.front_door
|
extra_chips:
|
||||||
state: unlocked
|
- type: conditional
|
||||||
chip:
|
conditions:
|
||||||
type: entity
|
- entity: lock.front_door
|
||||||
entity: lock.front_door
|
state: unlocked
|
||||||
icon_color: red
|
chip:
|
||||||
content_info: none
|
type: entity
|
||||||
icon: ''
|
entity: lock.front_door
|
||||||
use_entity_picture: false
|
icon_color: red
|
||||||
tap_action:
|
content_info: none
|
||||||
action: toggle
|
tap_action:
|
||||||
|
action: toggle
|
||||||
```
|
```
|
||||||
|
|
||||||
## Full Example
|
## Full Example
|
||||||
|
Reference in New Issue
Block a user