Skip to content

Latest commit

 

History

History
239 lines (193 loc) · 12 KB

CHANGELOG.md

File metadata and controls

239 lines (193 loc) · 12 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[2024.10.0]

Note: This release requires ESPHome 2024.10.0 or newer.

Fixed

  • Include platform: esphome in the ota: section of the example.yaml file.
  • Include ignore_efuse_custom_mac: true in the esp32: section of the core configuration package, to make the configuration compatible with ESPHome version 2024.10.0.
    Thanks to Andy (ezcGman on GitHub) for the PR!
  • Checked and formatted the Python code in the project using ruff.

Changed

  • Include friendly_name in the esphome: section of the core configuration package, so that the set friendly name (as used in the example.yaml) shows up in the ESPHome Dashboard and in Home Assistant.
    Thanks to Florian (fmauNeko on GitHub) for the PR!
  • The ${friendly_name} was removed from the default values for the light_name and light_mode_text_sensor_name substitutions, because the esphome.friendly_name is automatically used as a prefix for these. If you have customized these substitutions, and are using the ${friendly_name} variable in them, you might want to remove this variable to prevent duplication of the friendly name in the representation of the device in Home Assistant.
  • Added support for suppressing warnings about strapping pins by using the ESPHome pin configuration option ignore_strapping_warning: true. Previously, a temporary workaround was used because this configuration option was not available at the time. The new option eliminates the need for the earlier hack, providing a cleaner and more straightforward solution.

[2023.4.0]

Note: This release requires at least ESPHome 2023.4.0. It will not work with ESPHome 2024.10.0 or newer.

Fixed

  • Compile issues with recent ESPHome versions fixed:
    • An error about toolchain-riscv32-esp not being found (the PlatformIO tool manager tries to install this one, even though the lamp is an ESP32 device and not riscv).
    • On systems for which the above toolchain could be found, compilation would fail with an error about esp_mac.h not being found.

Changed

  • ESPHome's compile-time warnings about "GPIO is a Strapping PIN and should be avoided" are now being suppressed. These warning are often interpreted by users of this firmware as problems. However, the pinouts are dictated by the hardware and there are no strapping issues because of how they are used.
  • Updated the documentation for the deprecated API password support (which must now be an API encryption key instead).

[2022.12.0]

Note: This release requires ESPHome 2022.12.0 and Home Assistant 2021.8.0 or newer.

Fixed

  • Due to changes in the ESP-IDF framework, and ESPHome 2022.12.0 using the newer version of the framework, upgrading the lamp from ESPHome version 2022.11.0 to 2022.12.0 could result in a failing device. It would not connect to WiFi anymore and serial logging showed a reboot loop, crashing at the WiFi setup. This release of the lamp firmware forces the use of the last known working version of the ESP-IDF framework. This is not a final solution, because I don't want to be stuck to old versions for dependencies, but for now this change at least prevents issues for users that flash their lamps.

If you already flashed your lamp and it ended up bricked, then no worries! Things can be fixed. Check out this information from the related GitHub issue report: Fix recipe from issue #104

[2021.10.0]

Note: This release requires ESPHome 2021.10.0 and Home Assistant 2021.8.0 or newer.

Changed

  • Due to changes in ESPHome, the configuration for the lamp has changed. This means that existing configuration files have to be updated accordingly. To make configuration as easy as possible, the example.yaml configuration now makes use of configuration packages that are stored on GitHub. This reduces the amount of configuration that is required in your own device configuration file, making future configuration changes easier.
  • ESPHome 2021.10.0 has brought us support for using ESP-IDF instead of the Arduino framework. ESP-IDF is the "Espressif IoT Development Framework", which is the native development framework for ESP32 SoCs. I switched to this framework. This made it possible to get the required ESP32 unicore support and to ignore the MAC CRC using a vanilla build. No more need for hacked up platform packages to get things going! <3
  • The code has been made compatible with ESPHome 2021.10.0.

[2021.9.1]

Note: This release requires ESPHome 2021.8.0 and Home Assistant 2021.8.0 or newer.

Changed

  • Fixed a memory leak, causing the lamp to disconnect occasionally when doing a lot of color transformations (e.g. when running the Random light effect).

[2021.9.0]

Note: This release requires ESPHome 2021.8.0 and Home Assistant 2021.8.0 or newer.

Changed

  • Fixed a compilation issue with ESPHome 2021.9.0.
  • Added refresh: 60s to the external_components definition in example.yaml, to make use that the code is updated when using a non-release ref (e.g. main instead of 2021.9.0).

[2021.8.1]

Note: This release requires ESPHome 2021.8.0 and Home Assistant 2021.8.0 or newer.

Changed

  • Fixed transitioning from the off to on state. Thanks to @marcel1988 for informing me about his non-functional wake-up light script. Before this fix, the light would stay off during the full transformation, only to turn on at the very end.
  • The on_brightness trigger is now also called at the start of a transition. This fixes a problem with the brightness slider illumination not following along when you slide your finger over it.
  • Suppressing a transition time for transitioning to a night light color is now only instant when starting from a night light setting. Before this change, moving from for example 80% brightness to 1% brightness (i.e. night light), would be instant. Now an actual transformation is done.

[2021.8.0]

Note: This release requires ESPHome 2021.8.0 and Home Assistant 2021.8.0 or newer.

Added

  • Preset identifiers (group and preset) for the preset.activate action are now validated at compile time. This prevents us from building a firmware with incorrect preset identifiers. Before this change, using an invalid preset name would only result in a warning message in the device log, which is only moderately useful.

Changed

  • The code has been made compatible with the new color mode support in Home Assistant and ESPHome.
  • The example.yaml has been updated to not make use of underscores in hostnames. Using an underscore in the name yields a warning during the firmware compilation, because hostnames should only contain letters, numbers and dashes "-".
  • My project will follow the Home Assistant / ESPHome versioning scheme from now on (..), because the ESPHome project adopted this versioning scheme too.

[1.1.0]

Note: This release requires ESPHome v1.20.0 or newer.

Added

  • It is now possible to address the LEDs in the front panel of the device individually. There are 12 LEDs in total: the power button, the color button and 10 LEDs that are used by the original firmware to represent the lamp's current brightness setting. The output component for the lamp was updated to provide access to the individual LEDs. Check out the documentation guide for details on how to control these. Thanks to @Stewie3112 for the feature request that triggered this development!
  • Implemented support for visual feedback during the OTA update process in the example.yaml file: the light becomes blue during flahsing, the brightness slider represents the progress, on failure the light flashes red and on success the light flashes green.

Changed

  • Made it possible to use lambdas with the preset.activate automation. This makes it possible to link the action to an api service, which exposes the preset functionality to Home Assistant. The example.yaml has been updated with an example for this.
  • Fixed a rounding error in the slider sensor component. When using custom "range from" / "range to" settings, the maximum value could exceed the "range to" value due to rounding errors. Thanks to Jos for the heads up!
  • Made the codebase compatible with ESPHome v1.19.0 (PR #1657: Introduce new async-def coroutine syntax) Thanks to @Kaibob2 for giving me a heads up that my code was not compiling anymore!

[1.0.0]

Note: This release requires ESPHome v1.18.0 or newer.

Changed

  • The GitHub repository structure has been updated, in order to make it compatible with the new external_components feature of ESPHome v1.18.0. From now on, the code from this repository no longer has to be downloaded and installed manually. The example.yaml has been updated for using this new feature. Fixes issue #16.
  • A fix has been implemented to prevent the lamp from being disconnected from Home Assistant a lot (resulting in the lamp becoming unavailable). ESPHome v1.18.0 or newer is required for making this fix work. Fixes issue #19.
  • Transitions are now fully suppressed when in night light mode. In that mode, LED output levels are too low for producing good looking transitions. Fixes issue #10.
  • The example.yaml now uses my own arduino-esp32 unicore build.
  • Formatted the codebase using the ESPHome clang rules.
  • The flashing guide got a big update, with detailed pictures for every step on the way.

Added

  • New documentation section: Technical details (it's all about the internals)

Removed

  • The known issue documentation page has been removed, now we have a fix for the disconnect issues in ESPHome v1.18.0.

[1.0.0-RC1]

Changed

  • The documentation has been restructured.

Added

  • Support for disco mode-style light updates through the light.disco_on and light.disco_off actions. The light.disco_on action can be used to configure the lamp state without delay, without publishing the update and without saving the state. The light.disco_off action will restore the lamp to its last save state, so from before the light.disco_on updates.
  • Support for configuring light presets, making it possible to mimic the lamp's original firmware feature to switch light color using the color button. This fixes issue #8.
  • New documentation section: Configuration guide (explaining all the YAML file configuration options).

[1.0-beta]

Changed

  • The component was renamed from "yeelight_bs2" to "xiaomi_bslamp2". The reasoning behind this can be found in issue #7.

Added

  • Component "text_sensor" that publishes changes in the light mode ("off", "night", "rgb", "white"), This fixes issue #6.
  • Documentation improvements and a better example.yaml.

[1.0-alpha]

Added

  • All light modes for the lamp have been implemented:
    • RGB light (colored light, based on red/green/blue and brightness)
    • White light (based on color temperature and brightness)
    • Night light (either RGB- or White light, but highly dimmed; enabled by setting brightness to 1%)
  • Component "light" for controlling the LEDs.
  • Component "binary_sensor" that act as touch/release sensors for power button, color button and slider.
  • Component "sensor" that report the level at which the slider was touched.
  • Component "output" for controlling the front panel light and its level indicator.