Zephyr Workshop

Welcome to this Zephyr Workshop! This workshop is designed for everyone who is new to Zephyr. This repository includes slides firmware samples and a modular application. It links to existing references on how to get started and explains basic RTOS concepts with examples.

The slides will guide you through the content and the hands-on parts of the workshop. Please check out the pdf version of the slides at the releases section

Resources to quickly get started with Zephyr:

• Zephyr Documentation
• Supported Boards
• Samples and Demos
• Zephyr GitHub Repository

Slides 📊

The slides can be downloaded as pdf file under the releases. They explain Zephyr fundamentals and how to get started with the hands-on part of the workshop.

The presentation slides are written with Latex Beamer and the mtheme. To build the presentation and generate a PDF file, execute make.

Presentation License

The content in the /slides directory is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0). A full copy of the license text is available in the LICENSE_PRESENTATION file at the root of this repository.

Firmware 🛠

Samples

There are several samples in the folder samples. These samples are mostly adapted from the Zephyr GitHub Repository and referenced here for a better overview. All samples can be built as Zephyr workspace examples.

Modular Application

The modular application is a simple example of a modular application that consists of multiple modules. Different modules communicate with each oter via Zephyr's Zbus. The application is located at ´app´, related tests are in the ´tests´ folder.

The application should run on most supported boards as it only uses a button and an led. However, if you do not have a hardware available, you can run the application with Renode. The Renode configuration is located in the utils folder. For running the application in Renode, you have to build for the stm32f4_disco board.

You can build the application as follows:

west build -b stm32f4_disco app -p

And run in Renode:

renode util/stm32f4.resc --disable-gui --console

To run and explore integration tests with twister, you can build the tests and application for mulitple boards:

west twister -T app/ -T test/ --integration

Github Codespaces Environment

Just click on the button <> Code above to create a Github Codespaces environment for the workshop. For further instructions, please refer to the slides.

Local Environment

Setup the with existing Zephyr Project Workspace

After completing the Zephyr Getting Started guide, you should already have a project folder setup. In this case, you can just clone this repository into the existing zephyrproject folder:

# clone this repository in the existing zephyrproject folder
cd zephyrproject
git clone https://github.com/jonas-rem/zephyr-workshop
# Change west config manifest file location to the zephyr-workshop repository
west config manifest.path zephyr-workshop
cd zephyr-workshop
# update Zephyr modules
west update

Setup from Scratch

To set up a new Zephyr workspace directly from this repository, west can be used with the following options:

# Initialize a workspace named zephyrproject from this repository.
west init -m https://github.com/jonas-rem/zephyr-workshop --mr main zephyrproject
# update Zephyr modules
cd zephyrproject/zephyr-workshop
west update

Building and running of the Firmware Samples

# e.g. for reel_board
west build -b reel_board samples/01_hello_world -p

# Or for a simulation that can run on the host system
west build -b qemu_cortex_m0 samples/01_hello_world -p

Once the sample is build, run the following command to flash/run it:

# on a board
west flash

# qemu simulation
west build -t run