Skip to content

Commit

Permalink
Merge pull request #1016 from NordicSemiconductor/doc_add_installatio…
Browse files Browse the repository at this point in the history
…n_link_fix

doc: add installation cross-links
  • Loading branch information
greg-fer authored Jun 24, 2024
2 parents 9bc66cb + da1753f commit 8cef7f7
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 13 deletions.
38 changes: 25 additions & 13 deletions doc/docs/download_cfd.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,44 @@
Download nRF Connect for Desktop's executable from Nordic Semiconductor's [website](https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Connect-for-desktop).

All nRF Connect for Desktop applications require the launcher v4.1.0 or later.
See also the list of [Supported operating systems](./os_support.md).

After installing and starting the launcher, you will see the list of available apps.
See the [Launcher overview](overview_cfd.md) and [Installing nRF Connect for Desktop apps](installing_apps.md) pages for more information.

## Additional requirements

Running nRF Connect for Desktop on macOS and Linux has additional requirements.
Running nRF Connect for Desktop has the following additional requirements.

### J-Link driver on macOS and Linux
### SEGGER J-Link driver

You must install SEGGER J-Link driver separately on macOS and Linux. To do so, download and
install it from [SEGGER](https://www.segger.com/downloads/jlink) under the
section _J-Link Software and Documentation Pack_.
Required on all platforms.

If you don't install the J-Link driver, running the apps will fail and you will get error messages
`CouldNotFindJprogDLL`, `CouldNotOpenDLL`, `JLINKARM_DLL_NOT_FOUND`, or similar.
On Windows, the driver comes bundled with nRF Connect for Desktop.

### udev rules for Linux only
On macOS and Linux, you must install the driver manually.
Download the installer for your platform from [SEGGER J-Link Software](https://www.segger.com/downloads/jlink/#J-LinkSoftwareAndDocumentationPack).
If you don't install the J-Link driver, running the apps will be very limited and you will get error messages `CouldNotFindJprogDLL`, `CouldNotOpenDLL`, `JLINKARM_DLL_NOT_FOUND`, or similar.

In order to access Nordic USB devices with correct permissions, you must set up _udev_ rules.
To do so, follow the instructions in the [nrf-udev](https://github.com/NordicSemiconductor/nrf-udev)
repository. You need to set up these rules only once.
### Installing libusb-1.0-0 and nrf-udev on Linux

libusb-1.0-0 usually comes installed with Ubuntu.

nrf-udev can be installed by downloading a DEB file from the [nrf-udev](https://github.com/NordicSemiconductor/nrf-udev) project repository.

The _udev_ rules are required to access Nordic USB devices with correct permissions.
You need to set up these rules only once.

Complete the following steps:

1. Download the latest DEB file from [nrf-udev](https://github.com/NordicSemiconductor/nrf-udev).
2. Run the following command to install nrf-udev:

```
sudo dpkg -i nrf-udev_1.0.1-all.deb
```
## Using behind proxy
To use nRF Connect for Desktop and its applications behind a proxy, see the
[Starting nRF Connect for Desktop with proxy settings](./proxy_settings.md) page.


1 change: 1 addition & 0 deletions doc/docs/os_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The following table lists operating systems supported by nRF Connect for Desktop
| macOS 11 | Not applicable | Tier 2 | Tier 2 |
| macOS 10.15 | Not applicable | Tier 3 | Not supported |

To download and install nRF Connect for Desktop, see [Requirements and installation](./download_cfd.md).
Linux and macOS have [additional installation requirements](download_cfd.md#requirements).

!!! info "Tier definitions"
Expand Down

0 comments on commit 8cef7f7

Please sign in to comment.