Skip to content

Commit

Permalink
add template doc
Browse files Browse the repository at this point in the history
  • Loading branch information
piitaya committed Feb 2, 2022
1 parent 548a1f3 commit d3d3692
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/cards/sensor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Sensor card

![Sensor light](../images/sensor-light.png)
![Sensor dark](../images/sensor-dark.png)

## Description

A sensor card allow you to control a sensor entity.

## Configuration variables

All the options are available in the lovelace editor but you can use `yaml` if you want.

| Name | Type | Default | Description |
| :--------------- | :------ | :-------------------------------------------------- | :--------------------------------------- |
| `entity` | string | Required | Sensor entity |
| `icon` | string | Optional | Custom icon |
| `icon_color` | string | `blue` | Custom color for icon |
| `name` | string | Optional | Custom name |
| `vertical` | boolean | `false` | Vertical layout |
| `primary_info` | boolean | `name` `state` | Info to show as primary info |
| `secondary_info` | boolean | `name` `state` `last-changed` `last-updated` `none` | Info to show as secondary info |
| `tap_action` | action | `more-info` | Home assistant action to perform on tap |
| `hold_action` | action | `more-info` | Home assistant action to perform on hold |
24 changes: 24 additions & 0 deletions docs/cards/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Template card

![Template light](../images/template-light.png)
![Template dark](../images/template-dark.png)

## Description

A cover card allow you to control a template entity.

## Configuration variables

All the options are available in the lovelace editor but you can use `yaml` if you want.

| Name | Type | Default | Description |
| :------------ | :-------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------- |
| `icon` | string | Optional | Icon to render. May contain [templates](https://www.home-assistant.io/docs/configuration/templating/). |
| `icon_color` | string | Optional | Icon color to render. May contain [templates](https://www.home-assistant.io/docs/configuration/templating/). |
| `primary` | string | Optional | Primary info to render. May contain [templates](https://www.home-assistant.io/docs/configuration/templating/). |
| `secondary` | string | Optional | Secondary info to render. May contain [templates](https://www.home-assistant.io/docs/configuration/templating/). |
| `vertical` | boolean | `false` | Vertical layout |
| `hide_state` | boolean | `false` | Hide the entity state |
| `tap_action` | action | `none` | Home assistant action to perform on tap |
| `hold_action` | action | `none` | Home assistant action to perform on hold |
| `entity_id` | `string` `list` | Optional | Only reacts to the state changes of these entities. This can be used if the automatic analysis fails to find all relevant entities. |

0 comments on commit d3d3692

Please sign in to comment.