Skip to content

Commit 3fe3c19

Browse files
more tweaks
1 parent 8e3a748 commit 3fe3c19

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

content/learning-paths/embedded-and-microcontrollers/zephyr_shell/1_installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ layout: learningpathall
99

1010
## Before you begin
1111

12-
In this section, you'll prepare your host computer and identify the hardware needed for two Zephyr shell examples. You'll use the shell over two transports:
12+
In this section, you'll prepare your host computer and identify the hardware you need for two Zephyr shell examples. You'll use the shell over two transports:
1313

1414
- MQTT over Ethernet
1515
- UART over a USB serial connection
@@ -60,7 +60,7 @@ Workbench for Zephyr supports multiple debug runners depending on the connected
6060

6161
## Network requirements for the MQTT shell example
6262

63-
For the MQTT shell example, the board needs access to an MQTT broker over Ethernet. You'll run Mosquitto locally with Docker Compose and use the Mosquitto command-line tools to send and receive shell messages.
63+
For the MQTT shell example, the board needs access to an MQTT broker over Ethernet. You'll run Mosquitto locally and use the Mosquitto command-line tools to send and receive shell messages.
6464

6565
Make sure that:
6666

@@ -72,7 +72,7 @@ Make sure that:
7272
The example configuration uses IPv4. If your network doesn't provide DHCP, use the static IPv4 settings shown in the next section.
7373
{{% /notice %}}
7474

75-
## What you've accomplished and what's next
75+
## What you've learned and what's next
7676

7777
You've now learned which boards to use, which host tools to install, and how the Zephyr shell fits into an embedded application.
7878

content/learning-paths/embedded-and-microcontrollers/zephyr_shell/2_overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ In this Learning Path, you'll work with two transports:
3535

3636
### MQTT backend
3737

38-
Enable the MQTT backend with `CONFIG_SHELL_BACKEND_MQTT=y`. The MQTT backend routes shell commands and responses over MQTT topics. The board subscribes to `<device_id>/sh/rx` for inbound commands and publishes responses to `<device_id>/sh/tx`. The backend connects automatically when the board has an IPv4 address. The backend is IPv4-only.
38+
Enable the MQTT backend with `CONFIG_SHELL_BACKEND_MQTT=y`. The MQTT backend routes shell commands and responses over MQTT topics. The board subscribes to `<device_id>/sh/rx` for inbound commands and publishes responses to `<device_id>/sh/tx`. The backend is IPv4-only and connects automatically when the board has an IPv4 address.
3939

4040
### UART backend
4141

42-
Enable the UART backend with `CONFIG_SHELL_BACKEND_SERIAL=y`. The UART backend routes shell commands and responses over the board's UART interface, accessible through a USB serial connection. Use PuTTY on Windows, or `screen` on macOS and Linux. This backend works on a wide range of Zephyr-supported development boards with no additional debug hardware required.
42+
Enable the UART backend with `CONFIG_SHELL_BACKEND_SERIAL=y`. The UART backend routes shell commands and responses over the board's UART interface, accessible through a USB serial connection. Use PuTTY on Windows, or `screen` on macOS and Linux. This backend works on a wide range of Zephyr-supported development boards without the need for additional debug hardware.
4343

4444
## What you've accomplished and what's next
4545

content/learning-paths/embedded-and-microcontrollers/zephyr_shell/3_mqtt_shell.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,8 @@ IPv4 gateway : 192.168.1.1
392392
DHCPv4 state : bound
393393
DHCPv4 server : 192.168.1.1
394394
```
395+
Next, run `net ping` with the gateway address shown by `net iface`. The board sends three ICMP echo requests by default.
396+
395397
Example output for `net ping 192.168.1.1` (board pinging its gateway):
396398

397399
```output
@@ -401,8 +403,6 @@ Example output for `net ping 192.168.1.1` (board pinging its gateway):
401403
28 bytes from 192.168.1.1 to 192.168.1.41: icmp_seq=3 ttl=64 time=0 ms
402404
```
403405

404-
To run `net ping`, replace `192.168.1.1` with the gateway address shown by `net iface`. The board sends three ICMP echo requests by default.
405-
406406
{{% notice Note %}}
407407
The MQTT shell backend executes a command after it receives a newline character. The `printf 'kernel version\n' | ... mosquitto_pub -s` form sends the command with the required newline.
408408
{{% /notice %}}

0 commit comments

Comments
 (0)