Skip to content

Commit 8716659

Browse files
opbld17gcampbell-msftcolin-home19BMG00v-alje
authored
Repo sync for protected CLA branch (MicrosoftDocs#4061)
* add initial doc stubs * Initial docs push, contains stubs for some files and a stub for a landing page * update some links * add more cards and links to the Hub page * fix error * remove monikor's so it's easy to test, fix rtos-view.md path * fix link * add more to the sidebar * update peripheral view by consolidating to the table, change things to objects in rtos-view * add tabs * forgot to end tabbed section * fix items after adding tabs * update h1 * slightly fix some wording * add link from C++ and C workloads, features, and libraries to embedded hub * move into own directory so that the url is better * fix some warnings * remove next steps that pointed to linux items * prefer tabbed view vs table * attempt to add moniker * attempt highest moniker in range * assign to a specific version * push again to get new build * add '=' sign to try and test it * add metadata for msvc-170 * add moniker range for index.yml * remove inline moniker since we only need it on the files themselves * Follow up 4221 Acrolinx score for TN035 * Fix heading style * Update C++-specific template info * Fix links to raw and rendered markdown * Edit pass for house style * add 'while debugging' for peripheral-view * Fix table issue, stray punctuation Co-authored-by: Garrett Campbell <gcampbell@microsoft.com> Co-authored-by: Colin Robertson <3836425+corob-msft@users.noreply.github.com> Co-authored-by: Bryan Gold <101299717+19BMG00@users.noreply.github.com> Co-authored-by: Alma Jenks <v-alje@microsoft.com>
1 parent d574947 commit 8716659

18 files changed

+270
-0
lines changed

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

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: "Install the Embedded tooling in Visual Studio and Visual Studio Code"
3+
description: "How to download and install the Embedded tooling in Visual Studio and Visual Studio Code."
4+
ms.date: "07/12/2022"
5+
ms.custom: intro-installation
6+
author: gcampbell-msft
7+
ms.author: gcampbell
8+
monikerRange: '>=msvc-170'
9+
---
10+
11+
# Download and install the Embedded tooling
12+
13+
# [Visual Studio](#tab/visual-studio)
14+
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.
16+
17+
To use the embedded development tools in Visual Studio, you must install the required **Linux and embedded development with C++** workload.
18+
19+
## To install the Linux and embedded development with C++ workload
20+
21+
1. Enter "Visual Studio Installer" in the Windows search box:
22+
23+
![Screenshot showing the Windows search box.](../linux/media/visual-studio-installer-search.png)
24+
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.
26+
27+
![Screenshot showing the Visual C++ for Linux Development workload item in Visual Studio Installer.](media/linux-and-embedded-workload.png)
28+
29+
1. Choose **Modify** to continue with the installation.
30+
31+
When installation completes, you're ready to use Visual Studio for embedded development.
32+
33+
# [Visual Studio Code](#tab/visual-studio-code)
34+
35+
## Install the Embedded extensions in Visual Studio Code
36+
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.
38+
39+
## To install the embedded extensions for Visual Studio Code
40+
41+
1. Enter "Visual Studio Code" in the Windows search box:
42+
43+
![Search-Visual-Studio-Code](media/windows-search-vscode.png)
44+
45+
1. Open Visual Studio Code. In Visual Studio Code, open the **Extensions Pane**.
46+
47+
![Visual Studio Code Extensions Pane](media/extensions-pane.png)
48+
49+
1. Search for and install the [Embedded Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-embedded-tools) extension.
50+
51+
![Embedded Tools extension](media/embedded-tools-extension.png)
52+
53+
1. Search for and install the [Serial Monitor](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor) extension.
54+
55+
![Serial Monitor extension](media/serial-monitor-extension.png)
56+
57+
When installation completes, you're ready to use Visual Studio Code for embedded development.
58+
59+
---

‎docs/embedded/index.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
### YamlMime:Landing
2+
title: Embedded development with C++ | Create and debug embedded applications # < 60 chars
3+
summary: Use Embedded tooling in Visual Studio 2022 and later to create and debug applications for Embedded. # < 160 chars
4+
5+
metadata:
6+
title: Embedded development with C++
7+
description: Learn how to use Embedded tooling in Visual Studio and Visual Studio Code to create and debug applications for Linux.
8+
ms.topic: landing-page
9+
author: gcampbell-msft
10+
ms.author: gcampbell
11+
ms.date: 07/12/2022
12+
ms.custom: intro-landing-hub
13+
monikerRange: '>=msvc-170'
14+
15+
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new
16+
17+
landingContent:
18+
# Cards and links should be based on top customer tasks or top subjects
19+
# Start card title with a verb
20+
21+
# Card
22+
- title: Build and debug embedded projects in Visual Studio and Visual Studio Code
23+
linkLists:
24+
- linkListType: get-started
25+
links:
26+
- text: Download the Embedded workload in Visual Studio and Visual Studio Code
27+
url: download-and-install-the-embedded-tooling.md
28+
- linkListType: how-to-guide
29+
links:
30+
- text: Getting started guides
31+
url: https://github.com/azure-rtos/getting-started
32+
- linkListType: tutorial
33+
links:
34+
- text: Embedded Software Development in Visual Studio
35+
url: https://devblogs.microsoft.com/cppblog/visual-studio-embedded-development/
36+
- text: Embedded Software Development in Visual Studio Code
37+
url: https://devblogs.microsoft.com/cppblog/vscode-embedded-development/
38+
- linkListType: whats-new
39+
links:
40+
- text: Zephyr support in Visual Studio and Visual Studio Code
41+
url: https://devblogs.microsoft.com/cppblog/serial-and-zephyr-support/
42+
43+
- title: Embedded Tooling in Visual Studio and Visual Studio Code
44+
linkLists:
45+
- linkListType: reference
46+
links:
47+
- text: Peripheral Viewer
48+
url: ./peripheral-view.md
49+
- text: RTOS Viewer
50+
url: ./rtos-view.md
51+
- text: Serial Monitor
52+
url: ./serial-monitor.md
53+
54+
- title: More embedded tools
55+
linkLists:
56+
- linkListType: whats-new
57+
links:
58+
- text: Bootstrap your development environment
59+
url: https://devblogs.microsoft.com/cppblog/vcpkg-artifacts/

‎docs/embedded/media/embedded-tools-extension.png‎

20 KB
Loading

‎docs/embedded/media/extensions-pane.png‎

30.9 KB
Loading

‎docs/embedded/media/linux-and-embedded-workload.png‎

99.1 KB
Loading

‎docs/embedded/media/peripheral-viewer-vscode.png‎

27.1 KB
Loading

‎docs/embedded/media/peripheral-viewer.png‎

30.7 KB
Loading

‎docs/embedded/media/rtos-threads-vscode.png‎

52.7 KB
Loading

‎docs/embedded/media/rtos-threads.png‎

36.5 KB
Loading

‎docs/embedded/media/serial-monitor-extension.png‎

11 KB
Loading

0 commit comments

Comments
 (0)