|
17 | 17 | <a href="https://discord.gg/dadfWYE">
|
18 | 18 | <img src="https://img.shields.io/discord/556563650429583360.svg">
|
19 | 19 | </a>
|
| 20 | + <a href="http://zigbee2mqtt.discourse.group/"> |
| 21 | + <img src="https://img.shields.io/discourse/https/zigbee2mqtt.discourse.group/status.svg"> |
| 22 | + </a> |
20 | 23 | </div>
|
21 | 24 | <h1>Official Zigbee2MQTT Home Assistant add-on</h1>
|
22 | 25 | </div>
|
23 | 26 |
|
24 |
| -> [!CAUTION] |
25 |
| -> If you're using a Raspberry Pi, ensure you have at least a Raspberry Pi 4, as running it on a Raspberry Pi 3 may cause instability due to its limited resources. |
26 |
| -
|
27 | 27 | ## Installation
|
28 | 28 |
|
29 | 29 | 1. If you don't have an MQTT broker yet; in Home Assistant go to **[Settings → Add-ons → Add-on store](https://my.home-assistant.io/redirect/supervisor_store/)** and install the **[Mosquitto broker](https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_mosquitto)** add-on, then start it.
|
|
33 | 33 | - **Zigbee2MQTT** is the stable release that tracks the released versions of Zigbee2MQTT. (**recommended for most users**)
|
34 | 34 | - **Zigbee2MQTT Edge** tracks the `dev` branch of Zigbee2MQTT such that you can install the edge version if there are features or fixes in the Zigbee2MQTT dev branch that are not yet released.
|
35 | 35 | 1. Click on the add-on and press **Install** and wait till the add-on is installed.
|
| 36 | +1. Click on **Configuration** |
| 37 | + - If you are **not** using the Mosquitto broker add-on fill in your MQTT details (leave empty when using the Mosquitto broker add-on) under the `mqtt` section. Format can be found [here](https://www.zigbee2mqtt.io/guide/configuration/mqtt.html#server-connection), but skip the initial `mqtt:` indent. e.g.: <br> |
| 38 | + ```yaml |
| 39 | + server: mqtt://localhost:1883 |
| 40 | + user: my_user |
| 41 | + password: "my_password" |
| 42 | + ``` |
| 43 | + Note: If the `password` includes certain special characters (reserved by yaml specification), the enclosing quotes are required. So it is recommended to always quote it when in doubt. |
| 44 | + - Since Zigbee2MQTT automatically attempts to detect the adapter, you can leave the `serial` section empty for now; we may need it later in step 7. |
| 45 | + - Click **Save** |
| 46 | + - **Tip:** it is possible to refer to variables in the Home Assistant `secrets.yaml` file (not the Zigbee2MQTT one!) by using e.g. `password: '!secret mqtt_pass'` |
| 47 | + - **CAUTION:** settings configured through the add-on configuration page will take precedence over settings in the `configuration.yaml` page (e.g. you set `rtscts: false` in add-on configuration page and `rtscts: true` in `configuration.yaml`, `rtscts: false` will be used). |
36 | 48 | 1. Start the add-on by going to **Info** and click **Start**
|
37 |
| -1. Wait a few seconds and press **OPEN WEB UI**, you will now see the onboarding page. More information about the onboarding can be found [here](https://www.zigbee2mqtt.io/guide/getting-started/#onboarding). |
38 |
| -1. Fill in the desired settings, for most setups changing the following is enough: |
39 |
| - - Select your adapter under _Found Devices_, this will configure the _Coordinator/Adapter Port/Path_ and _Coordinator/Adapter Type/Stack/Driver_. |
40 |
| - - Fill in the _Closests WiFi Channel_ to select the most optimal Zigbee channel. |
41 |
| -1. Press **Submit**, Zigbee2MQTT will now start, wait a few seconds and refresh the page. You should now see the Zigbee2MQTT frontend. |
| 49 | +1. Wait till Zigbee2MQTT starts and press **OPEN WEB UI** to verify Zigbee2MQTT started correctly. |
42 | 50 | - If it shows `502: Bad Gateway` wait a bit more and refresh the page.
|
43 | 51 | - If this takes too long (e.g. 2 minutes +) check the **Log** tab to see what went wrong.
|
44 |
| - - In case the add-on fails to start with the following error: `USB adapter discovery error (No valid USB adapter found). Specify valid 'adapter' and 'port' in your configuration.`, we need to fill in the `serial` section. Format can be found [here](https://www.zigbee2mqtt.io/guide/configuration/adapter-settings.html#adapter-settings), but skip the initial `serial:` indent. e.g.: <br> |
| 52 | + - In case the add-on fails to start with the following error: `USB adapter discovery error (No valid USB adapter found). Specify valid 'adapter' and 'port' in your configuration.`, we need to fill in the `serial` section (which we skipped in step 5). Format can be found [here](https://www.zigbee2mqtt.io/guide/configuration/adapter-settings.html#adapter-settings), but skip the initial `serial:` indent. e.g.: <br> |
45 | 53 | ```yaml
|
46 |
| - adapter: zstack |
47 | 54 | port: /dev/serial/by-id/usb-Texas_Instruments_TI_CC2531_USB_CDC___0X00124B0018ED3DDF-if00
|
| 55 | + adapter: zstack |
48 | 56 | ```
|
49 | 57 | If you don't know the port and you have just one USB device connected to your machine try `/dev/ttyUSB0` or `/dev/ttyAMA0`. Else use the [Home Assistant CLI](https://www.home-assistant.io/common-tasks/os#home-assistant-via-the-command-line) and execute `ha hardware info` to find out.
|
50 | 58 |
|
|
0 commit comments