You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Maurice Makaay ae4181f487 Rename doc_chinese to doc.chinese 2 years ago
.github Update FUNDING.yml 3 years ago
components/xiaomi_bslamp2 Add missing .h include 2 years ago
doc Add warning about GPIO0 pad soldering 2 years ago
doc.chinese Rename doc_chinese to doc.chinese 2 years ago
packages Lower default log level for example.yaml 2 years ago
.gitignore Moved to a proper ESPHome component structure. 3 years ago
CHANGELOG.md Updated changelog for 2021.10.0 release. 3 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 3 years ago
LICENSE.md Create LICENSE.md 3 years ago
README.chinese.md Add README for Chinese translation 2 years ago
README.md Update README.md 3 years ago
example.yaml Have some items in substitutions: to prevent ESPHome error 3 years ago

README.md

ESPHome support for Xiaomi Mijia Bedside Lamp 2

[ Changelog | License | Code of conduct ]

The Bedside Lamp 2 is a smart RGBWW LED lamp, produced by Yeelight for the Xiaomi Mijia brand. It can be controlled via the WiFi network and from a touch panel on the front of the device. The touch panel contains a power button, a button that changes the color of the light and a slider that can be used to change the brightness of the light.

This project provides custom components for ESPHome, which make it possible to fully control every aspect of the lamp and to integrate the lamp in your Home Assistant setup.

Features

  • The lamp integrates easily with Home Assistant using the ESPHome integration.

  • The lamp no longer phones home to the Mijia Cloud. Using this firmware, you can rest assured that the network traffic is limited to your own network. This matches the ideas behind Home Assistant, of providing a local home automation platform, that puts privacy first.

  • No more need for the LAN control option to integrate the lamp with Home Assistant. Especially important, because Xiaomi decided in all their wisdom to remove LAN control from the device, breaking existing integrations.

  • The night light supports multiple colors. The original firmware only supports a single warm white night light color.

  • Smooth light color transitions, unlike the current version of the Yeelight integration. The Homekit integration does provide good transitions, but on my system, the color temperature white light mode is missing in the Home Assistant GUI.

  • Since the components of the lamp are exposed as ESPHome components, you don't have to stick with the lamp's original behavior. You can hook up the lamp in your home automation as you see fit. Use the slider to control the volume of your audio set? Long press the power button to put your house in night mode? Use the illumination behind the slider bar to represent the progress of your sour dough bread bulk fermentation? Go ahead, make it so! :-)

  • All LEDs that are used for illumination of the front panel (power button, color button and 10 LEDs for the brightness slider) can be controlled individually. This means that you have 12 LEDs in total to use as you see fit, instead of sticking with the behavior of the original firmware.

  • Possibilities to extend the device's functionality through hardware mods. There are GPIO pins that are not in use. If "tinkerer" is your middle name, you can use those pins to come up with your own hardware hacks to extend the device's functionality.

Quick start guide

For those who have experience with flashing ESPHome onto devices:

  • Make sure you are using ESPHome 2021.10.0 or newer.
  • Copy example.yaml to <CONFIG_DIR>/<NODE_NAME>.yaml.
  • Modify the configuration to your needs (see the configuration guide).
  • Compile the firmware.bin file and download it to the device to which you have connected your serial to USB adapter.
  • Open up the lamp and connect its TX, RX, GND and GPIO0 debug pads to the serial adapter. Check this image for the debug pad locations.
  • Power up the lamp with GPIO0 connected to GND to enable flashing mode.
  • Flash firmware.bin onto the device, for example using esphome-flasher..

Upgrading

I always try to make it possible to upgrade the lamp firmware without having to do anything special. Sometimes, this is not possible. For those cases, the upgrade instruction can be found here:

Table of contents