Skip to content

Commit a965077

Browse files
committed
Move the sterm instructions into test/debug
1 parent 47c1e22 commit a965077

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

docs/tools/CLI/cli-collaborate.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,6 @@ Don't forget to set the current directory as the root of your program:
1616
$ mbed new .
1717
```
1818

19-
#### Serial terminal
20-
21-
You can open a serial terminal to the serial port of a connected Mbed target (usually board) using the `mbed sterm` command. If no serial port is specified, Mbed CLI will attempt to detect the connected Mbed targets and their serial ports.
22-
23-
There are various options to `mbed sterm`:
24-
25-
- `--port <serial port>` to specify system serial port to connect to.
26-
- `--baudrate <numeric>` to select the communication baudrate, where the default value is 9600.
27-
- `--echo <on|off>` to switch local echo (default is `on`).
28-
- `--reset` to reset the connected target by sending Break before opening the serial terminal.
29-
30-
You can also set default port, baudrate and echo mode using the `TERM_PORT`, `TERM_BAUDRATE` and `TERM_ECHO` Mbed CLI configuration options.
31-
32-
The following shortcuts are available within the serial terminal:
33-
34-
- Ctrl+b - Send Break (reset target)
35-
- Ctrl+c - Exit terminal
36-
- Ctrl+e - Toggle local echo
37-
- Ctrl+h - Help
38-
- Ctrl+t - Menu escape key
39-
40-
More shortcuts can be viewed within the serial terminal's help menu (Ctrl+h).
41-
42-
You can also add the `--sterm` option to `mbed compile -f` to compile a new program, flash the program/firmware image to the connected target and then open the serial terminal to its serial port:
43-
44-
```
45-
$ mbed compile -t GCC_ARM -m K64F -f --sterm
46-
```
47-
4819
### Publishing changes
4920

5021
#### Checking status

docs/tools/CLI/cli-test-debug.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,35 @@ All unit tests are under the `mbed-os/UNITTESTS` directory. You can **generate**
271271
$ mbed test --unittests --new rtos/Semaphore.cpp
272272
```
273273

274+
### Serial terminal
275+
276+
You can open a serial terminal to the serial port of a connected Mbed target (usually board) using the `mbed sterm` command. If no serial port is specified, Mbed CLI will attempt to detect the connected Mbed targets and their serial ports.
277+
278+
There are various options to `mbed sterm`:
279+
280+
- `--port <serial port>` to specify system serial port to connect to.
281+
- `--baudrate <numeric>` to select the communication baudrate, where the default value is 9600.
282+
- `--echo <on|off>` to switch local echo (default is `on`).
283+
- `--reset` to reset the connected target by sending Break before opening the serial terminal.
284+
285+
You can also set default port, baudrate and echo mode using the `TERM_PORT`, `TERM_BAUDRATE` and `TERM_ECHO` Mbed CLI configuration options.
286+
287+
The following shortcuts are available within the serial terminal:
288+
289+
- Ctrl+b - Send Break (reset target)
290+
- Ctrl+c - Exit terminal
291+
- Ctrl+e - Toggle local echo
292+
- Ctrl+h - Help
293+
- Ctrl+t - Menu escape key
294+
295+
More shortcuts can be viewed within the serial terminal's help menu (Ctrl+h).
296+
297+
You can also add the `--sterm` option to `mbed compile -f` to compile a new program, flash the program/firmware image to the connected target and then open the serial terminal to its serial port:
298+
299+
```
300+
$ mbed compile -t GCC_ARM -m K64F -f --sterm
301+
```
302+
274303
### Troubleshooting
275304

276305
#### Import Mercurial (mbed.org) programs or libraries

0 commit comments

Comments
 (0)