Add serial terminal section to cli-collaborate.md #1000
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add section from legacy documentation.
|
PR #1000 🎉 |
theotherjimmy
suggested changes
Mar 8, 2019
docs/tools/CLI/cli-collaborate.md
Outdated
| @@ -101,6 +101,35 @@ $ mbed export -i uvision -m K64F | |||
|
|
|||
| Mbed CLI creates a `.uvprojx` file in the root project directory. 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. | |||
There was a problem hiding this comment.
COM port is a windows-only term. They're called tty... on linux and OSX. Could we replace COM with serial?
docs/tools/CLI/cli-collaborate.md
Outdated
|
|
||
| There are various options to `mbed sterm`: | ||
|
|
||
| - `--port <COM port>` to specify system COM port to connect to. |
There was a problem hiding this comment.
COM -> serial. again, to remove a windows-only term
docs/tools/CLI/cli-collaborate.md
Outdated
|
|
||
| More shortcuts can be viewed within the serial terminal's help menu (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 its COM port: |
Replaces references to COM with serial, so the instructions don't relate only to Windows, as requested in the comments.
theotherjimmy
approved these changes
Mar 8, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add section from legacy documentation.