# Zigbee Devices

## **1. Install Zigbee Adapters**

If you have followed the optional steps for Zigbee when installing CUBE, you can jump to [Step 2](#id-2.-initialize-zigbee) to initialize your dongle as your Zigbee network coordinator. 

Before adding a Zigbee device, you need a Zigbee adapter, typically a USB dongle. Insert the Zigbee adapter into the USB port of the device running CUBE OS.

**For Virtual Machine Users**: After inserting the Zigbee adapter, add it to the virtual machine settings and restart CUBE. Detailed steps can be found in the virtual machine [installation guide](https://cube.ewelink.cc/getting-started/quickstart/virtual-machine).

### **1.1 Compatible Adapters**

CUBE is compatible with various Zigbee adapters from different manufacturers. It currently supports protocol stacks such as EZSP, Deconz, Zstack, and Zigate. Although any adapter supporting these protocol stacks can be used, the following are recommended:

> SONOFF ZBDongle-MAX\
> SONOFF ZBDongle-PMG24\
> SONOFF ZBDongle-LMG21\
> SONOFF ZBDongle-E\
> SONOFF ZBDongle-P\
> [Others listed](https://darkxst.github.io/silabs-firmware-builder/) by developer @darkxst 

## **2. Initialize Zigbee**

{% stepper %}
{% step %}
To add a device, click the “Add Device” button on the device’s homepage.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FdrmISytAApUiRPfkcSKr%2FScreenshot%202024-11-27%20at%2016.27.26.png?alt=media&#x26;token=cfb4a774-b7d2-4a1c-8343-b675cf14ff37" alt="" data-size="original">
{% endstep %}

{% step %}
Start pairing, and select “Continue Setup” in the pop-up window to automatically detect your inserted Zigbee adapter.&#x20;

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2Fpei07hfzpgvfRQRAAZKY%2FScreenshot%202024-11-15%20at%2018.10.39.png?alt=media&#x26;token=01f31b8c-c60f-4e53-a6d3-60cca7bfbb44" alt="" data-size="original">

Once the adapter is automatically discovered, select the Zigbee adapter you wish to use from the list and click “Confirm” to complete the configuration.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FZrl4qny62yziSbwXvxcM%2FScreenshot%202024-11-15%20at%2018.10.45.png?alt=media&#x26;token=185620a4-750d-45b7-88f8-a1344ee125d8" alt="" data-size="original">
{% endstep %}

{% step %}
If your Zigbee adapter is not detected, you may manually add it by inputting the necessary information:

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FKnWEVsVaFJXSSKMSFZOi%2FScreenshot%202024-11-27%20at%2016.37.09.png?alt=media&#x26;token=cc946496-6b43-444f-a523-af57edd56779" alt="" data-size="original">

* **Serial Path**: Check the “All Hardware” section on the settings page for the serial port path of the inserted Zigbee adapter.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FpVaENyLH4CszLMlPdb29%2FScreenshot%202024-11-27%20at%2016.38.47.png?alt=media&#x26;token=607a3e56-fcac-46cc-afea-dc1b1f7b58ea" alt="" data-size="original">

* **Protocol Stack Type**: Currently supports EZSP, Deconz, ZStack, and Zigate. Check the adapter’s purchase site for the corresponding protocol stack type.
* **Port Speed**: Optional, not applicable to all Zigbee adapters.
* **Data Flow**: Optional, not applicable to all Zigbee adapters.
  {% endstep %}

{% step %}
Submit the configuration by clicking confirm. If successful, you can add Zigbee devices. In case of a failure, check the specific error message.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2Fpr3hIv1y4QGmS8HbfD9U%2FScreenshot%202024-11-18%20at%2016.38.47.png?alt=media&#x26;token=836f18b5-0939-4d44-9bf8-750becece0d9" alt="" data-size="original">
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Since a Zigbee network can only have one adapter configuration, multiple setups are not supported. If a configured adapter is removed and then reinserted, it will attempt to automatically restore itself without needing reconfiguration.
{% endhint %}

## **3. Add Zigbee Devices**

{% stepper %}
{% step %}
After configuration, on the add device page, click “Start Pairing” to add Zigbee devices in pairing mode automatically.

{% hint style="info" %}
If your Zigbee device is not found, ensure the device is in network configuration mode and check for excessive surrounding radio interference.
{% endhint %}

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FhumPj2kUuggjxHsDnoj6%2FScreenshot%202024-11-27%20at%2016.42.05.png?alt=media&#x26;token=52b24ea2-ccdc-4070-9603-59d578cec024" alt="" data-size="original">
{% endstep %}

{% step %}
Discovered Zigbee devices will then be added to your CUBE OS, ready to assign a room or edit the name.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FwGmUkBGsYaKSimVBqYZA%2FScreenshot%202024-11-15%20at%2018.11.36.png?alt=media&#x26;token=9d0ab73f-ac71-4c35-b96d-b073e8ef3b7d" alt="" data-size="original">
{% endstep %}
{% endstepper %}

{% hint style="info" %}
The total number of Zigbee devices that can be added is limited, depending on the adapter's hardware and firmware.&#x20;

In certain cases, you need to add extra router devices (e.g. smart plugs, lights, signal repeaters) to add more battery-powered devices like sensors.
{% endhint %}

## 4. Potential Compatibility

CUBE is **compatible with hundreds of Zigbee devices**. However, substantial differences exist between products from different manufacturers due to the complexity and wide range of devices. This means compatibility with all devices cannot be guaranteed, but improvements will be made iteratively.

Please direct you to check the <https://cube-web.ewelink.cc/> to check the compatibility.