Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dmatik authored Dec 28, 2024
1 parent 1523499 commit 0814015
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,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 and/or Electrical Current in state field.
- Optional additional sensor to display in state field. For example if you have added Thermostat inside the Boiler to measure actual water temperature.
- The time selection button loops through 15/30/45/60 minutes, when clicked.
- Turn on with or without selected timer.
- Support editing in YAML as well (please see table below).
Expand Down Expand Up @@ -67,14 +68,15 @@ 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 |
| `electrical_current` | Electrical Current sensor entity. Leave empty if you don't want it to be displayed. | no |
| 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 |
| `electrical_current` | Electrical Current sensor entity. Leave empty if you don't want it to be displayed. | no |
| `additional_sensor` | Additional sensor entity. Leave empty if you don't want it to be displayed. | no |

Example:

Expand Down

0 comments on commit 0814015

Please sign in to comment.