Zephyr Project

https://docs.zephyrproject.org/
Admin
Zephyr is a real-time operating system (RTOS) for connected IoT and embedded devices, supporting a...
Tokens:76,417
Snippets:1,645
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Build and Flash Sample

Source: https://docs.zephyrproject.org/samples/basic/threads/README.html

Use 'west build' to compile the sample for a specific board and 'west flash' to upload it. Ensure the board name and path are correct for your setup.

```bash
west build -b 96b_carbon/stm32f401xe samples/basic/threads
west flash

```

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

### Build SD Card MSC Example (Direct Controller)

Source: https://docs.zephyrproject.org/samples/subsys/usb/mass/README.html

Builds the USB Mass Storage sample with SD card support when the board has a dedicated SD card controller.

```bash
west build -b mimxrt1050_evk samples/subsys/usb/mass -- -DCONFIG_APP_MSC_STORAGE_SDCARD=y
```

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

### Start IPv6 SOCKS5 Proxy Server

Source: https://docs.zephyrproject.org/samples/net/sockets/echo_client/README.html

Start an IPv6 SOCKS5 proxy server on the host using ssh with the default port.

```bash
$ ssh -N -D [::]:1080 localhost
```

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

### Build and Flash ESP Peripheral Sample

Source: https://docs.zephyrproject.org/samples/bluetooth/peripheral_esp/README.html

Build the sample using west and flash it to the target board. Replace `<board>` with your specific board name.

```bash
west build -b <board> samples/bluetooth/peripheral_esp
west flash

```

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

### Start IPv4 SOCKS5 Proxy Server

Source: https://docs.zephyrproject.org/samples/net/sockets/echo_client/README.html

Start an IPv4 SOCKS5 proxy server on the host using ssh with the default port.

```bash
$ ssh -N -D 0.0.0.0:1080 localhost
```

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

### Build and Flash SHT3XD Sample

Source: https://docs.zephyrproject.org/samples/sensor/sht3xd/README.html

Build the SHT3XD sample application using west and flash it to the target board. This requires the Zephyr repository to be set up.

```bash
# From the root of the zephyr repository
west build -b nrf51_ble400 samples/sensor/sht3xd
west flash

```

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

### Hardening Tool Output Example

Source: https://docs.zephyrproject.org/security/hardening-tool.html

This table shows an example of the output from the hardening tool, highlighting configuration options that fail security checks and their recommended values.

```text
+---------------------------------------+-----------+---------------+----------------+
| Name                                  | Current   | Recommended   | Check result   |
+=======================================+===========+===============+================+
| CONFIG_BUILD_OUTPUT_STRIPPED          | n         | y             | FAIL           |
+---------------------------------------+-----------+---------------+----------------+
| CONFIG_FAULT_DUMP                     | 2         | 0             | FAIL           |
+---------------------------------------+-----------+---------------+----------------+
| CONFIG_MPU_STACK_GUARD                | n         | y             | FAIL           |
+---------------------------------------+-----------+---------------+----------------+
| CONFIG_OVERRIDE_FRAME_POINTER_DEFAULT | n         | y             | FAIL           |
+---------------------------------------+-----------+---------------+----------------+
| CONFIG_STACK_SENTINEL                 | n         | y             | FAIL           |
+---------------------------------------+-----------+---------------+----------------+
| CONFIG_EXCEPTION_DEBUG                | y         | n             | FAIL           |
+---------------------------------------+-----------+---------------+----------------+
| CONFIG_PRINTK                         | y         | n             | FAIL           |
+---------------------------------------+-----------+---------------+----------------+
```

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

### Build and Flash Peripheral Sample

Source: https://docs.zephyrproject.org/samples/bluetooth/peripheral/README.html

Build and flash the peripheral sample to your target board. Replace `<board>` with your specific board identifier.

```bash
west build -b <board> samples/bluetooth/peripheral
west flash

```

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

### Start Mosquitto Server

Source: https://docs.zephyrproject.org/samples/net/mqtt_publisher/README.html

Commands to start the Mosquitto MQTT broker. Use the first command for versions less than 2.0, and the second for 2.0 and above, ensuring anonymous access is enabled in mosquitto.conf.

```bash
$ sudo mosquitto -v -p 1883             # For mosquitto < 2.0
$ sudo mosquitto -v -c mosquitto.conf   # For mosquitto >= 2.0

```

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

### Build with MQTT logging backend

Source: https://docs.zephyrproject.org/samples/net/mqtt_publisher/README.html

Enable the MQTT logging backend by building the sample with the appropriate overlay configuration file.

```bash
west build -DEXTRA_CONF_FILE=overlay-log-backend-mqtt.conf
```

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

### GCC Build Error Example

Source: https://docs.zephyrproject.org/samples/basic/blinky/README.html

An example of a build error that may occur with GCC-based toolchains if Blinky is built for an unsupported board, specifically related to the 'struct gpio_dt_spec' variable definition.

```c
error: "__device_dts_ord_DT_N_ALIAS_led_P_gpios_IDX_0_PH_ORD" undeclared here (not in a function)

```

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

### Run Echo Server on Linux Host

Source: https://docs.zephyrproject.org/samples/net/sockets/echo_client/README.html

Start the echo-server on a Linux host with a specified network interface.

```bash
$ sudo ./echo-server -i tap0
```

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

### Build and Flash HID Peripheral Sample

Source: https://docs.zephyrproject.org/samples/bluetooth/peripheral_hids/README.html

Build and flash the HID Peripheral sample to your target board. Replace `<board>` with your specific board name.

```bash
west build -b <board> samples/bluetooth/peripheral_hids
west flash

```

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

### Build and Flash Peripheral SC-only Sample

Source: https://docs.zephyrproject.org/samples/bluetooth/peripheral_sc_only/README.html

Use these commands to build and flash the sample to your target board. Replace `<board>` with your specific board identifier.

```bash
west build -b <board> samples/bluetooth/peripheral_sc_only
west flash

```

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

### Build and Run with OpenThread Support

Source: https://docs.zephyrproject.org/samples/net/sockets/echo_client/README.html

Example of building the echo-client for a specific board with OpenThread support and then running it.

```bash
west build -b nrf52840dk/nrf52840 samples/net/sockets/echo_client -- -DCONF_FILE="prj.conf overlay-ot.conf"
west build -t run
```

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

### Sample Output

Source: https://docs.zephyrproject.org/samples/sensor/lsm6dsl/README.html

This is an example of the output produced by the LSM6DSL sensor sample. The 'magn' row appears only when a magnetometer is connected.

```text
LSM6DSL sensor samples:

accel (-3.184000 -0.697000 9.207000) m/s2
gyro (0.065000 -0.029000 0.002000) dps
magn (-0.042000 0.294000 -0.408000) G
- (0) (trig_cnt: 190474)

<repeats endlessly every 2 seconds>
```

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

### Build and Flash WebUSB Sample

Source: https://docs.zephyrproject.org/samples/subsys/usb/webusb/README.html

Use these west commands to build and flash the WebUSB sample to your target board. Replace `<board to use>` with your specific board name.

```bash
west build -b <board to use> samples/subsys/usb/webusb
west flash

```

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

### Subscriber Output Example

Source: https://docs.zephyrproject.org/samples/net/mqtt_publisher/README.html

This is the data received by a subscriber listening to the 'sensors' topic, showing messages published by the sample.

```shell
$ mosquitto_sub -t sensors
DOORS:OPEN_QoS0
DOORS:OPEN_QoS1
DOORS:OPEN_QoS2
DOORS:OPEN_QoS0
DOORS:OPEN_QoS1
DOORS:OPEN_QoS2
DOORS:OPEN_QoS0
DOORS:OPEN_QoS1
DOORS:OPEN_QoS2
DOORS:OPEN_QoS0
DOORS:OPEN_QoS1
DOORS:OPEN_QoS2
DOORS:OPEN_QoS0
DOORS:OPEN_QoS1
DOORS:OPEN_QoS2


```

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

### Build and Flash Bluetooth Scan & Advertise Sample

Source: https://docs.zephyrproject.org/samples/bluetooth/scan_adv/README.html

Build and flash the sample application to your target board. Replace `<board>` with your specific board identifier.

```bash
west build -b <board> samples/bluetooth/scan_adv
west flash

```
Tokens:
Raw