Skip to content

Commit

Permalink
Change CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kiwi-cam committed Jun 16, 2023
1 parent 7501cfc commit d7c1bca
Showing 1 changed file with 252 additions and 0 deletions.
252 changes: 252 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,252 @@
# Changelog
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/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Added
- w1 and file temperatures will return a battery level of 100 if none found
- Serializes the simultaneous IR/RF commands. (Thanks @banboobee) #520
### Fixed
- Fixes log error (Thanks @hypery2k) #606
- Fan speed fixes (Thanks @dnicolson) #592 and #593

## [4.4.12] - 2022-06-08
### Added
- Added tempStepSize to configuration (defaulting to 1) to allow AC units with 0.5 steps (Thanks @nasudon) #570
- Added support for fahrenheit temperature sources #495 - set tempSourceUnits to 'F'
### Fixed
- Updated versions to address vulnerabilities
- Set HAP properties for fan speed handling (Thanks @datibbaw) #583
## Changed
- Serialised simultaneous IR/RF commands (Thanks @banboobee) #520
- Adjusted logging levels for temperature/humidity updates
- Adds support for 0x520b and 0x520c Devices

## [4.4.11] - 2022-06-08
### Added
- MQTT support for zigbee2mqtt (Thanks @mikicof) #467
### Fixed
- "no device found" message in Node 18 (Thanks @h2oota) #486
- Version number message incorrect in prerelease (Thanks @seidnerj)
### Changed
- Homebridge versions bumped
- Device not found message update to suggest unlocking (Thanks @jacoblukewook) #491

## [4.4.10] - 2022-04-12
### Added
- Turns off other lights in group when it turns on. (Thanks @banboobee)
### Fixed
- Improved 'device unreachable' false alerts (Thanks @banboobee)
- Updated dependencies to resolve vulnerabilities

## [4.4.9] - 2022-02-24
### Added
- Adds AutoOff support to the AirConditioner accessory (Thanks @banboobee)
- Updated dependencies to remove security vulnerabilities.

## [4.4.8] - 2021-12-08
### Fixed
- Updated dependencies to resolve security vulnerabilities
- Keepalive logs now only log under debug

## [4.4.7] - 2021-11-26
### Added
- Adds 0x6184 device support
- Added support for 'white' light. Thanks to @JuniorGenius
### Fixed
- Removed unsupported AutoOnOff code from heater-cooler accessory which was causing exceptions.

## [4.4.6] - 2021-08-03
### Added
- Adds support for 0x6508 devices
### Changed
- General code tidy-up/standardisation.
### Fixed
- Improved the temperature update process when using MQTT to make the UI more responsive
- Fixed 'One of your plugins incorrectly registered an external accessory using the platform name ([object Object]) and not the plugin identifier' message which caused TVs to fail in HOOBS
- Fixes Version checks on start-up (Thanks @dnicolson)

## [4.4.5] - 2021-06-23
### Changed
- Improved default allowResend logic when using preventResendHex
- Heater-Cooler now shows as Heating or Cooling depending on mode selected
- Updated to always use noHumidity when using a source which doesn't support it (w1 or pseudo)
### Fixed
- Fixed characteristic 'Current Temperature': characteristic was supplied illegal value when a heater-cooler reads below 10
- Fixed name not defined error when using oscillate in Heater Cooler
- Fixed bug in Humidifier-Dehumidifier sending FanOnly hex regardless of state
- Fixed logLevel is not defined error in aircon accessory
- Updated MQTT version requirements to fix known vulnerabilities in dependencies

## [4.4.4] - 2021-06-09
### Added
- Heater-Cooler states now all support allowResend for when values are not changing.
- Heater-Cooler now supports humidity values and noHumidity configuration.
- Accessorys now support logLevel configuration (none=6, critical=5, error=4, warning=3, info=2, debug=1, trace=0)
- The Platform now also supports logLevel configuration
- Learn RF now finds 0xb2 codes
### Changed
- Updated CHANGELOG.md to follow [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- turnOnWhenOff now defaults to true for Heater-Cooler accessories.
- All accessories now explicitly have allowResend set to true by default.
- Learn Accessories will temporarily enable platform level debug during a learn
### Fixed
- Learn RF now times out after 60 seconds to allow all frequencies to be scanned.

## [4.4.3] - 2021-05-04
### Added
- Adds Mute button to TV accessories (No HomeKit support and untested yet)
- Adds the RM Mini 3 6507
- Adds fan speed step functionality and speed improvements (Thanks @EpicKris)
- Adds Current Temperature support to Heater-Cooler accessories. Offers all the same options: file, MQTT, or RM Pro Device (Thanks @uzumaki20398)
- Allows HEX Objects for additional charactistics on Fan, Air-Purifier, and HumidifierDehumidifier Accessories (Thanks @ aymericbaur)
- Adds turnOnWhenOff support to the HeaterCooler Accessory
### Fixed
- Fixes bug with Parsing JSON MQTT messages (#298)
- Fixes fanv1 "counterClockwise is undefined" error when showRotationDirection is true (#306)

## [4.4.2] - 2021-04-07
### Added
- Adds offDryMode configuration option to the airconditioner accessory. Thanks @pixeleyesltd
- Adds stateless configuration switch option to have a switch "forget" its state
- Adds Eve History service support. This can be disabled by adding `"noHistory":true` to your config
### Changed
- Set node-persist to ignore parse errors to stop crashing the plugin on read errors
- Sets "undefined" characteristics to either 0 or minValue to prevent future Homebridge errors
- Moves onTemperature and onHumidity logging to Debug only, reducing noice in the logs from all updates
### Fixed
- Fixes mac address formatting error when using manual hosts devices #266
- Fixes Accessory mac address formatting to support all formats the hosts section does - and improve matching to devices.
- Stopped MQTT updates from defaulting to 0 when the topic isn't found. This does create messages that the plugin is slowing homebridge until MQTT updates are recieved.

## [4.4.1] - 2021-01-27
### Added
- Adds pingUseArp configuration to use an ARP lookup instead of ICMP ping to test a device's status
- Adds heater-cooler tempStepSize to support devices without 0.5 temperaure codes
### Fixed
- Fixes "'Temperature Display Units': characteristic was supplied illegal value: undefined!"
- Fixes "SET handler returned write response value, though the characteristic doesn't support write response! when returning a value"
- Fixes Learn Button error "the characteristic 'On': characteristic was supplied illegal value: undefined!"
- Fixes Error in Heater-Cooler with setting a value to a constant

## [4.4.0] - 2020-12-17
### Added
- Added Low Battery Alerts to Humidity and Temperature sensors (using battery:XX in readings from files)
- Extended Temperature and Humidity readings from files to support temperature:XX, humidity:XX, and battery:XX values on each line
- Added MQTT support to AC and Temperature sensor using temperature,humidity, and battery identifiers
- Added HeaterCooler accessory option. Refer to [this document](https://github.com/kiwi-cam/homebridge-broadlink-rm/blob/kiwi-cam-beta-1/docs/heater-cooler.md) to read @newt10's work here.
### Changed
- Updated all dependencies to remove some security vulnerabilities
- Removed file and w1 Temperature readings being forced to 10 minutes. Now 1 minute minimum and adjustable
- Integrated the platform helper module to improve maintainability.
- MQTT will update when published so frequent refreshes aren't required ( 10 minute default as a fallback )
### Fixed
- Fixed duplicate monitorTemperature calls from Temperature Sensor accessories
- Fixed SIGTERM when unexpected packet received

## [4.3.8] - 2020-12-01
### Added
- **Added RF Learning** steps from #45
### Changed
- Added Keep Alive packet to RM Devices to avoid reboots when the cloud is unreachable.
### Fixed
- Fixes "No Response" from Dehumidifers when noHumidity and accessory Off
- Fixes "log is not a function" error when using Pronto codes

## [4.3.7] - 2020-11-16
### Fixed
- Fixes missing FanSpeed/Direction features in Fanv1

## [4.3.6] - 2020-11-11
### Added
- Adds humidityFilePath support to the HumidifierDehumidifier accessory to update the current humidity from a local file
- Adds autoOn/autoOff support to the Fan and HumidifierDehumidifier accessory (Note the Bug detail below)
### Changed
- Improves HumidifierDehumidifier accessory to update state by using Humidity data from the Broadlink device
- Updated humiditySensor and temperatureSensor accessories to extend HumidifierDehumidifier and AirCon accessories (respectively) so both gain MQTT and file values too.
- Updated the switch accessory to use On/Active status depending on device type. Many accessories inherit from this and it broke their AutoOff functions.
### Fixed
- Fixed AutoOn/AutoOff functions for Fan and HumidifierDehumidifier. This was an issue with the different characteristics between the HomeKit Fan and Fanv2 Services. In order to tidy this up users wanting to have the classic style Fan (with more icon options) will need to update type to "fanv1" i.e. `"type": "fanv1"`

## [4.3.5] - -2020-11-02
- Fixes bug in Fan accessory that removed Rotation Direction and/or Swing options

## [4.3.4] - 2020-10-27
### Added
- Adds fan improvements with defaultFanSpeed and stepSize (Thanks @newt10)
### Changed
- Improves HumidifierDehumidifier accessory by using Humidity data from the Broadlink device (See README.md for notes.)
- Uses Service.Fan instead of Service.Fanv2 to allow Fan icons if not using SwingMode (Thanks @apexad)
### Fixed
- Fixes Air Purifier so it no longer appears as a fan
- Removes limits on air-conditioner Current Temperature so it isn't constrained to the same limits as the Target Temperature.
- Fixed the identification of manual devices. New Manual deviceTypes added which are selected based on isRFSupported and isRM4. isRM4 will be required on newer devices to make sure messages include the correct headers.
- Fixes an error in the aircon accessory where HEX codes for temperatureXX would falsely report as missing

## [4.3.3] - 2020-09-29
### Added
- Adds Humidity information to the Aircon accessory
- Adds TemperatureSensor accessory to give temperature and humidity information from Broadlink sensors
- Adds HumiditySensor accessory to give humidity information from Broadlink sensors
- Adds AirPurifier and HumidifierDehumidifier accessory from the original fork
### Fixed
- Fixes error in heombridge-platform-helper "ReferenceError: log is not defined"

## [4.3.2] - 2020-09-21
### Added
- Updated documentation around TV changes

## [4.3.1] - 2020-09-21
### Added
- Adds coolOnly mode for Aircon accessories
- Fixes TV Display issue in iOS14. *All TVs are now seperate accessories. Previously the first TV connected via Homebridge as a bridge. This means that after updating, that first TV will need to be removed and re-added to HomeKit.*
- Adds TV subType to display STB, Receiver, or Stick types
### Fixed
- Fixes issue in heatOnly mode for Aircon accessories
- Fixes MAC address order error. *If you specify a HOST in your config.json by MAC address, you'll likely need to correct this value after you update.*

## [4.3.0] - 2020-09-09
### Added
- Adds HeatOnly mode for Aircon accessories
- Adds support for RM4 Temperature sensors
### Changed
- Improves support for RM4 RF devices (e.g. RM4 Pro)

## [4.2.9] - 2020-08-11
### Added
- Added `Broadlink RM Mini 4 C` 610f support
- Added notes about IHC setup/reset process

## [4.2.8] - 2020-07-15
### Added
- Added `Broadlink RM4 4 Pro` 649b support

## [4.2.7] - 2020-07-10
### Added
- Adds IR Learn support for RM4 devices
- Adds additional Debug information
- Added `Broadlink RM4 Mini 4 KR` support

## [4.2.6] - -2020-06-12
### Added
- Adds command acknowledgement messages
### Fixed
- Fix for RM4 SendCode issues

## [4.2.5] - 2020-06-10
### Added
- Added `Broadlink RM Mini 4 S` support
### Fixed
- Updated to use new kiwicam-broadlinkjs-rm version with RM4 bug fixes (Learn Mode)

## [4.2.3] - 2020-06-08
### Fixed
- Update to use new fork kiwicam-broadlinkjs-rm with RM4 support

## [4.2.0] - 2020-05-25
### Added
- Inital version - forked from AlexanderBabel/homebridge-broadlink-rm-tv
### Fixed
- Added device support from def-broadlinkjs-rm

0 comments on commit d7c1bca

Please sign in to comment.