The Zephyr Project RTOS is a recent effort by the Linux Foundation to provide the embedded world with a free, secure and fully-featured Real Time Operating System. It is designed from the ground up to be a modern, scalable, secure and responsive RTOS with a clear focus on IoT protocols and foundations. This open source RTOS is Apache 2.0 licensed and has a fully open development model
Recently Nordic contributed ports to all of our Cortex-M based ICs (nRF51, nRF52832 and nRF52840) as well as a fully featured, open source BLE Controller (Link Layer + HCI)that is highly optimized for the nRF5x family of ICs. This means that if you own any of the Nordic Development Kits for the nRF5x series you can clone, build and run Zephyr today and take advantage of all the features that it enables, including many standard BLE profiles, IPv6 over BLE, and a rich set of APIs and functionality that one would expect from a modern RTOS. On top of that every single line of code, including the BLE Host and Controller, are fully open source, allowing you to tweak and modify its behaviour or even extend it at will. You can even build your own controller and then use it to control it from an external Host stack or run the rest of the RTOS on your desktop computer using QEMU!
Here are some of the features that Zephyr supports:
Bluetooth Low Energy:
Build and debug:
Zephyr currently supports the following Nordic ICs:
Additionally, there's built-in support for the following nRF5x-based boards:
Important note on custom or additional boards: If your board is similar to one of the above supported ones but does not include a 32KHz external crystal, you may have to include the following lines in your prj.conf:
Since the internal RC would then need to be used as the low frequency source.
Using the nRF52832 and the nRF52 DK as an example, let's go through the steps of building, flashing and running Zephyr on it. If you want to use the official documentation instead of following this guide, please refer to:
NOTE: This instructions are valid for macOS and Linux. To build on Windows please refer to the official documentation
First we need to obtain and install a toolchain. The following toolchains are supported:
Assuming we go with GNU ARM Embedded and that you have a working native compiler and basic toolset on your machine, you can then follow the steps below:
Download and unpack GNU ARM Embedded to the folder of your choice. In this manual we will assume you've unpacked it in ~/gccarmemb/
Export the following environment variables:
$ export GCCARMEMB_TOOLCHAIN_PATH="~/gccarmemb/"
$ export ZEPHYR_TOOLCHAIN_VARIANT=gccarmemb
$ git clone https://github.com/zephyrproject-rtos/zephyr.git
$ source zephyr-env.sh
$ cd samples/bluetooth/beacon
$ mkdir build && cd build
$ cmake -DBOARD=nrf52_pca10040 ..
To flash the image into the board you will need to download and install the JLink Software and Documentation Pack and the nRF5x command-line tools. Additional information about Segger J-Link in Nordic nRF5x boards can be found in the Nordic nRF5x Segger J-Link doc page
Now you are ready to use nrfjprog to erase and program the board:
$ nrfjprog --eraseall -f nrf52
$ nrfjprog --program outdir/nrf52_pca10040/zephyr.hex -f nrf52
$ nrfjprog --reset -f nrf52
$ make flash
$ minicom -D /dev/ttyACM0 -b 115200
Using Zephyr's built-in, Nordic-contributed, BLE Controller you can actually turn any of your nRF5x-based boards into a fully featured, standard BLE Controller than you can use with external protocol stacks. The Controller supports nRF51 and nRF52, and you can configure it to support any number of connections in any role.
To do so, you only need to compile the hci_uart sample:
$ cd samples/bluetooth/hci_uart
$ mkdir build && cd build
$ cmake -DBOARD=nrf52_pca10040 ..
After that, you can flash the .hex file to your board and you already have a fully-featured BLE Controller ready to accept HCI commands. The UART settings are as follows:
Once you have built and flashed a BLE Controller to your Development Kit, you can even try it out with Linux's built-in Bluetooth stack, BlueZ!
Here's a short guide to achieving that, full instructions can be found in the Using BlueZ with Zephyr documentation page.
$ git clone git://git.kernel.org/pub/scm/bluetooth/bluez.git
$ ./bootstrap-configure --disable-android --disable-midi
You can then find btattach, btmgt and btproxy in the tools/ folder and btmon in the monitor/ folder.
Compile and flash the hci_uart example as shown above
On a separate terminal, open btmon to be able to observe all HCI traffic between BlueZ and the controller:
$ sudo btmon
$ sudo btattach -B /dev/ttyACM0 -S 1000000 -P h4
$ sudo btmgmt --index 0
NOTE: the "--index" option is the controller index. Depending on whether you already had one or more controllers connected this could be a number from 0 to N.
[hci0]# static-addr FF:02:03:04:05:FF
[hci0]# find -l
Additional documentation can be found in the btmon, btattach and btmgmt man pages.
Note: We recommend enabling the experimental features in BlueZ in order to access all of the BLE functionality. To do that edit:
And make sure that you include the -E option in bluetoothd's ExecStart:
After that reload and restart the daemon:
$ sudo systemctl daemon-reload
$ sudo systemctl restart bluetooth
Another useful feature of Zephyr is the possibility to run all or part of its codebase from QEMU, allowing you to develop and debug directly on your computer, no flashing or remote debugger required.
To enable BLE development with QEMU, first follow the instructions on the section above to build and flash a BLE Controller build onto your Development Kit. Additionally you will need to install the Zephyr SDK to compile for QEMU, since you cannot use GCC ARM Embedded at this point for it. To install the SDK (Linux only) follow the steps detailed here.
Make sure you have a recent Linux kernel installed (at least 4.6) and a modern (5.42+) version of the BlueZ userspace tools.
$ sudo btattach -B /dev/ttyACM0 -S 1000000 -R
$ sudo btproxy -i 0 -u
NOTE: Replace -i 0 with the index corresponding to your Zephyr-based BLE Controller
$ cd samples/bluetooth/peripheral_hr
$ make qemu
At this point you are running the application, RTOS and the Bluetooth Host on QEMU locally on your development computer, but the controller on the nRF5x on the Development Kit. They interface using standard HCI, and you will see all traffic being sent between the two in your btmon window.
Happy coding! If you try Zephyr out on the nRF5x and have feedback for us, please feel free to leave a comment in the blog post or tweet to us at @NordicTweets.
Also if you want to get involved with Zephyr, or simply need help as a user, you can join the Zephyr mailing list or join the #zephyrproject IRC channel.
is it stable on nrf5283
Hello, very useful software thanks for doing this! I would like to advertise as a public address. Is there an option or code change I can do for this?
I have filed an issue related to HCI UART sample from zephyr. I am able to get it working with the ttyUSBx interface but I am not able to use the UART interface through an external USB-UART converter (CP2102 ). I btattach the dev/ttyUSBx and monitor the process with btmon,It indicates that the 52832 chip running hci_uart sample does not respond to the Linux host who sends hci reset command to it.Is anyone met this problem before ？ I don't know to debug and resolve this problem.
@lalit-tmt please join us on IRC (#zephyrproject) or send an email to the mailing list: lists.zephyrproject.org/.../
Can Any one help me to how to setup for mesh sample of Zephyr??Thanks in advance..