https://github.com/osresearch/ZbPy

MicroPython IEEE802.15.4 / Zigbee parser
https://github.com/osresearch/ZbPy

Last synced: 2 months ago
JSON representation

MicroPython IEEE802.15.4 / Zigbee parser

• Host: GitHub
• URL: https://github.com/osresearch/ZbPy
• Owner: osresearch
• Created: 2019-12-26T09:57:04.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-12T10:08:50.000Z (almost 4 years ago)
• Last Synced: 2024-01-28T08:09:44.233Z (5 months ago)
• Language: Python
• Size: 258 KB
• Stars: 43
• Watchers: 6
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Lists

• awesome-micropython - ZbPy - MicroPython IEEE802.15.4 / Zigbee parser. (Libraries / Communications)

README

        
# Gecko Zigbee Python interface

This is a pure Python implementation of a IEEE802.15.4 and ZigBee network stack

that works with MicroPython.

It was developed for the Silicon Labs Gecko boards used in

Ikea Tradfri devices.  The firmware port of MicroPython lives in

[osresearch/micropython/ports/efm32](https://github.com/osresearch/micropython/tree/efm32/ports/efm32).

The underlying ZigBee radio interface also lives in the machine specific

port for that board; this is the hardware agnostic software stack that

processes the packets.

For more information on the project, see [Ikea+Micropython lightning talk](https://trmm.net/Ikea).

# Installing

![Ikea Tradfri remote with header attached](images/ikea-remote.jpg)

See the

[README](https://github.com/osresearch/micropython/blob/efm32/ports/efm32/README.md)

in the MicroPython port for details on building and installing using OpenOCD + SWD.

Using [`ampy.py`](https://learn.adafruit.com/micropython-basics-load-files-and-run-code/install-ampy) you can

install all of the code from the `ZbPy` directory into the flash on the device.

# ZigBee network layers

* Phyiscal layer (handled by the radio, supported via `import Radio`)

* IEEE802.15.4: `import ZbPy.IEEE802154`

* NWK - Network Layer: `import ZbPy.ZigbeeNetwork`

* Security Layer (not really a layer, an optional part of the NWK header)

* APS - Application Support Layer: `import ZbPy.ZigbeeApplication`

* ZCL - ZigBee Cluster Library: `import ZbPy.ZigbeeCluster`

Most of the layers are sufficiently implemented to join an

existing Zigbee network, receive a 16-bit short network address,

decrypt+validate and encrypt+mac messages encrypted with the

[AES-CCM mode](https://en.wikipedia.org/wiki/CCM_mode).

The Application and Cluster layers are only partially

implemented right now; the messages are decoded but not

mapped to functionality.

Perhaps parts of [ZigPy](https://github.com/zigpy/zigpy) can be 

ported to MicroPython to provide these mappings.

# Debugging Zigbee

It is easiest to use `zbsniff` in this tree, talking to an

Ikea device on `/dev/ttyACM0`, which will output a PCAP file

on stdout.  You can pipe this to `wireshark` to trace what

is going on:

```

zbsniff | wireshark -k -i -

```

However, there is lots of "noise" in the Zigbee protocol

with repeat messages, acks, etc that make the wireshark

display messy.

Don't display acks: `!(wpan.frame_type == 0x2)`

Don't display repeats: `(!(wpan.frame_type == 0x1) || wpan.src16 == zbee_nwk.src)`