New feature: Serial Terminal (revised) #664

screamerbg · 2018-04-29T00:30:05Z

Revised based on feedback in #650 and #652

This PR adds serial terminal feature to Mbed CLI via mbed sterm command. Currently, the supported command-line arguments are:

--port <COM port> to specify system COM port to connect to.
--baudrate <numeric> to select the communication baudrate, where the default value is 9600.
--echo <on|off> to switch local echo (default is on).
--reset to reset the connected target by sending Break before opening the serial terminal.

If no COM port is specified, Mbed CLI will attempt to detect the connected Mbed target and its COM port.

Inside the serial terminal, there's a wider variety of options:

--- CTRL+B     Send Break (reset target)
--- CTRL+C     Exit terminal
--- CTRL+E     Toggle local echo
--- CTRL+H     Help
--- CTRL+T     Menu escape key, followed by:
---    P       Change COM port
---    B       Change baudrate
---    TAB     Show detailed terminal info
---    CTRL+A  Change encoding (default UTF-8)
---    CTRL+F  Edit filters
---    CTRL+L  Toggle EOL
---    CTRL+R  Toggle RTS
---    CTRL+D  Toggle DTR
---    CTRL+C  Send control character to remote
---    CTRL+T  Send control character to remote

Example usage with mbed sterm

$ mbed sterm -r -b 115200
[mbed] Detecting connected targets/boards to your system...
[mbed] Opening serial terminal to "DISCO_L475VG_IOT01A"
--- Terminal on /dev/tty.usbmodem1413 - 115200,8,N,1 ---
$$$076402216E3C651F5178F3460x10000188
Start Simple Mbed Cloud Client
Connecting to the network using Wifi...

This feature also extends the mbed compile command and adds --sterm argument, which could be combined with -f/--flash. This enables automation workflow where Mbed CLI will first compile a program, then flash/apply it onto the connected target, and then open serial terminal to the target, so you can check the output of the freshly compiled program - see below.

$ mbed compile -t GCC_ARM -m DETECT -f --sterm
Building project mbed-os-example-blinky (DISCO_L475VG_IOT01A, GCC_ARM)
Scan: .
Scan: mbed
Scan: env
Compile [100.0%]: main.cpp
Link: mbed-os-example-blinky
Elf2Bin: mbed-os-example-blinky
+------------------+-------+-------+------+
| Module           | .text | .data | .bss |
+------------------+-------+-------+------+
| [fill]           |   102 |     7 |   11 |
| [lib]/c.a        | 27166 |  2204 |   56 |
| [lib]/gcc.a      |  3752 |     0 |    0 |
| [lib]/m.a        |    88 |     0 |    0 |
| [lib]/misc       |   236 |    16 |   28 |
| main.o           |   267 |     4 |  276 |
| mbed-os/drivers  |  1301 |     4 |  100 |
| mbed-os/hal      |  1395 |     4 |   66 |
| mbed-os/platform |  3096 |     4 |  354 |
| mbed-os/rtos     |  9114 |   168 | 5989 |
| mbed-os/targets  |  7017 |     5 |  388 |
| Subtotals        | 53534 |  2416 | 7268 |
+------------------+-------+-------+------+
Total Static RAM memory (data + bss): 9684 bytes
Total Flash memory (text + data): 55950 bytes

Image: ./BUILD/DISCO_L475VG_IOT01A/GCC_ARM/mbed-os-example-blinky.bin
[mbed] Detecting connected targets/boards to your system...
[mbed] Opening serial terminal to "DISCO_L475VG_IOT01A"
--- Terminal on /dev/tty.usbmodem1413 - 115200,8,N,1 ---
$$$07200221061A657F395EF362start
something 1
something 2
something 3

The implementation is based on PySerial, which is one of the fundamental libraries for Mbed Greentea (mbed test). Therefore there are no additional dependencies.

Inspired by @yennster's request (#639).
Also revised based on feedback in #650 and #652

…s are present

…dback

sg-

LGTM 👍 but might want @toyowata to review and confirm if we are using UTF-8 support by default with the Arm standard library and Japanese characters.

toyowata · 2018-04-30T05:49:54Z

@sg- @screamerbg

I tested it on Japanese Windows 10 and works fine.
The test program had UTF-8 Japanese code below.

#include "mbed.h"

DigitalOut led1(LED1);

// main() runs in its own thread in the OS
int main() {
    printf("hello, Mbed world!\n");
    printf("こんにちは。ｴｪｪｪｪﾝﾍﾞｯﾄﾞの世界へようこそ！\n");
    int count = 0;
    while (true) {
        led1 = !led1;
        printf("count = %d\n", ++count);
        wait(0.5);
    }
}

C:\Users\toyom\mbed-os-example-blinky>mbed sterm
[mbed] Detecting connected targets/boards to your system...
[mbed] Opening serial terminal to "K64F"
--- Terminal on COM22 - 9600,8,N,1 ---
hello, Mbed world!
こんにちは。ｴｪｪｪｪﾝﾍﾞｯﾄﾞの世界へようこそ！
count = 1
count = 2
count = 3
count = 4
count = 5
count = 6
count = 7
count = 8
count = 9
count = 10
count = 11
count = 12
count = 13
count = 14
--- [QUIT] ---

screamerbg · 2018-04-30T17:53:08Z

Bump @theotherjimmy @yennster

Also cc @jupe @teetak01

yennster · 2018-04-30T18:59:32Z

@screamerbg For all of the commands with letters such as CTRL+B, does this command require that B be capitalized? i.e. the full command would be CTRL+SHIFT+b?

screamerbg · 2018-04-30T19:12:48Z

@yennster these don't have to be capitalised. Technically lower case.

theotherjimmy · 2018-04-30T19:23:07Z

@screamerbg I'd personally like to see them lower cased. I don't think anyone will have a problem with CTRL vs. Ctrl, although the later is what's printed on my keyboard...

screamerbg · 2018-05-09T17:24:57Z

@theotherjimmy @yennster These are now provided lower case (see latest commit)

screamerbg · 2018-05-09T17:25:27Z

Bump @MarceloSalazar

screamerbg · 2018-05-09T17:47:16Z

@iriark01 @AnotherButler @GarySwansonARM @cargro This feature could replace the various OS-specific terminal tools we have in OS documentation and training materials. What do you think?

theotherjimmy · 2018-05-09T18:16:08Z

@screamerbg As usual, you want to specify the version of Mbed CLI :D. Yes documenting this feature are the primary method of interaction with the serial console is warranted. You may want to leave the rest as alternatives.

MarceloSalazar

Works great!

yennster · 2018-05-10T20:42:10Z

mbed/mbed_terminal.py

+--- Mbed Serial Terminal (0.3a)
+--- Based on miniterm from pySerial
+---
+--- CTRL+B     Send Break (reset target)


@screamerbg Are these just comments within the file? Can they be changed to match the lowercase commands in the README? (L67-L85)

yennster · 2018-05-10T20:47:03Z

README.md

+- Ctrl+t - Menu escape key
+- _Even more shortcuts are available through the Menu shortcut. Check the help within the serial terminal (Ctrl+h).__
+
+To automate things, 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 serial terminal to it's COM port:


@screamerbg I think this should say:

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 it's COM port:

That's great. Thanks!

yennster · 2018-05-10T20:47:20Z

README.md

+- Ctrl+e - Toggle local echo
+- Ctrl+h - Help
+- Ctrl+t - Menu escape key
+- _Even more shortcuts are available through the Menu shortcut. Check the help within the serial terminal (Ctrl+h).__


@screamerbg Why not list all of the shortcut commands within the README?

@yennster Primarily because it's a long list of commands that are very specific to the console experience. Unless you have the console running, you won't care about these options. Does this make sense?

screamerbg · 2018-05-15T10:31:41Z

cc @janjongboom @BlackstoneEngineering @neil-tan

iriark01 · 2018-05-15T10:32:55Z

@AnotherButler can you do a quick run-through please?

BlackstoneEngineering · 2018-05-15T13:24:31Z

I assume we've tested it and works on all 3 OS's? Im super pumped for this, cant wait to make a video about it!

yennster · 2018-05-15T17:44:37Z

README.md

+- Ctrl+e - Toggle local echo
+- Ctrl+h - Help
+- Ctrl+t - Menu escape key
+- _Even more shortcuts are available through the Menu shortcut. Check the help within the serial terminal (Ctrl+h).__


I think the last bullet should say:

More shortcuts can be viewed within the serial terminal's help menu (Ctrl+h).

yennster · 2018-05-15T17:50:00Z

README.md

+- Ctrl+t - Menu escape key
+- _Even more shortcuts are available through the Menu shortcut. Check the help within the serial terminal (Ctrl+h).__
+
+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 it's COM port:


Also, this line needs references to commands wrapped in code tags:

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 it's COM port:

yennster · 2018-05-15T17:52:27Z

README.md

@@ -514,6 +514,32 @@ $ mbed export -i uvision -m K64F

 Mbed CLI creates a `.uvprojx` file in the projectfiles/uvision folder. You can open the project file with uVision.

+### Serial terminal
+
+You can open a serial terminal to the COM port of a connected Mbed target (usually board) using the `mbed sterm` command. If no COM port is specified, Mbed CLI will attempt to detect the connected Mbed targets and their COM ports.


Mbed CLI will attempt to detect the connected Mbed targets and their COM ports.

Does this mean you can use the mbed sterm command with multiple Mbed boards plugged into the computer at the same time?

Yes. It would detect all and iterate through them (one by one, not simultaneously).

screamerbg · 2018-05-17T18:44:19Z

@BlackstoneEngineering it's now live.

jeromecoutant · 2018-06-06T10:20:39Z

Hi @screamerbg

As in test_api.py, greentea is able to detect the used baud rate:
baud_rate = cfg['platform.stdio-baud-rate'].value

Do you think it is possible to get the same feature within 'mbed compile xxx -f --sterm' command ?

Thx

theotherjimmy · 2018-06-06T14:43:55Z

@screamerbg If we were to implement this feature, it would involve calling mbed compile --config to extract the parameter. That seems pretty excessive, implementation wise.

screamerbg added 8 commits April 29, 2018 01:08

Add initial support for PySerial Miniterm

f6c29a7

Allow reset and sterm switches for 'mbed detect' even if mbed OS tool…

4aeb3be

…s are present

Fix help messages

6c8cf25

Move CDC code to separate python file

2753d3a

Catch missing serial module (but don't depend on it)

05d2216

Address comments in PR ARMmbed#650

c4c4c01

Reimplement Serial Terminal feature and documentation based on PR fee…

dd6cb5d

…dback

Minor help improvements

90a548b

screamerbg requested review from sg-, theotherjimmy, MarceloSalazar and yennster April 29, 2018 00:30

screamerbg mentioned this pull request Apr 29, 2018

New feature: Serial Terminal #650

Closed

Fix 'mbed sterm --echo off' behavior

15d50d7

sg- approved these changes Apr 29, 2018

View reviewed changes

yennster mentioned this pull request Apr 30, 2018

Added README info for Serial Terminal #652

Closed

Fix capitalized shortcuts in command-line and terminal help

4c30306

theotherjimmy approved these changes May 9, 2018

View reviewed changes

MarceloSalazar approved these changes May 10, 2018

View reviewed changes

yennster reviewed May 10, 2018

View reviewed changes

Few more additions based on PR feedback

3c9dbf4

screamerbg force-pushed the feature_term branch from a23b253 to 3c9dbf4 Compare May 15, 2018 10:27

yennster suggested changes May 15, 2018

View reviewed changes

yennster reviewed May 15, 2018

View reviewed changes

Few more additions based on PR feedback ARMmbed#2

dbb455f

screamerbg requested a review from AnotherButler May 16, 2018 13:19

AnotherButler approved these changes May 16, 2018

View reviewed changes

yennster approved these changes May 16, 2018

View reviewed changes

screamerbg merged commit 66f734d into ARMmbed:master May 16, 2018

screamerbg mentioned this pull request May 26, 2018

parser for MBED_MEM_TRACE output #630

Closed

fasthazard mentioned this pull request Aug 24, 2018

[mbed] ERROR: Unknown Error: __init__() should return None, not 'bool' #688

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New feature: Serial Terminal (revised) #664

New feature: Serial Terminal (revised) #664

screamerbg commented Apr 29, 2018

sg- left a comment

toyowata commented Apr 30, 2018 •

edited

Loading

screamerbg commented Apr 30, 2018

yennster commented Apr 30, 2018

screamerbg commented Apr 30, 2018

theotherjimmy commented Apr 30, 2018

screamerbg commented May 9, 2018

screamerbg commented May 9, 2018

screamerbg commented May 9, 2018

theotherjimmy commented May 9, 2018

MarceloSalazar left a comment

yennster May 10, 2018 •

edited

Loading

yennster May 10, 2018

screamerbg May 15, 2018

yennster May 10, 2018

screamerbg May 15, 2018

screamerbg commented May 15, 2018

iriark01 commented May 15, 2018

BlackstoneEngineering commented May 15, 2018

yennster May 15, 2018

yennster May 15, 2018

yennster May 15, 2018 •

edited

Loading

screamerbg May 16, 2018

screamerbg commented May 17, 2018

jeromecoutant commented Jun 6, 2018

theotherjimmy commented Jun 6, 2018

New feature: Serial Terminal (revised) #664

New feature: Serial Terminal (revised) #664

Conversation

screamerbg commented Apr 29, 2018

sg- left a comment

Choose a reason for hiding this comment

toyowata commented Apr 30, 2018 • edited Loading

screamerbg commented Apr 30, 2018

yennster commented Apr 30, 2018

screamerbg commented Apr 30, 2018

theotherjimmy commented Apr 30, 2018

screamerbg commented May 9, 2018

screamerbg commented May 9, 2018

screamerbg commented May 9, 2018

theotherjimmy commented May 9, 2018

MarceloSalazar left a comment

Choose a reason for hiding this comment

yennster May 10, 2018 • edited Loading

Choose a reason for hiding this comment

yennster May 10, 2018

Choose a reason for hiding this comment

screamerbg May 15, 2018

Choose a reason for hiding this comment

yennster May 10, 2018

Choose a reason for hiding this comment

screamerbg May 15, 2018

Choose a reason for hiding this comment

screamerbg commented May 15, 2018

iriark01 commented May 15, 2018

BlackstoneEngineering commented May 15, 2018

yennster May 15, 2018

Choose a reason for hiding this comment

yennster May 15, 2018

Choose a reason for hiding this comment

yennster May 15, 2018 • edited Loading

Choose a reason for hiding this comment

screamerbg May 16, 2018

Choose a reason for hiding this comment

screamerbg commented May 17, 2018

jeromecoutant commented Jun 6, 2018

theotherjimmy commented Jun 6, 2018

toyowata commented Apr 30, 2018 •

edited

Loading

yennster May 10, 2018 •

edited

Loading

yennster May 15, 2018 •

edited

Loading