Zigbee Module

Zigbee is a self-organizing network communication module launched by M5Stack. The module adopts the CC2630F128 solution, integrates the Zigbee protocol stack internally, and provides an open serial communication interface. It features an external antenna, with a stable single-node communication distance of up to 1 km and supports up to 200 levels of router depth. Through MESH networking, it can significantly extend the range of your IoT applications, offering both ultra-low power consumption and high sensitivity. The Zigbee network can support hundreds of nodes and has enhanced security features, providing a complete and interoperable IoT solution for home and building automation.

Support the following products:

Micropython TX Example:

# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from module import ZigbeeModule
import time


label0 = None
com_zigbee_0 = None
zigbee_0 = None


def setup():
    global label0, com_zigbee_0, zigbee_0

    M5.begin()
    Widgets.fillScreen(0x222222)
    label0 = Widgets.Label("label0", 32, 35, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)

    com_zigbee_0 = ZigbeeModule(2, 17, 18, verbose=True)
    com_zigbee_0.set_module_param(
        ZigbeeModule.DEVICE_TYPE_COORDINATOR,
        0x1620,
        11,
        ZigbeeModule.TRANSFER_MODE_PASS_THROUGH,
        0x6677,
    )
    label0.setText(str("start"))


def loop():
    global label0, com_zigbee_0, zigbee_0
    M5.update()
    com_zigbee_0.p2p_transmission(0x0066, "p2p")
    time.sleep(3)
    com_zigbee_0.broadcast("broadcast")
    time.sleep(3)


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            com_zigbee_0.stop_receive()
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

Micropython RX Example:

# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from module import ZigbeeModule


label0 = None
com_zigbee_0 = None


zigbee_str_data = None
zigbee_dest_address = None
zigbee_src_address = None


def com_zigbee_0_receive_event(dest_address, src_address, received_data):
    global label0, com_zigbee_0, zigbee_str_data, zigbee_dest_address, zigbee_src_address
    zigbee_dest_address = dest_address
    zigbee_src_address = src_address
    try:
        zigbee_str_data = received_data.decode()
    except:
        zigbee_str_data = str(received_data)
    label0.setText(str(zigbee_str_data))


def setup():
    global label0, com_zigbee_0, zigbee_str_data, zigbee_dest_address, zigbee_src_address

    M5.begin()
    Widgets.fillScreen(0x222222)
    label0 = Widgets.Label("label0", 50, 34, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)

    com_zigbee_0 = ZigbeeModule(2, 14, 13, verbose=True)
    com_zigbee_0.set_module_param(
        ZigbeeModule.DEVICE_TYPE_ROUTER,
        0x1620,
        11,
        ZigbeeModule.TRANSFER_MODE_PASS_THROUGH,
        0x0066,
    )
    while not (com_zigbee_0.isconnected()):
        pass
    label0.setText(str(com_zigbee_0.get_custom_address()))
    com_zigbee_0.receive_none_block(com_zigbee_0_receive_event)


def loop():
    global label0, com_zigbee_0, zigbee_str_data, zigbee_dest_address, zigbee_src_address
    M5.update()


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            com_zigbee_0.stop_receive()
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

UIFLOW2 TX Example:

UIFLOW2 RX Example:

cores3_zigbee_tx_example.m5f2

stickc_plus2_zigbee_rx_example.m5f2

class ZigbeeModule

Constructors

class ZigbeeModule(id: Literal[0, 1, 2], port: list | tuple, verbose: bool = True)

Create a Zigbee unit.

Parameters:

id – The ID of the unit.
port – The port that the unit is connected to.
verbose – Print the log information. Default is True.

UIFLOW2:

Methods

ZigbeeModule.set_module_param(device_type: int, pan_id: int, channel: int, transfer_mode: int, custom_address: int, ant_type: int, encryption_enable=ENCRYPTION_ENABLE, encryption_key=b'\x11\x12\x13\x14', node_type=DEVICE_TYPE_ROUTER, node_ant_type=ANT_TYPRE_ON_BOARD, node_transfer_mode=TRANSFER_MODE_PASS_THROUGH, node_custom_address=0x0066)

Parameters:

device_type (int) – The device type of the Zigbee module.
pan_id (int) – The PAN ID of the Zigbee module. The PAN ID is a 16-bit value that is used to identify the network.
channel (int) – The channel of the Zigbee module. The channel range is from 11 to 26
transfer_mode (int) – The transfer mode of the Zigbee module.
custom_address (int) – The custom address of the Zigbee module.
ant_type (int) – The antenna type of the Zigbee module.
encryption_enable (int) – The encryption status of the Zigbee module.
encryption_key (bytes) – The encryption key of the Zigbee module.
node_type (int) – The node type of the Zigbee module.
node_ant_type (int) – The antenna type of the Zigbee node.
node_transfer_mode (int) – The transfer mode of the Zigbee node.
node_custom_address (int) – The custom address of the Zigbee node.

Set the parameters of the Zigbee module.

UIFLOW2:

ZigbeeModule.set_device_type(device_type: int)

Parameters:: device_type (int) – The device type of the Zigbee module.

Set the device type of the Zigbee module.

UIFLOW2:

ZigbeeModule.set_pan_id(pan_id: int)

Parameters:: pan_id (int) – The PAN ID of the Zigbee module.

Set the PAN ID of the Zigbee module.

UIFLOW2:

ZigbeeModule.set_channel(channel: int)

Parameters:: channel (int) – The channel of the Zigbee module.

Set the channel of the Zigbee module.

UIFLOW2:

ZigbeeModule.set_transfer_mode(transfer_mode: int)

Parameters:: transfer_mode (int) – The transfer mode of the Zigbee module.

Set the transfer mode of the Zigbee module.

UIFLOW2:

ZigbeeModule.get_custom_address() → int

Get the custom address of the Zigbee module.

Returns:: The custom address of the Zigbee module.

UIFLOW2:

ZigbeeModule.set_custom_address(custom_address: int)

Parameters:: custom_address (int) – The custom address of the Zigbee module.

Set the custom address of the Zigbee module.

UIFLOW2:

ZigbeeModule.set_ant_type(ant_type: int)

Parameters:: ant_type (int) – The antenna type of the Zigbee module.

Set the antenna type of the Zigbee module.

UIFLOW2:

ZigbeeModule.get_short_address() → int

Get the short address of the Zigbee module.

Returns:: The short address of the Zigbee module.

UIFLOW2:

ZigbeeModule.isconnected() → bool

Check whether the Zigbee module is connected to the Zigbee network.

Returns:: True if the Zigbee module is connected to the Zigbee network, False otherwise.

UIFLOW2:

ZigbeeModule.receive_none_block(receive_callback)

Parameters:: receive_callback – The callback function that is called when the Zigbee module receives data.

Receive data from the Zigbee module.

UIFLOW2:

ZigbeeModule.stop_receive()

Stop receiving data from the Zigbee module.

UIFLOW2:

ZigbeeModule.p2p_transmission(address: int, data: bytes)

Parameters:

address (int) – The custom address of the Zigbee module that the data is sent to.
data (bytes) – The data that is sent to the Zigbee module.

Send data to the Zigbee module.

UIFLOW2:

ZigbeeModule.broadcast(data: bytes)

Parameters:: data (bytes) – The data that is sent to the Zigbee module.

Broadcast data to all Zigbee modules.

UIFLOW2: