Skip to content

Commit 8e7d6f4

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

File tree

1 file changed

+1
-74
lines changed

1 file changed

+1
-74
lines changed

gauge-card/README.md

+1-74
Original file line numberDiff line numberDiff line change
@@ -1,74 +1 @@
1-
# Gauge card
2-
3-
A simple gauge implemented in CSS based on https://github.com/JohnrBell/Gauge_CSS.
4-
5-
![gauge-card](https://user-images.githubusercontent.com/7738048/42317998-73070c5e-8056-11e8-8621-49c61b5b7be5.gif)
6-
7-
![bedroom-temperature](https://user-images.githubusercontent.com/7738048/42344596-806b4a82-80a5-11e8-8e92-9077ad749dfe.gif)
8-
9-
10-
**Options**
11-
12-
| Name | Type | Default | Description
13-
| ---- | ---- | ------- | -----------
14-
| type | string | **Required** | `custom:gauge-card`
15-
| title | string | optional | Name to display on card
16-
| measurement | string | optional | If not set, uses the unit_of_measurement on the entity
17-
| entity | string | **Required** | `sensor.my_temperature`
18-
| attribute | string | optional | If set, this attribute of the entity is used, instead of its state
19-
| min | number | 0 | Minimum value for graph
20-
| max | number | 100 | Maximum value for graph
21-
| scale | string | '50px' | Base value for graph visual size
22-
| severity | object | optional | Severity object. See below
23-
24-
Severity object
25-
26-
| Name | Type | Default | Description
27-
| ---- | ---- | ------- | -----------
28-
| red | number | **Required** | Value from which to start red color
29-
| green | number | **Required** | Value from which to start green color
30-
| amber | number | **Required** | Value from which to start amber color
31-
32-
**Example**
33-
34-
Using two with stack
35-
```yaml
36-
- type: horizontal-stack
37-
cards:
38-
- type: custom:gauge-card
39-
title: Temperature
40-
entity: sensor.random_temperature
41-
min: -20
42-
max: 35
43-
- type: custom:gauge-card
44-
title: Oil
45-
entity: sensor.my_oil_sensor
46-
severity:
47-
red: 50
48-
green: 0
49-
amber: 40
50-
```
51-
52-
Simple one
53-
```yaml
54-
- type: custom:gauge-card
55-
entity: sensor.my_oil_sensor
56-
scale: 100px
57-
```
58-
59-
Using an attribute
60-
```yaml
61-
- type: custom:gauge-card
62-
entity: climate.living_room
63-
attribute: current_temperature
64-
```
65-
66-
Using an attribute with dot notation
67-
```yaml
68-
- type: custom:gauge-card
69-
entity: climate.living_room.current_temperature
70-
```
71-
72-
## Credits
73-
- [@ciotlosm](https://github.com/ciotlosm)
74-
- [@isabellaalstrom](https://github.com/isabellaalstrom)
1+
# Gauge card has moved to https://github.com/custom-cards/gauge-card

0 commit comments

Comments
 (0)