Python library for Yeelight bedside lamp
Switch branches/tags
Clone or download

Python library for Yeelight Bedside lamp

This is an ongoing effort to create a python library for Yeelight's bedside lamp and Yeelight Candela. Candelas support only setting the light on and off, and adjusting the brightness.

Patches are very welcome, if you intent to contribute, please do note that quite a lot of the protocol is already figured out but lacking interfaces.

Currently supported features:

  • State
  • Color mode (white, color, flow)
  • Temperature
  • Brightness
  • Sleep, wakeup & scheduling (partially)


  • Flow mode
  • Other features?


pip install git+

In case you are getting "No such file or directory" error for bluepy-helper, you have to go into bluepy's directory and run make there. It is also a good idea to let the helper to have capabilities for accessing the bluetooth devices without being root, e.g., by doing the following:

setcap cap_net_admin,cap_net_raw+eip bluepy-helper

And then simply try if the scanning works. You can use pass '-dd' as option to the command to see the debug messages from bluepy in case it is not working.



$ yeelightbt --help


$ yeelightbt [command] --help

For debugging you can pass -d/--debug, adding it second time will also print out the debug from bluepy.

Finding supported devices

$ yeelightbt scan
Scanning for 5 seconds
Devices found:
  f8:24:41:xx:xx:xx (XMCTD_XXXX), rssi=-83

Reading status & states

To avoid passing --mac for every call, set the following environment variable:

export YEELIGHTBT_MAC=AA:BB:CC:11:22:33
$ yeelightbt

MAC: f8:24:41:xx:xx:xx
  Mode: LampMode.White
  Color: (0, 0, 0)
  Temperature: 5000
  Brightness: 50
$ yeelightbt temperature

Temperature: 5000
$ yeelightbt color 255 0 0
Setting color: 255 0 0

Homeassistant support

There is also a WIP Home Assistant component stored inside custom_components. Just copy the file over to ~/.homeassistant/custom_components/light/ and add the following into your config:

  - platform: yeelight_bt
        mac: 'f8:24:41:xx:xx:xx'