Skip to content

Commit

Permalink
Add Custom Person and Scene guides. (#1)
Browse files Browse the repository at this point in the history
* add usage guide for `Custom Card Person'

* add usage guide for `Custom Card Scenes'

* add and example of Dark Dashboard.

---------

Co-authored-by: Andrew Blackburn <andyblac@icloud.com>
  • Loading branch information
andyblac and Andrew Blackburn authored Sep 7, 2023
1 parent 18c1158 commit 7cb4930
Show file tree
Hide file tree
Showing 13 changed files with 113 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@

# Minimalist Custom Cards
My custom cards for Minimalist UI.

![example-dark](docs/assets/img/Example_Dashboard_Dark.png)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
custom_card_andyblac_scenes:
custom_card_andyblac_scene:
# 1.1
template:
- "ulm_translation_engine"
Expand Down
Binary file added docs/assets/img/Example_Dashboard_Dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 64 additions & 0 deletions docs/usage/custom_cards/custom_card_andyblac_person.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Custom Card "Person"
hide:
- toc
---
<!-- markdownlint-disable MD046 -->

## Description

![example-image-light](../../assets/img/custom_card_andyblac_person/custom_card_andyblac_person_light.png)
![example-image-dark](../../assets/img/custom_card_andyblac_person/custom_card_andyblac_person_dark.png)

This card shows if a person is `Home` or `Away`. If you have setup other zones, it will show these as well, it also shows you your battery level.

## Credits

- Authors:
- AndyBlac
- Full credit to the Minimalist UI team for creating the base card that this 'mod' was used.

## Changelog

<details>
<summary>1.2.0</summary>
Initial release
</details>

## Variables

| Variable | Default | Required | Notes |
|----------|---------|------------------|-------------------|
| entity | | Yes | The person entity |
| ulm_card_person_use_entity_picture | | No | If you set this to true, the card shows the entity picture from your user, otherwise (set to false) shows the icon. Default is false. |
| ulm_card_person_icon | mdi:face-man | No | Sets the icon to display if entity picture not shown. |
| ulm_card_person_eta | | No | Sensor with ETA info from integrations like: [Waze](https://www.home-assistant.io/integrations/waze_travel_time/), [Google](https://www.home-assistant.io/integrations/google_travel_time/) and [HERE](https://www.home-assistant.io/integrations/here_travel_time/) |
| ulm_address | | No | Show an address as label, add an entity with a geo location |
| battery | | No | Battery sensor a `battery` object (see below) |

## Battery entity

| Variable | Default | Required | Notes | Requirement |
|----------------------------------------|-----------------|------------------|----------------|-------------|
| entity_id | | Yes | The entity_id of the status icon | |

## Usage

```yaml
- type: 'custom:button-card'
template: custom_card_andyblac_person
entity: person.username
variables:
ulm_card_person_use_entity_picture: true
ulm_card_person_icon: mdi:face-woman
ulm_card_person_eta: sensor.waze_travel_time_person
ulm_address: sensor.andys_iphone_zone_name
battery:
entity_id: sensor.iphone_battery_level
```
??? note "Template Code"
```yaml title="custom_card_andyblac_person.yaml"
--8<-- "custom_cards/custom_card_andyblac_person/custom_card_andyblac_person.yaml"
```
46 changes: 46 additions & 0 deletions docs/usage/custom_cards/custom_card_andyblac_scene.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Custom Card "Scene"
hide:
- toc
---
<!-- markdownlint-disable MD046 -->

## Description

![example-image-light](../../assets/img/custom_card_andyblac_scene/custom_card_andyblac_scene_light.png)
![example-image-dark](../../assets/img/custom_card_andyblac_scene/custom_card_andyblac_scene_dark.png)

## Credits

- Authors:
- AndyBlac

## Changelog

<details>
<summary>1.1.0</summary>
Initial release
</details>

## Variables

| Variable | Default | Required | Notes |
|----------|---------|------------------|-------------------|
| entity | | Yes | The scene entity |
| ulm_card_scene_color | | No | This lets you change the colour if the icon and background. |

## Usage

```yaml
- type: custom:button-card
template: custom_card_andyblac_scene
entity: scene.good_morning
variables:
ulm_card_scene_color: yellow
```
??? note "Template Code"
```yaml title="custom_card_andyblac_scenes.yaml"
--8<-- "custom_cards/custom_card_andyblac_scenes/custom_card_andyblac_scenes.yaml"
```

0 comments on commit 7cb4930

Please sign in to comment.