maksimdrachov / zephyr-rtos-tutorial

Zephyr: Tutorial for beginners

A step-by-step guide that teaches you how to use Zephyr RTOS. It assumes:

• knowledge of C
• no previous experience with RTOS
• basic embedded electronics knowledge (GPIO, Timers, Interrupt,...)

Each lesson builds on the previous one. Most lessons end with exercises (with solutions!) that show how the covered concepts can be used in a practical application.

This tutorial is under active development, if you want to participate - please read the Contribution guide.

A web version of this tutorial can be found here

Table of Contents

• Introduction

• Contribution guide

• Prerequisites

• Lesson 1: Zephyr Setup

  • 1.1 Installation
    • MacOS
    • Linux
    • Windows
  • 1.2 Basic Workspace Setup
    • MacOS
    • Linux
    • Windows

• Lesson 2: Introduction

  • 2.1 RTOS basics
  • 2.2 Zephyr structure
  • 2.3 Tutorial structure

• Lesson 3: Threads

  • 3.1 Introduction
  • 3.2 Commands
  • 3.3 Kconfig
  • 3.4 Exercise

• Lesson 4: GPIO

  • 4.1 Introduction
  • 4.2 Commands
  • 4.3 Kconfig
  • 4.4 Exercise

• Lesson 5: Scheduling

  • 5.1 Introduction
  • 5.2 Commands
  • 5.3 Kconfig
  • 5.4 Exercise

• Lesson 6: Logging

  • 6.1 Introduction
  • 6.2 Commands
  • 6.3 Kconfig
  • 6.4 Exercise

• Lesson 7: Debugging

  • 7.1 Introduction
  • 7.2 Commands
  • 7.3 Kconfig
  • 7.4 Exercise

• Lesson 8: Interrupts

  • 8.1 Introduction
  • 8.2 Commands
  • 8.3 Kconfig
  • 8.4 Exercise

• Lesson 9: Timers

  • 9.1 Introduction
  • 9.2 Commands
  • 9.3 Kconfig
  • 9.4 Exercise

• Lesson 10: Mutexes

  • 10.1 Introduction
  • 10.2 Commands
  • 10.3 Kconfig
  • 10.4 Exercise

Useful Links

General

• Zephyr Official Documentation
• Introduction to the Zephyr RTOS (video)
• awesome-zephyr

Youtube channels

• The Linux Foundation
• Zephyr Project

Projects using Zephyr

• Golioth: IoT cloud platform
• Battery management system
• MG100: IoT sensor module
• Anyl: Embedded crypto wallet (for IoT)
• BLE sensor
• PineTime smartwatch
• UWB position tracking
• zmk: mechanical keyboard firmware
• air quality sensor

Zephyr libraries

• Zephyr Scientific Library
• micro-ROS Zephyr module
• sof: sound/DSP firmware

Contact

Follow me on twitter: stay up to date on my latest blogs/projects

zephyr-rtos-tutorial's Issues

Zephyr Setup for Linux

I would like to write the tutorial for zephyr rtos setup for Linux environment.
Arch Linux to be more specific.
I am also learning zephyr right now.

Images not working on web version

Images are not loading on the web version, https://maksimdrachov.github.io/zephyr-rtos-tutorial/

Example link to image: "/images/2-introduction/sample-folder.png", to my understanding means it's trying to load it from the root URL, i.e. https://maksimdrachov.github.io/images/2-introduction/sample-folder.png which gives a 404

Whereas they should be, or at least they're accessable on: https://maksimdrachov.github.io/zephyr-rtos-tutorial/images/2-introduction/sample-folder.png
I think they should drop the leading forward slash but it's been a while since I did any web stuff
No idea how Just the Docs works otherwise I'd give it a go :)

Better layout / theme

I believe it would be more accessible if this used a theme such as Just the Docs, which would provide easier navigation and search functionality. (This is something I'm actively working on, at least for myself, and would like to contribute it back if possible).

Add interesting articles

• Getting Started With Zephyr: West Manifest Customization
• Getting Started With Zephyr: Devicetrees
• Getting Started With Zephyr: Kconfig

Section on Device Trees

Good work on this project. Might be good to explain more about the device tree and related.

Add license

Great tutorial! Can you add a license to the project so we know what is fair use and proper attribution?

Thanks!

K_thread_define exercise

The current exercise invoking the k_thread_design function fails to compile in v3.1.99. I had to recast my_tid using:

extern const k_tid_t name; or extern const k_tid my_tid;

I hope this helps.

new learner willing to document the process and contribute

Hi just found this gem on my learning on zephyr os API.
The official documentation has good tutorials for the kernel API. Not so much for devices...

Would you be interested in using Gitbook format?

k_sleep parameter in the latest Zephyr API

Hi,
When I try to build the code in the thread start exercise, the k_sleep gave error. I found that the parameter k_sleep takes should be in type k_timeout_t (https://docs.zephyrproject.org/apidoc/latest/group__thread__apis.html#ga48d4b041790454da4d68ac8711f29657). And the code can be changed to k_sleep(K_MSEC(500)), or change the define of SLEEPTIME.

zephyr-rtos-tutorial/exercises/threads/thread-start/src/main.c

Line 19 in 36b3f5b

#define SLEEPTIME 500

Have you thought of adding a section for drivers?

I'm in the process of developing for a board that needs to use a driver. I'm having trouble figuring out exactly how to use it. Do you have experience with using an existing Zephyr driver for UART, SPI, etc?

Broken images on web view

Many pages on the web view have broken images. For example, here https://maksimdrachov.github.io/zephyr-rtos-tutorial/docs/3-threads/introduction.html