Skip to content

Commit 0ad9457

Browse files
divipillaidivipillai
committed
doc: Add VSC instructions to the GSG guide
Add VSC instructions to the GSG guide. Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
1 parent 00fe00c commit 0ad9457

2 files changed

Lines changed: 83 additions & 40 deletions

File tree

‎doc/gsg_guide.rst‎

Lines changed: 76 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,87 +10,123 @@ Getting started
1010
Before getting started, make sure you have a proper |NCS| development environment.
1111
Follow the official `Getting started guide`_.
1212

13+
There are two options for setting up the project, depending on your preferred development environment:
14+
15+
* Using `nRF Connect for VS Code`_ (recommended)
16+
* Using the command line
17+
1318
Initialization
1419
**************
1520

1621
This section represents alternative approaches for initializing the workspace.
1722

18-
Add |SM| into existing |NCS| workspace
19-
======================================
23+
.. tabs::
24+
25+
.. group-tab:: nRF Connect for VS Code
26+
27+
#. To install the |NCS| and its toolchain using nRF Connect for VS Code, follow `extension documentation <nRF Connect for VS Code install_>`_ or `Installing nRF Connect SDK and VS Code exercise <Devacademy VS Code exercise_>`_ on Nordic Developer Academy.
28+
#. Open the nRF Connect extension in |VSC| by clicking its icon in the :guilabel:`Activity Bar`.
29+
#. Click :guilabel:`Create New Application`.
30+
#. Select the **Browse nRF Connect SDK add-on Index** option.
31+
#. Search for the **Serial Modem** application and create the project.
32+
33+
.. group-tab:: Command line
34+
35+
.. tabs::
36+
37+
.. group-tab:: Add |SM| into existing |NCS| workspace
2038

21-
Assume you have an existing |NCS| workspace in the :file:`ncs` folder.
39+
Assume you have an existing |NCS| workspace in the :file:`ncs` folder.
2240

23-
#. Navigate to the workspace folder::
41+
#. Navigate to the workspace folder::
2442

25-
cd ncs
43+
cd ncs
2644

27-
#. Clone |SM| repository::
45+
#. Clone |SM| repository::
2846

29-
git clone https://github.com/nrfconnect/ncs-serial-modem.git
47+
git clone https://github.com/nrfconnect/ncs-serial-modem.git
3048

31-
#. Set manifest path to the |SM|::
49+
#. Set manifest path to the |SM|::
3250

33-
west config manifest.path ncs-serial-modem
51+
west config manifest.path ncs-serial-modem
3452

35-
#. Update the |NCS| modules::
53+
#. Update the |NCS| modules::
3654

37-
west update
55+
west update
3856

39-
Depending on the current state of your |NCS| modules, this may take several minutes as it fetches all |NCS| modules according to the requirements of the |SM|.
57+
Depending on the current state of your |NCS| modules, this may take several minutes as it fetches all |NCS| modules according to the requirements of the |SM|.
4058

41-
Initialize workspace and add |SM| from scratch
42-
==============================================
59+
.. group-tab:: Initialize workspace and add |SM| from scratch
4360

44-
Complete the following steps for initialization:
61+
Complete the following steps for initialization:
4562

46-
#. To initialize the workspace::
63+
#. To initialize the workspace::
4764

48-
west init -m https://github.com/nrfconnect/ncs-serial-modem --mr main ncs
65+
west init -m https://github.com/nrfconnect/ncs-serial-modem --mr main ncs
4966

50-
#. Navigate to the workspace folder::
67+
#. Navigate to the workspace folder::
5168

52-
cd ncs
69+
cd ncs
5370

54-
#. Update the |NCS| modules::
71+
#. Update the |NCS| modules::
5572

56-
west update
73+
west update
5774

58-
This may take several minutes as it fetches all |NCS| modules according to the requirements of the |SM|.
75+
This may take several minutes as it fetches all |NCS| modules according to the requirements of the |SM|.
5976

6077
Building and running
6178
********************
6279

80+
Before building and running the application, you need to connect the development kit to your PC using a USB cable and power on the development kit.
6381
Complete the following steps for building and running:
6482

65-
#. From the workspace folder, navigate to the :file:`ncs-serial-modem` folder::
83+
.. tabs::
84+
85+
.. group-tab:: nRF Connect for VS Code
86+
87+
#. Complete the steps in the `How to build an application`_ section in the extension documentation to build the application.
88+
89+
You can also specify the additional configuration variables (Kconfig, DTC overlays, and extra Kconfig options) while setting up a build configuration during building the application.
90+
See `Providing CMake options <cmake_options_>`_ for more information on setting the additional configuration variables.
91+
92+
#. Open the nRF Connect extension in |VSC| by clicking its icon in the :guilabel:`Activity Bar`.
93+
#. In the extension's `Actions View`_, click on :guilabel:`Flash`.
94+
95+
The application is now built and flashed to the device.
96+
You can open a serial terminal to use the application.
97+
The default baud rate is 115200.
98+
99+
.. group-tab:: Command line
100+
101+
#. From the workspace folder, navigate to the :file:`ncs-serial-modem` folder::
66102

67-
cd ncs-serial-modem/app
103+
cd ncs-serial-modem/app
68104

69-
#. To build the application, run the following command::
105+
#. To build the application, run the following command::
70106

71-
west build -p -b nrf9151dk/nrf9151/ns
107+
west build -p -b nrf9151dk/nrf9151/ns
72108

73-
To build the application with Kconfig and DTC overlays and extra Kconfig options, the following command gives an example of how they are passed as build arguments::
109+
To build the application with Kconfig, DTC overlays, and extra Kconfig options, the following command gives an example of how they are passed as build arguments::
74110

75-
west build -p -b nrf9151dk/nrf9151/ns -- -DEXTRA_CONF_FILE="overlay-ppp.conf;overlay-cmux.conf" -DEXTRA_DTC_OVERLAY_FILE="overlay-external-mcu.overlay" -DCONFIG_SM_LOG_LEVEL_DBG=y
111+
west build -p -b nrf9151dk/nrf9151/ns -- -DEXTRA_CONF_FILE="overlay-ppp.conf;overlay-cmux.conf" -DEXTRA_DTC_OVERLAY_FILE="overlay-external-mcu.overlay" -DCONFIG_SM_LOG_LEVEL_DBG=y
76112

77-
#. To program the application, run the following command::
113+
#. To program the application, run the following command::
78114

79-
west flash
115+
west flash
80116

81-
The application is now built and flashed to the device.
82-
You can open a serial terminal to use the application.
83-
The default baud rate is 115200.
117+
The application is now built and flashed to the device.
118+
You can open a serial terminal to use the application.
119+
The default baud rate is 115200.
84120

85-
.. note::
121+
.. note::
86122

87-
When building the |SM| application, the manifest path must point to the :file:`ncs-serial-modem` folder.
88-
Otherwise linking will fail as drivers and libraries from |SM| will not be found.
123+
When building the |SM| application, the manifest path must point to the :file:`ncs-serial-modem` folder.
124+
Otherwise linking will fail as drivers and libraries from |SM| will not be found.
89125

90-
To check your current manifest path, run the following command anywhere in your workspace::
126+
To check your current manifest path, run the following command anywhere in your workspace::
91127

92-
west config manifest.path
128+
west config manifest.path
93129

94-
To set the manifest path for |SM|, run the following command::
130+
To set the manifest path for |SM|, run the following command::
95131

96-
west config manifest.path ncs-serial-modem
132+
west config manifest.path ncs-serial-modem

‎doc/links.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,11 @@
8686
.. _`+CGDCONT`: https://docs.nordicsemi.com/bundle/ref_at_commands_nrf91x1/page/REF/at_commands/packet_domain/cgdcont.html
8787
.. _`+CGAUTH`: https://docs.nordicsemi.com/bundle/ref_at_commands_nrf91x1/page/REF/at_commands/packet_domain/cgauth.html
8888

89+
.. _`nRF Connect for VS Code`: https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/index.html
90+
.. _`nRF Connect for VS Code install`: https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/get_started/quick_setup.html
91+
.. _`How to build an application` : https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/get_started/build_app_ncs.html#how-to-build-an-application
92+
.. _`Actions View`: https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/reference/ui_sidebar_actions.html
93+
8994
.. ### docs.zephyrproject.org/
9095

9196
.. _`Zephyr Networking`: https://docs.zephyrproject.org/latest/connectivity/networking/index.html
@@ -103,6 +108,8 @@
103108

104109
.. ### others
105110

111+
.. _`Devacademy VS Code exercise`: https://academy.nordicsemi.com/courses/nrf-connect-sdk-fundamentals/lessons/lesson-1-nrf-connect-sdk-introduction/topic/exercise-1-1/
112+
106113
.. _`Private addresses`: https://en.wikipedia.org/wiki/IP_address#Private_addresses
107114

108115
.. _`3GPP TS 27.010`: https://www.etsi.org/deliver/etsi_ts/127000_127099/127010/18.00.00_60/ts_127010v180000p.pdf

0 commit comments

Comments
 (0)