To build the example applications, a toolchain based on either CMake or SEGGER Embedded Studio is required. Install instructions are provided for Windows and Debian/Ubuntu. The steps should be similar for other platforms.
Important: Ensure that all command line tools are available in a folder referenced by the system path (e.g. the
PATHenvironment variable).
The following table lists the required tools to work with the nRF5 SDK for Mesh:
| Download link | Recommended minimum version | Installation notes |
|---|---|---|
| nRF5x Command Line Tools | 9.5.0 | |
| SEGGER J-Link Software Pack | 6.16a | |
| Python 2.7 | 2.7 | Only needed for DFU. See note about Python below |
| Python 3 | 3.5.1.32 | Must be 32-bit for nrfjprog DLL to work |
In addition to these tools, a build environment is needed. The nRF5 SDK for Mesh supports both CMake and SEGGER Embedded Studio. You only need to install one of them.
To use SEGGER Embedded Studio, download the installer from the SEGGER website and follow the installation instructions. You will find project files for each of the examples in their respective folders.
As an alternative to SEGGER Embedded Studio, CMake is a build management system used for managing an environment that is independent of the compiler and build system used. Version 3.6 or above is required by the mesh stack.
The following tools must be installed:
Additionally, if you want to build the documentation, make sure that the following tools are installed and available from the command line:
Instructions for how to install these tools are provided for the following platforms:
Python is not required to build the mesh stack and examples, but it is required when working with DFU, the Interactive PyACI, generating SEGGER Embedded Studio projects and when building documentation. The nRF5 SDK for Mesh uses Python 3, however, the nrfutil tool used for DFU transfers over serial requires Python 2.7.