You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/docs/overview.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,24 @@
2
2
3
3
The {{app_name}} main window displays the memory layout of the device and the file you want to work with. It also provides options to program the device and inspect the entire process through the log.
4
4
5
-
When you start the Programmer app, the application main window appears with the **Programmer** tab selected by default and the [**File Memory Layout**](#file-memory-layout) and [**Device Memory Layout**](#device-memory-layout) panels empty:
5
+
When you start the {{app_name}}, the application main window appears with the **Programmer** tab selected by default and the [**File Memory Layout**](#file-memory-layout) and [**Device Memory Layout**](#device-memory-layout) panels empty:
6
6
7
7
![{{app_name}} default view at startup](./screenshots/programmer_overview.png"{{app_name}} main window")
8
8
9
-
## Select Device
9
+
## Select device
10
10
11
11
Once you connect a device to the system, it becomes visible and available when you click on the **Select device** drop-down list. You can choose a device from the list of connected devices to perform further actions on the device such as programming.
When you select a device, the following actions are available in the File section:
20
24
21
25
| Action | Description |
@@ -26,7 +30,9 @@ When you select a device, the following actions are available in the File sectio
26
30
27
31
### Device
28
32
29
-
When you select a device, the following actions are available in the Device section:
33
+
![Device section for a device programmed with MCUboot](./screenshots/programmer_device_section.png"Device section for a device programmed with MCUboot")
34
+
35
+
When you select a device, the following actions are available in the Device section, depending on the programming method:
When you select a device, the following toggles are available in the J-Link Settings section:
43
51
44
52
| Toggle | Description |
@@ -60,11 +68,13 @@ Both windows display the different sections in the memory with different colors.
60
68
61
69
### File Memory Layout
62
70
63
-
The **File Memory Layout** panel displays the memory layout for files added to the Programmer app with the [**Add file**](#file-section) option. Once added, these files can be programmed onto the device.
71
+
The **File Memory Layout** panel displays the memory layout for files added to the {{app_name}} with the [**Add file**](#file) option. Once added, these files can be programmed onto the device.
In the **Device Memory Layout**, you can read the name, address range, and size of a memory section by hovering the mouse cursor over one of the memory sections. This option is possible only after loading a memory layout.
77
+
In the **Device Memory Layout**, you can read the name, address range, and size of a memory section by hovering the mouse cursor over one of the memory sections. This is possible only after loading a memory layout.
68
78
69
79
![Memory section details](./screenshots/programmer_with_device.png"Memory section after selecting a device")
In the {{app_name}}, you can program [supported devices](index.md#supported-devices) or a custom board with a supported chip that allows for communication with J-Link, Nordic Secure DFU devices, and MCUboot devices.
3
+
In the {{app_name}}, you can program [supported devices](index.md#supported-hardware) or a custom board with a supported chip that allows for communication with J-Link, Nordic Secure DFU devices, and MCUboot devices.
4
4
5
5
!!! tip "Tip"
6
6
If you experience any problems during the programming process, press Ctrl-R (command-R on macOS) to restart the {{app_name}}, and try programming again.
@@ -11,11 +11,12 @@ The following devices have specific programming requirements or procedures:
| Nordic Thingy:91 | To program Nordic Thingy:91, see [Updating the Thingy:91 firmware using Programmer](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/device_guides/working_with_nrf/nrf91/thingy91.html#updating_the_thingy91_firmware_using_programmer).
15
14
| nRF9160 DK | To program the nRF9160 DK, see [Updating the nRF9160 DK firmware using Programmer](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/device_guides/working_with_nrf/nrf91/nrf9160.html#updating_the_dk_firmware_using_programmer). |
16
-
| Nordic Thingy:53 | To program Nordic Thingy:53, follow the steps from the [Programming Nordic Thingy:53](#programming-nordic-thingy53) section. |
15
+
| Nordic Thingy:91 X | To program Nordic Thingy:91 X, see [Programming Nordic Thingy prototyping platforms](programming_thingy.md).
16
+
| Nordic Thingy:91 | To program Nordic Thingy:91, see [Programming Nordic Thingy prototyping platforms](programming_thingy.md).
17
+
| Nordic Thingy:53 | To program Nordic Thingy:53, see [Programming Nordic Thingy prototyping platforms](programming_thingy.md). |
17
18
| Nordic Thingy:52 | Nordic Thingy:52 can be programmed using the [general programming procedure](#general-programming-procedure), but only through J-Link and a 10-pin programming cable. |
18
-
| nRF52840 Dongle | To program the nRF52840 Dongle, follow the steps from the [Programming the nRF52840 Dongle](#programming-the-nrf52840-dongle) section. |
19
+
| nRF52840 Dongle | To program the nRF52840 Dongle, see [Programming the nRF52840 Dongle](programming_nrf52840_dongle.md). |
19
20
| Custom board | When programming a custom board with a supported chip, use the [general programming procedure](#general-programming-procedure), but make sure that the J-Link version is compatible with the relevant Arm® CPU. For example, an nRF52 Series DK cannot be used to program a Nordic Thingy:91 since the J-Link on an nRF52 Series DK does not support the programming of the Arm Cortex®-M33 CPU of Nordic Thingy:91. |
20
21
21
22
## General programming procedure
@@ -43,124 +44,3 @@ To program a supported development kit, complete the following procedure:
43
44
-**Write** for MCUboot, Nordic Secure DFU, or modem firmware
44
45
45
46
When programming starts, a progress bar appears.
46
-
47
-
## Programming the nRF52840 Dongle
48
-
49
-
To program the nRF52840 Dongle, complete the following steps:
50
-
51
-
1. Open nRF Connect for Desktop and launch the {{app_name}}.
52
-
2. Insert the nRF52840 Dongle into a USB port on the computer.
53
-
3. Put the dongle into bootloader mode by pressing the **RESET** button.
54
-
55
-
![nRF52840 Dongle overview](./screenshots/nRF52840_dongle_press_reset.svg"Pressing the RESET button")
56
-
57
-
!!! note "Note"
58
-
- This step is not needed if the currently running application uses the [DFU trigger library](https://docs.nordicsemi.com/bundle/sdk_nrf5_v17.1.0/page/lib_dfu_trigger_usb.html), part of the nRF5 SDK v17.1.0.
59
-
- If this is the first time the dongle is connected, a driver needed for the nRF52840 Nordic Secure DFU feature is also installed as part of this step.
60
-
61
-
The status light (**LD2**) will start pulsing red, indicating that the dongle is powered up and in bootloader mode. After a few seconds, the computer recognizes the dongle as a USB composite device.
62
-
63
-
5. In the navigation bar in the Programmer app, click **Select device** and choose the serial number of the dongle from the drop-down list.
64
-
6. Drag and drop the HEX file into the **File Memory Layout** section. Alternatively, click **Add file** to add the files you want to program, using one of the following options:
65
-
66
-
- Select the files you used recently.
67
-
- If there are no recently used files, click **Browse** from the drop-down list.
68
-
69
-
7. Select the firmware image file (with the extension HEX) from the file browser that opens up.
70
-
8. Click **Write** to program the firmware onto the dongle.
71
-
72
-
When the writing process completes, the device resets, and – unless the application uses the [DFU trigger library](https://docs.nordicsemi.com/bundle/sdk_nrf5_v17.1.0/page/lib_dfu_trigger_usb.html) of the nRF5 SDK v17.1.0 – the dongle will no longer show up in the Programmer app, as it is no longer in the bootloader mode.
73
-
74
-
## Programming Nordic Thingy:53
75
-
76
-
You can program the Nordic Thingy:53 application and network core firmware over USB by using MCUboot, which is a secure bootloader that you can use to update applications without an external debugger. MCUboot bootloader is [enabled by default](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/device_guides/thingy53/thingy53_application_guide.html#mcuboot_bootloader) for Thingy:53 in the `Kconfig.defconfig` file of the board.
77
-
78
-
You can follow this procedure to update the preloaded firmware on Nordic Thingy:53, using the precompiled application firmware available from the [Nordic Thingy:53 Downloads](https://www.nordicsemi.com/Products/Development-hardware/Nordic-Thingy-53/Downloads?lang=en#infotabs) page. The ZIP archive includes the ``CONTENTS.txt`` file, which lists the location and names of the different firmware images available.
79
-
80
-
To program Nordic Thingy:53, you can use one of the following options:
81
-
82
-
* Using USB-C cable
83
-
* Using an external debug probe
84
-
85
-
!!! note "Note"
86
-
87
-
Do not unplug the Nordic Thingy:53 during this process.
88
-
89
-
### Programming using a USB-C cable
90
-
91
-
To program Nordic Thingy:53 using the USB-C connection, complete the following steps:
92
-
93
-
1. Take off the top cover of the Nordic Thingy:53 so you can access the **SW2** button in Step 7.
94
-
1. Plug the Nordic Thingy:53 into the computer using a USB-C cable.
95
-
96
-
![The Nordic Thingy:53 schematic - **SW1** and USB connector cover](./screenshots/thingy53_sw1_usb.svg"The Nordic Thingy:53 schematic - **SW1** and USB connector cover")
97
-
98
-
1. Open nRF Connect for Desktop and launch the Programmer app.
99
-
1. Press **SW2** while moving the power switch **SW1** to the **ON** position.
100
-
101
-
![The Nordic Thingy:53 schematic - **SW1** and **SW2**](./screenshots/thingy53_sw1_sw2.svg"The Nordic Thingy:53 schematic - **SW1** and **SW2**")
102
-
103
-
1. In the Programmer navigation bar, click **Select device**.<br/>
104
-
A drop-down menu appears.
105
-
1. In the drop-down menu, select **Bootloader Thingy:53**.
106
-
1. Click **Add file** in the **FILE** section, and select **Browse**.<br/>
107
-
A file explorer window appears.
108
-
1. Navigate to the folder with the application firmware.<br/>
109
-
If you are programming the precompiled application firmware from the [Nordic Thingy:53 Downloads](https://www.nordicsemi.com/Products/Development-hardware/Nordic-Thingy-53/Downloads?lang=en#infotabs), open the folder where you extracted the archive. For example, the ``Peripheral_LBS`` folder.
110
-
1. Select the update file and click **Open**.<br/>
111
-
If you are programming the precompiled application firmware, the update file mentions the nRF Connect SDK version, for example ``peripheral_lbs_<version-number>_thingy53_nrf5340.zip``.
112
-
1. Click the **Write** button in the **DEVICE** section.<br/>
1. Click **Write** in the **MCUboot DFU** window.<br/>
118
-
The flash slot is erased. When the flash slot has been erased, image transfer starts and a progress bar appears.When the image transfer has been completed, the network core part of the image is transferred from RAM to the network core flash. This can take up to 20 seconds.<br/>
119
-
When the update is complete, a **Completed successfully** message appears.
120
-
121
-
You can now disconnect the Nordic Thingy:53 from the computer and put the top cover back on.
122
-
123
-
### Programming using an external debug probe
124
-
125
-
You can update the Nordic Thingy:53 application and network core firmware by using an external debug probe.
126
-
127
-
The external debug probe must support Arm Cortex-M33, such as the nRF5340 DK.
128
-
You need a 10-pin 2x5 socket-socket 1.27 mm IDC (Serial Wire Debug - SWD) JTAG cable to connect to the external debug probe.
129
-
130
-
To program Nordic Thingy:53 using an external debug probe, complete the following steps:
131
-
132
-
1. Open nRF Connect for Desktop and launch the Programmer app.
133
-
1. Prepare the hardware:
134
-
135
-
a. Open the connector cover on the side of Nordic Thingy:53.
136
-
137
-
b. Use a JTAG cable to connect Nordic Thingy:53 to the debug out port on a 10-pin external debug probe.
138
-
139
-
140
-
141
-
c. Power on the Nordic Thingy:53; move the power switch **SW1** to the **ON** position.
142
-
143
-
d. Power on the external debug probe.
144
-
145
-
e. Connect the external debug probe to the computer with a micro-USB cable.<br/>
146
-
In the Programmer app's navigation bar, **No devices available** changes to **Select device**.
1. Click **Select device** and select the appropriate debug probe entry from the drop-down list.<br/>
151
-
The icon text changes to board name and the ID of the selected device, and the **Device memory layout** section indicates that the device is connected.<br/>
152
-
You can identify the nRF5340 DK by its PCA number PCA10095 and its ID that is printed on the label sticker on the DK.
153
-
154
-
!!! note "Note"
155
-
If the nRF5340 DK does not show up in the drop-down list, press Ctrl-R in Windows or command-R in macOS to restart the Programmer application.
156
-
157
-
1. Click **Add file** in the **FILE** section, and select **Browse**.<br/>
158
-
A file explorer window appears.
159
-
1. Navigate to the folder with the application firmware.<br/>
160
-
If you are programming the precompiled application firmware from the [Nordic Thingy:53 Downloads](https://www.nordicsemi.com/Products/Development-hardware/Nordic-Thingy-53/Downloads?lang=en#infotabs), open the folder where you extracted the archive.
161
-
1. Open the folder for the application that you want to transfer to the Nordic Thingy:53.
162
-
1. Select the corresponding HEX file to be used with the debug probe and click **Open**.<br/>
163
-
The HEX file appears in the **File memory layout** section.
164
-
1. Click **Erase & write** in the **DEVICE** section of the side panel.
165
-
166
-
The update is complete when the animation in the Programmer app's **Device memory layout** section ends.
To program the nRF52840 Dongle, complete the following steps:
4
+
5
+
1. Open nRF Connect for Desktop and launch the {{app_name}}.
6
+
2. Insert the nRF52840 Dongle into a USB port on the computer.
7
+
3. Put the dongle into bootloader mode by pressing the **RESET** button.
8
+
9
+
![nRF52840 Dongle overview](./screenshots/nRF52840_dongle_press_reset.svg"Pressing the RESET button")
10
+
11
+
!!! note "Note"
12
+
- This step is not needed if the currently running application uses the [DFU trigger library](https://docs.nordicsemi.com/bundle/sdk_nrf5_v17.1.0/page/lib_dfu_trigger_usb.html), part of the nRF5 SDK v17.1.0.
13
+
- If this is the first time the dongle is connected, a driver needed for the nRF52840 Nordic Secure DFU feature is also installed as part of this step.
14
+
15
+
The status light (**LD2**) will start pulsing red, indicating that the dongle is powered up and in bootloader mode. After a few seconds, the computer recognizes the dongle as a USB composite device.
16
+
17
+
5. In the navigation bar in the {{app_name}}, click **Select device** and choose the serial number of the dongle from the drop-down list.
18
+
6. Drag and drop the HEX file into the **File Memory Layout** section. Alternatively, click **Add file** to add the files you want to program, using one of the following options:
19
+
20
+
- Select the files you used recently.
21
+
- If there are no recently used files, click **Browse** from the drop-down list.
22
+
23
+
7. Select the firmware image file (with the extension HEX) from the file browser that opens up.
24
+
8. Click **Write** to program the firmware onto the dongle.
25
+
26
+
When the writing process completes, the device resets, and – unless the application uses the [DFU trigger library](https://docs.nordicsemi.com/bundle/sdk_nrf5_v17.1.0/page/lib_dfu_trigger_usb.html) of the nRF5 SDK v17.1.0 – the dongle will no longer show up in the {{app_name}}, as it is no longer in the bootloader mode.
0 commit comments