Zephyr

https://github.com/zephyrproject-rtos/zephyr
Admin
Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized,...
Tokens:4,285,014
Snippets:33,280
Trust Score:9.6
License:Apache-2.0
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Setup: Initialize and advertise

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/bluetooth/shell/audio/bap_scan_delegator.rst

Initializes the Bluetooth stack, initializes the Scan Delegator service, and starts advertising. The output confirms advertising started.

```console
uart:~$ bt init
uart:~$ bap_scan_delegator init
uart:~$ bt advertise on
Advertising started
```

--------------------------------

### Download and run litex_setup.py

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/enjoydigital/litex_vexriscv/doc/index.rst

Downloads and runs the LiteX setup script to initialize and install LiteX with a chosen configuration (minimal, standard, or full). The --user flag installs to the user directory.

```bash
wget https://raw.githubusercontent.com/enjoy-digital/litex/master/litex_setup.py
chmod +x litex_setup.py
./litex_setup.py --init --install --user (--user to install to user directory) --config=(minimal, standard, full)
```

--------------------------------

### Setup: bt init and bt advertise on

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/bluetooth/shell/audio/tbs.rst

Initializes the Bluetooth stack and starts advertising. This is the prerequisite for using the TBS client interactively.

```console
uart:~$ bt init
uart:~$ bt advertise on
Advertising started
```

--------------------------------

### Setup MCU+ SDK with west and download components

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/ti/common/doc/k3/am64x-am243x-mcuplus-sdk.rst

Commands to set up a Python virtual environment, install west, initialize the MCU+ SDK manifest, update repositories, and run the download_components.sh script. Replace 'am243x/dev.yml' with 'am243x/dev.yml' if you want fewer repositories. Pass '--skip_doxygen=true' and '--skip_ccs=true' to skip those components.

```shell
python3 -m venv .venv
source .venv/bin/activate
pip3 install west
west init -m https://github.com/TexasInstruments/mcupsdk-manifests.git --mr mcupsdk_west --mf am243x/dev.yml
west update
./mcupsdk_setup/am243x/download_components.sh --skip_doxygen=true --skip_ccs=true
```

--------------------------------

### Start STM32MP1 SDK environment

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/96boards/avenger96/doc/index.rst

Command to source the SDK environment setup script. Required before starting OpenOCD.

```console
source <SDK installation directory>/environment-setup-cortexa7hf-neon-vfpv4-openstlinux_weston-linux-gnueabi
```

--------------------------------

### Start QEMU

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/drivers/ethernet/eth_ivshmem/README.rst

Start QEMU with the arm64 argument, which should boot Linux and drop into a shell.

```console
./start-qemu.sh arm64
```

--------------------------------

### Sample console output

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/subsys/video/capture_to_lvgl/README.rst

Example console output showing device name, supported formats and resolutions, selected format, and capture start.

```console
[00:00:02.779,000] <inf> main: - Device name: dcmi@48020000
[00:00:02.779,000] <inf> main: - Capabilities:
[00:00:02.779,000] <inf> main:   RGBP width [160; 160; 0] height [120; 120; 0]
[00:00:02.779,000] <inf> main:   RGBP width [176; 176; 0] height [144; 144; 0]
[00:00:02.780,000] <inf> main:   RGBP width [240; 240; 0] height [160; 160; 0]
[00:00:02.780,000] <inf> main:   RGBP width [320; 320; 0] height [240; 240; 0]
[00:00:02.780,000] <inf> main:   RGBP width [352; 352; 0] height [288; 288; 0]
[00:00:02.780,000] <inf> main:   RGBP width [640; 640; 0] height [480; 480; 0]
[00:00:02.780,000] <inf> main:   RGBP width [800; 800; 0] height [600; 600; 0]
[00:00:02.780,000] <inf> main:   RGBP width [1024; 1024; 0] height [768; 768; 0]
[00:00:02.780,000] <inf> main:   RGBP width [1280; 1280; 0] height [1024; 1024; 0]
[00:00:02.780,000] <inf> main:   RGBP width [1600; 1600; 0] height [1200; 1200; 0]
[00:00:02.780,000] <inf> main:   JPEG width [160; 160; 0] height [120; 120; 0]
[00:00:02.780,000] <inf> main:   JPEG width [176; 176; 0] height [144; 144; 0]
[00:00:02.780,000] <inf> main:   JPEG width [240; 240; 0] height [160; 160; 0]
[00:00:02.780,000] <inf> main:   JPEG width [320; 320; 0] height [240; 240; 0]
[00:00:02.780,000] <inf> main:   JPEG width [352; 352; 0] height [288; 288; 0]
[00:00:02.780,000] <inf> main:   JPEG width [640; 640; 0] height [480; 480; 0]
[00:00:02.780,000] <inf> main:   JPEG width [800; 800; 0] height [600; 600; 0]
[00:00:02.780,000] <inf> main:   JPEG width [1024; 1024; 0] height [768; 768; 0]
[00:00:02.780,000] <inf> main:   JPEG width [1280; 1280; 0] height [1024; 1024; 0]
[00:00:02.780,000] <inf> main:   JPEG width [1600; 1600; 0] height [1200; 1200; 0]
[00:00:02.852,000] <inf> main: - Format: RGBP 160x120 320
[00:00:02.854,000] <inf> main: - Capture started
```

--------------------------------

### Setup the virtual disk image

Source: https://github.com/zephyrproject-rtos/zephyr/wiki/Boot-Zephyr-from-SYSLINUX

Creates a 100MB disk image, partitions it as MSDOS with a bootable primary partition, and attaches it to a loop device. The output shows the loop device name (/dev/loopX), with an example note that X can be any number (e.g., 5).

```bash
$ dd if=/dev/zero of=disk.img bs=$((1024 * 1024)) count=100
$ parted -s disk.img mktable msdos mkpart primary 0 100% toggle 1 boot
$ sudo losetup --show -Pf disk.img
/dev/loopX
```

```bash
$ sudo chown $LOGNAME:$LOGNAME /dev/loopX*
$lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
loopX 7:0 0 100M 0 loop 
└─loopXp1 259:6 0 100M 0 loop
$ mkfs.fat -F32 /dev/loopXp1
$ sudo mount -o uid=$(id -u) /dev/loopXp1 /mnt
```

--------------------------------

### Example west workspace directory structure

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/develop/west/basics.rst

Shows the layout of a typical west workspace after following the getting started guide. The topdir is named zephyrproject, and it contains the .west directory, the manifest repository (zephyr), and projects such as zcbor and net-tools.

```none
zephyrproject/                 # west topdir
├── .west/                     # marks the location of the topdir
│   └── config                 # per-workspace local configuration file
│
│   # The manifest repository, never modified by west after creation:
├── zephyr/                    # .git/ repo
│   ├── west.yml               # manifest file
│   └── [... other files ...]
│
│   # Projects managed by west:
├── modules/
│   └── lib/
│       └── zcbor/             # .git/ project
├── tools/
│   └── net-tools/             # .git/ project
└── [ ... other projects ...]
```

--------------------------------

### Build and run hello_world sample on qemu_x86 with west build -t run

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/develop/west/build-flash-debug.rst

Runs the hello_world sample for the qemu_x86 board on QEMU in one command. This is useful for host platforms with QEMU.

```bash
west build -b qemu_x86 -t run samples/hello_world
```

--------------------------------

### Set up aiocoap CoAP TCP server

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/net/sockets/coap_client_tcp/README.rst

Install aiocoap, create a file root, and start a CoAP TCP file server on port 5683. This is the server setup required before running the sample.

```bash
python -m pip install "aiocoap[all]"
mkdir file_root
echo "Hello from CoAP TCP!" > file_root/test
aiocoap-fileserver --bind "coap+tcp://[::]:5683" file_root
```

--------------------------------

### Show net-setup.sh help

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/networking/native_sim_setup.rst

Display the available options for the net-setup.sh script to tweak its behavior.

```console
./net-setup.sh --help
```

--------------------------------

### Sample output from TFTP client

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/net/tftp_client/README.rst

Example output from running the TFTP client sample on native_sim, showing network initialization, received data, and completion of get and put operations.

```bash
<inf> net_config: Initializing network
<inf> net_config: IPv4 address: 192.0.2.1
<inf> net_tftp_client_app: Run TFTP client
<inf> net_tftp_client_app: Received data:
        74 65 73 74 74 66 74 70  66 6f 72 7a 65 70 68 79 |testtftp forzephy
        72 0a                                            |r.
<inf> net_tftp_client_app: TFTP client get done
<inf> net_tftp_client_app: TFTP client put done
```

--------------------------------

### Example CMakeLists.txt for MCUmgr handler (Zephyr module and Application)

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/device_mgmt/mcumgr_handlers.rst

These are example CMakeLists.txt files used by the build system to setup files to compile, include directories, and specify options. The Zephyr module version is from example_as_module/CMakeLists.txt, and the Application version is from CMakeLists.txt with content starting after 'Include handler files'.

```cmake
.. literalinclude:: ../../../tests/subsys/mgmt/mcumgr/handler_demo/example_as_module/CMakeLists.txt
   :language: cmake
```

```cmake
.. literalinclude:: ../../../tests/subsys/mgmt/mcumgr/handler_demo/CMakeLists.txt
   :language: cmake
   :start-after: Include handler files
```

--------------------------------

### Launch net-setup.sh

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/net/tftp_client/README.rst

Launch net-setup.sh in net-tools to set up the network for running the sample on native_sim.

```bash
net-setup.sh
```

--------------------------------

### Windows: Configure OpenOCD path and build/flash

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/infineon/cy8cproto_063_ble/doc/index.rst

Windows-specific setup: configure the Infineon OpenOCD path and then build and flash the hello_world sample on the cy8cproto_063_ble board.

```shell
west config build.cmake-args -- "-DOPENOCD=path/to/infineon/openocd/bin/openocd.exe"
```

```shell
west build -b cy8cproto_063_ble -p always samples/hello_world
west flash
```

--------------------------------

### Start net-tools configuration

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/net/mqtt_sn_publisher/README.rst

Command to start the net-tools configuration for the MQTT-SN gateway setup.

```console
$ ./net-setup.sh --config docker.conf
```

--------------------------------

### bap start command

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/bluetooth/shell/audio/bap.rst

Starts a source stream. This command is only necessary when starting a source stream. The example shows the basic command.

```console
uart:~$ bap start
```

--------------------------------

### Build and flash hello_world sample

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/silabs/radio_boards/siwx917/doc/siwx917_rb4342a.rst

Build and flash the hello_world sample for the siwx917_rb4342a board using west.

```console
west build -b siwx917_rb4342a samples/hello_world
west flash
```

--------------------------------

### Install net-tools and dependencies

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/networking/qemu_setup.rst

Install required packages and clone the net-tools repository, then build the tools with make. If you get an error about AX_CHECK_COMPILE_FLAG, install the autoconf-archive package on Debian/Ubuntu.

```console
sudo apt install -y socat libpcap-dev
git clone https://github.com/zephyrproject-rtos/net-tools
cd net-tools
make
```

--------------------------------

### Windows: Set OPENOCD path and flash hello_world

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/infineon/kit_psc3m5_evk/doc/index.rst

One-time setup to point the build system at the Infineon OpenOCD executable on Windows, then build and flash the hello_world sample.

```shell
west config build.cmake-args -- "-DOPENOCD=path/to/infineon/openocd/bin/openocd.exe"
```

```shell
west build -b kit_psc3m5_evk -p always samples/hello_world
west flash
```

--------------------------------

### Build and flash hello_world for mm_swiftio

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/madmachine/mm_swiftio/doc/index.rst

Build the hello_world sample for the mm_swiftio board and copy the resulting binary to the DAPLink USB disk. On Ubuntu, the disk mounts to /media/<user>/SWIFTIODBGR/.

```console
west build -b mm_swiftio samples/hello_world
cp build/zephyr/zephyr.bin /media/<user>/SWIFTIODBGR/
```

--------------------------------

### MCP Server Setup

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/networking/api/mcp.rst

Initializes the MCP server and HTTP transport, then starts both. Register tools between the init and start calls.

```c
#include <zephyr/net/mcp/mcp_server.h>
#include <zephyr/net/mcp/mcp_server_http.h>

static mcp_server_ctx_t server;

int main(void)
{
    server = mcp_server_init();
    mcp_server_http_init(server);

    /* Register tools here */

    mcp_server_start(server);
    mcp_server_http_start(server);
    return 0;
}
```

--------------------------------

### Sensor get command output examples

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/sensor/sensor_shell/README.rst

Example outputs for the sensor get command on reel_board, showing all channels, a named channel, and a channel index. Passing an invalid device name can cause undefined behavior like a hardware exception.

```console
uart:~$ sensor get mma8652fc@1d
channel idx=0 accel_x =   0.000000
channel idx=1 accel_y =   0.268150
channel idx=2 accel_z =   9.959878
channel idx=3 accel_xyz x =   0.000000 y =   0.268150 z =   9.959878
```

```console
uart:~$ sensor get mma8652fc@1d accel_z
channel idx=2 accel_z =   9.959878
```

```console
uart:~$ sensor get mma8652fc@1d 2
channel idx=2 accel_z =   9.959878
```

--------------------------------

### Start host TAP interface

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/net/ptp/README.rst

Create a host TAP interface using net-setup.sh from tools/net-tools. Keep this interface while the sample is running.

```console
sudo ./net-setup.sh start
```

--------------------------------

### Build and flash hello_world on Windows

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/infineon/cy8cproto_040t/doc/cy8cproto_040t.rst

Builds the hello_world sample for the cy8cproto_040t board and flashes it using west. Run after setting the OpenOCD path.

```shell
west build -b cy8cproto_040t -p always samples/hello_world
west flash
```

--------------------------------

### Set and get bearer technology

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/bluetooth/shell/audio/ccp.rst

Shows how to get and set the bearer technology. The example sets technology to 0x02 (4G) and displays the new value.

```console
uart:~$ ccp_call_control_server get_bearer_tech
Bearer[0] technology: 3G (0x01)
uart:~$ ccp_call_control_server set_bearer_tech 0x02
Bearer[0] new technology: 4G (0x02)
```

--------------------------------

### Build and flash hello_world sample

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/st/nucleo_h563zi/doc/index.rst

Build and flash the hello_world sample for the nucleo_h563zi board using west.

```console
west build -b nucleo_h563zi samples/hello_world
west flash
```

--------------------------------

### ASCII PCM output format example

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/boards/96boards/argonkey/microphone/README.rst

Example of ASCII PCM output format when the PCM_OUTPUT_IN_ASCII macro is enabled. The output starts with 'ArgonKey test!!' and '-- start', then lists 16-bit sample values in hexadecimal, and ends with '-- end'. This output needs to be converted to binary later on.

```console
ArgonKey test!!
-- start
0xfbe0,
0xfbf0,
0xfc0c,
0xfc24,
0xfc3c,
0xfc4c,
0xfc68,
0xfc48,

[...]

0xfb98,
0xfb98,
0xfbb8,
0xfbac,
0xfbc4,
0xfbe8,
0xfbf4,
-- end
```

--------------------------------

### Build and flash hello_world sample

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/u-blox/ubx_evknorab2/doc/index.rst

Standard command to build and flash the hello_world sample to the EVK NORA-B2 board (ubx_evknorab2/nrf54l15/cpuapp). Follow the instructions in the nordic_segger page to install and configure the necessary software.

```shell
west build -p -b ubx_evknorab2/nrf54l15/cpuapp samples/hello_world
west flash
```

--------------------------------

### Start GDB client for target

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/llext/debug.rst

Sets the Zephyr SDK install directory and starts the GDB client for the target. The output shows the GDB version and symbol loading.

```shell
zephyr$ export LLEXT_SDK_INSTALL_DIR=/opt/zephyr-sdk-0.17.0
zephyr$ ${LLEXT_SDK_INSTALL_DIR}/arm-zephyr-eabi/bin/arm-zephyr-eabi-gdb build/zephyr/zephyr.elf
GNU gdb (Zephyr SDK 0.17.0) 12.1
[...]
Reading symbols from build/zephyr/zephyr.elf...
(gdb)
```

--------------------------------

### Flashing hello_world sample

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/silabs/radio_boards/xg24/doc/xgm240_rb4317a.rst

Example command to flash the hello_world sample to the xgm240_rb4317a board using west. Requires the board connected via USB.

```console
west build -b xgm240_rb4317a samples/hello_world
west flash
```

--------------------------------

### Install and run aiocoap fileserver

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/net/sockets/coap_download/README.rst

Commands to install the aiocoap Python package, create a file root directory, add a test file, and start the CoAP fileserver.

```bash
python -m pip install "aiocoap[all]"
mkdir file_root
echo "some test data" > file_root/test.txt
aiocoap-fileserver file_root
```

--------------------------------

### Build and flash hello_world sample

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/silabs/radio_boards/xg29/doc/xg29_rb4413a.rst

Build and flash the hello_world sample for the xg29_rb4413a board using west. The default flasher is SEGGER J-Link, which must be available on PATH. Alternatively, use 'west flash -r silabs_commander' with Simplicity Commander.

```console
west build -b xg29_rb4413a samples/hello_world
west flash
```

--------------------------------

### Get message listing with filters

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/bluetooth/shell/classic/map.rst

Example of getting a message listing with filters: adds max_list_count, filter_msg_type (0x1f), and filter_read_status (unread), then sends get_msg_listing and clears the parameters.

```console
uart:~$ map add_header app_param max_list_count 10
Added MaxListCount: 10
uart:~$ map add_header app_param filter_msg_type 1f
Added FilterMessageType: 0x1f
  EMAIL=Y, SMS_GSM=Y, SMS_CDMA=Y, MMS=Y, IM=Y
uart:~$ map add_header app_param filter_read_status unread
Added FilterReadStatus: unread (1)
uart:~$ map mce mas get_msg_listing
MCE MAS 0x20005a00 get_msg_listing rsp, rsp_code Continue, data len 252
...
uart:~$ map add_header app_param clear
Cleared all application parameters
uart:~$
```

--------------------------------

### Set and get bearer URI schemes

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/bluetooth/shell/audio/ccp.rst

Shows how to get and set the supported URI schemes list for the default bearer. The example sets the list to "tel,teamspeak".

```console
uart:~$ ccp_call_control_server get_bearer_uri_schemes
Bearer[0] URI schemes supported list: tel,skype
uart:~$ ccp_call_control_server set_bearer_uri_schemes "tel,teamspeak"
Bearer[0] new URI schemes supported list: tel,teamspeak
```

--------------------------------

### Build and flash (Windows)

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/infineon/kit_t2g_b_h_lite/doc/index.rst

Build and flash the hello_world sample for the kit_t2g_b_h_lite/cyt4bf8cds/m0p board on Windows.

```shell
west build -b kit_t2g_b_h_lite/cyt4bf8cds/m0p -p always samples/hello_world
west flash
```

--------------------------------

### Build and flash hello_world sample

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/u-blox/ubx_bmd345eval/doc/index.rst

Build and flash the hello_world sample for the ubx_bmd345eval/nrf52840 board using the Zephyr build system.

```console
samples/hello_world
:board: ubx_bmd345eval/nrf52840
:goals: build flash
```

--------------------------------

### Start screen for serial connection

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/nxp/imx8mq_evk/doc/index.rst

Starts the screen terminal emulator to connect to the board's serial console. Requires the 'screen' and 'lrzsz' packages to be installed. Replace <tty-device> with the appropriate serial device.

```console
screen <tty-device> 115200
```

--------------------------------

### Start ICEman Server with sudo

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/andestech/adp_xc7k_ae350/doc/index.rst

Set execute permission on the ICEman executable and start the server with version 5. Run with sudo unless you have installed the udev rules file and reconnected the AICE adapter.

```console
# Enable execute file permission of ICEman
chmod a+x ./ICEman

# Running the ICEman server
sudo ./ICEman -Z v5
```

--------------------------------

### Build and flash application (Windows)

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/infineon/cy8cproto_041tp/doc/index.rst

Build and flash the hello_world sample on the CY8CPROTO-041TP board using west. The -p always option forces a pristine build.

```shell
west build -b cy8cproto_041tp -p always samples/hello_world
west flash
```

--------------------------------

### Polling sensor example (magn_polling main.c)

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/hardware/peripherals/sensor/fetch_and_get.rst

Example of reading sensor data in a polling manner from a software thread using fetch and get APIs. The code is from the magn_polling sample's main.c file.

```c
.. literalinclude:: ../../../../samples/sensor/magn_polling/src/main.c
   :language: c
```

--------------------------------

### Start a web server in the sample directory

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/subsys/usb/webusb/README.rst

Run this command in the sample directory to serve the WebUSB demo page. The page can then be accessed at http://localhost:8001/.

```console
$ python -m http.server
```

--------------------------------

### Launch DDD graphical GDB frontend

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/develop/debug/index.rst

Starts DDD with GDB as the debugger, loading the ELF binary's symbol table. Requires DDD to be installed (e.g., sudo apt-get install ddd on Ubuntu).

```bash
ddd --gdb --debugger "gdb zephyr.elf"
```

--------------------------------

### Sample test configuration with hello world scenarios

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/develop/twister/index.rst

Example test configuration for a sample, including a 'sample:' section with name and description, and test scenarios with build_only, tags, min_ram, extra_args, and filter options.

```yaml
sample:
  name: hello world
  description: Hello World sample, the simplest Zephyr application
tests:
  sample.basic.hello_world:
    build_only: true
    tags:
      - tests
    min_ram: 16
  sample.basic.hello_world.singlethread:
    build_only: true
    extra_args: CONF_FILE=prj_single.conf
    filter: not CONFIG_BT
    tags:
      - tests
    min_ram: 16
```

--------------------------------

### net capture setup example

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/networking/network_monitoring.rst

Example that creates the tunneling interface. 192.0.2.2 is the remote host, 2001:db8:200::1 is the local tunnel IP, and 2001:db8:200::2 is the peer IP where captured packets are sent.

```console
net capture setup 192.0.2.2 2001:db8:200::1 2001:db8:200::2
```

--------------------------------

### ASCII PCM output format

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/shields/x_nucleo_iks02a1/microphone/README.rst

Example of the ASCII PCM output format when the PCM_OUTPUT_IN_ASCII macro is enabled. The output starts with '-- start' and ends with '-- end', with each 16-bit sample printed as a hexadecimal value followed by a comma.

```console
-- start
0xfbe0,
0xfbf0,
0xfc0c,
0xfc24,
0xfc3c,
0xfc4c,
0xfc68,
0xfc48,

[...]

0xfb98,
0xfb98,
0xfbb8,
0xfbac,
0xfbc4,
0xfbe8,
0xfbf4,
-- end
```

--------------------------------

### Build and flash hello_world sample

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/st/nucleo_u031r8/doc/index.rst

Builds and flashes the hello_world sample for the nucleo_u031r8 board using west.

```console
west build -b nucleo_u031r8 samples/hello_world
west flash
```

--------------------------------

### Build and run application

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/subsys/llext/edk/README.rst

Build the application including extensions and run it on qemu_cortex_r5.

```console
west build -p=always -b qemu_cortex_r5 samples/subsys/llext/edk/app --target run
```

--------------------------------

### Zperf TCP and UDP upload with -w option

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/networking/api/zperf.rst

Example console session showing TCP and UDP uploads with the -w option to wait for the 'zperf jobs start' command. The output shows the waiting state and the effect of starting the jobs.

```console
uart:~$ zperf tcp upload -a -t 6 -w 192.0.2.2 5001 10 1K
Remote port is 5001
Connecting to 192.0.2.2
Duration:       10.00 s
Packet size:    1000 bytes
Rate:           10 kbps
Waiting "zperf jobs start" command.
[01:06:51.392,288] <inf> net_zperf: [0] TCP waiting for start

uart:~$ zperf udp upload -a -t 6 -w 192.0.2.2 5001 10 1K 10M
Remote port is 5001
Connecting to 192.0.2.2
Duration:       10.00 s
Packet size:    1000 bytes
Rate:           10000 kbps
Waiting "zperf jobs start" command.
Rate:           10.00 Mbps
Packet duration 781 us
[01:06:58.064,552] <inf> net_zperf: [0] UDP waiting for start

uart:~$ zperf jobs start
-
Upload completed!
-
Upload completed!
```

--------------------------------

### Example conformance test function

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/networking/conformance/architecture.rst

Example pytest test for an mDNS conformance suite. It waits for the ready line from the system under test and then runs the suite. The network_lock fixture is requested first to ensure the interface lock is held before starting the test.

```python
def test_mdns_conformance(network_lock, dut, suite_binary):
    dut.readlines_until(regex='mDNS responder ready', timeout=30.0)
    run_suite(suite_binary, SUITE)
```

--------------------------------

### Build hello_world for contextualelectronics_abc

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/contextualelectronics/abc/doc/index.rst

Builds the hello_world sample for the contextualelectronics_abc board. Requires an external programmer attached to the SWD header.

```console
west build -b contextualelectronics_abc samples/hello_world
```

--------------------------------

### Create output folder for instance 1

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/drivers/ipm/ipm_ivshmem/README.rst

Create the output folder for the first QEMU instance.

```console
$ mkdir -p path/to/instance_1
```

--------------------------------

### AVRCP TG side operations

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/bluetooth/shell/classic/avrcp.rst

Example of AVRCP TG (target) side operations, showing how to register callbacks, respond to get capabilities, register notification, passthrough commands, get play status, get element attributes, and set absolute volume. The commands are entered on the TG side while the CT side sends corresponding requests.

```console
uart:~$ avrcp tg register_cb
AVRCP TG callbacks registered
<input `avrcp connect` in CT side>
AVRCP TG connected
<input `avrcp ct get_caps events` in CT side>
AVRCP get capabilities command received: cap_id 0x03 (EVENTS_SUPPORTED)
uart:~$ avrcp tg send_get_caps_rsp
Get capabilities response sent successfully
<input `avrcp ct register_notification 0x01` in CT side>
receive register notification request event_id=0x01
uart:~$ avrcp tg send_notification_rsp 0x01 interim 0
Sent notification rsp event_id=0x01 type=interim
<input `avrcp ct play` in CT side>
receive passthrough command: op_id=0x44 (PLAY)
uart:~$ avrcp tg send_passthrough_rsp op play pressed
Passthrough opid=0x44 (STANDARD), state=pressed sent successfully
uart:~$ avrcp tg send_passthrough_rsp op play released
Passthrough opid=0x44 (STANDARD), state=released sent successfully
uart:~$ avrcp tg send_notification_rsp 0x01 changed 1
Sent notification rsp event_id=0x01 type=changed
<input `avrcp ct get_play_status` in CT side>
receive get play status request
uart:~$ avrcp tg send_get_play_status_rsp
GetPlayStatus rsp sent
<input `avrcp ct get_element_attrs` in CT side>
AVRCP GetElementAttributes command received
uart:~$ avrcp tg send_get_element_attrs_rsp 0
Sending standard GetElementAttributes response (7 attrs)
GetElementAttributes response sent successfully
<input `avrcp ct set_absolute_volume 50` in CT side>
AVRCP set_absolute_volume_req: tid=0x06, absolute_volume=0x32
uart:~$ avrcp tg send_absolute_volume_rsp 50
Set absolute volume response sent successfully
<input `avrcp ct pause` in CT side>
AVRCP passthrough command received: opid = 0x46
uart:~$ avrcp tg send_passthrough_rsp op pause pressed
send passthrough response
uart:~$ avrcp tg send_passthrough_rsp op pause released
send passthrough response
```

--------------------------------

### Build and flash hello_world on Windows

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/infineon/kit_xmc72_evk/doc/index.rst

Build and flash the hello_world sample for the M0+ core on Windows. Requires the OpenOCD path to be set first.

```shell
west build -b kit_xmc72_evk/xmc7200d_e272k8384/m0p -p always samples/hello_world
west flash
```

--------------------------------

### Build and run HTTP server sample

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/net/sockets/http_server/README.rst

Build and run the HTTP server sample for a specified board using west.

```bash
$ west build -p auto -b <board_to_use> -t run samples/net/sockets/http_server
```

--------------------------------

### Verify dependency versions on Ubuntu

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/develop/getting_started/index.rst

Check the installed versions of CMake, Python, and the Devicetree compiler against the minimum required versions listed in the guide.

```bash
cmake --version
python3 --version
dtc --version
```

--------------------------------

### Linux: Configure OpenOCD path and build/flash

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/infineon/cy8cproto_063_ble/doc/index.rst

Linux-specific setup: configure the Infineon OpenOCD path and then build and flash the hello_world sample on the cy8cproto_063_ble board.

```shell
west config build.cmake-args -- -DOPENOCD=path/to/infineon/openocd/bin/openocd
```

```shell
west build -b cy8cproto_063_ble -p always samples/hello_world
west flash
```

--------------------------------

### Verify GNU Arm Embedded environment variables in shell

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/develop/toolchains/gnu_arm_embedded.rst

Example shell sessions to confirm that ZEPHYR_TOOLCHAIN_VARIANT is set to gnuarmemb and GNUARMEMB_TOOLCHAIN_PATH points to the toolchain installation directory. The values shown are examples and may differ on your system. Includes commands for Linux/macOS and Windows.

```console
# Linux, macOS:
$ echo $ZEPHYR_TOOLCHAIN_VARIANT
gnuarmemb
$ echo $GNUARMEMB_TOOLCHAIN_PATH
/home/you/Downloads/gnu_arm_embedded

# Windows:
> echo %ZEPHYR_TOOLCHAIN_VARIANT%
gnuarmemb
> echo %GNUARMEMB_TOOLCHAIN_PATH%
C:\gnu_arm_embedded
```

--------------------------------

### Build and flash hello_world sample

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/u-blox/ubx_bmd330eval/doc/index.rst

Build and flash the hello_world sample for the ubx_bmd330eval/nrf52810 board using Zephyr's build and flash goals.

```console
west build -b ubx_bmd330eval/nrf52810 samples/hello_world
west flash
```

--------------------------------

### Run sample with twister

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/subsys/fs/virtiofs/README.rst

Execute the sample automatically with the virtiofs twister harness, which starts virtiofsd on a per-run socket. The test is skipped if virtiofsd is not installed.

```bash
scripts/twister -p qemu_x86_64 -T samples/subsys/fs/virtiofs
```

--------------------------------

### Build hello_world with SAM-BA bootloader

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/atmel/sam/sam4e_xpro/doc/index.rst

Build the hello_world sample for the sam4e_xpro board using the SAM-BA bootloader. Requires closing the ERASE jumper, powering on for 10s, opening the jumper, and connecting via the SoC USB port.

```console
west build -b sam4e_xpro samples/hello_world
```

--------------------------------

### Debug nSIM with lldbac runner

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/snps/nsim/arc_v/doc/index.rst

Starts interactive debugging on the nSIM simulator using the lldbac runner. Requires run-lldbac from ARC MWDT to be installed and in PATH.

```console
west debug --runner lldbac --simulator
```

--------------------------------

### Build hello_world sample for M4F core

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/ti/sk_am62/doc/index.rst

Command to build the hello_world sample for the SK-AM62 M4F core. The resulting binary must be copied to the SD card for the A53 cores to load it via remoteproc.

```console
west build -b sk_am62/zephyr/m4 samples/hello_world
```

--------------------------------

### Minimal prj.conf for MCP Server

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/connectivity/networking/api/mcp.rst

Enables the MCP server with the HTTP transport. Requires networking and HTTP server support. This is the minimal configuration to get started.

```kconfig
CONFIG_NETWORKING=y
CONFIG_NET_TCP=y
CONFIG_HTTP_SERVER=y
CONFIG_MCP_SERVER=y
CONFIG_MCP_TRANSPORT_HTTP=y
```

--------------------------------

### Run trace viewer with semihosting backend

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/subsys/tracing/basic/README.rst

Build and run the application under QEMU, then start the trace viewer with -f to follow the growing tracing.bin file. The viewer waits for the file and first events, so it can be started before or after the run.

```shell
west build -t run &
$ZEPHYR_BASE/scripts/tracing/trace_viewer.py -f build/tracing.bin
```

--------------------------------

### i2s shell tone commands

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/hardware/peripherals/audio/i2s.rst

Example of using the i2s shell command to start, query, and stop a test tone on an I2S device. The command starts a 1 kHz, 48 kHz, 16-bit stereo tone on i2s@0, then shows the stream status, and finally stops the tone.

```console
uart:~$ i2s tone start i2s@0 1000 48000 16
Streaming 1000 Hz tone on i2s@0 @ 48000 Hz, 16-bit stereo
uart:~$ i2s tone info
state    : streaming
i2s dev  : i2s@0
tone     : 1000 Hz
rate     : 48000 Hz
format   : 16-bit stereo, 64-frame blocks x 8
uart:~$ i2s tone stop
Stopped
```

--------------------------------

### Set up aiocoap file server

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/net/sockets/coap_upload/README.rst

Install the aiocoap Python package and start a file server that accepts writes. Run these commands on the host that will receive the CoAP uploads.

```bash
python -m pip install "aiocoap[all]"
mkdir file_root
aiocoap-fileserver --write file_root
```

--------------------------------

### Build and run Hello C++ world on qemu_riscv32

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/cpp/hello_world/README.rst

Build and run the sample on QEMU using the qemu_riscv32 board. Change the board name to build for another supported board. Exit QEMU by pressing CTRL+C.

```console
west build -b qemu_riscv32 samples/cpp/hello_world
west build -t run
```

--------------------------------

### Run hello_world sample on qemu_tc3x

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/qemu/tricore/doc/index.rst

Command to build and run the hello_world sample on the qemu_tc3x board. Use qemu_tc4x for the TC4Dx target. The console output shows the boot message and the Hello World line.

```console
west build -b qemu_tc3x samples/hello_world
west build -t run
```

```console
*** Booting Zephyr OS build ... ***
Hello World! qemu_tc3x/qemu_tc3x
```

--------------------------------

### Generate MCUboot ROM report

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/tfm/build.rst

Use the bl2_rom_report goal to get the ROM report for TF-M MCUboot, if enabled. The example uses the hello_world sample on the mps2/an521/cpu0/ns board.

```zephyr-app-commands
west build -b mps2/an521/cpu0/ns samples/hello_world -t bl2_rom_report
```

--------------------------------

### Generate MCUboot RAM report

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/tfm/build.rst

Use the bl2_ram_report goal to get the RAM report for TF-M MCUboot, if enabled. The example uses the hello_world sample on the mps2/an521/cpu0/ns board.

```zephyr-app-commands
west build -b mps2/an521/cpu0/ns samples/hello_world -t bl2_ram_report
```

--------------------------------

### Build and flash hello_world with west (nucleo_n657x0_q//sb)

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/st/nucleo_n657x0_q/doc/index.rst

Build and flash the hello_world sample using the STM32CubeProgrammer runner. Requires STM32CubeProgrammer 2.18.0 or later and the STM32_SigningTool_CLI in PATH. The board must be powered with boot pins configured as described before flashing.

```console
west build -b nucleo_n657x0_q//sb samples/hello_world
west flash
```

--------------------------------

### Start pyftpdlib FTP server

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/net/ftp_client/README.rst

Installs the pyftpdlib Python package, creates a root directory for the FTP server, creates a dummy test file, and starts the server in write-mode on port 2121. The server runs in write-mode, allowing create, delete, and overwrite operations; be careful when using other root locations.

```bash
pip install pyftpdlib
mkdir file_root
echo "some test data" > file_root/test_file.txt
python3 -m pyftpdlib -p 2121 --write --directory=file_root
```

--------------------------------

### Expected console output for use-case 1

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/boards/nxp/s32/netc/README.rst

Example console output after starting the sample for use-case 1, showing PHY ID, MAC address, and interface configuration details.

```console
[00:00:00.051,000] <inf> phy_mii: PHY (7) ID 1CC916

[00:00:00.052,000] <inf> nxp_s32_eth_psi: SI0 MAC: 00:00:00:01:02:00
[00:00:00.058,000] <inf> shell_telnet: Telnet shell backend initialized
[00:00:00.058,000] <inf> nxp_s32_netc_sample: Starting sample
[00:00:00.058,000] <inf> nxp_s32_netc_sample: Waiting for iface 1 to come up
[00:00:07.595,000] <inf> phy_mii: PHY (7) Link speed 1000 Mb, full duplex

[00:00:07.595,000] <inf> nxp_s32_netc_sample: Configuring iface 1 (0x318008f0)
[00:00:07.595,000] <inf> nxp_s32_netc_sample: IPv6 address: 2001:db8::1
[00:00:07.595,000] <inf> nxp_s32_netc_sample: IPv4 address: 192.0.2.1
```

--------------------------------

### Linux: Set OPENOCD path and flash hello_world

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/infineon/kit_psc3m5_evk/doc/index.rst

One-time setup to point the build system at the Infineon OpenOCD executable on Linux, then build and flash the hello_world sample.

```shell
west config build.cmake-args -- -DOPENOCD=path/to/infineon/openocd/bin/openocd
```

```shell
west build -b kit_psc3m5_evk -p always samples/hello_world
west flash
```

--------------------------------

### Run Zephyr Docker CI container

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/develop/manifest/external/executorch.rst

Start a container with your Zephyr workspace and Zephyr SDK mounted. The SDK version (0.17.4) may change; replace it with your installed version.

```console
docker run -it --rm \
  -v $HOME/zephyrproject:$HOME/zephyrproject \
  -v $HOME/zephyr-sdk-0.17.4:$HOME/zephyr-sdk-0.17.4 \
  -w $HOME/zephyrproject \
  -e HOME=$HOME \
  -e ZEPHYR_SDK_INSTALL_DIR=$HOME/zephyr-sdk-0.17.4 \
  --user root \
  --entrypoint /bin/bash \
  ghcr.io/zephyrproject-rtos/zephyr-build:main
```

--------------------------------

### Sample startup output

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/samples/drivers/smbus/README.rst

Shows the console output when the SMBus shell sample starts on the qemu_x86_64 board.

```console
*** Booting Zephyr OS build zephyr-v3.2.0-804-gfedd72615e82  ***
Start SMBUS shell sample qemu_x86_64
uart:~$
```

--------------------------------

### Build and flash hello_world with CONFIG_BOOT_DELAY=5000

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/weact/mini_stm32h7b0/doc/index.rst

Build and flash the hello_world sample for the MiniSTM32H7B0 board. Add CONFIG_BOOT_DELAY=5000 to allow USB CDC ACM to initialize before printing.

```console
west build -b mini_stm32h7b0 samples/hello_world -DCONFIG_BOOT_DELAY=5000
west flash
```

--------------------------------

### Listen for serial output with minicom

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/norik/octopus_io_board/doc/index.rst

Starts a terminal emulator to listen for serial output from the board. Replace <tty_device> with the port where the Octopus IO-Board can be found, for example /dev/ttyACM0 under Linux.

```console
$ minicom /dev/<tty_device> 115200
```

--------------------------------

### Run QEMU on the disk and connect via VNC

Source: https://github.com/zephyrproject-rtos/zephyr/wiki/Boot-Zephyr-from-SYSLINUX

Launches QEMU with the disk image, enabling KVM, and outputs to serial. Then connects to the VM display using a VNC viewer.

```bash
$ /opt/zephyr-sdk-0.9.5/sysroots/x86_64-pokysdk-linux/usr/bin/qemu-system-i386 \
-m 1024 -cpu qemu32,+nx,+pae \
-enable-kvm \
-device isa-debug-exit,iobase=0xf4,iosize=0x04 \
-clock dynticks -no-acpi -balloon none \
-L /usr/share/qemu -bios bios.bin \
-machine type=pc-0.14 \
-serial stdio \
-hda disk.img
```

```bash
$ vncviewer 127.0.0.1:5900
```

--------------------------------

### Generate TF-M ROM report

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/services/tfm/build.rst

Use the tfm_rom_report goal to get the ROM report for TF-M secure firmware (tfm_s). The example uses the hello_world sample on the mps2/an521/cpu0/ns board.

```zephyr-app-commands
west build -b mps2/an521/cpu0/ns samples/hello_world -t tfm_rom_report
```

--------------------------------

### Build and flash hello_world for sam_e70_xplained/same70q21

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/atmel/sam/sam_e70_xplained/doc/index.rst

Build and flash the hello_world sample for the sam_e70_xplained/same70q21 board. After flashing, you should see "Hello World! sam_e70_xplained" in the terminal.

```console
west build -b sam_e70_xplained/same70q21 samples/hello_world
west flash
```

--------------------------------

### Build and flash hello_world

Source: https://github.com/zephyrproject-rtos/zephyr/blob/main/boards/st/nucleo_l496zg/doc/index.rst

Build and flash the hello_world sample for the nucleo_l496zg board.

```console
west build -b nucleo_l496zg samples/hello_world
west flash
```
Tokens:
Raw