Installing Zigbee2MQTT with Home Assistant

[@ThomasS17]

I have spent two day trying to install Mosquitto and Z2M in docker (I could have installed them in HA, but I wanted them to run separately), following multiple videos and written guides. Your video on how to install mosquitto in docker and this video finally helped me get it to run. Thank you! Also, one little note for anyone having issues accessing the web ui: don't forget to add 'frontend: true' to the configuration.yaml.

[@HomeAutomationGuy]

I'm glad it was helpful! ☺️

[@MyHeap]

Thanks for the great video series. i had issues with loading the zigbee2mqtt front end on the docker version. I had to add frontend: true to the configuration file and restart zigbee2mqtt to fix it. Just thought I would share in case anyone else had a problem. Thank you for the video series. They really help this newbie out! Joe

[@HomeAutomationGuy]

Thanks for sharing!

[@lakisan]

Thank you so much.

[@lacot5]

Same for me, took me a while to troubleshoot it

[@nagisupercell]

Same for me, I got it from Github discussion.

[@theowlpo]

Hi. I had the same problem. Thank you for sharing

[@fredericomachado4116]

I followed all the steps for the docker install and for some reason the zigbee2mqtt frontend would not start. Ended up adding the following line to the zigbee2mqtt configuration.yaml file: frontend: port: 8080 and it worked!

[@alexchapman8330]

Came here after a while of looking a solution to this problem! Thanks! Worked for me!

[@Teleport73]

I had the same issue. Thank you so much for that! Was also useful for changing the frontend to a different port, as mine clashed with TasmoAdmin, already on 8080.

[@ahmedabdelsalam6508]

I had the same issue, thank you!!

[@bernharddablander225]

Thanks for the hint, also solved the problem on my system.

[@EvolverDX]

[12:04] the wget command created an additional data folder under your chosen path "zigbee2mqtt\data\. The downloaded sample file is saved to ".\zigbee2mqtt\data\data\configuration.yaml". Was this meant to be or was it a mistake?

[@simon057]

pretty sure a mistake

[@vintier2k]

awesome after like ten hours of searching through trash tutorials i found your video and it worked. thank you!

[@HomeAutomationGuy]

Glad it helped

[@vintier2k]

@@HomeAutomationGuy Now using it for a second time after destroying my machine and can confirm, tutorial is still useful LOL fk ubuntu

[@linlu2773]

thanks! I add the following command to configuration.yaml inside zigbee2mqtt folder. Otherweise the zigbee2mqtt frondend won't load in home assistant. # Enable the Zigbee2MQTT frontend frontend: port: 8080

[@andrewmcnulty0]

dam bro i was on this for about 7 hours... you fixed it

[@dhruv.pandey93]

I really love the docker part of all your videos!! Can you please create a video on how to setup DuckDNS and HTTPS on dockerized Home Assistant?

[@simon057]

yes please!

[@AdrianRMOS]

Great tutorial. Thanks! Two things that would improve the video: 1) add a tip at 5:18 to do a hard refresh of the browser (Ctrl+F5). Sometimes Zigbee2MQTT addons don't show up after adding the repo. 2) add a tip at 7:13 to include "adapter: ezsp" in the configuration for Sonoff Zigbee Dongle-E.

[@HomeAutomationGuy]

Great tip!

[@itsmith32]

Thank you so much for such a clear explanations! Keep up your good job! 💪

[@CHLEE-ou6ub]

Great video, thanks Needed to add this to zigbee2mqtt's configuration frontend: true to get the HAOS side panel to function. Thanks again.

[@hugoribeiro874]

only managed to make it work after this! Thank you!

[@nicolasrigaud1139]

I have 502 bad gateway ans no error on log file. I have put frontend : true but thats te same. Any idea ?

[@gavintheurquhart]

Thank you for this. Had the same issue and was failing to figure it out until I read this.

[@gavintheurquhart]

@@nicolasrigaud1139 where in your configuration.yaml file did you put that? Maybe you already figured it out? I put it below homeassistant: true and lined up with it and it worked. Log file then showed (after restart of container) "Started frontend on port 0.0.0.0:8080"

[@lee-he3ey]

Thank you for this.. it also fixed my issue

[@kzmpianist]

i've just watched most of the series from the playlist and realized that Suprvized version is actually container process which is controls other continaers "health", get logs, run/check updates. I have plan to migrate to Container version of HA from supervized after this, loooks like not so complicated having some experience with docker

[@junkins]

Thank you so much! It's like you literally read my mind. Earlier today I was looking for a good video explaining how to do this. :)

[@HomeAutomationGuy]

Glad I was able to help!

[@trevsweb]

just had my HA die and google deleted my backup so your video helped me out bigtime

[@MrFranciscorocha]

Great Explanation, Congrats Perhaps you can make a content about local and remote access to Z2M from HA (and talk about new panel integration for that) My 5 cents ...

[@HomeAutomationGuy]

Thanks for the suggestion!

[@dinadenic2756]

Maybe someone can help me here. When I use the ls -l /dev/serial/by-id I get the following message: "No such file or directory". I'm running HA on a docker container. Thanks!

[@roygift]

I installed HA on my Synology NAS (DS720+) using Docker (as VM version doesnt work) and I dont have the Addons link available under HA settings. What are my options?

[@nikolas-cy]

Thank you ! Very Helpful the only problem if someone has problem and not starting is to set in zigbee2mqtt configuration file serial: adapter: ezsp

[@mbp5863]

Thanks for the video, it helped me out a lot! I have a problem i don't know how to solve though. I connected 2 devices with the zigbee2mqtt, but there are no devices or entities shown in the mqtt broker. Do you know what's wrong?

[@tomhueb793]

Did U find a solution?

[@anirangs]

Great video. Can you tell me how do I update Zigbee2MQT docker installation? Should i mention it to pull the stable image in my docker compose file? TIA

[@serhioromano]

How to install node red with all HA elements?

[@SergioBlackDolphin]

Thank you! You convinced me to go for ZHA! :-)

[@HomeAutomationGuy]

It's great, and getting better each month!

[@ezrakoper]

What is the difference parameters I get if I use ZHA instead

[@revealingfacts4all]

great video but what I am not understanding is in Zigbee2MQTT under each device, click on settings for that device, there is a category called Home Assistant with an input field called Home Assistant Name. Inside MQTT Broker, I see devices showing up under zigbee2mqtt topic and a topic named homeassistant. So which is it? Additionally, I notice that the zigbee2mqtt friendly name shows up under the zigbee2mqtt topic while the IEEE ID shows up under homeassistant topic.

[@drbyte2009]

Thx again for the video Alan. I have it up an running on my old laptop! Can you please also do a video for Node-Red?

[@Calzune]

I have followed all your steps but I get 502 bad gateway... HELP!

[@Skracken]

Top tip: If you like me are using a ConBee flavour adapter, you need to add "adapter: deconz" in the serial setting of the addon

[@ShadyfoxUK]

Thanks, this solved the problem I had with the 502 Bad Gateway error 👍

[@Skracken]

@@ShadyfoxUK Glad it was of help :)

[@Mike28081991]

Hey Alan, thank you for your Videos. I absolutely love them! I just have to add one note for the installation method via docker-compose: I think there is a mistake when creating the configuration.yaml file. It is created in the wrong folder. If I follow your instructions, the file is created in the /opt/zigbee2mqtt/data/data folder. When starting the container the file in this directory will be ignored and instead a configuration.yaml file will be created in the folder /opt/zigbee2mqtt/data which looks exactly like the sample file we created before. Unfortunately, you did not show the logs after starting the container. I think there would have been an error.

[@mathieuhantz]

Hey, I face the same issue. What seems to be the best solution for you? I think editing the docker-compose.yaml this way : - /opt/zigbee2mqtt:/app/data (instead of -/opt/zigbee2mqtt/data:/app/data) may be a good answer, but I'm kind of a newbie, so any advice is welcome...

[@Mike28081991]

​ @Mathieu Hantz Burnet Hey you are rigth. I think that would also do the trick. But with this method the files in the container would be on a different level as on the host and wich i wanted to avoid. That is why my prefered solution was to manually create the configuration.yaml file in the directory zigbee2mqtt/data with visual studio code (instead of using the wget command like alan). Another method would be to write the wget command in the folder /zigbee2mqtt instead of /zigbee2mqtt/data like alan in 12:02

[@mathieuhantz]

@@Mike28081991 I didn't even though about these solutions, thank you for your quick answer ! I will try the last solution! Once more, thank you for your time and answer !

[@xoarex]

Yes Don't create the "data" directory Just run the wget inside the "zigbee2mqtt" directory, it will create the files for you in the proper place

[@keroner9998]

Maybe someone can help me here. I cant get zigbee2mqtt working. When I use the ls -l /dev/serial/by-id I get the following message: "No such file or directory" I'm running HASS in VMware and the host machine is Windows 11. Thanks in advance!!

[@SondelaConsulting]

What adapter do you recommend from the list for an absolute beginner like me

[@HomeAutomationGuy]

Either the Sonoff 3.0 USB Dongle Plus or the Home Assistant SkyConnect

[@SondelaConsulting]

@@HomeAutomationGuy thanks

[@theowlpo]

Great video and clear as always. Thank you for helping a newbie 🙂

[@jeanbernier6751]

Great video again. I got the container running fine, but the frontend panel does not want to connect to my server address. I can’t figure out what could be wrong.

[@sQeeez]

have you figured it out?

[@robobobo23]

not big deal to set it up.. i have the same scenario at home.. but im wondering how we can access these panel menu from outside (from HA application).. i tried to expose it to world through the ngninx and it worked.. but its not so good idea as there's no password protection so eveybody with the link could manage my home :) any idea ?

[@janosch123456789able]

Guys one question, i have openmediavault 5 and use portainer. So far did nothing in terms of home assistant, but I want to get startet. So my question is can I install ha on docker using portainer and than setup all the other stuff concerning ZigBee as described in this video? I am not an expert so I want to keep it simple. Thanks for all kinds of advice!

[@HomeAutomationGuy]

I am pretty sure you can, but I've not personally tried it

[@michaeloren3358]

I had to add the following for my dongle to the configuration.yml serial: adapter: ezsp

[@Rob-sc8mq]

Hi I am struggling to find the associated blog post for the zigbee2mqtt install on your website. has it been deleted? I am trying to get up and running with the slzb-06 network coordinator but theres not a huge amount of info in setting up using docker compose. Thanks!

[@HomeAutomationGuy]

I don't think I ever had an article for that, I usually just use the zigbee2mqtt docs. You need to configure the coordinator in the zigbee2mqtt configuration.yaml file to point to the IP address of the coordinator.

[@JordanRiser]

Is it possible to disable an Aqara switch internal relay with just ZHA? I have seen it's possible with Z2M but I already have ZHA installed and wonder if there is a way to do this that I'm just not seeing.

[@rakeshkumart9297]

How to install Home Assistant on windows 11, I have a Sonff ZigBee dongle plus, i need to pair that with ZigBee enabled sensor(Temperature and Humidity sensor).

[@HomeAutomationGuy]

You will need to install it in a virtual machine.

[@t3chrs]

Thanks for the video. I’d love to see something similar for running ESPHome using docker compose.

[@HomeAutomationGuy]

I haven't yet dipped my toe into the water of ESPHome yet, but once I do I'll definitely be videoing it!

[@GlennPerdicaro]

Thanks for the excellent video, I'm considering whether to take the sonoff or wait for the new sky connect, does sky connect have any more advantages compared to sonoff dungle usb?

[@PetruCristolovean]

Hello Alan, great video, very well structured and explained . I'm new to HA and docker but following your video/blog was very easy to install them. Now I have a challenge :) I'm trying to install them with ssl/tls. The big issue is zigbee2mqtt which connect to mqtt (and publish to the HA topics) but the UI is not started. I checked the documentation and change the configuration but not succeed. It is possible to have a look on this topic and maybe to publish an update of this (great) tutorial?

[@Skeeterflea]

My Zigbee2MQTT container is running but I cannot connect to the web interface on 8080. I have 'frontend: true' in my /opt/zigbee2mqtt/data/configuration.yaml file.

[@HomeAutomationGuy]

Make sure you've got the ports mapped through and that the routing is working correctly.

[@guyvxt]

I have the same issue. I've tried deleting the container etc still no joy... I have tried frontend:true and Frontend: port:8080 as suggested in the comments on here. Almost at the point of giving up...

[@guyvxt]

finally sorted my issue. I checked the logs in the zigbee2mqtt data folder. The log file listed a load of errors with my USB device starting. It said to delete the coordinator_backup.json file so I did and restarted in portainer. Now working!

[@bobbymooreok]

any way to encrypt or hide your MQTT password? Or can we just copy the hash from previous video?

[@haligali386]

how you add thsoe devices now as entity to home assistant?

[@HomeAutomationGuy]

They get added automatically if you have the MQTT integration configured

[@haligali386]

@@HomeAutomationGuy yea i did miss in the documentation the homeassistant: true nice video, thank you

[@grygub]

Major miss in the configuration.yaml instructions. You must add frontend: true or there will be no dashboard to go to. Other than this I really appreciated this guide. I also second using serial by-id to specify the zigbee radio

[@SkysimAir]

Thanks for pointing this out. I was already in desperation mode, because no frontend showed up, although there was no error message in the log.

[@Dasol0135]

Great Video, Thanks for sharing.

[@antoniodecrisci2369]

thanks for the video! Do I have to remove ZHA before adding Z2M?

[@AshleyTayles]

Yes you do, unless you have two zigbee coordinators.

[@nicolasrigaud1139]

How to do this ?

[@robertperkins4909]

How to find Conbee II devname on VM Virtualbox to be able to configure Zigbee2MQTT on HA?

[@HomeAutomationGuy]

I don't know, I'm not an expert on VMs

[@taronk.4030]

Thanks! Everything works great!

[@AceBoy2099]

Heck, my program won't even start mostly 502 bad gateway.... "error: spawn udevadm EN0ENT" in log.

[@kmtsvetanov]

same here. Any new info ?

[@guillaumebertin682]

Hello, thanks for your video ! Do you know if the conbee 2 on a raspberry Pi4 with home assistant detected a roller shutter zigbee module that is installed behind a switch ? Thanks

[@HomeAutomationGuy]

That will depend on which roller shutter module you are using. ZHA supports quite a few different ones.

[@WvnDesign]

I'm unable to find my usb any way possible it seems.. Give gives cant find it. Im on Synology + docker

[@saarnevejans9623]

installed the usb driver ?

[@raveen69]

But sure if this was asked, but why should I use the mqtt version vs just the native ZHA? What makes the mqtt version "better"?

[@HomeAutomationGuy]

I cover that in this video actually: kzbin.info/www/bejne/aniqZZZ3gsmnh6s

[@diogor420]

Would I get access to addons if I installed home assistant in an Intel Nuc with Proxmox?

[@HomeAutomationGuy]

Yes, if you install the Home Assistant OS version

[@mako9673]

Man I have been racking my brain trying to figure out why Zigbee2MQTT will not work properly in my docker container. Followed this video twice, and checked online and tried a few ideas there. But still cannot get this thing to talk to my zigbee controller. The only thing I have not tried yet is reflashing the firmware on the controller. I may have to do that.

[@benjenkins183]

Did you ever solve it? I'm having similar issue. sonoff dongle 3.0 plus-e

[@mako9673]

@@benjenkins183 It took a lot of time, but finally got it working. There is a task that is was running at the same time, that is sort of hidden, that was conflicting. I am not at home or at my computer at the moment. But believe it was the built in MQTT sub task that you would run if you were installing it with out using docker containers. I thought it was part of the needed components, but it was not. Once I fully disabled, or uninstalled it (don't remember what exactly) it started working without any errors.

[@_od_7825]

I'm running HA on a virtual machine using Virtual Box. I've already got everything running through ZHA, but I've got some new devices that need Zigbee2MQTT to work with HA. Do I need to remove all of the ZHA devices to be able to do this or can both run at the same time? I've also got an issue that as soon as I start Zigbee2MQTT my CPU usage goes through the roof and the fan kicks in at full speed. I then get 502:bad gateway when I try to look in the WebUI, the log is blank. This is the same set of errors that I got the first time I tried to use MQTT and is what put me off, but I must just be doing something wrong so any help would be appreciated.

[@bat3332]

Hey Can I ask you a simple question as someone who is going to begin home automation from first step. Should I buy a raspberry pi or nuc with windows. For home assistant I know nuc are on the pricier side but ignoring the pricing factor in the long run. Which one should I consider Nuc(windows) or Raspberry pi. for additional info I dont have either one or used either one before

[@HomeAutomationGuy]

Get a raspberry pi. It's cheaper and easier to get started. If you get really into it you can always upgrade to something more powerful (and expensive) in a year or so. Raspberry pi is a FANTASTIC place to start with Home Assistant and home automation Good luck and have fun with it! ☺️

[@bat3332]

@@HomeAutomationGuy Thank you so much for the information . Once I purchase it I will have more question untill then please keep inspiring us

[@Danish3Cubed]

You need to activate terminal, it's not on by default, I think that is worth mentioning.

[@HomeAutomationGuy]

That's a good tip, thanks for sharing!

[@FedeHippo]

I currently have 108 devices and 505 entities connected via ZHA, using the same SOnOff dongle as you do in the video. Would there be any advantages for me by goind through the hassle of moving everything to Zigbee2MQTT ?

[@HomeAutomationGuy]

Nope! I'd stay using ZHA if I was in your situation. If it ain't broke, don't fix it!

[@discodogge]

@@HomeAutomationGuy how many devices do you have in your network? And would you say it's been stable? Considering moving my 140 devices from deconz to gain better device capabilities and faster implementation of new devices.

[@TheBurnsiela]

I have around 70-80

[@TheBurnsiela]

And yes. It's been pretty stable. I've had the odd blip when someone has unplugged or switched off a router device in the middle and I've had to repair devices. But that has only happened two or three times in three years

[@discodogge]

@@TheBurnsiela yeah, that sounds alright I would say :) thanks! It's hard to find any mentions of stability in larger networks :)

[@wouter2599]

Did something happend to your blogpost. It seems rather empty with just some links to other sites instead of a step by step tutorial lika the other blogpost/videos

[@HomeAutomationGuy]

There are different steps based on your type of HA installation, which I why I've linked out to the official instructions (which are really good and detailed)

[@DanangWidiantoro]

mine is 502: bad gateway i've been waiting for while

[@CCoburn3]

Presumably, there is a similar plugin for z-wave.

[@HomeAutomationGuy]

I believe it's almost the same setup, but I've never personally used it so I'm not 100% sure

[@Maaniic]

You should probably recommend attaching the dongle on an USB extension as it can dramatically increase the range and/or reliability of the mesh(coordinator). As ZB is low power and on the heavily contested 2,4 GHz band, sitting close to the computer might disrupt it quite a lot. If you want you could also look up the frequency plans and see to it that you don't overlap with your wifi.

[@HomeAutomationGuy]

I do recommend a USB cable at 3:20.

[@Maaniic]

@@HomeAutomationGuy Ah must have looked away when watching that later part, my bad :)

[@Maaniic]

​@@HomeAutomationGuy Personally I have experimented with attaching a dongle to a RaspiZero2 with Zigbee2Mqtt so that i can have multiple coordinators remotely to Hassio.

[@tacklealto88]

Thank you!

[@lowrider692000]

got a notification that says you uploaded this 2 mins ago here it says 1 year lost now as a year in Tech may as well be 10 years lol

[@HomeAutomationGuy]

Well that's odd, I definitely uploaded it years ago! Silly KZbin!

[@iraabramowitz6027]

I am getting an invalid repository error and cannot get further, Thanks

[@iraabramowitz6027]

I added the repository after rebooting the RPi several times and typing in the url directly

[@gzcwnk]

nope 502 error....:/

[@rfehr613]

I cannot get z2m to start. I did exactly the steps in the beginning, but when i click Start it fails and says "error while starting zigbee-herdsman". I'm running a new installation of HAOS on bare metal and this is my first attempt at setting up a zigbee network. I already have mosquitto setup BTW.

[@HomeAutomationGuy]

Make sure your USB stick is mapped correctly

[@rfehr613]

I'm not sure what you mean by mapped. The dongle had the right firmware and was visible on the usb port. After a bunch of searching I finally figured it out. I had to define inputs for 'mqtt' and 'serial' on the config page. In your video you just left both blank and it still started fine. So they must have changed something since making this video, because mine absolutely refused to start without these inputs.