This page is part of archived documentation for openHAB 3.1. Go to the current stable version

# Yeelight Binding

This binding integrates the Yeelight Lighting Product (opens new window).

# Supported Things

# Preconditions

To control Yeelight devices with this binding, you need to connect the device to your local network at first with the Yeelight app. This app is available in the iOS AppStore and on Google Play.

Then you need to activate LAN control mode by enable Developer Mode in device settings, after which it will become discoverable by openHAB.

# Discovery

Yeelight smart LED devices announce themselves on the network through UPnP, so that they can be discovered.

# Thing Configuration

All Yeelight things require the deviceId from the device as a configuration parameter. This table shows all available parameters:

Parameter Values Mandatory
deviceId ID of the Yeelight device Yes
duration Duration for changing between different states No

# Channels

All devices support some of the following channels:

Channel Item Type Description
brightness Dimmer This channel supports adjusting the brightness value, it is available on dolphin and ceiling.
color Color This channel supports color control, it is available on wonder and stripe.
colorTemperature Dimmer This channel supports adjusting the color temperature, it is available on wonder and stripe and ceiling.
command String This channel sends a command directly to the device, it is available on all Yeelight Things.
backgroundColor Color or Dimmer This channel supports color control for the ambient light, it is available on ceiling4.
nightlight Switch This supports switching to nightlight mode, it is available on ceiling1 or ceiling4.

# Full Example

Things:

Thing yeelight:stripe:1 [ deviceId="0x000000000321a1bc", duration=1000 ]

Items:

Color YeelightLEDColor { channel="yeelight:stripe:1:color" }
Switch YeelightLEDSwitch { channel="yeelight:stripe:1:color" }
String YeelightLEDCommand { channel="yeelight:stripe:1:command" }

Rules:

rule "Yeelight Custom Command"
when
        Time is noon
then
        YeelightLEDCommand.sendCommand("set_power;\"on\",\"smooth\",2000")
end

Note that set_power is the command, then a separator ; must be used. \"on\",\"smooth\",2000 are the parameters.

Full list of commands can be found here (opens new window).