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.

65 lines
3.4 KiB

  1. # Changelog
  2. All notable changes to this project will be documented in this file.
  3. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
  4. and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
  5. ## [Unreleased]
  6. ### Changed
  7. - The GitHub repository structure has been updated, in order to make it compatible with
  8. the new `external_components` feature of ESPHome v1.18.0. From now on, the code from this
  9. repository no longer has to be downloaded and installed manually. The `example.yaml` has
  10. been updated for using this new feature.
  11. - A fix has been implemented to prevent the lamp from being disconnected from Home Assistant
  12. a lot (resulting in the lamp becoming unavailable).
  13. Fixes [issue #19](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/19).
  14. ESPHome v1.18.0 or higher is required for making this fix work.
  15. - Transitions are now fully suppressed when in night light mode. In that mode, LED output
  16. levels are too low for producing good looking transitions.
  17. Fixes [issue #10](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/10).
  18. - The `example.yaml` now uses my own arduino-esp32 unicore build.
  19. - Formatted the codebase using the ESPHome clang rules.
  20. - The flashing guide got a big update, with detailed pictures for every step on the way.
  21. ### Added
  22. - New documentation section: Technical details (it's all about the internals)
  23. ### Removed
  24. - The known issue documentation page has been removed, now we have a fix for the disconnect issues
  25. in ESPHome v1.18.0.
  26. ## [1.0.0-RC1]
  27. ### Changed
  28. - The documentation has been restructured.
  29. ### Added
  30. - Support for disco mode-style light updates through the `light.disco_on` and `light.disco_off` actions.
  31. The `light.disco_on` action can be used to configure the lamp state without delay, without publishing
  32. the update and without saving the state. The `light.disco_off` action will restore the lamp to its
  33. last save state, so from before the `light.disco_on` updates.
  34. - Support for configuring light presets, making it possible to mimic the lamp's original firmware
  35. feature to switch light color using the color button.
  36. This fixes [issue #8](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/8).
  37. - New documentation section: Configuration guide (explaining all the YAML file configuration options).
  38. ## [1.0-beta]
  39. ### Changed
  40. - The component was renamed from "yeelight_bs2" to "xiaomi_bslamp2".
  41. The reasoning behind this can be found in [issue #7](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/7).
  42. ### Added
  43. - Component "text_sensor" that publishes changes in the light mode ("off", "night", "rgb", "white"),
  44. This fixes [issue #6](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/6).
  45. - Documentation improvements and a better example.yaml.
  46. ## [1.0-alpha]
  47. ### Added
  48. - All light modes for the lamp have been implemented:
  49. - RGB light (colored light, based on red/green/blue and brightness)
  50. - White light (based on color temperature and brightness)
  51. - Night light (either RGB- or White light, but highly dimmed; enabled by setting brightness to 1%)
  52. - Component "light" for controlling the LEDs.
  53. - Component "binary_sensor" that act as touch/release sensors for power button, color button and slider.
  54. - Component "sensor" that report the level at which the slider was touched.
  55. - Component "output" for controlling the front panel light and its level indicator.