# Zigbee2MQTT

### 1. Prerequisites:

1）Zigbee Upgrade

* iSG users upgrade the Zigbee Dongle to the ZHA version,<https://kb.linknlink.com/isg/settings/firmware-updates/zigbee-dongle-firmware>
* iSG MAX users upgrade Zigbee to the ZHA version.<https://kb.linknlink.com/isg/settings/firmware-updates/built-in-zigbee-firmware>，
* Why I Can't Get Zigbee Firmware Update on iSG Display Max，<https://kb.linknlink.com/isg/faq/others/why-i-cant-get-zigbee-firmware-update-on-isg-display-max>
* How to differentiate between iSG Display and iSG Display Max，<https://kb.linknlink.com/isg/faq/others/how-to-differentiate-between-isg-display-and-isg-display-max>

2）Remove the ZHA integration installed in Home Assistant in iSG.

3）Restart iSG

4）Go to iSG Add-on, find MQTT Broker add-on and enter the username and password you want for the MQTT service..

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2FTkctT5nOLsFAzBUjdiGN%2Fimage.png?alt=media&#x26;token=854a2051-9076-4a07-a177-553dc1237a32" alt=""><figcaption></figcaption></figure>

### 2. Install and configure Zigbee2MQTT

1）Install Zigbee2MQTT

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2Favdu8R4H10JHum0TCTKR%2Fimage.png?alt=media&#x26;token=aaa48698-b436-4ff3-965a-27084deca851" alt=""><figcaption></figcaption></figure>

2）Configure Zigbee2Mqtt

<mark style="color:red;">**Note: After you enter the information in the configuration pop-up window, click Save. If the content you entered is not displayed, please click Enter again.**</mark>

* **Original iSG**

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2F6HjBEwfpcX0Ew9V4Z04j%2Fimage.png?alt=media&#x26;token=ef8aa312-c063-4047-92c4-f0cf4de85fcc" alt=""><figcaption></figcaption></figure>

* **iSG MAX**

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2FrL4JmS8mAQI0EOVfSGrQ%2Fimage.png?alt=media&#x26;token=a505e074-0fd0-44f9-8dec-54bf22dfac4c" alt=""><figcaption></figcaption></figure>

3）Enable Service and Auto Start Service

4）Use PC web browser and enter <mark style="color:blue;">**iSG IP:8080**</mark>

5\)   Configure Zigbee2MQTT in the web page

* Make sure Zigbee2Mqtt is Not in Join Status
* Enter Settings - Home Assistant integration
* Choose Home Assistant (advanced)
* Input Home Assistant Status topic: hass/status
* Click Submit

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2F24znd7fAETcEx9voie24%2Fimage.png?alt=media&#x26;token=412143cf-110b-49ee-b380-d8fb98b42d9b" alt=""><figcaption></figcaption></figure>

### 3. Configure HA MQTT Integration

1）In HA settings - Devices & Services - Add integration, search MQTT and add to HA.

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2FNTsIJKW4wHfLuaM3hctU%2F151727435948_.pic.jpg?alt=media&#x26;token=57c94777-82d7-4b9b-a6de-d11fabafdf8b" alt=""><figcaption></figcaption></figure>

2）Click CONFIGURE MQTT

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2FUqiR0341Oj0IYRE7QmOX%2F161727436019_.pic.jpg?alt=media&#x26;token=4e2d0d84-d930-411f-b9ff-ebc49bd96c9d" alt=""><figcaption></figcaption></figure>

3）Click RE-CONFIGURE MQTT

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2FSJydZEOsRQT9eY9pVHJ8%2F171727436069_.pic.jpg?alt=media&#x26;token=3448909a-0026-4cc8-afbf-bdc4c504d480" alt=""><figcaption></figcaption></figure>

4）Fill in the Broker information from iSG Mqtt Broker add-on into here

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2FwSewtUZnJBu0PslaCV6v%2Fimage.png?alt=media&#x26;token=fa276319-2053-46a9-8f8c-264ee6a93b23" alt=""><figcaption></figcaption></figure>

### 4. Add Zigbee devices in HA

After the MQTT Integration is configured, please come back to Zigbee2MQTT page. Click "Permit join (All)" and reset your Zigbee device. The Zigbee2MQTT service will automatically discover the device and let it join in.

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2F43K12SSnFl1r9G0Vkcwl%2Fimage.png?alt=media&#x26;token=7a5980ad-93fc-4764-85eb-a07efe3ec511" alt=""><figcaption></figcaption></figure>

Now, return to Home Assistant and navigate to Devices page, you will find the Zigbee device automatically shows up.

<figure><img src="https://1561436000-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpCtFemS511EXKjNnjKqg%2Fuploads%2FBIBQd8h9PUMeb1fIONJQ%2Fimage.png?alt=media&#x26;token=84efdb10-9d72-4709-834a-2e683784f140" alt=""><figcaption></figcaption></figure>

### 5. Add devices to iSG

Go to iSG - Devices - Add Device - Home Assistant, choose devices and add to iSG