From 4b37915e260f43fa4d9a82f39d04a110ddf902b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Victor=20Hagelb=C3=A4ck?= Date: Tue, 26 Jan 2021 20:28:48 +0100 Subject: [PATCH] Make changelog more complete and rewrite to clearer format with links --- CHANGELOG.md | 359 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 316 insertions(+), 43 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6ebf66b..0c49bb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,81 +1,354 @@ -# Hass.io Plejd add-on +# Changelog hassio-plejd Home Assistant Plejd addon -_v 0.4.5_: +## 0.5.0 -- FIX: Resolved a Docker build error +**New features:** -_v 0.4.4_: +- Improved transitions due to new per-device queue of commands +- Completely rewritten and improved logging for js to improve code structure and user experience -- FIX: Disabled AppArmor Policy since there's been a lot of issues with that. +**Implemented enhancements:** -_v 0.4.3_: +- Adjust code to airbnb style guid, including eslint rules and prettier config. +- Updated dependencies -- FIX: Updated add-on to work with the API changes made by Plejd. +**Fixed bugs:** -_v 0.4.0_: +- Fix wrong initial brightness when transitioning turned-off lights +- Fix includeRoomsAsLights setting -- NEW: Implemented support for Plejd scenes, each scene appears as a switch in Home Assistant. -- NEW: _WPH-01_ is supported and generates two switches (left and right button). -- NEW: Write queues, finally able to incorporate Plejd devices in HA automations/scenes etc. +**Closed issues:** -_v 0.3.4_: +- Cannot read property 'length' of undefined - when turning of the light [\#134](https://github.com/icanos/hassio-plejd/issues/134) +- Idea: Add device id and shouldRetry to writeQueue [\#128](https://github.com/icanos/hassio-plejd/issues/128) +- light.turn_off turns the lights on [\#124](https://github.com/icanos/hassio-plejd/issues/124) +- Reverse transition: revisit [\#68](https://github.com/icanos/hassio-plejd/issues/68) -- NEW: `connectionTimeout` configuration parameter to enable tweaking of wait time on connection, usable for RPi 3B+. -- FIX: Reworked some logging to get better understanding of what happens. +**Merged pull requests:** -_v 0.3.0_: +- Feature/code style [\#150](https://github.com/icanos/hassio-plejd/pull/150) ([SweVictor](https://github.com/SweVictor)) +- Improved logging [\#149](https://github.com/icanos/hassio-plejd/pull/149) ([SweVictor](https://github.com/SweVictor)) +- Feature/per device write queue [\#144](https://github.com/icanos/hassio-plejd/pull/144) ([SweVictor](https://github.com/SweVictor)) +- Fix wrong initial brightness when transitioning turned-off lights [\#142](https://github.com/icanos/hassio-plejd/pull/142) ([SweVictor](https://github.com/SweVictor)) +- Fix includeRoomsAsLights and improve logging [\#141](https://github.com/icanos/hassio-plejd/pull/141) ([SweVictor](https://github.com/SweVictor)) +- Update README.md [\#140](https://github.com/icanos/hassio-plejd/pull/140) ([buffedelic](https://github.com/buffedelic)) +- multiple fixes for improved lifecycle and errors [\#137](https://github.com/icanos/hassio-plejd/pull/137) ([JohnPhoto](https://github.com/JohnPhoto)) +- Bump axios from 0.19.0 to 0.21.1 in /plejd [\#133](https://github.com/icanos/hassio-plejd/pull/133) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Improve transitioning of brightness [\#127](https://github.com/icanos/hassio-plejd/pull/127) ([SweVictor](https://github.com/SweVictor)) +- Bump ini from 1.3.5 to 1.3.8 in /plejd [\#116](https://github.com/icanos/hassio-plejd/pull/116) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Remove dead code [\#113](https://github.com/icanos/hassio-plejd/pull/113) ([thomasloven](https://github.com/thomasloven)) +- Bump bl from 1.2.2 to 1.2.3 in /plejd [\#112](https://github.com/icanos/hassio-plejd/pull/112) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump lodash from 4.17.15 to 4.17.19 in /plejd [\#93](https://github.com/icanos/hassio-plejd/pull/93) ([dependabot[bot]](https://github.com/apps/dependabot)) -- NEW: New BLE manager, DBus instead of noble -- FIX: Adding entities as devices now as well -- FIX: Bug fixes +## 0.4.6 (2020-11-24) -_v 0.2.8_: +**Closed issues:** + +- Unable to install [\#111](https://github.com/icanos/hassio-plejd/issues/111) +- Reverse transition: revisit [\#68](https://github.com/icanos/hassio-plejd/issues/68) + +**Merged pull requests:** + +- transitions work [\#89](https://github.com/icanos/hassio-plejd/pull/89) ([icanos](https://github.com/icanos)) + +## 0.4.5 (2020-05-06) + +**Closed issues:** + +- Installation issue [\#83](https://github.com/icanos/hassio-plejd/issues/83) +- Cant install v 0.4.4 [\#77](https://github.com/icanos/hassio-plejd/issues/77) + +**Merged pull requests:** + +- fixed build error [\#84](https://github.com/icanos/hassio-plejd/pull/84) ([icanos](https://github.com/icanos)) +- fixed build error and upped version [\#81](https://github.com/icanos/hassio-plejd/pull/81) ([icanos](https://github.com/icanos)) + +## 0.4.4 (2020-03-19) + +**Implemented enhancements:** + +- Disabled AppArmor Policy since there's been a lot of issues with that. + +**Closed issues:** + +- Apparmor in latest version [\#74](https://github.com/icanos/hassio-plejd/issues/74) +- No devices added [\#70](https://github.com/icanos/hassio-plejd/issues/70) + +**Merged pull requests:** + +- disabled apparmor since lots of issues with that [\#76](https://github.com/icanos/hassio-plejd/pull/76) ([icanos](https://github.com/icanos)) + +## 0.4.3 (2020-03-13) + +**Fixed bugs:** + +- Updated add-on to work with the API changes made by Plejd. + +**Closed issues:** + +- Error: unable to retrieve the crypto key. error: Error: Request failed with status code 400 [\#72](https://github.com/icanos/hassio-plejd/issues/72) +- plejd-ble: warning: wasn't able to connect to Plejd, will retry. [\#69](https://github.com/icanos/hassio-plejd/issues/69) + +**Merged pull requests:** + +- updated to comply with new api version [\#73](https://github.com/icanos/hassio-plejd/pull/73) ([icanos](https://github.com/icanos)) + +## 0.4.2 (2020-03-03) + +**Closed issues:** + +- Error: Cannot find module './scene.manager' in 0.4.0 [\#65](https://github.com/icanos/hassio-plejd/issues/65) + +**Merged pull requests:** + +- reworked write queue and added configurable wait time [\#67](https://github.com/icanos/hassio-plejd/pull/67) ([icanos](https://github.com/icanos)) + +## 0.4.1 (2020-02-29) + +**Merged pull requests:** + +- added missing file to dockerfile [\#66](https://github.com/icanos/hassio-plejd/pull/66) ([icanos](https://github.com/icanos)) + +## 0.4.0 (2020-02-29) + +**New features:** + +- Implemented support for Plejd scenes, each scene appears as a switch in Home Assistant. +- _WPH-01_ is supported and generates two switches (left and right button). +- Write queues, finally able to incorporate Plejd devices in HA automations/scenes etc. + +**Closed issues:** + +- voluptuous.error.MultipleInvalid: extra keys not allowed @ data\['schema'\] [\#61](https://github.com/icanos/hassio-plejd/issues/61) +- Can't install R pi3+ [\#62](https://github.com/icanos/hassio-plejd/issues/62) +- Plejd plugin installation fail [\#60](https://github.com/icanos/hassio-plejd/issues/60) +- dBus Error? [\#59](https://github.com/icanos/hassio-plejd/issues/59) +- Connection problem with 3.4 [\#56](https://github.com/icanos/hassio-plejd/issues/56) +- Scene triggering via MQTT [\#43](https://github.com/icanos/hassio-plejd/issues/43) +- Reverse transition: [\#26](https://github.com/icanos/hassio-plejd/issues/26) +- light transition: not supported? [\#15](https://github.com/icanos/hassio-plejd/issues/15) + +**Merged pull requests:** + +- scene support, wph-01 and write queues [\#64](https://github.com/icanos/hassio-plejd/pull/64) ([icanos](https://github.com/icanos)) + +## 0.3.4 (2020-01-27) + +**New features:** + +- `connectionTimeout` configuration parameter to enable tweaking of wait time on connection, usable for RPi 3B+. + +**Implemented enhancements:** + +- Reworked some logging to get better understanding of what happens. + +**Merged pull requests:** + +- new config parameter [\#55](https://github.com/icanos/hassio-plejd/pull/55) ([icanos](https://github.com/icanos)) + +## 0.3.3 (2020-01-24) + +**Merged pull requests:** + +- resolved missing device bug and new version [\#52](https://github.com/icanos/hassio-plejd/pull/52) ([icanos](https://github.com/icanos)) + +**Closed issues:** + +- v0.3.1, DBusError: Software caused connection abort [\#50](https://github.com/icanos/hassio-plejd/issues/50) + +## 0.3.2 (2020-01-24) + +**Merged pull requests:** + +- potential bug fixed and new version [\#51](https://github.com/icanos/hassio-plejd/pull/51) ([icanos](https://github.com/icanos)) + +## 0.3.1 (2020-01-24) + +**Merged pull requests:** + +- added missing dbus access [\#49](https://github.com/icanos/hassio-plejd/pull/49) ([icanos](https://github.com/icanos)) + +## 0.3.0 (2020-01-24) + +**New features:** + +- New BLE manager, DBus instead of noble + +**Closed issues:** + +- Entities without devices [\#28](https://github.com/icanos/hassio-plejd/issues/28) +- noble warning: unknown peripheral in ver 0.2.0 [\#24](https://github.com/icanos/hassio-plejd/issues/24) +- \(node:291\) MaxListenersExceededWarning: Possible EventEmitter memory leak detected. [\#19](https://github.com/icanos/hassio-plejd/issues/19) + +**Merged pull requests:** + +- new ble manager [\#48](https://github.com/icanos/hassio-plejd/pull/48) ([icanos](https://github.com/icanos)) + +## 0.2.10 (2020-01-18) + +**Merged pull requests:** + +- upped version to fix issue [\#47](https://github.com/icanos/hassio-plejd/pull/47) ([icanos](https://github.com/icanos)) +- fix [\#46](https://github.com/icanos/hassio-plejd/pull/46) ([icanos](https://github.com/icanos)) +- bug fix [\#45](https://github.com/icanos/hassio-plejd/pull/45) ([icanos](https://github.com/icanos)) + +## 0.2.9 (2020-01-18) + +**Merged pull requests:** + +- added sorted list of devices discovered [\#44](https://github.com/icanos/hassio-plejd/pull/44) ([icanos](https://github.com/icanos)) + +## 0.2.8 (2020-01-16) + +**Fixed bugs:** - FIX: Reset characteristic state on disconnect -_v 0.2.7_: +**Merged pull requests:** -- FIX: Added exception handling to unsubscribing lastData characteristic if already disconnected +- Update README.md [\#42](https://github.com/icanos/hassio-plejd/pull/42) ([icanos](https://github.com/icanos)) +- reset characteristic state and new version [\#41](https://github.com/icanos/hassio-plejd/pull/41) ([icanos](https://github.com/icanos)) -_v 0.2.6_: +## 0.2.7 (2020-01-16) -- FIX: Added null check to remove listeners for characteristics +**Fixed bugs:** -_v 0.2.5_: +- Added exception handling to unsubscribing lastData characteristic if already disconnected -- FIX: Invalid scene id in events/scene message +**Merged pull requests:** -_v 0.2.4_: +- more error handling and version upgrade [\#39](https://github.com/icanos/hassio-plejd/pull/39) ([icanos](https://github.com/icanos)) +- Update README.md [\#40](https://github.com/icanos/hassio-plejd/pull/40) ([icanos](https://github.com/icanos)) + +## 0.2.6 (2020-01-15) + +**Merged pull requests:** + +- resolved null usage exception [\#38](https://github.com/icanos/hassio-plejd/pull/38) ([icanos](https://github.com/icanos)) + +## 0.2.5 (2020-01-14) + +**Closed issues:** + +- Scene ID always 0 [\#35](https://github.com/icanos/hassio-plejd/issues/35) + +**Merged pull requests:** + +- Update README.md [\#37](https://github.com/icanos/hassio-plejd/pull/37) ([icanos](https://github.com/icanos)) +- resolved bug with scenes [\#36](https://github.com/icanos/hassio-plejd/pull/36) ([icanos](https://github.com/icanos)) + +## 0.2.4 (2020-01-14) + +**Merged pull requests:** + +- added error handling for writing to Plejd [\#34](https://github.com/icanos/hassio-plejd/pull/34) ([icanos](https://github.com/icanos)) + +## 0.2.3 (2020-01-14) + +**Closed issues:** + +- parse error: Expected string key before ':' at line 1, column 4 [\#17](https://github.com/icanos/hassio-plejd/issues/17) +- Raspberry Pi4 Hassos - Installation exited [\#32](https://github.com/icanos/hassio-plejd/issues/32) + +**Merged pull requests:** + +- resolved container build error [\#33](https://github.com/icanos/hassio-plejd/pull/33) ([icanos](https://github.com/icanos)) + +## 0.2.2 + +**Implemented enhancements:** - Stability improvements -_v 0.2.3_: +## [0.2.1](https://github.com/icanos/hassio-plejd/tree/0.2.1) (2020-01-08) -- FIX: Container build error fix +[Full Changelog](https://github.com/icanos/hassio-plejd/compare/0.2.0...0.2.1) -_v 0.2.2_: +**Implemented enhancements:** -- Stability improvements +- stability improvements -_v 0.2.1_: +**Merged pull requests:** -- Stability improvements +- 0.2.1 extended logging [\#25](https://github.com/icanos/hassio-plejd/pull/25) ([icanos](https://github.com/icanos)) -_v 0.2.0_: +## [0.2.0](https://github.com/icanos/hassio-plejd/tree/0.2.0) (2019-12-31) -- Stability improvements -- Bugfixes +[Full Changelog](https://github.com/icanos/hassio-plejd/compare/v0.1.4...0.2.0) -_v 0.1.1_: +**New features** -- FIX: Fixed missing reference on startup, preventing add-on from starting +- Include rooms as lights -_v 0.1.0_: +**Implemented enhancements:** -- NEW: Rewrote the BLE integration for more stability -- FIX: discovery wasn't always sent +- stability improvements -_previous_: +**Fixed bugs:** -- FIX: bug preventing add-on from building -- NEW: Added support for Plejd devices with multiple outputs (such as DIM-02) +- noble warning: unknown peripheral [\#1](https://github.com/icanos/hassio-plejd/issues/1) + +**Closed issues:** + +- parse error: Expected string key before ':' at line 1, column 4/code 404 [\#18](https://github.com/icanos/hassio-plejd/issues/18) +- Cannot find module './plejd' [\#13](https://github.com/icanos/hassio-plejd/issues/13) +- Cannot add repo [\#11](https://github.com/icanos/hassio-plejd/issues/11) +- REL-02 [\#8](https://github.com/icanos/hassio-plejd/issues/8) +- Http error on line 1 [\#7](https://github.com/icanos/hassio-plejd/issues/7) +- DIM-2 and MQTT auto discover issue? [\#6](https://github.com/icanos/hassio-plejd/issues/6) +- Switch / Light [\#5](https://github.com/icanos/hassio-plejd/issues/5) +- Devices not loading after restart of HA [\#4](https://github.com/icanos/hassio-plejd/issues/4) +- Error building [\#3](https://github.com/icanos/hassio-plejd/issues/3) + +**Merged pull requests:** + +- merge to 0.2.0 [\#23](https://github.com/icanos/hassio-plejd/pull/23) ([icanos](https://github.com/icanos)) +- Remove old reference to plejd.js [\#14](https://github.com/icanos/hassio-plejd/pull/14) ([treet](https://github.com/treet)) +- rewritten the ble communication layer [\#12](https://github.com/icanos/hassio-plejd/pull/12) ([icanos](https://github.com/icanos)) +- more stability improvements [\#9](https://github.com/icanos/hassio-plejd/pull/9) ([icanos](https://github.com/icanos)) + +## [0.1.4](https://github.com/icanos/hassio-plejd/tree/v0.1.4) (2019-12-11) + +[Full Changelog](https://github.com/icanos/hassio-plejd/compare/v0.1.3...v0.1.4) + +## [0.1.3](https://github.com/icanos/hassio-plejd/tree/v0.1.3) (2019-12-11) + +[Full Changelog](https://github.com/icanos/hassio-plejd/compare/942be4c54317abd768fb7470f0b2d49fd58f06db...v0.1.3) + +**Closed issues:** + +- DIM-02 only one entity per device detected [\#2](https://github.com/icanos/hassio-plejd/issues/2) + +## 0.1.1 + +**Fixed bugs:** + +- Fixed missing reference on startup, preventing add-on from starting + +## 0.1.0 + +**New features:** + +- Rewrote the BLE integration for more stability + +**Fixed bugs:** + +- discovery wasn't always sent + +## 0.0.9: + +**New features:** + +- Added support for Plejd devices with multiple outputs (such as DIM-02) + +**Fixed bugs:** + +- bug preventing add-on from building + +## Initial (2019-12-04) + +**New features:** + +- Initial version of the addon created! + +\* _This Changelog was partially generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)_