mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Update flux_led for addition of config flow (#19566)
Co-authored-by: J. Nick Koston <nick@koston.org> Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
icemanch
GitHub
parent
f4e107ef2d
commit
285bc7f8cb
@ -10,7 +10,9 @@ ha_platforms:
|
||||
- light
|
||||
---
|
||||
|
||||
The `flux_led` support is integrated into Home Assistant as a light platform. Several brands of both bulbs and controllers use the same protocol and they have the HF-LPB100 chipset in common. The chances are high that your bulb or controller (eg. WiFi LED CONTROLLER) will work if you can control the device with the MagicHome app.
|
||||
The Flux LED integration supports several brands of both bulbs and controllers that use the same protocol and have the HF-LPB100 chipset in common. Chances are high that your bulb or controller (eg. WiFi LED CONTROLLER) will work with this integration if you can control the device with the MagicHome app.
|
||||
|
||||
This integration will provide local control over your LED lights/strips and can be configured to auto-scan your network for controllers or for you to manually configure individual lights by their IP address.
|
||||
|
||||
Example of bulbs:
|
||||
|
||||
@ -23,137 +25,19 @@ Examples of controllers:
|
||||
- [Ledenet WiFi RGBW Controller](https://amzn.to/2WZKXNa)
|
||||
- [SUPERNIGHT WiFi Wireless LED Smart Controller](https://amzn.to/2WURx7w)
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable those lights, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
light:
|
||||
- platform: flux_led
|
||||
```
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
{% configuration %}
|
||||
automatic_add:
|
||||
description: To enable the automatic addition of lights on startup.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
devices:
|
||||
description: A list of devices with their IP address.
|
||||
required: false
|
||||
type: list
|
||||
keys:
|
||||
name:
|
||||
description: A friendly name for the device.
|
||||
required: false
|
||||
type: string
|
||||
mode:
|
||||
description: "The chosen brightness mode, options are: `rgbw`, `rgb` and `w`."
|
||||
required: false
|
||||
default: rgbw
|
||||
type: string
|
||||
protocol:
|
||||
description: Set this to `ledenet` if you are using a ledenet bulb.
|
||||
required: false
|
||||
type: string
|
||||
custom_effect:
|
||||
description: A definition of the custom effect.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
colors:
|
||||
description: A list of 1 to 16 colors, used in the effect loop (see example below). Defined as three comma-separated integers between 0 and 255 that represent the color in RGB. There is no way to set brightness, but you can define lower RGB values to simulate lower brightness. E.g., if you want 50% red, define it as `[127,0,0]` instead of `[255,0,0]`.
|
||||
required: true
|
||||
type: list
|
||||
speed_pct:
|
||||
description: A speed in percents (100 being the fastest), at which controller will transition between the colors.
|
||||
required: false
|
||||
type: integer
|
||||
default: 50
|
||||
transition:
|
||||
description: "A type of transition, which will be used to transition between the colors. Supported values are: `gradual`, `jump` and `strobe`."
|
||||
required: false
|
||||
type: string
|
||||
default: gradual
|
||||
{% endconfiguration %}
|
||||
After the devices have been added they can be configured with different effects listed below. These settings can be accessed by navigating to the integration settings in Configuration -> Integrations and selecting the "Flux Led/Magic Home" configuration for the bulb or controller.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Depending on your controller or bulb type, there are two ways to configure brightness.
|
||||
The integration defaults to rgbw. If your device has a separate white channel, you do not need to specify anything else; changing the white value will adjust the brightness of white channel keeping rgb color constant. However, if your device does not have a separate white channel, you will need to set the mode to rgb. In this mode, the device will keep the same color, and adjust the rgb values to dim or brighten the color.
|
||||
**Custom Effect**\
|
||||
A list of RGB colors can be entered to create an effect. The effect speed can be adjusted using the slider underneath.
|
||||
|
||||
</div>
|
||||
**Custom Effect Type**\
|
||||
This determines the transition between each color.
|
||||
|
||||
### Example configuration
|
||||
|
||||
Will automatically search and add all lights on start up:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
light:
|
||||
- platform: flux_led
|
||||
automatic_add: true
|
||||
```
|
||||
|
||||
Will add two lights with given name and create an automation rule to randomly set color each 45 seconds:
|
||||
|
||||
```yaml
|
||||
light:
|
||||
# Example configuration.yaml entry
|
||||
- platform: flux_led
|
||||
devices:
|
||||
192.168.0.106:
|
||||
name: flux_lamppost
|
||||
192.168.0.109:
|
||||
name: flux_living_room_lamp
|
||||
|
||||
automation:
|
||||
alias: random_flux_living_room_lamp
|
||||
trigger:
|
||||
platform: time_pattern
|
||||
seconds: '/45'
|
||||
action:
|
||||
service: light.turn_on
|
||||
data:
|
||||
entity_id: light.flux_living_room_lamp
|
||||
effect: random
|
||||
```
|
||||
|
||||
Will add a light without the white mode:
|
||||
|
||||
```yaml
|
||||
192.168.1.10:
|
||||
name: NAME
|
||||
mode: "rgb"
|
||||
```
|
||||
|
||||
Will add a light with rgb+white mode (default). White and RGB channels can be adjusted independently using a slider and color picker respectively.
|
||||
|
||||
```yaml
|
||||
192.168.1.10:
|
||||
name: NAME
|
||||
mode: "rgbw"
|
||||
```
|
||||
|
||||
Will add a light with white mode only. This is useful when only W channel is connected to an RGBW controller and allows the white level to be controlled via brightness value.
|
||||
|
||||
```yaml
|
||||
192.168.1.10:
|
||||
name: NAME
|
||||
mode: "w"
|
||||
```
|
||||
|
||||
Some devices such as the Ledenet RGBW controller use a slightly different protocol for communicating the brightness to each color channel. If your device is only turning on or off but not changing color or brightness try adding the LEDENET protocol.
|
||||
|
||||
```yaml
|
||||
light:
|
||||
- platform: flux_led
|
||||
devices:
|
||||
192.168.1.10:
|
||||
name: NAME
|
||||
protocol: 'ledenet'
|
||||
```
|
||||
|
||||
### Effects
|
||||
|
||||
@ -170,23 +54,27 @@ The Flux LED light offers a number of effects which are not included in other li
|
||||
| `gb_cross_fade` | Fades between green and blue. |
|
||||
| `red_strobe`, `green_strobe`, `blue_strobe`, `yellow_strobe`, `cyan_strobe`, `purple_strobe`, `white_strobe` | Strobes the color indicated by the effect name. |
|
||||
| `random` | Chooses a random color by selecting random values for R, G, and B. |
|
||||
| `custom` | Custom effect (if defined, see below). |
|
||||
|
||||
Users can define their own custom effect. It consists of three parameters: a list of 1 to 16 colors, speed and type of transition. The controller will transition between the colors in a loop, with specified transition and speed. Here is an example of a custom effect that will quickly flash red, yellow, green, cyan, blue, magenta in a loop:
|
||||
|
||||
### Custom Effects - Service `flux_led.set_custom_effect`
|
||||
|
||||
The integration offers a custom service to enable you to set the lights to a custom light effect.
|
||||
|
||||
| Service data attribute | Description |
|
||||
| ---------------------- | ----------- |
|
||||
| `entity_id` | The entity_id of the LED light to set the effect on. |
|
||||
| `colors` | List of RGB colors to transition between in your effect. (Max 16, Required) |
|
||||
| `speed_pct` | The speed of the effect in % (0-100. Default 50) |
|
||||
| `transition` | The transition effect you would like. Valid options are `gradual`, `jump`, or `strobe`. (Default `gradual`) |
|
||||
|
||||
```yaml
|
||||
light:
|
||||
- platform: flux_led
|
||||
devices:
|
||||
192.168.1.10:
|
||||
custom_effect:
|
||||
speed_pct: 100
|
||||
transition: 'strobe'
|
||||
#Example Service Call
|
||||
entity_id: light.led_strip
|
||||
colors:
|
||||
- [255,0,0]
|
||||
- [255,255,0]
|
||||
- [0,255,0]
|
||||
- [0,255,255]
|
||||
- [0,0,255]
|
||||
- [255,0,255]
|
||||
speed_pct: 80
|
||||
transition: "jump"
|
||||
```
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user