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.

39 lines
1.8 KiB

  1. # ESPHome components for Xiaomi Mijia Bedside Lamp 2
  2. The Bedside Lamp 2 is a smart RGBWW LED lamp, produced by Yeelight. It can
  3. be controlled via the WiFi network and using a touch panel on the front of
  4. the device. The touch panel contains a power button, a button that changes
  5. the color of the light and a slider that can be used to change the
  6. brightness of the light.
  7. This project provides custom components for ESPHome, which make it
  8. possible to fully control every aspect of the lamp and to integrate the
  9. lamp in your Home Assistant setup.
  10. ## Quick start guide
  11. For those who have experience with flashing ESPHome onto devices:
  12. * Clone the [GitHub repo](https://github.com/mmakaay/esphome-xiaomi_bslamp2)
  13. into your ESPHome `config/custom_components` directory.
  14. * Copy `[doc/example.yaml](doc/example.yaml)` to `config/your_device_name.yaml`.
  15. * Modify the configuration to your needs (see the [configuration guide](doc/configuration.md)]).
  16. * Compile the `firmware.bin` file and download it to the device to which you
  17. have connected your serial to USB adapter (FTDI).
  18. * Open up the lamp and connect its `TX`, `RX`, `GND` and `GPIO0` debug pads
  19. to the serial adapter (see the [installation
  20. guide](doc/installation.md) for the debug pad locations).
  21. * Power up the lamp with `GPIO0` connected to GND to enable flashing mode.
  22. * Flash `firmware.bin` onto the device.
  23. If you experience regular disconnects between Home Assistant and the lamp,
  24. then take a look at the [known issues document](doc/known_issues.md).
  25. ## Table of contents
  26. * [Why custom firmware?](doc/why_custom_firmware.md)
  27. * [Installation guide](doc/installation.md)
  28. * [Configuration_guide](doc/configuration.md)
  29. * [Flashing guide](doc/flashing.md)
  30. * [Known issues](doc/known_issues.md)
  31. * [Sponsoring](doc/sponsoring.md)