doc: programmer: bring docs up-to-date #440
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
greg-fer
added
documentation
greg-fer
force-pushed
the
doc_programmer_doc_review_outdated_content
branch
3 times, most recently
from
f1e6402
to
d7b8cb0
Compare
Updated the docs for v4.2.0 of nRF Connect Programmer. NCD-651. Signed-off-by: Grzegorz Ferenc <[email protected]>
greg-fer
force-pushed
the
doc_programmer_doc_review_outdated_content
branch
from
d7b8cb0
to
3473d04
Compare
kylebonnici
reviewed
Jan 30, 2024
README.md
Outdated
| firmware to Nordic Semiconductor devices and custom devices that use Nordic | ||
| Semiconductor hardware. | ||
|
|
||
| The application supports J-Link, Nordic USB, and MCUboot programming methods, |
There was a problem hiding this comment.
Not sure if we should say Nordic USB or Nordic DFU?
doc/docs/index.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # nRF Connect Programmer | |||
|
|
|||
| nRF Connect Programmer is an app available from [nRF Connect for Desktop](https://nordic-dev.zoominsoftware.io/bundle/nrf-connect-desktop/page/index.html) that you can use to program firmware to Nordic devices. The application allows you to see the memory layout for both J-Link and Nordic USB devices. It also allows you to display content of HEX files and write it to the devices. | |||
| nRF Connect Programmer is an app available from [nRF Connect for Desktop](https://nordic-dev.zoominsoftware.io/bundle/nrf-connect-desktop/page/index.html) that you can use to program firmware to Nordic devices. The application allows you to see the memory layout for J-Link, Nordic USB devices, and MCUboot devices. It also allows you to display content of HEX files and write it to the devices. | |||
There was a problem hiding this comment.
Not sure if we should say Nordic USB or Nordic DFU?
doc/docs/overview.md
Outdated
|  | ||
| | Action | Description | | ||
| |---------------------|----------------------------------------------------------------------------------------------------| | ||
| | **Add files** | Adds the file you select to the [**File Memory Layout**](#file-memory-layout) panel. You can select the files either from the drop-down list of previous files or by browsing to the file destination. | |
There was a problem hiding this comment.
Consider adding multiple hex files can be added at the same time?
doc/docs/overview.md
Outdated
| | **Erase & write** | J-Link | Clears the written memory and programs the files added to the **File Memory Layout**. | | ||
| | **Save as file** | J-Link | After you **Read** the memory, saves the current memory layout in the **Device Memory Layout** to a HEX file. | | ||
| | **Reset** | J-Link | Resets the device. | | ||
| | **Write** | MCUboot, Nordic USB, Modem firmware | Programs the files added to the **File Memory Layout**. | |
There was a problem hiding this comment.
Nordic USB -> Nordic DFU
doc/docs/overview.md
Outdated
| - Additionally, after you read the memory, **Save as file** allows you to save the memory as a HEX file. | ||
| | Toggle | Description | | ||
| |-----------------------------------|------------------------------------------------------------------------------------------------------| | ||
| | **Auto read memory** | Enable to automatically read and display the memory layout of the device when the device is selected.| |
There was a problem hiding this comment.
Consider adding -> Data is only auto read on non protected devices ?
doc/docs/overview.md
Outdated
|
|
||
| | Toggle | Description | | ||
| |-------------------------------------|-------------------------------------------------------------------------------------------------------| | ||
| | **Enable MCUBoot** | Enable to write to the device memory when programming a Nordic USB device, such as Nordic Thingy:91 or the nRF52840 Dongle. You can also use this option for custom SoCs that support MCUboot. | |
There was a problem hiding this comment.
Given that this does not worked and has not for as long as I know () should we remove it from UI? Should we mark it as experimental? (https://nordicsemi.atlassian.net/browse/NRFU-696)
There was a problem hiding this comment.
Marked as experimental.
doc/docs/programming_dk.md
Outdated
|
|
||
| - **Erase & write** for J-Link | ||
| - **Write** for MCUboot, Nordic USB, or modem firmware |
There was a problem hiding this comment.
Nordic USB -> Nordic DFU?
doc/docs/troubleshooting.md
Outdated
| - A device is reset while it is connected to the Programmer app. In this case, you may not see all COM ports in the drop-down list while selecting the device (for example, the nRF9160 DK) in the Programmer app. |
There was a problem hiding this comment.
I would omit this not sure how relevant this is
"In this case, you may not see all COM ports in the drop-down list while selecting the device (for example, the nRF9160 DK)" in the Programmer app.
Signed-off-by: Grzegorz Ferenc <[email protected]>
|
@kylebonnici , please re-review. |
kylebonnici
approved these changes
Feb 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the docs for v4.2.0 of nRF Connect Programmer. NCD-651.