CHANGELOG.md

   Matterbridge zigbee2mqtt plugin changelog

If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-zigbee2mqtt and sponsoring it.

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

[2.4.5] - 2025-02-05

Added

• [thermostat]: Added fan_only mode (tested by https://github.com/robvanoostenrijk). No controllers seem to support this mode in UI right now.

Changed

• [package]: Updated dependencies.

Fixed

• [thermostat]: Fix thermostat bug (thanks https://github.com/robvanoostenrijk).

[2.4.4] - 2025-02-02

Changed

• [plugin]: Requires Matterbridge 2.1.0.
• [package]: Updated package.
• [package]: Updated dependencies.

[2.4.3] - 2025-01-20

Changed

• [plugin]: Requires Matterbridge 1.7.3.
• [package]: Updated dependencies.

[2.4.2] - 2025-01-11

Fixed

• [endpoint]: Fixed blacklist of child endpoints.

[2.4.1] - 2025-01-11

Added

• [selectEntity]: Added selectEntity to get the features names from a list in the config editor.
• [configUrl]: Added zigbeeFrontend in the config to prefix configUrl to get a link to the zigbee2mqtt frontend from the Matterbridge frontend Devices page. This allows to open the device configuration from the frontend.

Changed

• [plugin]: Requires Matterbridge 1.7.2.
• [package]: Updated dependencies.

[2.4.0] - 2025-01-08

Added

• [selectDevice]: Added selectDevice to get the device names from a list in the config editor.

Changed

• [illuminace_lux]: Follow removal of illuminace_lux Koenkk/zigbee-herdsman-converters#8304
• [plugin]: Requires Matterbridge 1.7.1.
• [package]: Updated dependencies.

[2.3.2] - 2024-12-24

Changed

• [package]: Updated package.
• [package]: Updated dependencies.
• [plugin]: Use platform white and black list.
• [platform]: Use platform endpoint number check.

[2.3.1] - 2024-12-12

Added

• [colorControl] Update ColorControl cluster
• [levelControl] Update currentLevel to minLevel

Changed

• [package]: Updated dependencies.
• [plugin]: Requires Matterbridge 1.6.6.

Fixed

[2.3.0] - 2024-12-04

Added

• [matterbridge]: Verified to work with Matterbridge edge (matter.js new API).
• [covers]: Add position movement updates to the controller.
• [covers]: Fix group cover at controller.
• [zigbeeEntity]: Add create async to ZigbeeDevice and ZigbeeGroup.

Changed

• [package]: Updated dependencies.
• [plugin]: Requires Matterbridge 1.6.5.

Fixed

[2.2.2] - 2024-11-26

Added

• [thermostat]: Added min_temperature_limit and max_temperature_limit converter to thermostats.
• [thermostat]: Added min_heat_setpoint_limit and max_heat_setpoint_limit converter to thermostats.
• [thermostat]: Added configuration for heat only and cool only thermostats.
• [matter]: Added tagList to child endpoints.

Changed

• [mqtt]: Username and password are passed like undefined unless set.
• [readme]: Updated install script.
• [readme]: Updated build script.
• [package]: Updated dependencies.
• [plugin]: Requires Matterbridge 1.6.2.

Fixed

• [thermostat]: Fixed the case when instead of current_heating_setpoint the property is occupied_heating_setpoint.
• [thermostat]: Fixed the case when instead of current_cooling_setpoint the property is occupied_cooling_setpoint.

[2.2.1] - 2024-10-11

Fixed

• [entity]: Fixed propertyMap.
• [entity]: Fixed energy kWh.
• [entity]: Fixed log.

[2.2.0] - 2024-10-10

Added

• [groups]: Refactor the group to support also covers.

Changed

• [matterbridge]: Removed EveHistory energy measurement in favor of Matter 1.3 ElectricalPowerMeasurement and ElectricalEnergyMeasurement (supported by Home Assistant from version 2024.10).
• [matterbridge]: Updated to new child endpoints MatterbridgeDevice methods.
• [entity]: Code optimization.
• [package]: Updated dependencies.

[2.1.19] - 2024-10-01

Changed

• [package]: Upgrade to new workflows.
• [package]: Updated dependencies.

[2.1.17] - 2024-09-21

Changed

• [matterbridge]: Removed Matterbridge deprecated method to get the child endpoints.
• [package]: Updated dependencies.
• [plugin]: Moved trigger code to matterbridge triggerSwitchEvent.

Added

• [matterbridge]: Added a check of the current Matterbridge version (required v1.5.5).
• [plugin]: Added configuration of ColorControl cluster features (HS, XY, CT).
• [plugin]: Removed the superset device types.

[2.1.16] - 2024-09-04

Changed

• [package]: Final update to matter.js 0.10.0.
• [package]: Updated dependencies.

[2.1.15] - 2024-09-03

Changed

• [package]: Updated Thermostat cluster to matter.js 0.10.0.
• [package]: Updated dependencies.

[2.1.14] - 2024-08-29

Added

• [config]: Added parameter postfixHostname (default true). If you change it, the controllers will remove and recreate all the devices! (https://github.com/L2jLiga)

Changed

• [package]: Updated dependencies.
• [package]: Updated imports.

[2.1.13] - 2024-08-22

Changed

• [package]: Updated dependencies.

Fixed

• [package]: Fixed MQTT protocol.

[2.1.12] - 2024-08-21

Changed

• [schema]: Changed schema file to add MQTT protocol.
• [schema]: Changed descriptions in schema for easier setup.
• [package]: Updated dependencies.

[2.1.11] - 2024-08-20

Changed

• [package]: Updated dependencies.
• [package]: Update mqtt to 5.10.0.

Fixed

• [package]: Fixed dependencies.

[2.1.10] - 2024-08-09

Changed

• [package]: Updated dependencies.
• [package]: Update mqtt to 5.9.1.

Fixed

• [z2m]: Fixed issue: 'Only supported EndpointInterface implementation is Endpoint'.

[2.1.9] - 2024-07-28

Changed

• [package]: Updated dependencies.
• [logger]: Update node-ansi-logger to 2.0.6.
• [storage]: Update node-persist-manager to 1.0.8.

[2.1.8] - 2024-07-23

Changed

• [z2m]: Updated matterbridge imports.

[2.1.7] - 2024-07-11

Fixed

• [z2m]: Fixed trigger when the endpoint is undefined.

[2.1.6] - 2024-07-10

Changed

• [package]: Updated dependencies.
• [imports]: Updated matterbridge imports.

Fixed

• [z2m]: Fixed the detection of color_temp only lights.

[2.1.5] - 2024-07-01

Changed

• [z2m]: Added transition to ColorControl if the zigbee device supports it and the controller sends it. You can disable this globally adding transition to the featureBlackList or only for the single device adding transition to the deviceFeatureBlackList. (Thanks Stefan Schweiger).

Fixed

• [zigbee]: Fixed WindowCovering.targetPositionLiftPercent100ths update (Thanks Nitay Ben-Zvi).

[2.1.4] - 2024-06-30

Changed

• [dependencies]: Update dependencies.
• [dependencies]: Update eslint to 9.6.0.

[2.1.3] - 2024-06-23

Added

• [zigbee]: Added new properties: co - CarbonMonoxideConcentrationMeasurement, co2 - CarbonDioxideConcentrationMeasurement, formaldehyd - FormaldehydeConcentrationMeasurement, pm1 - Pm1ConcentrationMeasurement, pm25 - Pm25ConcentrationMeasurement, pm10 - Pm10ConcentrationMeasurement

Changed

• [bridge/info]: Log error when advanced.output is set to 'attribute'.

Fixed

• [bridge/info]: Fixed the issue when advanced.output is set 'attribute_and_json'. (Thanks copystring).
• [bridge/info]: Fixed the issue when include_device_information is set to true. (Thanks copystring).

[2.1.2] - 2024-06-21

Added

• [dependencies]: Update dependencies.
• [start]: Refactor start sequence.

[2.1.1] - 2024-06-20

Added

• [dependencies]: Update dependencies (mqtt to 5.7.2).
• [schema]: Added info log when the plugin starts to register devices and groups. Added empty bridge/config and bridge/definitions handlers.

[2.1.0] - 2024-06-19

Added

• [dependencies]: Update dependencies.
• [schema]: Added schema to the root directory of the plugin.
• [z2m]: Added soil_moisture property as humidity sensor.
• [z2m]: Added transition if the zigbee device supports it and the controller sends it. You can disable this globally adding transition to the featureBlackList or only for the single device adding transition to the deviceFeatureBlackList. (Thanks Stefan Schweiger).

Changed

• [matter]: Removed PowerSourceConfiguration cluster that is deprecated in Matter 1.3.

Fixed

• [schema]: Username and password are no more required fields (Thanks Stefan Schweiger).
• [LevelControl]: Fixed the commandHandler for LevelControl in child endpoint (Thanks jpadie).
• [availability]: Fixed the issue that caused the availability event sent before the start to be ignored.

[2.0.17] - 2024-06-16

Fixed

• [LevelControl]: Fixed the issue that caused LevelControl missing in child endpoint (Thanks jpadie).

Added

• [dependencies]: Update dependencies

[2.0.16] - 2024-06-06

Added

• [dependencies]: Update dependencies
• [matterbridge]: Added bridgeOnline to the start checks.

[2.0.15] - 2024-06-01

Added

• [dependencies]: Update dependencies
• [matterbridge]: Adapted the code to the new start mode of Matterbridge.

[2.0.14] - 2024-05-09

Added

• [mqtt]: Added Keekalive to MQTT.

[2.0.13] - 2024-05-02

Added

• [groups]: Added ColorControl.

Fixed

• [payload]: Fixed the case when z2m sends empty action in the payload.

[2.0.12] - 2024-04-30

Added

• [action]: Added support for devices with more then 3 events/actions. All SwitchCluster actions are mapped in groups of 3 on sub endpoints. The mapping schema is shown in log.
• [mqtt]: Added handles for group_add, group_remove, group_rename, group_add_member and group_remove_member

[2.0.11] - 2024-04-26

Added

• [mqtt]: Added handles for device_joined, device_announce, device_leave, device_remove, device_interview, device_rename.
• [exposes]: Added deviceFeatureBlackList to the config to exclude a feature on a device level (See the config section for guidelines on how to use it).
• [mqtt]: Incoming messages are filtered by featureBlackList and deviceFeatureBlackList (if only blacklisted features change, the message is not processed). If present, the features included in featureBlackList and deviceFeatureBlackList are also removed from the payload.
• [routers] Added the SMLIGHT routers (with router firmware) to the router list. They are exposed like DoorLock so it is possible, like for the Coordinator and the Texas instruments router, to ask Siri to turn on/off permit join.

[2.0.10] - 2024-04-22

Added

• [z2m]: Added a check for not changed mqtt messages.
• [extension]: Finalized implementation of zigbee2MQTT internal extension v. 1.0.0.

Changed

• [z2m]: Changed vendorName and productName with the values from device definition if present.

[2.0.9] - 2024-04-19

Added

• [extension]: Implementation of zigbee2MQTT internal extension.

[2.0.8] - 2024-04-16

Added

• [extension]: Started implementation of zigbee2MQTT internal extension.
• [presence]: Added feature presence (https://github.com/nitaybz).
• [FlowMeasurement]: Added FlowMeasurement cluster.

[2.0.7] - 2024-04-11

Added

• [config.featureBlackList] z2m features with name in the list will be ignored (e.g. device_temperature) (https://github.com/nitaybz).
• [config.switchList] Device with friendly name in the list will be exposed like switch.
• [config.lightList] Device with friendly name in the list will be exposed like light.
• [config.outletList] Devices with friendly name in the list will be exposed like outlet.

Fixed

• [payload]: Fixed the case when z2m sends null or undefined in the payload (https://github.com/khaidakin).

[2.0.6] - 2024-04-09

Added

• [electrical] Added support for voltage current power energy (right now they show up only in Home Assistant)
• [multiendpoint]: Added the support for electrical measurements and temperature (thanks https://github.com/khaidakin).

Changed

• [discovery]: Refactored the zigbee2mqtt discovery: now multi endpoints devices (mostly DIY devices) are supported.

[2.0.5] - 2024-04-01

Added

• [Coordinator and routers]: Coordinator and TexasInstruments pure routers are exposed like DoorLock. They change state when permitJoin is changed and turn on or off the permitJoin when they are opened or closed from the controller.
• [thermostat]: Added the Thermostat cluster (thanks https://github.com/khaidakin).
• [multiendpoint]: Added the support for OnOff cluster with child enpoints (thanks https://github.com/khaidakin).