Added README info for Serial Terminal #652
Conversation
| @@ -408,7 +408,8 @@ The arguments for *compile* are: | |||
| * `--config` to inspect the runtime compile configuration (see below). | |||
| * `-S` or `--supported` shows a matrix of the supported targets and toolchains. | |||
| * `-f` or `--flash` to flash/program a connected target after successful compile. | |||
| * `-c ` to build from scratch, a clean build or rebuild. | |||
| * `-s` or `--sterm` to open the connected target's serial terminal. This option can be chained with `-f` or `-r` so the new firmware image will be flashed to the target or reset, then open the serial terminal. | |||
There was a problem hiding this comment.
-s and -S seem confusing. I get -fr for flash and reset but seems that ending in a terminal should be an explicit --sterm or better --terminal or --term
There was a problem hiding this comment.
We would have to change the code than handles arguments to make that change. That's out of scope for this PR, probably.
There was a problem hiding this comment.
I personally don't like using the word "terminal" here. It's a tad off, as it's specifically a hardware thing https://en.wikipedia.org/wiki/Computer_terminal . What were talking about is really a terminal emulator. We could also claim that daplink is the terminal, and that we are connecting to it, so --connect might also make sense.
There was a problem hiding this comment.
@theotherjimmy In terms of other tutorials (like the offline quickstart) we refer to viewing serial port output as opening up a "serial terminal". I personally think calling it an emulator is confusing. Thoughts? Maybe "serial port viewer"?
There was a problem hiding this comment.
In terms of how the word "terminal" is used these days, it probably means "something that takes input, accepts output and looks like a command line". That's why I mentioned that it was a personal pref. Also, calling it an "emulator" is confusing because you omit "terminal" and the user is left without the context of what is being emulated.
I think that "serial port viewer" may have the same problem that "sterm" and "serial terminal" has: it starts with an "s", making the short option -s, which conflicts with -S. Further, I would rather we use terminal here, as it's a better understood word for this than "port viewer", despite being slightly inaccurate. Especially as "port viewer" might imply to a user that they cannot interact with the device.
There was a problem hiding this comment.
mbed terminal?
Note that mbed status is not a verb, nor is mbed releases
There was a problem hiding this comment.
Well you have me there :D The -s vs -S conflict exists on mbed compile only, as far as I know. Are you suggesting that mbed term/mbed terminal builds the code too? Maybe through a switch? Maybe as opt-out?
There was a problem hiding this comment.
Is "console" the word you're looking for? Regardless of what you have locally, and whether you call it a terminal or whatever you're looking and interfacing with the target's console.
(The word console got used in some of the new API added in mbed OS 5.8 to redirect stdin/stdout it to different physical interfaces).
There was a problem hiding this comment.
mbed console sounds good, but then the option -c would conflict with the existing -c for a clean build
|
See revised PR #664 |
|
@yennster The Serial Terminal functionality made it in the Mbed CLI 1.6 release. Do you think that this PR is still needed? |
This PR adds help information to the README file for the new Serial Terminal feature (#650)
It includes:
mbed compileandmbed detect@screamerbg