Skip to content

Commit

Permalink
Add docs for aqi option
Browse files Browse the repository at this point in the history
  • Loading branch information
denysdovhan committed Dec 10, 2020
1 parent 8ffc57e commit e5b2f20
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,18 @@ Here is what every option means:
| `show_status` | `boolean` | `true` | Show status of the purifier. |
| `show_toolbar` | `boolean` | `true` | Show toolbar with actions. |
| `compact_view` | `boolean` | `false` | Compact view without image. |
| `aqi` | `object` | Optional | Custom entity or attribute for AQI value. |
| `stats` | `object` | Optional | Custom per state stats for your purifier cleaner |
| `actions` | `object` | Optional | Custom actions for your purifier cleaner. |

### `aqi` object

| Name | Type | Default | Description |
| ----------- | :------: | -------- | --------------------------------------------------- |
| `entity_id` | `string` | Optional | An entity_id with state, i.e. `sensor.current_aqi`. |
| `attribute` | `string` | Optional | An attribute which should be used to get AQI value. |
| `unit` | `string` | Optional | An unit of measurement to display. |

### `stats` object

You can use any attribute of purifier or even any entity by `entity_id` to display by stats section:
Expand Down

0 comments on commit e5b2f20

Please sign in to comment.