Skip to content

Commit 023dbb3

Browse files
greg-ferRuth Fuchss
authored andcommitted
doc: rewrite SES installation info
Reworked SES installation section. Added licence registering info. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 8a8a2a8 commit 023dbb3

File tree

6 files changed

+102
-25
lines changed

6 files changed

+102
-25
lines changed

doc/nrf/gs_ins_linux.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,14 @@ If you use Ubuntu, install v1.4.7 from Cosmic by entering the following commands
6262

6363

6464

65+
.. _installing_ses_linux:
66+
67+
.. include:: gs_ins_windows.rst
68+
:start-after: installing_ses_start
69+
:end-before: installing_ses_end
70+
71+
72+
6573
.. _build_environment_linux:
6674

6775
.. include:: gs_ins_windows.rst

doc/nrf/gs_ins_mac.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@ Install Homebrew and install the required tools using the ``brew`` command line
5151

5252

5353

54+
.. _installing_ses_mac:
55+
56+
.. include:: gs_ins_windows.rst
57+
:start-after: installing_ses_start
58+
:end-before: installing_ses_end
59+
60+
61+
5462
.. _build_environment_mac:
5563

5664
.. include:: gs_ins_windows.rst

doc/nrf/gs_ins_windows.rst

Lines changed: 82 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,54 @@ To install those, open a |bash| in the ``ncs`` folder and enter the following co
265265
266266
.. add_deps_end
267267
268+
.. _installing_ses_win:
269+
270+
.. installing_ses_start
271+
272+
Installing |SES|
273+
****************
274+
275+
You must install a special version of |SES| (SES) to be able to open and compile projects in the |NCS|.
276+
277+
|SES| is free of charge for use with Nordic Semiconductor devices.
278+
279+
To install |SES|, complete the following steps:
280+
281+
1. Download the package for your operating system from the following links:
282+
283+
* `SEGGER Embedded Studio (Nordic Edition) - Windows x86`_
284+
* `SEGGER Embedded Studio (Nordic Edition) - Windows x64`_
285+
* `SEGGER Embedded Studio (Nordic Edition) - Mac OS x64`_
286+
* `SEGGER Embedded Studio (Nordic Edition) - Linux x86`_
287+
* `SEGGER Embedded Studio (Nordic Edition) - Linux x64`_
288+
289+
#. Extract the downloaded package in the directory of your choice.
290+
#. Register and activate a free license.
291+
|SES| is free of charge for use with Nordic Semiconductor devices, but you still need to request and activate a license.
292+
Complete the following steps:
293+
294+
a. Run the file :file:`bin/emStudio`.
295+
|SES| will open the Dashboard window and inform you about the missing license.
296+
297+
.. figure:: images/ses_license.PNG
298+
:alt: SEGGER Embedded Studio Dashboard notification about missing license
299+
300+
No commercial-use license detected SES prompt
301+
302+
#. Click :guilabel:`Activate Your Free License`.
303+
A request form appears.
304+
305+
#. Fill in your information and click :guilabel:`Request License`.
306+
The license is sent to you in an email.
307+
308+
#. After you receive your license key, click :guilabel:`Enter Activation Key` to activate the license.
309+
310+
#. Copy-paste the license key and click :guilabel:`Install License`.
311+
The license activation window will close and SES will open the Project Explorer window.
312+
313+
314+
315+
.. installing_ses_end
268316
269317
.. _build_environment_win:
270318

@@ -273,8 +321,41 @@ To install those, open a |bash| in the ``ncs`` folder and enter the following co
273321
Setting up the build environment
274322
********************************
275323

324+
Before you start :ref:`building and programming a sample application <gs_programming>`, you must set up your build environment.
325+
326+
Setting up the SES environment
327+
==============================
328+
329+
If you plan to :ref:`build with SEGGER Embedded Studio <gs_programming_ses>`, the first time you import an |NCS| project, SES will prompt you to set the paths to the Zephyr Base directory and the GNU ARM Embedded Toolchain.
330+
This must be done only once per project.
331+
332+
Complete the following steps to set up the |SES| environment:
333+
334+
1. Run the file :file:`bin/emStudio`.
335+
336+
#. Select :guilabel:`File` -> :guilabel:`Open nRF Connect SDK Project`.
337+
338+
.. figure:: images/ses_open.png
339+
:alt: Open nRF Connect SDK Project menu
340+
341+
Open nRF Connect SDK Project menu
342+
343+
#. Set the Zephyr Base directory to the full path to ``ncs\zephyr``.
344+
The GNU ARM Embedded Toolchain directory is the directory where you installed the toolchain (for example, ``c:\gnuarmemb``).
345+
346+
.. figure:: images/ses_notset.png
347+
:alt: Zephyr Base Not Set prompt
348+
349+
Zephyr Base Not Set prompt
350+
351+
352+
If you want to change these settings later, click :guilabel:`Tools` -> :guilabel:`Options` and select the :guilabel:`nRF Connect` tab (see :ref:`ses_options_figure`).
353+
354+
355+
Setting up the command line build environment
356+
=============================================
357+
276358
If you want to build and program your applications from the command line, you must set up your build environment by defining the required environment variables every time you open a new |bash|.
277-
If you plan to :ref:`build with SEGGER Embedded Studio <gs_programming>`, you can skip this step.
278359

279360
To define the environment variables, navigate to the ``ncs`` folder and enter the following command: |envfile|
280361

doc/nrf/gs_programming.rst

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,19 @@ Building and programming a sample application
66
The recommended way of building and programming an |NCS| sample is to use
77
the Nordic Edition of the SEGGER Embedded Studio (SES) IDE.
88

9-
SEGGER Embedded Studio is free of charge for use with Nordic Semiconductor
10-
devices. After downloading it, you can register and activate a free license.
11-
129

1310
.. note::
1411
If you prefer to build your applications from the command line,
1512
see :ref:`zephyr:getting_started_run_sample`.
1613

14+
.. _gs_programming_ses:
15+
1716
Building with SES
1817
*****************
1918

20-
You must install a special version of SEGGER Embedded Studio to be able to open
21-
and compile the projects in the |NCS|.
22-
You can download it from the following links:
19+
Complete the following steps to build |NCS| projects with SES after :ref:`installing SEGGER Embedded Studio <installing_ses_win>` and :ref:`completing the first time setup <build_environment_win>`:
2320

24-
* `SEGGER Embedded Studio (Nordic Edition) - Windows x86`_
25-
* `SEGGER Embedded Studio (Nordic Edition) - Windows x64`_
26-
* `SEGGER Embedded Studio (Nordic Edition) - Mac OS x64`_
27-
* `SEGGER Embedded Studio (Nordic Edition) - Linux x86`_
28-
* `SEGGER Embedded Studio (Nordic Edition) - Linux x64`_
29-
30-
1. Extract the downloaded package and run the file :file:`bin/emStudio`.
21+
1. Run the file :file:`bin/emStudio`.
3122

3223
#. Select **File -> Open nRF Connect SDK Project**.
3324

@@ -36,17 +27,6 @@ You can download it from the following links:
3627

3728
Open nRF Connect SDK Project menu
3829

39-
#. The first time you import an |NCS| project, SES will prompt you to set the paths to the Zephyr Base directory and the GNU ARM Embedded Toolchain.
40-
Set the Zephyr Base directory to the full path to ``ncs\zephyr``.
41-
The GNU ARM Embedded Toolchain directory is the directory where you installed the toolchain (for example, ``c:\gnuarmemb``).
42-
43-
.. figure:: images/ses_notset.png
44-
:alt: Zephyr Base Not Set prompt
45-
46-
Zephyr Base Not Set prompt
47-
48-
If you want to change these settings later, click **Tools -> Options** and select the **nRF Connect** tab (see :ref:`ses_options_figure`).
49-
5030
#. To import a project into SES, you must specify the following information:
5131

5232
- **CMakeLists.txt** - the location of the :file:`CMakeLists.txt` project file of the sample that you want to work with

doc/nrf/images/ses_license.PNG

26 KB
Loading

doc/nrf/images/ses_notset.png

-9.58 KB
Loading

0 commit comments

Comments
 (0)