Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/dmatik/switcher-boiler-card
Browse files Browse the repository at this point in the history
  • Loading branch information
@dmatik
dmatik committed Jan 31, 2025
2 parents 3290c60 + 9f2bd10 commit 1157cd8
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@

<a href="https://www.buymeacoffee.com/bg7MaEJHc" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/white_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

![alt text](https://github.com/dmatik/switcher-boiler-card/blob/main/images/switcher_boiler_card.png "Logo")
![alt text](https://github.com/dmatik/switcher-boiler-card/blob/main/images/switcher_boiler_card.png "Switcher Boiler Card")

## What is switcher-boiler-card ?

Custom Switcher Boiler Switch card for Home Assistant.
Built to work with official [Switcher Integration](https://www.home-assistant.io/integrations/switcher_kis/) for Home Assistant.
The card desgned to look and feel similar to other Tile cards in HA.
The card designed to look and feel similar to other Tile cards in HA.

Welcome to our [Smart Home Israel](https://discord.gg/ayZ3Kkg) Discord channel to discuss.

Expand All @@ -22,27 +22,25 @@ 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 minutes, when clicked.
- Turn on with or without selected timer.
- Support editing in YAML as well (please see table below).

## Installation

### HACS (Coming soon)
### HACS

To install from HACS you need to add this repository as custom repository first.

1. Go to HACS and open 3 dots menu on the right upper corner.
2. Select "Custom repositories" option.
3. In the "Custom repositories" popup polulate as below:
3. In the "Custom repositories" popup populate as below:
- **Repository:** `https://github.com/dmatik/switcher-boiler-card`
- **Type:** `Dashboard`
4. Click "Add".

Now you should be able to find "Switcher Boiler Card" in HACS store.

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=dmatik&repository=https%3A%2F%2Fgithub.com%2Fdmatik%2Fswitcher-boiler-card&category=plugin)

### Manual

1. Download `switcher-boiler-card.js` and `switcher-boiler-card-editor.js` files from `dist` folder in the [latest release][release-url].
Expand All @@ -62,22 +60,22 @@ Now you should be able to find "Switcher Boiler Card" in HACS store.
### UI Editor
The card can be fully configured from HA UI Editor.
![alt text](https://github.com/dmatik/switcher-boiler-card/blob/main/images/switcher_editor.png "Logo")
![alt text](https://github.com/dmatik/switcher-boiler-card/blob/main/images/switcher_editor.png "Switcher Boiler Card 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 (from 1 to 150). | no | 15, 30, 45, 60 |

Example:

Expand All @@ -103,4 +101,4 @@ timer_values:
<!-- References -->
[hacs-url]: https://github.com/hacs/integration
[home-assistant]: https://www.home-assistant.io/
[release-url]: https://github.com/piitaya/lovelace-mushroom/releases
[release-url]: https://github.com/dmatik/switcher-boiler-card/releases

0 comments on commit 1157cd8

Please sign in to comment.