Browse Source

Bump version to v1.0.0.

pull/31/head v1.0.0
Maurice Makaay 3 years ago
parent
commit
4dea022f3f
2 changed files with 11 additions and 7 deletions
  1. +9
    -5
      CHANGELOG.md
  2. +2
    -2
      doc/installation.md

+ 9
- 5
CHANGELOG.md View File

@ -4,16 +4,20 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [1.0.0]
**Note**: This release requires ESPHome v1.18.0 or newer.
### Changed ### Changed
- The GitHub repository structure has been updated, in order to make it compatible with - 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 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 repository no longer has to be downloaded and installed manually. The `example.yaml` has
been updated for using this new feature. been updated for using this new feature.
Fixes [issue #16](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/16).
- A fix has been implemented to prevent the lamp from being disconnected from Home Assistant - A fix has been implemented to prevent the lamp from being disconnected from Home Assistant
a lot (resulting in the lamp becoming unavailable).
a lot (resulting in the lamp becoming unavailable). ESPHome v1.18.0 or newer is required
for making this fix work.
Fixes [issue #19](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/19). Fixes [issue #19](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/19).
ESPHome v1.18.0 or higher is required for making this fix work.
- Transitions are now fully suppressed when in night light mode. In that mode, LED output - Transitions are now fully suppressed when in night light mode. In that mode, LED output
levels are too low for producing good looking transitions. levels are too low for producing good looking transitions.
Fixes [issue #10](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/10). Fixes [issue #10](https://github.com/mmakaay/esphome-xiaomi_bslamp2/issues/10).
@ -25,8 +29,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- New documentation section: Technical details (it's all about the internals) - New documentation section: Technical details (it's all about the internals)
### Removed ### Removed
- The known issue documentation page has been removed, now we have a fix for the disconnect issues
in ESPHome v1.18.0.
- 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] ## [1.0.0-RC1]
### Changed ### Changed


+ 2
- 2
doc/installation.md View File

@ -8,8 +8,8 @@ within Home Assistant as an add-on). For information on this, please refer to th
the [ESPHome website](https://esphome.io). the [ESPHome website](https://esphome.io).
The component code is distributed directly from GitHub. You will not have to download and install The component code is distributed directly from GitHub. You will not have to download and install
the code manually. This leverages the external components feature that was introduced in ESPHome
v1.18.0. Therefore, you must use ESPHome v1.18.0 or later.
the code manually. This leverages the [external components](https://esphome.io/components/external_components.html)
feature that was introduced in ESPHome v1.18.0. Therefore, you must use ESPHome v1.18.0 or newer.
Before you can compile the firmware, you will have to create the YAML configuration file for your Before you can compile the firmware, you will have to create the YAML configuration file for your
device. You can take the [`example.yaml`](../example.yaml) from this repository as a starting point, and device. You can take the [`example.yaml`](../example.yaml) from this repository as a starting point, and


Loading…
Cancel
Save