Skip to content

Commit 76fdbf9

Browse files
committed
README: document schema
1 parent ed37310 commit 76fdbf9

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,18 @@ sensor:
3232
state_class: total_increasing
3333
```
3434
35+
## Options
36+
37+
| Name | Type | Default | Description |
38+
|---------------------|--------|----------|-------------|
39+
| name | string | required | Friendly name |
40+
| expr | string | required | [PromQL](https://prometheus.io/docs/prometheus/latest/querying/basics/) expression |
41+
| unique_id | string | optional | Unique ID |
42+
| unit_of_measurement | string | optional | Unit of the measurement |
43+
| device_class | string | optional | [Device class](https://www.home-assistant.io/integrations/sensor/#device-class) |
44+
| state_class | string | optional | [State class](https://developers.home-assistant.io/docs/core/entity/sensor/#available-state-classes) |
45+
46+
3547
## Upstream integration
3648
3749
I tried to get this component merged into home-assistant in 2020/12.

0 commit comments

Comments
 (0)