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.

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