Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
basbruss committed Jun 28, 2022
1 parent 0573e34 commit 8a3bb9b
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/usage/cards/card_binary_sensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ The `binary-sensor-card` is to show the state (on/off, open/close, etc.) of a bi
|----------|---------|------------------|-------------------|
| entity | | :material-check: | |
| ulm_show_last_changed | | :material-close: | `true` or `false` |
| ulm_card_binary_sensor_name | | :material-close: | Set custom Name |
| ulm_card_binary_sensor_icon | | :material-close: | Set custom Icon |

!!! Warning "⚠️ Breaking Change `v1.0.1`"

Expand Down
2 changes: 2 additions & 0 deletions docs/usage/cards/card_binary_sensor_alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ The `binary-sensor-card` is to show the state (on/off, open/close, etc.) of a bi
|----------|---------|------------------|-------------------|
| entity | | :material-check: | |
| ulm_show_last_changed | | :material-close: | `true` or `false` |
| ulm_card_binary_sensor_alert_name | | :material-close: | Set custom Name |
| ulm_card_binary_sensor_alert_icon | | :material-close: | Set custom Icon |

!!! Warning "⚠️ Breaking Change `v1.0.1`"

Expand Down
2 changes: 2 additions & 0 deletions docs/usage/cards/card_generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ This is the `generic-card` to display values from a sensor, eg. to show humidity
| Variable | Default | Required | Notes |
|----------|---------|------------------|-------------------|
| entity | | :material-check: | |
| ulm_card_generic_name | | :material-close: | Set custom Name |
| ulm_card_generic_icon | | :material-close: | Set custom Icon |

## Usage

Expand Down
2 changes: 2 additions & 0 deletions docs/usage/cards/card_generic_swap.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ This is a `generic-card` with swapped label and name.
| Variable | Default | Required | Notes |
|----------|---------|------------------|-------------------|
| entity | | :material-check: | |
| ulm_card_generic_swap_name | | :material-close: | Set custom Name |
| ulm_card_generic_swap_icon | | :material-close: | Set custom Icon |

## Usage

Expand Down
1 change: 1 addition & 0 deletions docs/usage/cards/card_graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The `card_graph` shows an entity with the actual state and a *min-graph-card* in
|----------|---------|------------------|-------------------|
| ulm_card_graph_color | | :material-close: | This is to adjust your color value. Use a CSS varible from HA or set a color value (eg. #FFFFFF) |
| ulm_card_graph_name | | :material-close: | Enable background |
| ulm_card_graph_icon | | :material-close: | Set custom icon |
| ulm_card_graph_entity | | :material-check: | Your entity_id for the temperature sensor |
| ulm_card_graph_entity2 | | :material-close: | Your entity_id for the second temperature sensor |
| ulm_card_graph_color2 | | :material-close: | This is to adjust your color value of the second graph. Use a CSS varible from HA or set a color value (eg. #FFFFFF) |
Expand Down
3 changes: 2 additions & 1 deletion docs/usage/cards/card_input_boolean.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ The `input-boolean-card` is to switch an `input_boolean` on or off.
| Variable | Default | Required | Notes |
|----------|---------|------------------|-------------------|
| entity | | :material-check: | |
| name | | :material-close: | |
| ulm_card_input_boolean_name | | :material-close: | Set custom Name |
| ulm_card_input_boolean_icon | | :material-close: | Set custom Icon |

## Usage

Expand Down
1 change: 0 additions & 1 deletion docs/usage/cards/card_media_player.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ hide:
| Variable | Default | Required | Notes |
| -------------------------------------------- | ------- | ---------------- | ----------------------------------------------- |
| entity | | :material-check: | The media-player entity |
| name | | :material-check: | Name to display for your media-player |
| ulm_card_media_player_name | | | Name to display for your media-player |
| ulm_card_media_player_icon | | | Change the icon displayed |
| ulm_card_media_player_enable_art | false | | Enable album picture on background |
Expand Down
3 changes: 2 additions & 1 deletion docs/usage/cards/card_power_outlet.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ This is the `power-outlet-card`. It shows you the state of a power outlet, and i
| Variable | Default | Required | Notes |
|----------|---------|------------------|-------------------|
| entity | | :material-check: | |
|name| | :material-check: | Enable background |
| ulm_card_power_outlet_name | | :material-close: | Set custom Name |
| ulm_card_power_outlet_icon | | :material-close: | Set custom Icon |
|ulm_card_power_outlet_consumption_sensor| | :material-close: | If you set this sensor, the `power-outlet-card` shows the energy consumption next to the state. |

## Usage
Expand Down

0 comments on commit 8a3bb9b

Please sign in to comment.