Golioth Zephyr Training

Overview

This repository contains the code for Golioth's self-guided Zephyr training using the nRF7002-DK or the nRF9160-DK. Please visit Golioth's Developer Training Docs to learn Zephyr with us.

Local set up

Do not clone this repo using git. Zephyr's west meta tool should be used to set up your local workspace.

Install the Python virtual environment (recommended)

cd ~
mkdir zephyr-training
python -m venv zephyr-training/.venv
source zephyr-training/.venv/bin/activate
pip install wheel west

Use west to initialize and install

cd ~/zephyr-training
west init -m [email protected]:golioth/zephyr-training.git .
west update
west zephyr-export
pip install -r deps/zephyr/scripts/requirements.txt

Building the Training Applications

Each numbered directory contains a different applications used in the training.

Storing Device Credentials

After flashing firmware to the device (see below) you will need to store your WiFi and Golioth credentials in flash memory. Perform this task using a serial terminal and the following commands:

uart:~$ settings set wifi/ssid <my-wifi-ap-ssid>
uart:~$ settings set wifi/psk <my-wifi-ap-password>
uart:~$ settings set golioth/psk-id <my-psk-id@my-project>
uart:~$ settings set golioth/psk <my-psk>
uart:~$ kernel reboot cold

These credentials will be stored in the settings partition and will survive new application firmware flashed directly, or via OTA update.

Note: The WiFi security type must be specified as a Kconfig command. Looks for a section on this in the prj.conf file. The default is WPA2.

01-IOT

# Enable the Python virtual environment
$ cd ~/zephyr-training
$ source .venv/bin/activate

# Build the application
$ (.venv) cd app
# Choose one of the following build commands:
# For nRF7002dk
$ (.venv) west build -b nrf7002dk/nrf5340/cpuapp 01_IOT
# For nRF9160dk
$ (.venv) west build -b nrf9160dk/nrf9160/ns 01_IOT

# Flash the binary to your device
$ (.venv) west flash

Using Codespaces

When using Codespaces, the compiled binary must be downloaded and flashed to your device locally using the nRF Connect for Desktop programmer app.

Use the following command to copy a compiled hex file to the Download folder. (A timestamp and the name of the app will be added to the filename.)

$ (.venv) west download

For help, please consult the Build Your First Zephyr App section of the Developer Training docs.