Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kizza committed Jan 16, 2023
1 parent 1543bb4 commit 157bd54
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# magic-home-party-card
A Home Assistant custom card for managing Magic Home lighting effects
# 🥳 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)

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

<img width="1115" alt="Overview – Home Assistant" src="https://user-images.githubusercontent.com/1088717/212461442-e270da3d-b3e8-4b6f-b580-966faccaddb4.png">

## 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.

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

## Installation

### Manual
1. Download `magic-home-party-card.js` file from the [latest-release](https://github.com/kizza/magic-home-party-card/releases/latest).
2. Put magic-home-party.js file into your `config/www` folder.
3. Add a reference to this in your resources:
- Add `/local/magic-home-party-card.js` via the "manage resources" dashboard UI (as a javascript "module")
- Or add the following to your yaml...
```
resources:
- url: /local/magic-home-party-card.js
type: module
```

## 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.

0 comments on commit 157bd54

Please sign in to comment.