Skip to content

[Action] Update custom_cards docs #4

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Action] Update custom_cards docs #4

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
7 changes: 7 additions & 0 deletions docs/usage/custom_cards/custom_card_bar_card.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ This card needs the following to function correctly:
<td>Overwrites the sensor name</td>
</tr>
<tr>
<td>ulm_custom_card_bar_card_icon</td>
<td>"mdi:icon"</td>
<td>no</td>
<td>Sensor Icon</td>
<td>Overwrites the sensor icon</td>
</tr>
<tr>
<td>ulm_custom_card_bar_card_value</td>
<td>true / false</td>
<td>no</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/custom_cards/custom_card_device_tracker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ hide:

## Description

![Screenshot](../../assets/img/custom_card_device_tracker.png)
![example-image](../../assets/img/ulm_cards/custom_card_device_tracker.png){ width="500" }

The `custom_card_device_tracker` displays presence state of a device according to the provided entity.
It allow to display the state of two tracker for this device
Expand Down
4 changes: 2 additions & 2 deletions docs/usage/custom_cards/custom_card_nas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Fix card & add Screenshot
variables:
ulm_custom_card_nas_sensor: sensor.pinas_disk_use
ulm_custom_card_nas_text: "HDD used"
ulm_custom_card_nas_unit: "%"
ulm_custom_cad_nas_unit: %
```

## Requirements
Expand Down Expand Up @@ -69,7 +69,7 @@ n/a
<td>ulm_custom_card_nas_unit</td>
<td>%</td>
<td>yes</td>
<td>The unit to show after your sensors state (use empty string to show nothing eg. "")</td>
<td>The unit to show after your sensors state</td>
</tr>
</table>

Expand Down
24 changes: 24 additions & 0 deletions docs/usage/custom_cards/custom_card_saxel_fan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,30 @@ This card needs the following to function correctly:
<td>no</td>
<td>true/false if the fan speed row should collapse when the fan is turned off. Default: true</td>
</tr>
<tr>
<td>ulm_card_fan_horizontal</td>
<td>true</td>
<td>no</td>
<td>Single Line Horizontal Control. Collapsible MUST be false for this currently. Default: false</td>
</tr>
<tr>
<td>ulm_show_button</td>
<td>false</td>
<td>no</td>
<td>Set to false to remove the Button and have a full width Slider. Default: true</td>
</tr>
<tr>
<td>ulm_button_icon</td>
<td>mdi:button</td>
<td>no</td>
<td>Set the icon for the Button. Default: mdi:rotate-3d-variant</td>
</tr>
<tr>
<td>ulm_button_service</td>
<td>fan.toggle</td>
<td>no</td>
<td>Name of the Service Call on button press. Default: fan.oscillate</td>
</tr>
<tr>
<td>oscillate_attribute</td>
<td>oscillate</td>
Expand Down