Skip to content

Commit 7c5dd88

Browse files
committed
doc: remove app_name
Removed app_name snippet from docs. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
1 parent 9e955dd commit 7c5dd88

File tree

10 files changed

+36
-37
lines changed

10 files changed

+36
-37
lines changed

doc/docs/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# {{app_name}}
1+
# Programmer app
22

3-
The {{app_name}} in [nRF Connect for Desktop](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/index.html) lets you program firmware to Nordic devices. The application allows you to see the memory layout for devices that support programming with J-Link, Nordic Secure DFU, and MCUboot. It also allows you to display content of HEX files and write it to the devices.
3+
The Programmer app in [nRF Connect for Desktop](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/index.html) lets you program firmware to Nordic devices. The application allows you to see the memory layout for devices that support programming with J-Link, Nordic Secure DFU, and MCUboot. It also allows you to display content of HEX files and write it to the devices.
44

55
## Supported hardware
66

7-
The following table lists the hardware platforms that you can program with the {{app_name}}.
7+
The following table lists the hardware platforms that you can program with the Programmer app.
88

99
| Hardware platform | Device | PCA number | Programming with J-Link | Programming with Nordic Secure DFU | Programming with MCUboot |
1010
|---------------------|----------|------------|--------------------------|-------------------------------------|--------------------------|
@@ -32,16 +32,16 @@ Programming with Nordic Secure DFU is **Possible** on some nRF52 Series platform
3232

3333
### Support for custom hardware
3434

35-
The following criteria apply to programming custom hardware with the {{app_name}}:
35+
The following criteria apply to programming custom hardware with the Programmer app:
3636

3737
- **Device**: The hardware platform you are programming must use an SoC or SiP from Nordic Semiconductor.
3838
- **Programming with J-Link**: Possible for all custom hardware that features Nordic SoCs supported by [nRF Util](https://docs.nordicsemi.com/bundle/nrfutil/page/README.html).
39-
- **Programming with Nordic Secure DFU**: Possible if you implement a bootloader solution that supports Nordic Secure DFU. The {{app_name}} checks the bootloader for Nordic ID to be able to program using this method.
39+
- **Programming with Nordic Secure DFU**: Possible if you implement a bootloader solution that supports Nordic Secure DFU. The Programmer app checks the bootloader for Nordic ID to be able to program using this method.
4040
- **Programming with MCUboot**: Only possible using CLI.
4141

4242
## Deprecated hardware support
4343

44-
The following hardware platforms cannot be programmed with the {{app_name}} anymore.
44+
The following hardware platforms cannot be programmed with the Programmer app anymore.
4545

4646
| Hardware platform | Device | PCA number | Programming with J-Link | Programming with Nordic Secure DFU | Programming with MCUboot |
4747
|---------------------|----------|------------|--------------------------|-------------------------------------|--------------------------|

doc/docs/installing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Installing the {{app_name}}
1+
# Installing the Programmer app
22

33
For installation instructions, see [Installing nRF Connect for Desktop apps](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/installing_apps.html) in the nRF Connect for Desktop documentation.

doc/docs/overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Overview and user interface
22

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.
3+
The Programmer app 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.
44

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:
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:
66

7-
![{{app_name}} default view at startup](./screenshots/programmer_overview.png "{{app_name}} main window")
7+
![Programmer app default view at startup](./screenshots/programmer_overview.png "Programmer app main window")
88

99
## Select device
1010

@@ -56,7 +56,7 @@ When you select a device, the following toggles are available in the J-Link Sett
5656

5757
### MCUboot Settings
5858

59-
The experimental **Enable MCUBoot** toggle is deprecated and will be removed in a future release of the {{app_name}}.
59+
The experimental **Enable MCUBoot** toggle is deprecated and will be removed in a future release of the Programmer app.
6060

6161
## Programmer tab
6262

@@ -68,7 +68,7 @@ Both windows display the different sections in the memory with different colors.
6868

6969
### File Memory Layout
7070

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.
71+
The **File Memory Layout** panel displays the memory layout for files added to the Programmer app with the [**Add file**](#file) option. Once added, these files can be programmed onto the device.
7272

7373
![File Memory Layout panel](./screenshots/programmer_programmer_tab.png "File Memory Layout panel")
7474

@@ -86,7 +86,7 @@ In the **Device Memory Layout**, you can read the name, address range, and size
8686

8787
You can view application information, restore defaults, access source code and documentation. You also can find information on the selected device, access support tools, send feedback, and enable verbose logging.
8888

89-
![{{app_name}} About tab](./screenshots/nRF_Connect_for_Desktop_Prog_about.png "{{app_name}} About tab")
89+
![Programmer app About tab](./screenshots/nRF_Connect_for_Desktop_Prog_about.png "Programmer app About tab")
9090

9191
## Log
9292

doc/docs/programming_91dk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ To program the nRF91 Series DK, you will also need the following USB cables:
3737

3838
To update the modem firmware, application firmware, or NTN firmware, complete the following steps:
3939

40-
1. Open the {{app_name}}.
40+
1. Open the Programmer app.
4141
2. Connect the DK to the computer with a USB cable, and then turn the DK on.
4242
3. Click **SELECT DEVICE** and select the DK from the drop-down list.<br/>
4343

@@ -90,7 +90,7 @@ To update the modem firmware, application firmware, or NTN firmware, complete th
9090

9191
To update the modem or application firmware, complete the following steps:
9292

93-
1. Open the {{app_name}}.
93+
1. Open the Programmer app.
9494
2. Make sure the **PROG/DEBUG SW10** switch on the nRF9160 DK is set to **nRF91**.
9595
On DK v0.9.0 and earlier, this is the **SW5** switch.
9696

doc/docs/programming_dk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Programming devices
22

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.
3+
In the Programmer app, 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.
44

55
!!! tip "Tip"
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.
6+
If you experience any problems during the programming process, press Ctrl-R (command-R on macOS) to restart the Programmer app, and try programming again.
77

88
## Device-specific procedures
99

@@ -27,7 +27,7 @@ The following devices have specific programming requirements or procedures:
2727

2828
To program a supported development kit, complete the following procedure:
2929

30-
1. Open nRF Connect for Desktop and launch the {{app_name}}.
30+
1. Open nRF Connect for Desktop and launch the Programmer app.
3131
2. Connect a development kit to the computer with a USB cable and turn it on.
3232
3. Click **Select device** and choose the device from the drop-down list.</br>
3333
The button text changes to the name and serial number of the selected device, and the **Device Memory Layout** section indicates that the device is connected.

doc/docs/programming_nrf52840_dongle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To program the nRF52840 Dongle, complete the following steps:
44

5-
1. Open nRF Connect for Desktop and launch the {{app_name}}.
5+
1. Open nRF Connect for Desktop and launch the Programmer app.
66
2. Insert the nRF52840 Dongle into a USB port on the computer.<br/>
77
The status light **LD2** turns on solid green, indicating that the dongle is powered up.
88
3. Put the dongle into bootloader mode by pressing the **RESET** button.<br/>
@@ -15,7 +15,7 @@ To program the nRF52840 Dongle, complete the following steps:
1515
- 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.
1616
- 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.
1717

18-
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+
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.
1919
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:
2020

2121
- Select the files you used recently.
@@ -24,4 +24,4 @@ To program the nRF52840 Dongle, complete the following steps:
2424
7. Select the firmware image file (with the extension HEX) from the file browser that opens up.
2525
8. Click **Write** to program the firmware onto the dongle.
2626

27-
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.
27+
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.

doc/docs/programming_thingy.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ See the following sections for programming Nordic Thingy prototyping platforms u
6161
1. While holding **SW4** pressed, move the **SW1** power switch to **ON** to power the Thingy:91.<br/>
6262
The device turns on in the bootloader mode for the nRF52840 SoC.
6363

64-
1. Open nRF Connect for Desktop and launch the {{app_name}}.
64+
1. Open nRF Connect for Desktop and launch the Programmer app.
6565
1. Click **Select device**.<br/>
6666

6767
![Programmer - Select device](./screenshots/programmer_click_select_device.png "Programmer - Select device")
@@ -108,7 +108,7 @@ See the following sections for programming Nordic Thingy prototyping platforms u
108108
1. While holding **SW3** pressed, move the **SW1** power switch to **ON** to power the Thingy:91.<br/>
109109
The device turns on in the bootloader mode for the nRF9160 SiP.
110110

111-
1. Open nRF Connect for Desktop and launch the {{app_name}} if it is not already open.
111+
1. Open nRF Connect for Desktop and launch the Programmer app if it is not already open.
112112
1. Click **Select device**.<br/>
113113

114114
![Programmer - Select device](./screenshots/programmer_click_select_device.png "Programmer - Select device")
@@ -155,7 +155,7 @@ See the following sections for programming Nordic Thingy prototyping platforms u
155155
1. While holding **SW3** pressed, move the **SW1** power switch to **ON** to power the Thingy:91.<br/>
156156
The device turns on in the bootloader mode for the nRF9160 SiP.
157157

158-
1. Open nRF Connect for Desktop and launch the {{app_name}} if it is not already open.
158+
1. Open nRF Connect for Desktop and launch the Programmer app if it is not already open.
159159
1. Click **Select device**.<br/>
160160

161161
![Programmer - Select device](./screenshots/programmer_click_select_device.png "Programmer - Select device")
@@ -203,7 +203,7 @@ To program Nordic Thingy using the USB connection, complete the following steps:
203203
1. While holding **SW2** pressed, move the **SW1** power switch to **ON** to power the Thingy:53.<br/>
204204
The device turns on in the bootloader mode.
205205

206-
1. Open nRF Connect for Desktop and launch the {{app_name}} if it is not already open.
206+
1. Open nRF Connect for Desktop and launch the Programmer app if it is not already open.
207207
1. Click **Select device**.<br/>
208208

209209
![Programmer - Select device](./screenshots/programmer_click_select_device.png "Programmer - Select device")
@@ -253,7 +253,7 @@ Make sure you have the following hardware:
253253

254254
To update the nRF52840 SoC firmware on the Thingy:91 using the nRF9160 DK as an external debug probe, complete the following steps:
255255

256-
1. Open nRF Connect for Desktop and launch the {{app_name}}.
256+
1. Open nRF Connect for Desktop and launch the Programmer app.
257257
1. Prepare the hardware:
258258

259259
a. Connect the Thingy:91 to the debug out port on a 10-pin external debug probe using a JTAG cable.
@@ -289,7 +289,7 @@ Make sure you have the following hardware:
289289
See the `CONTENTS.txt` file for information on which file you need.
290290
1. Select the `thingy91_nrf52_connectivity_bridge_*.hex` file and click **Open**.
291291
1. In the [**Device** section](overview.md#device), click **Erase & write**.<br/>
292-
The update is complete when the animation in the {{app_name}}'s **Device memory layout** window ends.
292+
The update is complete when the animation in the Programmer app's **Device memory layout** window ends.
293293
1. In the [**File** section](overview.md#file), click **Clear files**.
294294

295295
You can now disconnect the external debug probe from Nordic Thingy:91, disconnect Nordic Thingy:91 from the computer, and put the cover back on.
@@ -298,7 +298,7 @@ Make sure you have the following hardware:
298298

299299
To update the modem firmware on the Thingy:91 using an external debug probe, complete the following steps:
300300

301-
1. Open nRF Connect for Desktop and launch the {{app_name}}.
301+
1. Open nRF Connect for Desktop and launch the Programmer app.
302302
1. Prepare the hardware:
303303

304304
a. Connect the Thingy:91 to the debug out port on a 10-pin external debug probe using a JTAG cable.
@@ -354,7 +354,7 @@ Make sure you have the following hardware:
354354

355355
To program the nRF9160 SiP application firmware on the Thingy:91 using an external debug probe, complete the following steps:
356356

357-
1. Open nRF Connect for Desktop and launch the {{app_name}}.
357+
1. Open nRF Connect for Desktop and launch the Programmer app.
358358
1. Prepare the hardware:
359359

360360
a. Connect the Thingy:91 to the debug out port on a 10-pin external debug probe using a JTAG cable.
@@ -386,7 +386,7 @@ Make sure you have the following hardware:
386386
1. Open the `img_app_bl` folder that contains the HEX files for updating using a debugger.
387387
1. Select the `thingy91_at_client_*.hex` file and click **Open**.
388388
1. In the [**Device** section](overview.md#device), click **Erase & write**.<br/>
389-
The update is complete when the animation in the {{app_name}}'s **Device memory layout** window ends.
389+
The update is complete when the animation in the Programmer app's **Device memory layout** window ends.
390390

391391
1. In the [**File** section](overview.md#file), click **Clear files**.
392392

@@ -396,7 +396,7 @@ Make sure you have the following hardware:
396396

397397
To program Nordic Thingy:53 using an external debug probe, complete the following steps:
398398

399-
1. Open nRF Connect for Desktop and launch the {{app_name}}.
399+
1. Open nRF Connect for Desktop and launch the Programmer app.
400400
1. Prepare the hardware:
401401

402402
a. Open the connector cover on the side of Nordic Thingy:53.
@@ -422,7 +422,7 @@ To program Nordic Thingy:53 using an external debug probe, complete the followin
422422
You can identify the nRF5340 DK by its PCA number PCA10095 and its ID that is printed on the label sticker on the DK.
423423

424424
!!! note "Note"
425-
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 {{app_name}}.
425+
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 app.
426426

427427
1. In the [**File** section](overview.md#file), click **Add file** and select **Browse**.<br/>
428428
A file explorer window appears.
@@ -432,7 +432,7 @@ To program Nordic Thingy:53 using an external debug probe, complete the followin
432432
1. Select the corresponding HEX file to be used with the debug probe and click **Open**.<br/>
433433
The HEX file appears in the **File memory layout** section.
434434
1. In the [**Device** section](overview.md#device), click **Erase & write**.<br/>
435-
The update is complete when the animation in the {{app_name}}'s **Device memory layout** window ends.
435+
The update is complete when the animation in the Programmer app's **Device memory layout** window ends.
436436
1. In the [**File** section](overview.md#file), click **Clear files**.
437437

438438
You can now disconnect the external debug probe from Nordic Thingy:53, disconnect Nordic Thingy:53 from the computer, and put the connector cover back on.

0 commit comments

Comments
 (0)