Skip to content

Commit 1d8fc06

Browse files
committed
Edit pass for house style
1 parent 0fe105c commit 1d8fc06

File tree

4 files changed

+42
-47
lines changed

4 files changed

+42
-47
lines changed

docs/embedded/download-and-install-the-embedded-tooling.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,46 +12,40 @@ monikerRange: '>=msvc-170'
1212

1313
# [Visual Studio](#tab/visual-studio)
1414

15-
## Download, install, and set up the Embedded workload
15+
In Visual Studio 2022 and later versions, you can use the Visual Studio IDE on Windows to edit and debug embedded projects. Use tools such as the [Peripheral Viewer](./peripheral-view.md), [RTOS Viewer](./rtos-view.md), and the [Serial Monitor](./serial-monitor.md) to help interact with and debug your embedded projects.
1616

17-
Embedded tooling is supported in Visual Studio 2022 and later. To see the documentation for these versions, set the Visual Studio **Version** selector control for this article to Visual Studio 2022. It's found at the top of the table of contents on this page.
17+
To use the embedded development tools in Visual Studio, you must install the required **Linux and embedded development with C++** workload.
1818

19-
You can use the Visual Studio IDE on Windows to edit and debug Embedded projects.
19+
## To install the Linux and embedded development with C++ workload
2020

21-
You can use tools like the [Peripheral Viewer](./peripheral-view.md), [RTOS Viewer](./rtos-view.md), and the [Serial Monitor](./serial-monitor.md) to help interact with and debug your embedded projects.
22-
23-
For any of these scenarios, the **Linux and embedded development with C++** workload is required.
24-
25-
## Visual Studio setup
26-
27-
1. Type "Visual Studio Installer" in the Windows search box:
21+
1. Enter "Visual Studio Installer" in the Windows search box:
2822

2923
![Screenshot showing the Windows search box.](../linux/media/visual-studio-installer-search.png)
3024

31-
1. Look for the installer under the **Apps** results and double-click it. When the installer opens, choose **Modify**, and then click on the **Workloads** tab. Scroll down to **Other toolsets** and select the **Linux and embedded development with C++** workload.
25+
1. Open the Visual Studio Installer. In Visual Studio Installer, choose **Modify** next to your installation of Visual Studio, and then select the **Workloads** tab. Scroll down to **Other toolsets** and select the **Linux and embedded development with C++** workload.
3226

3327
![Screenshot showing the Visual C++ for Linux Development workload item in Visual Studio Installer.](media/linux-and-embedded-workload.png)
3428

35-
1. Click **Modify** to continue with the installation.
29+
1. Choose **Modify** to continue with the installation.
30+
31+
When installation completes, you're ready to use Visual Studio for embedded development.
3632

3733
# [Visual Studio Code](#tab/visual-studio-code)
3834

39-
## Install the Embedded extensions in VSCode
35+
## Install the Embedded extensions in Visual Studio Code
4036

41-
Embedded tools like a [Peripheral Viewer](./peripheral-view.md), [RTOS Viewer](./rtos-view.md), and a [Serial Monitor](./serial-monitor.md) are supported in VSCode. This means that you now can use Microsoft tools to help debug your embedded applications in VSCode.
37+
Microsoft provides an extension to Visual Studio Code that lets you use embedded tools such as a [Peripheral Viewer](./peripheral-view.md), [RTOS Viewer](./rtos-view.md), and a [Serial Monitor](./serial-monitor.md). Now you can use Microsoft tools to help debug your Linux-based embedded applications.
4238

43-
## Visual Studio Code setup
39+
## To install the embedded extensions for Visual Studio Code
4440

45-
1. Type Visual Studio Code in the Windows search box:
41+
1. Enter "Visual Studio Code" in the Windows search box:
4642

4743
![Search-Visual-Studio-Code](media/windows-search-vscode.png)
4844

49-
1. Look for Visual Studio Code under **Apps** and double-click it. When Visual Studio Code opens, open the **Extensions Pane**.
45+
1. Open Visual Studio Code. In Visual Studio Code, open the **Extensions Pane**.
5046

5147
![Visual Studio Code Extensions Pane](media/extensions-pane.png)
5248

53-
### Install the Embedded Tools extension
54-
5549
1. Search for and install the [Embedded Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-embedded-tools) extension.
5650

5751
![Embedded Tools extension](media/embedded-tools-extension.png)
@@ -60,4 +54,6 @@ Embedded tools like a [Peripheral Viewer](./peripheral-view.md), [RTOS Viewer](.
6054

6155
![Serial Monitor extension](media/serial-monitor-extension.png)
6256

57+
When installation completes, you're ready to use Visual Studio Code for embedded development.
58+
6359
---

docs/embedded/peripheral-view.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ monikerRange: '>=msvc-170'
1010

1111
## Overview
1212

13-
The Peripheral View allows embedded developers to view and manipulate registers and peripherals defined SVD (System View Description) files.
13+
The Peripheral View allows embedded developers to view and manipulate registers and peripherals defined in SVD (System View Description) files.
1414

1515
# [Visual Studio](#tab/visual-studio)
1616

1717
![Peripheral View in VS](media/peripheral-viewer.png)
1818

1919
# [Visual Studio Code](#tab/visual-studio-code)
2020

21-
![Peripheral View in VSCode](media/peripheral-viewer-vscode.png)
21+
![Peripheral View in Visual Studio Code](media/peripheral-viewer-vscode.png)
2222

2323
---
2424

2525
## Capabilities
2626

27-
|Capabilities|Description|Instructions|Keyboard shortcuts|
27+
| Capability | Description | Instructions | Keyboard shortcuts |
2828
|:-:|:-:|:-:|:-:|
29-
|Navigation|Navigate the peripheral tree view by collapsing and expanding components in the tree view|Scroll to view all of the peripherals. Press the caret on each item to expand or collapses|Arrow-Up/Arrow-Down to scroll. Arrow-Left/Arrow-Right to expand/collapse.
30-
|Editing|Modify writeable peripheral values|Double click on the peripheral value to edit and press Enter to submit that value|F2 to edit. Esc to cancel editing. Enter to submit edits.|
31-
|Accessing memory|View the memory locations of peripherals|Click on the linked memory addresses|Tab to the link, Enter to navigate to the link.|
32-
|Pinning|Pin important peripherals to the top of the view|Click the pin icon to pin or unpin peripherals|Tab to the pin icon, Enter to pin/unpin|
29+
| Navigate peripherals | Navigate the peripheral tree view by collapsing and expanding components in the tree view. | Scroll to view all of the peripherals. Select the caret on each item to expand or collapse the view. | Use the **Up** or **Down** arrow keys to scroll. Use the **Left** and **Right** arrow keys to expand or collapse the view. |
30+
| Edit peripheral values | Modify writeable peripheral values. | Select the peripheral value to edit. Use the **Enter** key to submit that value. | Use the **F2** key to edit, **Esc** to cancel editing, and **Enter** to submit edits. |
31+
| Access memory | View the memory locations of peripherals. | Select the linked memory addresses to view. | Use **Tab** to select the link, and **Enter** to navigate to the link. |
32+
| Pin peripherals | Pin important peripherals to the top of the view. | Select the pin icon to pin or unpin peripherals. | Use **Tab** to select the pin icon, and **Enter** to pin or unpin it. ||

docs/embedded/rtos-view.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ monikerRange: '>=msvc-170'
1010

1111
## Overview
1212

13-
The RTOS Object Views allow for users to view various components of an RTOS while debugging their application.
13+
The RTOS Object View allows users to view various components of an RTOS while debugging their application.
1414

1515
# [Visual Studio](#tab/visual-studio)
1616

@@ -25,14 +25,14 @@ The RTOS Object Views allow for users to view various components of an RTOS whil
2525
## Supported RTOSes and their supported object types
2626

2727
- ThreadX
28-
- All of the **Available Object Types** list
28+
- All of the types listed in **Available object types**
2929
- FreeRTOS
3030
- Threads
3131
- Queues
3232
- Zephyr
33-
- All of the **Available Object Types** list
33+
- All of the types listed in **Available object types**
3434

35-
## Available Object Types
35+
### Available object types
3636

3737
- Block Pools
3838
- Byte Pools
@@ -45,10 +45,9 @@ The RTOS Object Views allow for users to view various components of an RTOS whil
4545

4646
## Usage
4747

48-
- Access memory locations of various objects
49-
- Access thread variables or various objects in the Watch view
48+
Use the RTOS Object View to:
5049

51-
## Accessibility
50+
- Access memory locations of various objects.
51+
- Access thread variables or various objects in the Watch view.
5252

53-
- Use the Arrow Keys to navigate the view
54-
- Press Enter to navigate to linked content
53+
Use the arrow keys to select objects within the view. Use the **Enter** key to navigate to the linked content.

docs/embedded/serial-monitor.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Serial Monitor"
33
ms.date: "07/12/2022"
4-
description: "Serial Monitor tool that allows user to monitor, and communicate with serial ports."
4+
description: "Serial Monitor allows users to configure, monitor, and communicate with serial ports."
55
author: gcampbell-msft
66
ms.author: gcampbell
77
monikerRange: '>=msvc-170'
@@ -24,17 +24,17 @@ The Serial Monitor allows users to configure, monitor, and communicate with seri
2424

2525
## Capabilities
2626

27-
- `Monitor a serial port`: Press the "Start Monitoring" or "Stop Monitoring button to begin monitoring data coming from the port.
28-
- `Send data to a serial port`: Input text into the text field at the bottom of the view. Press Enter or the "Send Message" button to send the data.
29-
- `Clear the Serial Monitor output`: Press the clear output button to clear the incoming data text field.
30-
- `Configure Serial Monitor and port connection settings`: See the following table to learn about the settings that the Serial Monitor provides.
27+
- **Monitor a serial port**: Choose the **Start Monitoring** or **Stop Monitoring** button to control whether to monitor data coming from the port.
28+
- **Send data to a serial port**: Enter text into the text field at the bottom of the view. Use the **Enter** key or choose the **Send Message** button to send the data.
29+
- **Clear the Serial Monitor output**: Choose the **Clear Output** button to clear the incoming data text field.
30+
- **Configure Serial Monitor and port connection settings**: See the following table to learn about the settings that the Serial Monitor provides.
3131

3232
## Configurable settings
3333

34-
|Settings|Description|Usage|Available options|
35-
|:------:|:---------:|:-:|:-:|
36-
|Port|Ports that are actively connected to a device|Use the `Port` dropdown|Serial port compatible devices connected to the machine|
37-
|Baud Rate|Frequency at which the monitor will attempt to communicate with the connected device|Use the `Baud Rate` dropdown|300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 74880, 115200, 230000, 250000|
38-
|Line ending|Appended line ending on messages sent to the connected device|Use the `Line Ending` dropdown|None, LF, CR, CRLF|
39-
|Timestamp|Ability to add timestamps to the output of data received from the connected port|Use the `timestamp` toggle button|On/Off|
40-
|Auto-scrolling|Ability to "auto-scroll" with new content coming from the connected port|Use the `auto-scroll` toggle button|On/Off|
34+
| Settings | Description | Usage | Available options |
35+
|--|--|--|--|
36+
| **Port** | Ports that are actively connected to a device | Use the **Port** dropdown | Serial port compatible devices connected to the machine |
37+
| **Baud Rate** | Frequency at which the monitor attempts to communicate with the connected device | Use the **Baud Rate** dropdown | 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 74880, 115200, 230000, 250000 |
38+
| **Line ending** | The line ending to use in messages sent to the connected device | Use the **Line Ending** dropdown | None, LF, CR, CRLF |
39+
| **Timestamp** | Adds timestamps to the output of data received from the connected port | Use the **timestamp** toggle button | On/Off |
40+
| **Auto-scroll** | Whether to auto-scroll new content that comes from the connected port | Use the **auto-scroll** toggle button | On/Off |

0 commit comments

Comments
 (0)