Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kizza committed Mar 3, 2024
1 parent 5c709f2 commit bc11331
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
# 🥳 Magic Home Party (Custom Card)
[![Tests](https://github.com/kizza/magic-home-party-card/actions/workflows/tests.yml/badge.svg)](https://github.com/kizza/magic-home-party-card/actions/workflows/tests.yml)
[<img height="24" alt="HACS badge" src="https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge">](https://github.com/hacs/frontend)
[<img height="24" alt="Downloads badge" src="https://img.shields.io/github/downloads/kizza/magic-home-party-card/total?style=for-the-badge">](https://api.github.com/repos/kizza/magic-home-party-card/releases)
[<img height="24" alt="Version badge" src="https://img.shields.io/github/v/release/kizza/magic-home-party-card?style=for-the-badge">](https://github.com/kizza/magic-home-party-card/releases)
[<img height="24" alt="Tests badge" src="https://github.com/kizza/magic-home-party-card/actions/workflows/tests.yml/badge.svg">](https://github.com/kizza/magic-home-party-card/actions/workflows/tests.yml)

A [Home Assistant](https://www.home-assistant.io/) custom card for managing the [Magic Home integration](https://www.home-assistant.io/integrations/flux_led/) lighting effects
A [Home Assistant](https://www.home-assistant.io/) custom card providing a palette for your [Magic Home integration](https://www.home-assistant.io/integrations/flux_led/) lighting effects.

<img width="1115" alt="Overview – Home Assistant" src="https://user-images.githubusercontent.com/1088717/212461442-e270da3d-b3e8-4b6f-b580-966faccaddb4.png">
<img width="1115" alt="Overview – Home Assistant" src="https://github.com/kizza/magic-home-party-card/assets/1088717/30ff4b45-4413-40fc-935a-5d9bc7b7b6a4">

## Motivation

I'm loving my [Magic Home integration](https://www.home-assistant.io/integrations/flux_led/) strips, and after a failed attempt and writing my own puthon _gradual transition_ effect I discovered the device can do it for me! Chooinsg (and experimenting) with the best colour combinations was awkward - going from colour wheels to yaml and back - so I made this card to make the expereince more enjoyable.
I love my [Magic Home integration](https://www.home-assistant.io/integrations/flux_led/) strips, they're inexpensive and effective. After a failed attempt and writing my own python _gradual transition_ effect I discovered the device could do it for me [with a custom effect](https://www.home-assistant.io/integrations/flux_led/#custom-effects---service-flux_ledset_custom_effect)! Choosing and experimenting with the colours was awkward though - going from colour wheels to yaml and back - so I made this card to make the experience more enjoyable.

Single clicking a colour chip will set all the configured lights to this colour - then double clicking any will add it to the sequence.
Single-clicking a colour chip from the palette will set all your configured lights to this colour - double-clicking any will add it to the sequence.

## Installation

<img align="left" src="https://github.com/kizza/magic-home-party-card/assets/1088717/134d836a-a2d5-4761-adcf-ea7d8feb1dc3" width="50" alt="Magic Home Logo" />
Configure your Magic Home lights as per normal in homeassistant. If you don't recognise this logo, this integration may not target your lights.

### HACS
Magic Home Party Card is available in [HACS][hacs] (Home Assistant Community Store).

Expand All @@ -36,4 +42,4 @@ Magic Home Party Card is available in [HACS][hacs] (Home Assistant Community Sto

## Usage

Once installed you should find it within your available cards. Add-and-remove selected colors by double clicking (single click turns lights to that colour to see it). Once setup, click anywhere on the card to run the [magic light effect](https://www.home-assistant.io/integrations/flux_led/#custom-effects---service-flux_ledset_custom_effect) with your selected colours on your selected lights.
Once installed you should find it within your available dashboard cards. Add-and-remove selected colors by double clicking (single click previews that colour with your lights). Once setup, click anywhere on the card to run the [magic light effect](https://www.home-assistant.io/integrations/flux_led/#custom-effects---service-flux_ledset_custom_effect) with your configuration.

0 comments on commit bc11331

Please sign in to comment.