Link Search Menu Expand Document
Zephyr Tutorial

Install

1) Install dependencies

  • Install Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  • Use brew to install the required dependencies
brew install cmake ninja gperf python3 ccache qemu dtc textmate

2) Clone Zephyr 

cd ~
mkdir zephyrproject
cd zephyrproject
git clone https://github.com/zephyrproject-rtos/zephyr

3) Install west

  • Install west
pip3 install -U west
  • Add west to path
mate etc/paths
#Add /Users/<username>/Library/Python/<version>/bin

(running pip3 show -f west shows where the binary is installed)

  • Get the Zephyr source code
west init ~/zephyrproject
cd ~/zephyrproject
west update
  • Export Zephyr CMake package:
west zephyr-export

(this allows CMake to automatically load boilerplate required for building Zephyr applications)

  • Install additional dependencies using pip3
pip3 install -r ~/zephyrproject/zephyr/scripts/requirements.txt

4) Install GNU ARM Embedded toolchain 

mate .zshenv

Add the following lines:

export ZEPHYR_TOOLCHAIN_VARIANT=GNUARMEMB
export GNUARMEMB_TOOLCHAIN_PATH=/Applications/ARM
  • Restart terminal and check if environment variables are set up correctly
echo $ZEPHYR_TOOLCHAIN_VARIANT
echo $GNUARMEMB_TOOLCHAIN_PATH

env_var_check

5) Build the Blinky sample

The board name can be found under ~/zephyrproject/zephyr/boards

cd ~/zephyrproject/zephyr/samples/basic/blinky
west build -b <board-name>  # for example: nucleo_l552ze_q

A successful build looks like this: succes_build

If you get a CMake error, this can usually be resolved by clearing the previous build: rm -rf build

6) Flash the sample 

cd ~/zephyrproject/zephyr/samples/basic/blinky
west flash

A successful flash looks like this:

succes_flash

Some boards will require installing an additional pyocd package! pyocd-error For Nucleo L552ZE-Q: pyocd pack install stm32l552zetxq (see pyocd/target_support)