Skip to content

Commit 4c7bcfd

Browse files
removing redundant steps from setup
1 parent c12fd8c commit 4c7bcfd

3 files changed

Lines changed: 10 additions & 70 deletions

File tree

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

Lines changed: 4 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -35,81 +35,25 @@ To check whether another board is supported by Zephyr, see the [Zephyr supported
3535

3636
## Set up UART terminal tools
3737

38-
For the UART shell example, install a serial terminal application on your host computer. You'll use the terminal application to connect to the Zephyr shell over the board's UART interface.
38+
For the UART shell example, you'll need a serial terminal application on your host computer. You'll use the terminal application to connect to the Zephyr shell over the board's UART interface.
3939

4040
You can complete this Learning Path on Windows, macOS, and Linux host computers.
4141

4242
### Windows
4343

44-
Install [PuTTY](https://www.putty.org/index.html), which provides a lightweight serial terminal for UART communication.
45-
46-
After installation:
47-
48-
1. Connect the development board over USB.
49-
2. Open **Device Manager** and locate the board's COM port under **Ports (COM & LPT)**.
50-
3. Open PuTTY and configure:
51-
52-
- **Connection type**: `Serial`
53-
- **Serial line**: your board's COM port (for example `COM5`)
54-
- **Speed**: `115200`
55-
56-
4. Select **Open** to connect to the Zephyr UART shell.
57-
58-
![PuTTY configuration window with Connection type set to Serial, Serial line set to COM5, and Speed set to 115200, ready to connect to the Zephyr UART shell#center](images/putty_installation.webp "PuTTY serial terminal configuration")
44+
Install [PuTTY](https://www.putty.org/index.html), which provides a lightweight serial terminal for UART communication on Windows.
5945

6046
### macOS
6147

62-
macOS includes a built-in UART terminal utility through the `screen` command, so no additional software is required.
63-
64-
After connecting the development board over USB:
65-
66-
1. Open a terminal window.
67-
2. List available serial devices:
68-
69-
```bash
70-
ls /dev/tty.*
71-
```
72-
3. Connect to the UART shell with:
73-
74-
```bash
75-
screen /dev/tty.usbmodemXXXX 115200
76-
```
77-
78-
Replace `/dev/tty.usbmodemXXXX` with the serial device shown on your system.
79-
80-
To exit `screen`, press the `Ctrl` key and `A`, then `K`, then `Y` to confirm.
48+
macOS includes a built-in UART terminal utility through the `screen` command, so you don't need additional software to connect to the shell.
8149

8250
### Linux
8351

84-
Linux includes `screen` in most distributions, so no additional software is required. If `screen` is not installed, use your package manager to install it:
52+
Linux includes `screen` in most distributions, so you don't need additional software to connect to the shell. If `screen` isn't installed, use your package manager to install it:
8553

8654
```bash
8755
sudo apt install screen
8856
```
89-
90-
After connecting the development board over USB:
91-
92-
1. Open a terminal window.
93-
2. List available serial devices:
94-
95-
```bash
96-
ls /dev/ttyACM* /dev/ttyUSB*
97-
```
98-
3. If you see a permission error when connecting, add your user to the `dialout` group and log out and back in:
99-
100-
```bash
101-
sudo usermod -aG dialout $USER
102-
```
103-
4. Connect to the UART shell with:
104-
105-
```bash
106-
screen /dev/ttyACM0 115200
107-
```
108-
109-
Replace `/dev/ttyACM0` with the device shown on your system. Boards using a CP210x or FTDI USB-UART chip typically appear as `/dev/ttyUSB0`.
110-
111-
To exit `screen`, press the `Ctrl` key and `A`, then `K`, then `Y` to confirm.
112-
11357
{{% notice Note %}}
11458
Workbench for Zephyr supports multiple debug runners depending on the connected board. The FRDM-MCXN947 board uses the onboard CMSIS-DAP/LinkServer interface for flashing and debugging, and UART over USB for shell access.
11559
{{% /notice %}}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,4 +430,4 @@ You need a pristine build when you change the board because Workbench for Zephyr
430430

431431
You now have a working Zephyr shell over MQTT on the FRDM-MCXN947.
432432

433-
In the next section, you'll enable the UART shell backend on the FRDM-MCXN947. You'll interact with the shell through a USB serial connection using PuTTY on Windows, the built-in `screen` utility on macOS, or `screen` on Linux.
433+
In the next section, you'll enable the UART shell backend on the FRDM-MCXN947. You'll interact with the shell through a USB serial connection.

content/learning-paths/embedded-and-microcontrollers/zephyr_shell/4_uart_shell.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Configure PuTTY with:
9292
- **Serial line**: your board's COM port
9393
- **Speed**: `115200`
9494
95-
Select **Open** to connect.
95+
After configuring, select **Open** to connect.
9696
9797
![PuTTY configuration window with Connection type set to Serial, Serial line set to the board's COM port, and Speed set to 115200, ready to connect to the Zephyr UART shell#center](images/putty_installation.webp "PuTTY Serial terminal configuration")
9898
@@ -104,18 +104,17 @@ Open a terminal window and identify the serial device:
104104
ls /dev/tty.*
105105
```
106106

107-
Connect with:
107+
Connect to the UART shell, replacing `/dev/tty.usbmodemXXXX` with the serial device shown on your system:
108108

109109
```bash
110110
screen /dev/tty.usbmodemXXXX 115200
111111
```
112-
113-
Replace `/dev/tty.usbmodemXXXX` with the serial device shown on your system.
114-
115112
To exit `screen`, press the `Ctrl` key and `A`, then `K`, then `Y` to confirm.
116113

117114
### Linux with screen
118115

116+
List available serial devices:
117+
119118
```bash
120119
ls /dev/ttyACM* /dev/ttyUSB*
121120
```
@@ -126,14 +125,11 @@ If you see a permission error, add your user to the `dialout` group, then log ou
126125
sudo usermod -aG dialout $USER
127126
```
128127

129-
Connect with:
128+
Connect to the UART shell, replacing `/dev/ttyACM0` with the device shown on your system:
130129

131130
```bash
132131
screen /dev/ttyACM0 115200
133132
```
134-
135-
Replace `/dev/ttyACM0` with the device shown on your system.
136-
137133
To exit `screen`, press the `Ctrl` key and `A`, then `K`, then `Y` to confirm.
138134

139135
### Check the shell prompt

0 commit comments

Comments
 (0)