Zephyr BuzzNode

https://github.com/zephyrproject-rtos/example-application

Getting Started

Before getting started, make sure you have a proper Zephyr development environment. Follow the official Zephyr Getting Started Guide.

Also make sure that your virtual Python environment has additional dependencies installed - inside your virtual environment, run:

pip install grpcio-tools nanopb protobuf

Initialization

source ~/zephyrproject/.venv/bin/activate

west init -m https://github.com/BuzzVerse/buzznode --mr main buzznode
cd buzznode

west config manifest.project-filter -- +nanopb
west update
west blobs fetch hal_espressif
west blobs fetch hal_stm32
cd buzznode/
git submodule update --init --recursive

Registering a device

west register-device --help
west register-device --join-eui 70B3D57ED0000001

Building and running BuzzNode ESP32

First time system build:

west build -b lora_node/esp32s3/procpu -p always app --sysbuild
west flash --esp-device [path to device]

where path to device is e.g. /dev/ttyACM0 or /dev/cu.usbmodem101

To build the application, run the following command:

west build -b lora_node/esp32s3/procpu -p always app

Once you have built the application, run the following command to flash it:

west flash --esp-device [path to device]

Monitor logs:

west espressif monitor -p [path to device]

Building and running STM32

Build:

west build -b nucleo_wl55jc -p always app --sysbuild

Flash:

west flash

Monitor logs:

minicom -D [path to device]

Testing

To execute Twister integration tests, run the following command:

west twister -T tests --integration

Documentation

A minimal documentation setup is provided for Doxygen and Sphinx. To build the documentation first change to the doc folder:

cd doc

Before continuing, check if you have Doxygen installed. It is recommended to use the same Doxygen version used in CI. To install Sphinx, make sure you have a Python installation in place and run:

pip install -r requirements.txt

API documentation (Doxygen) can be built using the following command:

doxygen

The output will be stored in the _build_doxygen folder. Similarly, the Sphinx documentation (HTML) can be built using the following command:

make html

The output will be stored in the _build_sphinx folder. You may check for other output formats other than HTML by running make help.