Replies: 197 comments 669 replies
-
|
I'd like to remove the |
Beta Was this translation helpful? Give feedback.
-
|
@D3SL We understand you are frustrated, but replying to every other comment in this thread with the same boilerplate text does not help anyone in the slightest. Please re-enable the legacy action sensors by adding |
Beta Was this translation helpful? Give feedback.
-
I've only replied once in this thread. There are also multiple other threads in parallel to this one where people are separately discussing the same issue, a testament to how severe and widespread of an issue this is. Keep in mind those of us who are already posting here are not only the early updaters but the most technical ones as well, and we're finding ourselves blindsided and crippled by this. A large plurality if not outright majority of Z2M users likely come from the home assistant addon and are not developers with github accounts like those of us posting here are. How do you think this is going for them? As I've said in separate threads: What concerns me more than the way this was handled is the way the fallout is being handled. The outright denigration and scorn being heaped on people who were already technical enough to find their way here for help and answers is deeply concerning, and very reminiscent of the abuse that drove the History Explorer Card developer out of the HA community entirely. It's a very disturbing trend in the overall HA ecosystem. |
Beta Was this translation helpful? Give feedback.
-
|
I meant the whole discussion topic. Replying with the some text does not help. This is an open-source project and most of the workload falls onto the shoulders of a single person, who still has a day job. Literally filling his inbox with walls of angry text does not help at all in this situation. |
Beta Was this translation helpful? Give feedback.
-
|
I'd like to chime in at my own peril. First: Thanks for all your hard work and dedication. I can only imagine the countless iterations on the backend, the long hours, the unthanked "overtime". Thank you for being willing to do all that, and please know there a huge number of people who will never sign up for github just to say thanks, but would likely mean it quite sincerely if they had a path to show their appreciation Second: I do recognize my feelings in @D3SL's comments overall, feels like maybe we got a beta through no malicious intent (you're in good company, HACS and Nabu each had a very rough start to the year, all will continue to bigger and better). That said, I was able to rebuild to a good save point, everything for me clearly broken on version 2+, but what I've not see stated clearly: what even are features and benefits? Of late, new release notes seem to simply reference the new version number (eg notes for 2.x, congratulations, no upgrades to 2x}. As one of the ignorant horde, I've been updating because newer = better. I'm not jumping ship here by any stretch, but it was eye opening enough to not blindly update anymore, this was definitely not a fun weekend for many. Rough, but not insurmountable. Took me years to justify smart home functions to family, not giving up now :) Third: I recognize just how hard it can be to look back to when you were mastering any subject, and I do 100% believe you all have expert level skills and focus, but maybe no longer a filter of what's a deepcut vs truly obvious (eg some recent support says to simply update "configuration.yaml" without clarifying which one, guess where I and many others went first... now assume you're wrong, now assume researching more only to find people still fighting abouts tabs vs spaces, or camelCase or whatever) This third line is not a criticism, simply an observation because I feel I see a thread of people's feelings getting hurt "I didn't mean anything by commenting 'simply," without defining simple to whom. Everything is simple with explicit instructions and a matching skillset, miss either of those requirements and the sky is the limit for frustration I do presume a lot here, but I have always pictured this project being open and welcoming to users of all skill levels. That said, I am at a point I'd love to offer what limited help I can, whether that's near release beta testing (I can at least let you know if I broke my own system with lack of knowledge while at the same time protecting myself with a backup [as a human I sometimes don't wait the 4 minutes to make a backup, especially if I really trust the source, I know, stupid but human])) or somehow helping with communications Fourth: If you're newer to HA/Z2M/any of it and reading this: things breaking is normal, you'll find that they almost always get fixed, and in the meantime backups are key, I personally think still worth moving forward with whatever brought you here, there's a lot to gain, but sadly no one can ever promise no bad days, no matter how skilled Fifth: If in doubt, please re-read First thought Update: Thanks @mundschenk-at for quick response and tips. Just like with firmware, maybe I don't update if not broken and no other compelling reason |
Beta Was this translation helpful? Give feedback.
-
|
@j-and-am There is no distinct beta version per se, but @Koenkk does monthly releases, so normally the changes are not as big as with 2.0.0. If you are using the HA add-on, you can switch to the Personally, I am on a version of the |
Beta Was this translation helpful? Give feedback.
-
|
My suggestion is to remove |
Beta Was this translation helpful? Give feedback.
-
|
added! |
Beta Was this translation helpful? Give feedback.
-
|
I'd also like to remove the duplicate 
|
Beta Was this translation helpful? Give feedback.
-
|
Also added! |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
So what's the timeframe for 2.0.0 approximately? (I am asking if I should do a larger clean-up PR for Home Assistant discovery instead of adding Also, wouldn't it be easier if there was a |
Beta Was this translation helpful? Give feedback.
-
|
Lets aim before EOY |
Beta Was this translation helpful? Give feedback.
-
|
It would be great to add to dev console in UI writing and reading numeric (non-standard) cluster attributes. 
Maybe it's not for z2m but for the frontend repo. |
Beta Was this translation helpful? Give feedback.
-
|
I am in favor of breaking change for 2.0 and major updates. It is not always possible or desirable to keep old stuff. I have a question about the 1.x z2m.
Is there a policy for z2m ? |
Beta Was this translation helpful? Give feedback.
-
|
My idea is: frozen and not touched anymore (because of time reasons) |
Beta Was this translation helpful? Give feedback.
-
What are those supposed to be replaced by ? I read here that actions are replaced by event, but how would it work with devices like old Ikea remotes, as i don't see events implemented yet ? |
Beta Was this translation helpful? Give feedback.
-
|
The wiki states that the Home Assistant event entity will be the standard and recommended way with 2.0.0 Is this correct? |
Beta Was this translation helpful? Give feedback.
-
|
Hello
I think device_id is less convincing/readable than entity_id. Isn't there such a use case? Regards |
Beta Was this translation helpful? Give feedback.
-
Using device IDs carries some distinct disadvantages when creating a network of automations, as every change of hardware now has to be followed up by a change to a potentially large number of automations. In my setup, I have been using semantic entity names like ‘.[]’ e.g. ‘fan.lounge_ceiling’ or ‘light.kitchen_counter’. These are often addressed from several automations and scripts. Using device IDs breaks this. (And i have strong feelings about that.) @devs, this project has been and is outstanding. And this change - while technologically warranted, I’m sure - needs some work. Home acceptance factors around a great part of the user base have dropped. And who is this project for, without our families having functioning lights? (Rhetorical question, I know of cool, non-home projects where it’s being used) |
Beta Was this translation helpful? Give feedback.
-
|
I couldn't agree more, |
Beta Was this translation helpful? Give feedback.
-
|
I also agree, using |
Beta Was this translation helpful? Give feedback.
-
|
So with Z2M 2.0 , will it be true that I cannot enable permit join via MQTT, wait up to 5 mins for a device to join, interview and configure then disable permit join via MQTT ? |
Beta Was this translation helpful? Give feedback.
-
|
One more question on detail, will 'permit join timeout' kill an existing interview/configure if in progress ? |
Beta Was this translation helpful? Give feedback.
-
|
Interview and configure are extra steps specific to Z2M that are not part of the ZigBee join, hence not affected by the permit join status. |
Beta Was this translation helpful? Give feedback.
-
Carry your phone with you as you travel around the building. Trigger the permit join and check the result from the z2m Frontend on the phone when you standing next to the sensor. |
Beta Was this translation helpful? Give feedback.
-
Great idea - for this you only need to allow phones (which belong into an unprivileged network) to access the otherwise tightly fenced automation vlan. why not just put all crap into a flat network while you're at it... Making those 254seconds the default would have been fine and a sensible decision - flat out preventing any other timeout and breaking permit_join for many people that have an infrastructure that spans over larger areas (and hence multiple z2m instances and zigbee clusters) is just ignorant. We run zigbee networks for various automation tasks in 4 buildings on 3 different sites. In the main site alone it can easily take me 10 minutes to get from my desk to some places in the other building to then install and start pairing a device. The other sites are several kms away and I can't always rely on reaching someone there just in time, so usually I send new devices there with instructions where & how to place/install and how to start pairing; having permit_join active until someone there finds the time to perform the task and the devices show up via mqtt. For now I reverted all related commits that broke permit_join in a forked repository, but I really hope (expect) this will be reverted upstram or at least refined so one can set (much higher) timeouts... |
Beta Was this translation helpful? Give feedback.
-
|
Sounds like you should be running some commercial software. |
Beta Was this translation helpful? Give feedback.
-
|
I've been enjoying Zigbee2MQTT for years now. Many thanks for maintaining such a great product so diligently. Hats off from me. |
Beta Was this translation helpful? Give feedback.
-
|
I look at the proposed changelist and everything is really promising @Koenkk, but one thing i want to put up for discussion, and that is the removal of I myself, and assume a lot of people use other automation platform, for example Node-RED. The HA-NR integration is greate, device triggers also added so basically this change should not be a prolem, right? Sadly, it is, generally as device triggers work, you cannot target multiple device with one selector, in the past I wrote a lot of common subflow/function that use the generic state triggers and filters entities by regex, because I use consistent naming for my entities, not really need to deploy 100s of device triggers just use, for example this regex: Can we at least shift the deprecation of this action/click entities because i assume that i not the only one that has such a use-case. |
Beta Was this translation helpful? Give feedback.
-
|
@mundschenk-at let's try to do at least 1.X release with the event support before releasing 2.X |
Beta Was this translation helpful? Give feedback.
-
|
It would be really nice, thank you. 🤲 |
Beta Was this translation helpful? Give feedback.
-
Yes, this would be a great idea. This would allow time to the community to see if there is any problem and anticipate the change👍 For sure, I would love to able to test already as some of my HA blueprints are a nightmare to change with a MQTT trigger without errors...🥴 |
Beta Was this translation helpful? Give feedback.
-
|
@chris-1243 We are still hashing out some details, but I've opened a documentation PR where you can see how it will work. |
Beta Was this translation helpful? Give feedback.
-
|
I had a look. Thanks for your effort. I hope you may provide a I will need to crash some automations to understand more precisely (some blueprint I made...🤫) |
Beta Was this translation helpful? Give feedback.
-
|
I may have missed this elsewhere, but I think it's worth coming up with a plan for the What if:
|
Beta Was this translation helpful? Give feedback.
-
|
This will also be a bad experience. First you will need to switch to Probably the best solution would be to display warnings (in logs, in release notes, etc.) about upcoming breaking changes when using legacy functionality, such as legacy sensors. Like in Home Assistant, which displays deprecated messages in logs for several months and generates a system issue. |
Beta Was this translation helpful? Give feedback.
-
|
I have been using Zigbee2mqtt for years. Many thanks and my respect for your great work. |
Beta Was this translation helpful? Give feedback.
-
|
You can already do that, just set a different |
Beta Was this translation helpful? Give feedback.
-
|
It would be good if some of the changes can be brought forward into v1 to enable people to migrate their configs off legacy sooner - e.g. introduce the change to update sensors alongside the current setup. |
Beta Was this translation helpful? Give feedback.
-
|
Have a look to this thread. It is expected👍 |
Beta Was this translation helpful? Give feedback.
-
|
This is probably the bottom of your list of priorities, but can we see some UI/UX improvements? thanks |
Beta Was this translation helpful? Give feedback.
-
|
Not for 2.0, the frontend is maintained in a separate project (not by me) |
Beta Was this translation helpful? Give feedback.
-
|
@Koenkk would renaming an effect for Hue bulbs be considered a bc break? If so, I'd like to get a fix in place now where "prism" is incorrectly called "colorloop". I figured it was worth checking since it's been wrong for a while and users could have automations tied to it. |
Beta Was this translation helpful? Give feedback.
-
|
That I consider a fix and not a breaking change. |
Beta Was this translation helpful? Give feedback.
-
|
I have both Zigbee2MQTT and ZHA adapters: I have about 11 Zigbee devices currently running under Z2M. What do I need to do to update without too many breaking changes? Edit: noticed I was already on V2.0.0 before I started using Z2M, so it doesn't really apply to me |
Beta Was this translation helpful? Give feedback.
-
|
Migrated from the Dec 2024 version to 2.1.0 today, after a bit of prep work over the last month or so:
Once I actually performed the update (Z2M addon in Home Assistant) and confirmed that everything looked ok in the logs, I could control lights from Zigbee2Mqtt GUI alright but nothing was getting through to Home Assistant (could not control lights or read climate sensor values etc). A reboot of Home Assistant fixed this, so I assume it was related to MQTT discovery or similar. Finally, I then had to track down the motion sensor devices in Home Assistant, re-enable the lux / illumination sensors, and rename them to their old entity names. So now my automations based on area brightness seem to be working ok again. It's only been a few hours since updating so fingers crossed everything continues to work ok and I don't find any weird issues. I found this update to 2.x of Zigbee2Mqtt to be quite challenging. |
Beta Was this translation helpful? Give feedback.
-
|
I have uninstalled z2m Add-On. Can I or should I manually remove the CONFIG/zigbee2mqtt folder and sub folders? I have everything in ZHA (SkyConnect) and added MQTT (Sonoff Dongle-P). Reasons:
[Edit: reinstalled z2m addon closely following this guide. This time entered No broker credentials and no serial info.
[edit 2: |
Beta Was this translation helpful? Give feedback.
-
|
I´ve upgraded to 2MQTT 2.0.0 with the suggestions I have read. I´ve also upgraded the dongle (Z2M) to "ember", and wrote this interface on config.yaml file. Everything works OK, except that I have lost all my Sonoff ZB Mini L2 switches (without neutral). I can't find a solution since then. Can´t get any discover of these devices in the Z2M net. |
Beta Was this translation helpful? Give feedback.
-
|
Hello sorry i have read all the comments but I'm still lost, not an IT expert just a normal person liking automatization so since than all my bottoms stopped working +- 20 !! so how can i get the actions buttons back , i understood as well, that there is something which i can change in my Z2M configutaration.ymal As I'm not a programmer i will copy my config file here and perhaps someone can help me to make the changes and i can than copy this bag on top of my original config file.. :-) thanks for your help and sorry for the long message.. <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
Beta Was this translation helpful? Give feedback.
-
|
Hi, personally I'm a big fan of reacting to the actions by listening to their MQTT events. Especially in Node Red as this allows to create really flexible automations. For the start simply listen to all MQTT events with an I've written about it here with some screenshots: You could then for example place a |
Beta Was this translation helpful? Give feedback.
-
|
sorry I dont understand what I have to do... |
Beta Was this translation helpful? Give feedback.
-
|
Personally I'd suggest looking more into mqtt within Node Red. Please follow this video: Hint: |
Beta Was this translation helpful? Give feedback.
-
|
Simple direct solution: go to Z2M settings, tab "Home Assistant Integration" and check "Home Assistant legacy action sensors", after a few seconds your automations will work again. All this MQTT triggers thing is cool and all but not user friendly at all (I love my GUI). |
Beta Was this translation helpful? Give feedback.
-
|
will trys thanks a lot |
Beta Was this translation helpful? Give feedback.
-
|
Even if legacy action sensors are enabled, action attributes do not show up in HA which brakes some automations. I see the action attributes being published in MQTT explorer, but they do not show up in HA. Is there any way to get the action attributes available in HA |
Beta Was this translation helpful? Give feedback.
-
|
Not working out of the box by changing Z2M config. I spent some time to investigate. I tested 2 options. Option 1, the easy one Sample: Option 2, what I implemented as I wanted to keep my automations. Adding the removed "json_attributes_topic" to the json mqtt "autodiscovery" message. I'm using Node-Red therefor I cannot give any sample using HomeAssistant automation. My MQTT topic is zigbee2mqttm/ZigbeeMHeatWz. You need to add the line with "json_attributes_topic" into your json message and re-publish. After that, the attributes are showing up again . Consider adding a IF-Condition whether the line "json_attributes_topic" doesn't exist otherwise you would produce an infinite loop (as you react and publish a message to same topic) |
Beta Was this translation helpful? Give feedback.
-
|
I could use some help here. I upgraded when the update came out and it didn't work. Tried a bit, but downgraded because lack of time. The issue is, the add-on will not start and hangs at: The logs don't tell more, even the HA logs. So I am stuck without a clue |
Beta Was this translation helpful? Give feedback.
-
|
Yay, "nice"! Ok, then I think there is a bigger problem, when several devices prevent z2m to start. We should create a new issue for this / or a discussion referencing the other (solved) issue that collects devices that produce the problem. |
Beta Was this translation helpful? Give feedback.
-
|
Yes, I agree we need to do something. Just a bit new to this and don't know how. |
Beta Was this translation helpful? Give feedback.
-
|
Sure I would create one. Do you maybe have a debug log of the whole failure process including the restart of z2m? For this you have to activate debug log levels in the zigbee2mqtt configuration.yaml for writing log files. Afterwards restart Zigbee2mqtt with the error happening and wait something like 2 minutes. Then stop z2m and save the created log files. Here is the documentation for the logging topic: When you're ready we could create an issue with this log file. |
Beta Was this translation helpful? Give feedback.
-
|
Done and got it! See attachment! |
Beta Was this translation helpful? Give feedback.
-
|
Issue created. #26430 @manuelkue can you please check and append if needed? |
Beta Was this translation helpful? Give feedback.
-
|
For those with a Zigstar UZG-01, just add to configuration.yaml: After restart Homeassistant and you're good to go. Thanks to @Koenkk awesome work! |
Beta Was this translation helpful? Give feedback.
-
|
hi @lesandie , Thank you for your feedback! |
Beta Was this translation helpful? Give feedback.
-
|
A pro tip is to verify correct nodejs and pnpm version has been installed before updating. I've not updated mine and got errors and the service failed to start `node --version # Should output V18.x, V20.x, V22.X #If not |
Beta Was this translation helpful? Give feedback.
-
|
Dear @Koenkk and the Team, I assume there's a number of users stuck at 1.4 and not able to upgrade to 2.x Will greatly appreciate your response and consideration! |
Beta Was this translation helpful? Give feedback.
-
|
It's odd, because I've seen people report issues with Aqara falling off all the time but having quite a bit of Aqara myself, I've never had an issue with a single one of the buttons or switches, only the PIRs. I think there are some routers they do not like, I obviously don't have those routers. One I did have an issue with is IKEA. Their sockets work fine (although they don't have a button which annoys me greatly, so I use them in locations you wouldn't need access to like down the back of the TV unit) but their switches were an absolute nightmare. But my whole network is basically:
Another consideration is the coordinator. My coordinator is now a UZG-01. Before that, it was a TI dev board (LAUNCHXL-CC26X2R1) so not low end. The only problems I have ever experienced are historically there would be some issues with the Hue PIRs but that seems to be a thing of the past - the only thing I get now is occasionally an Innr plug or Aqara PIR might need a re-configure, but it's maybe once every couple of months, and the ones that keep doing it are in a cupboard with a lot of equipment so it could be interference. But mostly I think it would seem I've been quite lucky. What coordinator are you using? What routers do you have? |
Beta Was this translation helpful? Give feedback.
-
|
I have 100+ Aqara H1 switches that act as routers, a number of Tuya-based ZigBee3.0 devices (power, presence, moisture, security, etc) from various manufacturers. Total number is just below 200 which I tend to blame since I run them all on one coordinator. It is all running on Raspberry Pi 4, Hassio, Zstack coordinator Ebyte Е72-2G4M20S1E. I don't see any other devices falling off the network except Aqara switches though. All end devices and the coordinator are updated the latest firmware. |
Beta Was this translation helpful? Give feedback.
-
|
Hrmmm... so your coordinator is a reputable decent chip, that's fine - this chip should be fine with 200 devices - it's almost identical to the chip I had in my TI Dev board coordinator but your P version (which is an earlier variant of the P7 used in the UZG-01) has a better transmit power than the R. I had some issues with some Tuya falling off in the past (namely the TS0044), so I got rid of them - no issues with their PIRs though. But also back then I had those problematic IKEA switches, so there could have been some sort of incompatibility there. Interesting... so your your H1 switches are all routers I would have thought that would be great but I can find people with a lot of issues with this model - I don't have a single Xiaomi router anywhere, so I can't compare. I did find something related to the timeout settings I don't know if you've seen this before but checking the details here, it's unclear if this setting is exposed in the devices specific settings in Z2M. If you see it there, try setting to 900 seconds (for each, I know it will be a PITA) but might be worth a shot to see if things improve? Edit: did you build this network from a smaller amount of H1s? Or did you buy them all at the same time? I guess what I'm asking is, did you have a smaller amount at one point and get no issues with them? Or have they always done this? Edit2: various edits and info on coordinators. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks, I will check out the timeout setting, though I don't see it immediately in z2m. |
Beta Was this translation helpful? Give feedback.
-
|
If it’s not there, it could be something that can be exposed with a tweak from Z2M. If the setting is available in ZHA, it surely must be possible to set it via Z2M. Keep us posted :-) |
Beta Was this translation helpful? Give feedback.
-
|
When 2.0.0 I was quite harsh in my comments initially because literally every device stopped working. Tried again now and things seem much better, also blueprints are being updated. One thing I don't understand, why is illuminance disabled by default on quite a number of devices (like 9290030675) ? It's possible to enable them manually, yes, true but why it got disabled in the first place? Thanks to Koenkk for your hard work! |
Beta Was this translation helpful? Give feedback.
-
|
OK, I have just updated from v1.42 to latest v2.2.1. Having read this breaking changes-issue when v2 was released, Today, the bosses (wife and kids) is out, so I decided to finally to take the leap. Turns out it helps to read Change logs. Thanx for an amazing experience, @Koenkk . |
Beta Was this translation helpful? Give feedback.
-
|
Ok so what now? I upgraded from 1.4 to the latest and nothing works. I checked the yaml configuration and all are set to false. Adapter was already zstack. But nothing works |
Beta Was this translation helpful? Give feedback.
-
|
fixed it with this line in configuration, maybe it helps someone: |
Beta Was this translation helpful? Give feedback.
-
@Koenkk: Can I ask why? I looked in the PRs and git commits (e.g. Koenkk/zigbee2mqtt.io#3104 and 5a699dd), but they don't give any motivation for this change. (This question was also raised in #24198 (comment), but it didn't get an answer.) Like another message, #24198 (comment), I also find the removal of group management from configuration.yaml to be a big loss. I even do nested groups in an abstraction layer above configuration.yaml (with templating in Nix), so I definitely don't look forward to doing all that work manually/imperatively. Can we re-add declarative group configuration please? |
Beta Was this translation helpful? Give feedback.
-
|
I see. But can't the same argument be made about devices themselves? It's not like having a device listed in configuration.yaml guarantees it's existence in the zigbee network? (This reminds me of the time I realized that I had to set up device bindings imperatively in the web UI. After seeing declarative groups I was hoping to use the same mechanism to set up device bindings.) |
Beta Was this translation helpful? Give feedback.
-
|
All of the settings under
For bindings this will be quite complicated, since many bindings are also done to make the device working (thus you end up with a lot of bindings in the config without the user having set those, and removing them might break device functionality). Not having this in the |
Beta Was this translation helpful? Give feedback.
-
That's a good argument from a developer perspective, but from an end user perspective that's moving complexity from computer cycles (cheap) to brain cycles (expensive). (E.g. I have 22 light groups with the same "transition" value, through a template. I don't want to manage that with point and click. It will get out of sync, it's just a matter of time.) Ok, so groups are conceptually a different kind of configuration. I understand. But it still feels like z2m's domain, and the web UI is optional. So when the web UI is disabled -- how to configure things if not in configuration.yaml? (Even if the web UI is mandatory, I think it is reasonable to assume that declarative group configuration is a lot more scalable/maintainable than manually clicking in a UI?) Can we have a user poll or something whether to bring back group config? If it's a hard no, where would declarative zigbee device config belong if not in this repo? I'd like to say that z2m configuration.yaml (declarative config) is the reason I have such a big (to me) zigbee network today. Before z2m I ran deCONZ, and because of its imperative configuration I never found energy/motivation to have many zigbee devices -- it just seemed like a chore. |
Beta Was this translation helpful? Give feedback.
-
You can create a feature request for this |
Beta Was this translation helpful? Give feedback.
-
|
Ok. I think https://www.zigbee2mqtt.io/guide/usage/mqtt_topics_and_messages.html#group has most of what's needed to build a declarative group configuration layer on top, except there's no way to list/obtain existing groups? (That's a blocker.)
Thanks, here it is: #27619 |
Beta Was this translation helpful? Give feedback.
-
|
Why, after 2.0, devices are Unknown after every restart of HA? I have to click on every device in UI for them to change their status from Unknown to Off? This breaks all of my automations. |
Beta Was this translation helpful? Give feedback.
and others
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
This discussion contains a list of breaking changes for Zigbee2MQTT 2.0.0.
Tip
Most of the breaking changes are about removing legacy features that have been deprecated for years (replaced & improved since), and as such, automatically disabled for newer networks.
How to get prepared (before updating to 2.0.0)?
In order to get the minimal amount of breaking changes when upgrading from 1.x.x to 2.0.0, make sure you have the following in your Zigbee2MQTT
configuration.yaml:Also it is recommended to explicitly add a
serial.adapterto yourconfiguration.yaml, see #24364 for more info.Important
Check you current
configuration.yaml, it is likely that some of these values are already present, and set tofalse, if your network is recent enough (past few years). The breaking changes marked with: Only breaking when legacy is enabled can be ignored if your configuration already has these values set tofalse.Breaking changes
General
USB adapter discovery error (No valid USB adapter found), see Z2M 2.0.0: `USB adapter discovery error (No valid USB adapter found)` #24364 how to fix this.zstackis no longer the default foradaptersetting. If Zigbee2MQTT fails to start saying the adapter could not be discovered, it means your adapter uses an identification not currently recognized by Zigbee2MQTT, make sure to specify theadaptersetting if that's the case.Bare-metal installations (no Docker/Home Assistant add-on)
configuration.yamlfrom repo, this will result in the following error when updating:git checkout data/configuration.example.yaml mv data/configuration.yaml data/configuration.yaml.bak ./update.sh # (update as you usually do) mv data/configuration.yaml.bak data/configuration.yamlpnpmis now used instead ofnpm, the installation instructions andupdate.shscript has been updated accordingly. For existing installations you need to executenpm install -g pnpmbefore updating../update.shscript, make sure you pull changes from git withgit pull --no-rebase(after stopping Zigbee2MQTT).pnpm run clean, then start Zigbee2MQTT again.Home Assistant
update_stateandupdate_availableentities have been removed (succeeded by theupdateentities).homeassistantproperty, useexposesinstead.sensor/selectforselect/number/buttonentities, the full list of removed entities per model can be found here.hass/statusHome Assistant status topic anymore,homeassistant/statusis used instead (ifhomeassistant.status_topicis not set in your Z2Mconfiguration.yaml). Double check that Home Assistant is using this status topic by going to: HA -> Settings -> Devices & services -> MQTT -> Configure -> Re-configure MQTT -> Next; the Birth message topic should behomeassistant/status.homeassistant.legacy_triggerssetting). This means allsensor.*_clickentities are removed. Use the MQTT device trigger instead.sensor.*_actionentities). It's recommended to use the MQTT device trigger instead. In case you really need the action sensors, add the following to yourconfiguration.yaml.homeassistant.legacy_entity_attributessetting) has been removed. This means that entities discovered by Zigbee2MQTT will no longer have entity attributes (Home Assistant entity attributes are accessed via e.g.states.binary_sensor.my_sensor.attributes).Device specific
child_lockon/off values have been changed fromtrue/falsetoLOCK/UNLOCK.illuminance_luxtoilluminance, this breaks in two ways:illuminance_luxhas been removed and the value ofilluminancechanges. Home Assistant users might have to manually enable this sensor via Home Assistant. This affects the following devices: 83633205, MOSZB-140, MOSZB-153, EFEKTA_iAQ3, EFEKTA_PWS_Max, EFEKTA_PWS_MaxPro, EFEKTA_eON29wz, EFEKTA_eFlower_Pro, EFEKTA_iAQ, E2134, POK004, POK011, ROB_200-070-0, HK-SENSOR-4IN1-A, AU-A1ZBPIRS, RADON TriTech ZB, TS0601_illuminance_temperature_humidity_sensor_1, TS0202_3, S-LUX-ZB, TS0222_light, THE01860A, TS0222, LCZ030, MIR-HE200-TY, XFY-CGQ-ZIGB, TS0601_smart_human_presence_sensor_1, Y1_IN, ZY-M100-S_1, ZY-M100-S_2, WZ-M100, ZG-205ZL, ZG-204ZM, YXZBRB58, ZY-M100-24G, ZY-M100-24GV2, ZY-M100-24GV3, MTG075-ZB-RL, RT_ZCZ03Z, ZY-M100-S_3, ZG-205Z, 8750001213, HSE2927E, ZB003-X, 07502L, JS-MC-SENSOR-ZB, KK-ES-J01W, KMPCIL_RES005, RTCGQ11LM, RTCGQ12LM, b-parasite, 7A-SS-ZABC-H0, 5AA-SS-ZA-H0, RTCGQ14LM, RTCGQ15LM, ZNCLBL01LM, GZCGQ01LM, GZCGQ11LM, 07047L, 9290012607, 9290019758, 9290030675, 9290030674, 545D6306, CCT595011, ZSS-ZK-THL, 4512770, TERNCY-PP01, MBD-S, CTM_MBD_Dim, 3RSNL02043Z, WB-MSW-ZIGBEE v.3, MS100, USM-300ZB, PIR313-E.illuminance_luxvalues, enable theilluminance_rawoption device specific settings (will be available from Z2M 2.1.0)switchexpose andactionvalues have been changed, see the device docs for the new values.device_options.legacy. These breaking changes below can be ignored if you havedevice_options.legacy: falsein yourconfiguration.yaml:button_*properties.duration,rate,brightnessandtransition.duration.step_size,transition_timeand the following actions:play_pause,skip_forward,skip_backward,rotate_*.rotate_*actions.button_*properties and removedsingleaction.singleaction.left,rightandbothaction (including the*_longand*_doubleactions).to_side,from_side,angle.angle.repeat,useranddata.duration.step_size,transition_timeandskip_*actions.actionvalues have been changed, see the device docs for the new values.keypad_lockoutvalue changedsetpoint_change_source,setpoint_change_source_timestamp,remote_sensingandcontrol_sequence_of_operationvalues are now mapped values (string) instead of a number.operation,setpoint_change_source,setpoint_change_source_timestamp,remote_sensingandcontrol_sequence_of_operationvalues are now mapped values (string) instead of a number.directionandnumberweekly_schedulepayload.action, removeddurationandcounter.click.External converters and extensions
external_converterssetting is no longer used. Instead all external converters insidedata/external_convertersdirectory are now automatically loaded. Make sure to move all your external converters to this directory.data/external_extensionsinstead ofdata/extension. Make sure to rename yourdata/extensiondirectory (if present) todata/external_extensions.MQTT api
update_availableproperty from the device state has been removed (useupdate.stateinstead).updateAvailabletoupdate_availableinzigbee2mqtt/bridge/response/device/ota_update/check.zigbee2mqtt/bridge/request/device/bind,zigbee2mqtt/bridge/request/group/members/add,zigbee2mqtt/bridge/request/group/members/removeandbridge/request/device/configure_reporting, the endpoint has been moved to theendpointproperty and cannot be set via thedevice/fromproperty anymore.zigbee2mqtt/bridge/request/configMQTT API, this includes the following MQTT topics:zigbee2mqtt/bridge/request/config/last_seenzigbee2mqtt/bridge/request/config/elapsedzigbee2mqtt/bridge/request/config/log_levelzigbee2mqtt/bridge/request/config/homeassistantdatapayload in the response is now always empty when there is anerror, this affectszigbee2mqtt/bridge/response/device/configureandzigbee2mqtt/bridge/response/device/ota_update/*.permit_join_timeouthas been removed fromzigbee2mqtt/bridge/info, it has been replaced bypermit_join_endwhich represents the Unix timestamp when permit joining will end.advanced.legacy_apisetting), this includes the following MQTT topics:zigbee2mqtt/bridge/logzigbee2mqtt/bridge/(bind|unbind)zigbee2mqtt/bridge/group/*zigbee2mqtt/bridge/networkmap/*zigbee2mqtt/bridge/ota_updatezigbee2mqtt/bridge/device/DEVICE_FRIENDLY_NAME/get_group_membershipzigbee2mqtt/bridge/config/*zigbee2mqtt/bridge/configureRemoved features and settings
Important
The new configuration update system will automatically (re)move deprecated settings the first time you start Z2M after updating to 2.0.0. Make sure to check the
data/migration-1-to-2.logafter startup. See the docs for more info.advanced.reportsetting).advanced.soft_reset_timeoutsetting).devices.IEEE_ADDR.options.retrieve_statesetting).availability_timeout,availability_blocklist,availability_passlist,availability_blacklist,availability_whitelistandadvanced.legacy_availability_payload(see availability docs for the new settings).advanced.legacy_availability_payload,zigbee2mqtt/bridge/statewill now always be a JSON object ({"state":"online"}or{"state":"offline"}).permit_joinsetting has been removed, use the frontend or MQTT to permit joining.configuration.yaml(groups.devicessetting). This will not impact current group members; however, you will no longer be able to add or remove devices from a group through theconfiguration.yaml.ota.ikea_ota_use_test_urloption has been removed.advanced.homeassistant_discovery_topicis now inhomeassistant.discovery_topicadvanced.homeassistant_status_topicis now inhomeassistant.status_topicadvanced.baudrateis now inserial.baudrateadvanced.rtsctsis now inserial.rtsctsexperimental.transmit_poweris now inadvanced.transmit_powerexperimental.outputis now inadvanced.outputwhitelistis now inpasslistbanis now inblocklistexperimentalsection no longer existsPull requests
retrieve_statezigbee2mqtt.io#3075readAfterWriteTimezigbee-herdsman-converters#8089configuration.yamlzigbee2mqtt.io#3104configuration.yaml#24338illuminance_luxzigbee-herdsman-converters#8304maximum_packet_sizeMQTT setting zigbee2mqtt.io#3228datain response is always empty onerror#24971sensor/selectforselect/number/buttonentities #25026permit_join_timeout#25082homeassistant.status_topictohomeassistant/status#25286Beta Was this translation helpful? Give feedback.
All reactions