Zigbee2MQTT Installation Guide for Home Assistant

This guide provides instructions for setting up Zigbee2MQTT and Mosquitto broker on Home Assistant to manage Zigbee devices.

I. Preparation Work

To use Zigbee2MQTT, a Zigbee Adapter is required. This adapter acts as the interface between your computer or server running Zigbee2MQTT and the Zigbee radio communication.

Image: A black USB Zigbee adapter with an antenna, used for Zigbee communication.

II. Installing Plugins on HomeAssistant

1. Click on Settings and Add-ons

Navigate to the 'Settings' section within your Home Assistant interface, and then select 'Add-ons'.

Screenshot: Home Assistant user interface. The left sidebar displays navigation options including 'Settings' and 'Add-ons'.

2. Add Mosquitto broker and Zigbee2MQTT in the Add-on Store

Access the 'Add-on Store' to find and install the necessary components. You will need to add the Zigbee2MQTT repository first.

Screenshot: Home Assistant's 'Add-on Store' page, listing various official add-ons. The user is to select 'Mosquitto broker' and 'Zigbee2MQTT'.

Zigbee2MQTT requires adding a repository first.

Screenshot: The 'Add-on Store' with the 'Repositories' tab active. An input field is present to add a repository URL, with the URL https://github.com/zigbee2mqtt/hassio-zigbee2mqtt ready to be added.

The repository can be found at: https://github.com/zigbee2mqtt/hassio-zigbee2mqtt

3. Start the Mosquitto broker and the Zigbee2MQTT plugin

After installation, start the Mosquitto broker and the Zigbee2MQTT plugin. The interface will indicate successful operation.

Screenshot: Configuration page for the 'Mosquitto broker' add-on in Home Assistant, showing operational settings like 'Start on boot', 'Watchdog', 'Auto update', hostname, CPU/RAM usage, and control buttons (STOP, RESTART, UNINSTALL).

III. Connect the Device

1. Click on 'Open Web UI' to enter the page.

To manage your Zigbee devices, open the Zigbee2MQTT web interface.

Screenshot: Configuration page for the 'Zigbee2MQTT' add-on in Home Assistant, with the 'Open Web UI' button highlighted for accessing the device management interface.

2. Click "Permit join" to match the device.

Ensure your Zigbee device is in pairing mode, then click the "Permit join" button in the Zigbee2MQTT interface to allow new devices to connect.

Screenshot: The main Zigbee2MQTT interface, showing the 'Permit join (All)' option and a table for managing Zigbee devices. The 'Permit join' button is active.

Successfully added device.

Screenshot: The Zigbee2MQTT device list displaying a successfully paired device with details including manufacturer 'Tongou' and model 'TO-Q-SY2-163JZT'. Action icons for editing, deleting, and viewing information are visible.

	TO-Q-SA1 Smart Energy Accessory User Manual Comprehensive user manual for the Tongou TO-Q-SA1 Smart Energy Accessory. Learn about installation, configuration, product features, technical specifications, and safety guidelines. Supports Wi-Fi, Zigbee, LTE, and Matter connectivity for smart home energy management.
	Tongou TOQCB2 Smart Metering Circuit Breaker User Manual & Specifications Comprehensive user manual and technical specifications for the Tongou TOQCB2 Smart Metering Circuit Breaker, covering installation, functions, features, and safety guidelines.
	TONGOU TO-Q-SY2-JWM Smart Switch with Tasmota Firmware - User Guide Comprehensive guide for the TONGOU TO-Q-SY2-JWM Smart Switch, detailing Tasmota firmware setup, button functions, Wi-Fi connection steps, and product features including Matter protocol support.
	Tongou Smart Din Rail Switch Operating Manual: Features, Configuration, and Specifications Comprehensive operating manual for the Tongou Smart Din Rail Switch (TO-Q-SY2-JWT, TO-Q-SY2-JZT) supporting WiFi and ZigBee. Learn about its main functions, data parameters, product selection, configuration steps, features like remote control and timers, and wiring diagrams.
	Tongou TO-Q-SY1-WE & TO-Q-SY2-JWE DIN Rail Smart Switch User Manual Comprehensive user manual for Tongou's TO-Q-SY1-WE and TO-Q-SY2-JWE DIN Rail Smart Switches, covering installation, operation, features like Wi-Fi and Zigbee connectivity, and safety precautions.
	TONGOU TO-Q-SY2-JWM Smart Switch with Tasmota - User Guide & Setup Learn how to connect and configure your TONGOU TO-Q-SY2-JWM Smart Switch using Tasmota open-source software. Includes button functions, setup guide, and product overview.
	TONGOU TO-Q-SY2-JWM Smart Switch with Tasmota - Product Overview Detailed product description and connection guide for the TONGOU TO-Q-SY2-JWM smart switch featuring Tasmota open-source software and Matter protocol support.
	TONGOU TO-Q-SY2-JWM Smart Switch con Tasmota - Guida Rapida Guida rapida per il TONGOU TO-Q-SY2-JWM Smart Switch con software Tasmota open-source. Include istruzioni di connessione, funzioni del pulsante e specifiche del prodotto.