Skip to content

Commit 4a79f46

Browse files
authored
Update README.md
1 parent cd7d1ed commit 4a79f46

File tree

1 file changed

+1
-61
lines changed

1 file changed

+1
-61
lines changed

entity-attributes-card/README.md

+1-61
Original file line numberDiff line numberDiff line change
@@ -1,61 +1 @@
1-
# Entity attributes
2-
3-
Entity attributes allows you to show basic attributes from multiple entities.
4-
5-
![enitty-attributes-card](https://user-images.githubusercontent.com/7738048/42527876-8e9f1206-8482-11e8-9e19-b5ffbfbf8474.png)
6-
7-
**Options**
8-
9-
| Name | Type | Default | Description
10-
| ---- | ---- | ------- | -----------
11-
| type | string | **Required** | `custom:entity-attributes-card`
12-
| title | string | optional | A title for the card
13-
| heading_name | string | 'Attributes' | Heading of the attribute column
14-
| heading_state | string | 'States' | Heading of the states column
15-
| filter | object | **Required** | A filter object that can contain `include` and `exclude` sections
16-
17-
⚠️ `include` and `exclude` can be simple lists (format `[domain]`.`[entity]`.`[attribute]`) or objects of type below. `[attribute]` can also be a pattern.
18-
19-
| Name | Type | Default | Description
20-
| ---- | ---- | ------- | -----------
21-
| key | string | **Required** | A pattern for the attribute. Example: `media_player.bedroom.media_title`
22-
| name | string | optional | A string to replace the actual attribute name with
23-
| unit | string | optional | A string to append an arbitrary unit to the value
24-
25-
**Example**
26-
27-
```yaml
28-
- type: custom:entity-attributes-card
29-
title: Attributes Card
30-
heading_name: List
31-
heading_state: States
32-
filter:
33-
include:
34-
- key: climate.hvac.*
35-
- key: media_player.bedroom.app_name
36-
name: Application
37-
- key: media_player.bedroom.media_title
38-
name: Media center
39-
- climate.heatpump.current_temperature
40-
- vacuum.xiaomi_mi_robot.battery_level
41-
unit: %
42-
```
43-
44-
How to embed this inside `entities` card:
45-
46-
![screen shot 2018-07-09 at 13 47 38](https://user-images.githubusercontent.com/7738048/42446481-1ac27c1e-837f-11e8-94e7-02ef35f2d853.png)
47-
48-
```yaml
49-
- type: entities
50-
title: Entities card
51-
entities:
52-
- media_player.bedroom
53-
- type: custom:entity-attributes-card
54-
entity: media_player.bedroom
55-
filter:
56-
include:
57-
- media_player.bedroom.app_name
58-
- media_player.bedroom.media_title
59-
- sensor.short_name
60-
- sensor.battery_sensor
61-
```
1+
# Entity attributes has moved to https://github.com/custom-cards/entity-attributes-card

0 commit comments

Comments
 (0)