Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Action] Update custom_cards docs #1574

Merged
merged 1 commit into from
Dec 24, 2024
Merged

[Action] Update custom_cards docs #1574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions docs/usage/custom_cards/custom_card_iAbadia_battery_chip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: iAbadia's Battery Chip Custom Card
hide:
- toc
---

<!-- markdownlint-disable MD046 -->

# Custom-card "Battery Chip"

This is a `custom-card` or `custom-chip` to see your device's battery level at a glance.

![Screenshot](../../assets/img/custom_card_iAbadia_battery_chip.png)

## Credits

Author: Iñaki Abadia - 2024
Version: 1.0.0

## Changelog

<details>
<summary>1.0.0</summary>
Initial release
</details>

## Requirements

None

## Usage

```yaml
type: "custom:button-card"
template: custom_card_iAbadia_battery_chip
variables:
ulm_custom_card_iAbadia_battery_chip_entity: sensor.living_room_sensor_battery
ulm_custom_card_iAbadia_battery_chip_icon: mdi:thermostat
ulm_custom_card_iAbadia_battery_chip_warning: 30
ulm_custom_card_iAbadia_battery_chip_danger: 10
```

## Variables

| Variable | Example | Required | Explanation |
| ---------------------------------------------- | -------------------- | -------- | ----------------------------------------------------- |
| ulm_custom_card_iAbadia_battery_chip_entity | `sensor.temperature` | ✓ | Battery entity |
| ulm_custom_card_iAbadia_battery_chip_icon | `mdi:thermometer` | ✘ | Icon to be displayed. Will default to mdi:battery |
| ulm_custom_card_iAbadia_battery_chip_warning | `20` | ✘ | Battery level below which to color as warning (yellow) |
| ulm_custom_card_iAbadia_battery_chip_danger | `10` | ✘ | Battery level below which to color as danger (red) |

## Template Code

??? note "Template Code"

```yaml title="custom_card_irmajavi_speedtest.yaml"
--8<-- "custom_cards/custom_card_iAbadia_battery_chip/custom_card_iAbadia_battery_chip.yaml"
```
35 changes: 32 additions & 3 deletions docs/usage/custom_cards/custom_card_schumijo_flower.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ This is a `custom-card` to display a plant entity. Shows state of the plant and

## Credits

Author: schumijo - 2021
Version: 1.1.0
- Author: schumijo - 2021
- Update 2.0.0 : Ashino - 2024
- Version: 2.0.0

## Changelog

Expand All @@ -28,6 +29,11 @@ Initial release
Fix language files for beta5
Updated README
</details>
<details>
<summary>2.0.0</summary>
Add support to lovelace-flower-card from Olen (advanced forked version)
Updated README
</details>

## Usage

Expand All @@ -38,6 +44,10 @@ Updated README
ulm_card_flower_entity: plant.bonsai_ficus
ulm_card_flower_name: Bonsai Ficus
ulm_card_flower_species: "ficus retusa"
ulm_card_flower_show_bars:
- temperature
- humidity
- moisture
```

#### Variables
Expand Down Expand Up @@ -67,11 +77,30 @@ Updated README
<td>yes</td>
<td>The species of your plant</td>
</tr>
<tr>
<td>ulm_card_flower_show_bars</td>
<td>
- temperature
<br>
- moisture
<br>
- humidity
</td>
<td>no</td>
<td>The bar you want to display. Any of :
<li>illuminance</li>
<li>humidity</li>
<li>moisture</li>
<li>conductivity</li>
<li>temperature</li>
<li>dli</li>
</td>
</tr>
</table>

## Requirements

Need [lovelace-flower-card](https://github.com/thomasloven/lovelace-flower-card)
Need [lovelace-flower-card](https://github.com/Olen/lovelace-flower-card)

## Template code

Expand Down