Skip to content

Commit 47f7d78

Browse files
Add embedded features to guides (#345)
* add tool windows to gsg * updating getting started guides in order to include embedded tools and link to public docs * remove unused images * remove images * fix names * fix names * update links * changes based on PR comments
1 parent 0912a22 commit 47f7d78

File tree

8 files changed

+82
-34
lines changed

8 files changed

+82
-34
lines changed

MXChip/AZ3166/VS.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This guide describes how to use Visual Studio to build, flash, and debug with the **MXChip AZ3166 IoT DevKit**.
44

5-
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-mxchip-az3166). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
5+
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-mxchip-az3166). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
66

7-
1. [Clone the repo for the quickstart](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-mxchip-az3166#clone-the-repo-for-the-quickstart).
7+
1. [Clone the repo for the quickstart](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-mxchip-az3166#clone-the-repo-for-the-quickstart).
88

9-
1. [Create the cloud components](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-mxchip-az3166#create-the-cloud-components).
9+
1. [Create the cloud components](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-mxchip-az3166#create-the-cloud-components).
1010

11-
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-mxchip-az3166#add-configuration).
11+
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-mxchip-az3166#add-configuration).
1212

1313
_*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
1414

@@ -83,6 +83,12 @@ This section shows how to configure your development environment with the new `v
8383
8484
1. Press `F5` to resume execution. The debugger is now running and connected the device.
8585
86+
## Using Visual Studio's Embedded Tooling
87+
88+
Visual Studio now supports additional tooling to help embedded programmers debug their applications: a [Peripheral Viewer](https://docs.microsoft.com/cpp/embedded/peripheral-view?view=msvc-170&tabs=visual-studio), a [RTOS Viewer](https://docs.microsoft.com/cpp/embedded/rtos-view?view=msvc-170&tabs=visual-studio), and a [Serial Monitor](https://docs.microsoft.com/cpp/embedded/serial-monitor?view=msvc-170&tabs=visual-studio).
89+
90+
> If you can't find these tools, ensure that you have the `Linux and embedded development with C++` workload and the `Embedded and IoT tools` component installed on your Visual Studio instance.
91+
8692
## Restoring Your Development Environment
8793
8894
`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:

MXChip/AZ3166/vscode.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This guide describes how to use Visual Studio Code to build, flash, and debug with the **MXChip AZ3166 IoT DevKit**.
44

5-
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-mxchip-az3166). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
5+
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-mxchip-az3166). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
66

7-
1. [Clone the repo for the quickstart](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-mxchip-az3166#clone-the-repo-for-the-quickstart).
7+
1. [Clone the repo for the quickstart](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-mxchip-az3166#clone-the-repo-for-the-quickstart).
88

9-
1. [Create the cloud components](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-mxchip-az3166#create-the-cloud-components).
9+
1. [Create the cloud components](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-mxchip-az3166#create-the-cloud-components).
1010

11-
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-mxchip-az3166#add-configuration).
11+
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-mxchip-az3166#add-configuration).
1212

1313
_*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
1414

@@ -144,6 +144,12 @@ This section shows how to configure your development environment with the new `v
144144
145145
1. Press `F5` to resume execution. The debugger is now running and connected the device.
146146
147+
## Using Visual Studio Code's Embedded Tooling
148+
149+
Visual Studio Code now supports additional tooling to help embedded programmers debug their applications: a [Peripheral Viewer](https://docs.microsoft.com/cpp/embedded/peripheral-view?view=msvc-170&tabs=visual-studio-code), a [RTOS Viewer](https://docs.microsoft.com/cpp/embedded/rtos-view?view=msvc-170&tabs=visual-studio-code), and a [Serial Monitor](https://docs.microsoft.com/cpp/embedded/serial-monitor?view=msvc-170&tabs=visual-studio-code).
150+
151+
> Note that if you don't see the aforementioned tooling, ensure that you have the extensions installed, [Embedded Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-embedded-tools) and [Serial Monitor](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor)
152+
147153
## Restoring Your Development Environment
148154
149155
`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:

NXP/MIMXRT1060-EVK/VS.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This guide describes how to use Visual Studio to build, flash, and debug with the **NXP MIMXRT1060-EVK Evaluation Kit**.
44

5-
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
5+
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
66

7-
1. [Clone the repo for the quickstart](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#clone-the-repo-for-the-quickstart).
7+
1. [Clone the repo for the quickstart](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#clone-the-repo-for-the-quickstart).
88

9-
1. [Create the cloud components](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#create-the-cloud-components).
9+
1. [Create the cloud components](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#create-the-cloud-components).
1010

11-
1. [Configure Azure IoT connection settings](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#add-configuration).
11+
1. [Configure Azure IoT connection settings](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#add-configuration).
1212

1313
_*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
1414

@@ -89,6 +89,12 @@ This section shows how to configure your development environment with the new `v
8989
9090
1. Press `F5` to resume execution. The debugger is now running and connected the device.
9191
92+
## Using Visual Studio's Embedded Tooling
93+
94+
Visual Studio now supports additional tooling to help embedded programmers debug their applications: a [Peripheral Viewer](https://docs.microsoft.com/cpp/embedded/peripheral-view?view=msvc-170&tabs=visual-studio), a [RTOS Viewer](https://docs.microsoft.com/cpp/embedded/rtos-view?view=msvc-170&tabs=visual-studio), and a [Serial Monitor](https://docs.microsoft.com/cpp/embedded/serial-monitor?view=msvc-170&tabs=visual-studio).
95+
96+
> If you can't find these tools, ensure that you have the `Linux and embedded development with C++` workload and the `Embedded and IoT tools` component installed on your Visual Studio instance.
97+
9298
## Restoring Your Development Environment
9399
94100
`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:

NXP/MIMXRT1060-EVK/vscode.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This guide describes how to use Visual Studio Code to build, flash, and debug with the **NXP MIMXRT1060-EVK Evaluation Kit**.
44

5-
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
5+
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
66

7-
1. [Clone the repo for the quickstart](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#clone-the-repo-for-the-quickstart).
7+
1. [Clone the repo for the quickstart](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#clone-the-repo-for-the-quickstart).
88

9-
1. [Create the cloud components](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#create-the-cloud-components).
9+
1. [Create the cloud components](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#create-the-cloud-components).
1010

11-
1. [Configure Azure IoT connection settings](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#add-configuration).
11+
1. [Configure Azure IoT connection settings](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-nxp-mimxrt1060-evk#add-configuration).
1212

1313
_*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
1414

@@ -146,6 +146,12 @@ This section shows how to configure your development environment with the new `v
146146
147147
1. Press `F5` to resume execution. The debugger is now running and connected the device.
148148
149+
## Using Visual Studio Code's Embedded Tooling
150+
151+
Visual Studio Code now supports additional tooling to help embedded programmers debug their applications: a [Peripheral Viewer](https://docs.microsoft.com/cpp/embedded/peripheral-view?view=msvc-170&tabs=visual-studio-code), a [RTOS Viewer](https://docs.microsoft.com/cpp/embedded/rtos-view?view=msvc-170&tabs=visual-studio-code), and a [Serial Monitor](https://docs.microsoft.com/cpp/embedded/serial-monitor?view=msvc-170&tabs=visual-studio-code).
152+
153+
> Note that if you don't see the aforementioned tooling, ensure that you have the extensions installed, [Embedded Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-embedded-tools) and [Serial Monitor](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor)
154+
149155
## Restoring Your Development Environment
150156
151157
`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:

STMicroelectronics/B-L475E-IOT01A/VS.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This guide describes how to use Visual Studio to build, flash, and debug with the **STMicroelectronics B-L475E-IOT01A Discovery Kit**.
44

5-
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l475e). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
5+
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l475e). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
66

7-
1. [Clone the repo for the quickstart](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l475e#clone-the-repo-for-the-quickstart).
7+
1. [Clone the repo for the quickstart](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l475e#clone-the-repo-for-the-quickstart).
88

9-
1. [Create the cloud components](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l475e#create-the-cloud-components).
9+
1. [Create the cloud components](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l475e#create-the-cloud-components).
1010

11-
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l475e#add-configuration).
11+
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l475e#add-configuration).
1212

1313
_*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
1414

@@ -70,11 +70,11 @@ This section shows how to configure your development environment with the new `v
7070
"C:\Program Files\Microsoft Visual Studio\2022\Preview\Common7\IDE\devenv"
7171
7272
1. Ensure that both the Configure Preset and the Build Preset are set to "arm-gcc-cortex-m4"
73-
73+
7474
![configuration-choice](../../docs/media/vs-preset-configuration-m4.png)
7575
7676
1. Ensure that the "Launch" target is selected as the Debug Target.
77-
77+
7878
![debug-target-choice](../../docs/media/vs-debug-target-stm32l4.png)
7979
8080
1. Press `F5` to start debugging the application.
@@ -83,6 +83,12 @@ This section shows how to configure your development environment with the new `v
8383
8484
1. Press `F5` to resume execution. The debugger is now running and connected the device.
8585
86+
## Using Visual Studio's Embedded Tooling
87+
88+
Visual Studio now supports additional tooling to help embedded programmers debug their applications: a [Peripheral Viewer](https://docs.microsoft.com/cpp/embedded/peripheral-view?view=msvc-170&tabs=visual-studio), a [RTOS Viewer](https://docs.microsoft.com/cpp/embedded/rtos-view?view=msvc-170&tabs=visual-studio), and a [Serial Monitor](https://docs.microsoft.com/cpp/embedded/serial-monitor?view=msvc-170&tabs=visual-studio).
89+
90+
> If you can't find these tools, ensure that you have the `Linux and embedded development with C++` workload and the `Embedded and IoT tools` component installed on your Visual Studio instance.
91+
8692
## Restoring Your Development Environment
8793
8894
`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:

STMicroelectronics/B-L475E-IOT01A/vscode.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This guide describes how to use Visual Studio Code to build, flash, and debug with the **STMicroelectronics B-L475E-IOT01A Discovery Kit**.
44

5-
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l475e). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
5+
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l475e). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
66

7-
1. [Clone the repo for the quickstart](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l475e#clone-the-repo-for-the-quickstart).
7+
1. [Clone the repo for the quickstart](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l475e#clone-the-repo-for-the-quickstart).
88

9-
1. [Create the cloud components](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l475e#create-the-cloud-components).
9+
1. [Create the cloud components](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l475e#create-the-cloud-components).
1010

11-
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l475e#add-configuration).
11+
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l475e#add-configuration).
1212

1313
_*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
1414

@@ -144,6 +144,12 @@ This section shows how to configure your development environment with the new `v
144144
145145
1. Press `F5` to resume execution. The debugger is now running and connected the device.
146146
147+
## Using Visual Studio Code's Embedded Tooling
148+
149+
Visual Studio Code now supports additional tooling to help embedded programmers debug their applications: a [Peripheral Viewer](https://docs.microsoft.com/cpp/embedded/peripheral-view?view=msvc-170), a [RTOS Viewer](https://docs.microsoft.com/cpp/embedded/rtos-view?view=msvc-170), and a [Serial Monitor](https://docs.microsoft.com/cpp/embedded/serial-monitor?view=msvc-170).
150+
151+
> Note that if you don't see the aforementioned tooling, ensure that you have the extensions installed, [Embedded Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-embedded-tools) and [Serial Monitor](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor)
152+
147153
## Restoring Your Development Environment
148154
149155
`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:

STMicroelectronics/B-L4S5I-IOT01A/VS.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This guide describes how to use Visual Studio to build, flash, and debug with the **STMicroelectronics B-L4S5I-IOT01A Discovery Kit**.
44

5-
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l4s5i). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
5+
This is a companion to the [Quickstart Guide](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l4s5i). Please ensure you have completed the following steps of the Quickstart Guide before continuing.
66

7-
1. [Clone the repo for the quickstart](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l4s5i#clone-the-repo-for-the-quickstart).
7+
1. [Clone the repo for the quickstart](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l4s5i#clone-the-repo-for-the-quickstart).
88

9-
1. [Create the cloud components](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l4s5i#create-the-cloud-components).
9+
1. [Create the cloud components](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l4s5i#create-the-cloud-components).
1010

11-
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/en-us/azure/iot-develop/quickstart-devkit-stm-b-l4s5i#add-configuration).
11+
1. [Configure Wi-Fi and Azure IoT connection settings](https://docs.microsoft.com/azure/iot-develop/quickstart-devkit-stm-b-l4s5i#add-configuration).
1212

1313
_*Note: It is not necessary to install the tools described in the quickstart guide. Tool installation will be covered in the next section below.*_
1414

@@ -83,6 +83,12 @@ This section shows how to configure your development environment with the new `v
8383
8484
1. Press `F5` to resume execution. The debugger is now running and connected the device.
8585
86+
## Using Visual Studio's Embedded Tooling
87+
88+
Visual Studio now supports additional tooling to help embedded programmers debug their applications: a [Peripheral Viewer](https://docs.microsoft.com/cpp/embedded/peripheral-view?view=msvc-170&tabs=visual-studio), a [RTOS Viewer](https://docs.microsoft.com/cpp/embedded/rtos-view?view=msvc-170&tabs=visual-studio), and a [Serial Monitor](https://docs.microsoft.com/cpp/embedded/serial-monitor?view=msvc-170&tabs=visual-studio).
89+
90+
> If you can't find these tools, ensure that you have the `Linux and embedded development with C++` workload and the `Embedded and IoT tools` component installed on your Visual Studio instance.
91+
8692
## Restoring Your Development Environment
8793
8894
`vcpkg-ce` only modifies the path in the shell in which it is activated. If you close your shell and wish to restore the development environment in a future session:

0 commit comments

Comments
 (0)