Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@dmatik
dmatik authored Jan 5, 2025
1 parent 99d8de6 commit 9e4fe7c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Welcome to our [Smart Home Israel](https://discord.gg/ayZ3Kkg) Discord channel t
- Fully supports HA UI Editor (no need to edit YAML code).
- Displays remaining time in state field.
- Optional additional 2 sensors to display in state field. Sensor 1 to be displayed when Switcher is On. Sensor 2 to be displayed when Switcher is On and Off.
- The time selection button loops through configurable timer values in munutes, when clicked. Default is 15/30/45/60.
- The time selection button loops through configurable timer values in munutes, when clicked.
- Turn on with or without selected timer.
- Support editing in YAML as well (please see table below).

Expand Down Expand Up @@ -68,16 +68,16 @@ The card can be fully configured from HA UI Editor.
### YAML configuration
| Name | Description | Required |
| -------------------- | ------------------------------------------------------------------------------------- | -------------------------------- |
| `type` | `custom:switcher-boiler-card` | yes |
| `entity` | Switcher switch entity | yes |
| `name` | Card name. Leave empty to take entity friendly name. | no |
| `icon` | Card icon. Leave empty to take icon from entity. | no |
| `time_left` | Time left sensor entity. Leave empty if you don't want it to be displayed. | no |
| `sensor_1` | Sensor 1 entity. Displayed only when Switcher is On. | no |
| `sensor_2` | Sensor 2 entity. Displayed when Switcher is On and Off. | no |
| `timer_values` | List of values for timer in minutes. Default is 15/30/45/60. | no |
| Name | Description | Required | Default |
| -------------------- | ------------------------------------------------------------------------------------- | -------------------------------- | ------------------------------- |
| `type` | `custom:switcher-boiler-card` | yes | |
| `entity` | Switcher switch entity | yes | |
| `name` | Card name. Leave empty to take entity friendly name. | no | "Boiler" |
| `icon` | Card icon. Leave empty to take icon from entity. | no | "mdi:waves" |
| `time_left` | Time left sensor entity. Leave empty if you don't want it to be displayed. | no | |
| `sensor_1` | Sensor 1 entity. Displayed only when Switcher is On. | no | |
| `sensor_2` | Sensor 2 entity. Displayed when Switcher is On and Off. | no | |
| `timer_values` | List of values for timer in minutes. | no | 15, 30, 45, 60 |

Example:

Expand Down

0 comments on commit 9e4fe7c

Please sign in to comment.