-
Notifications
You must be signed in to change notification settings - Fork 316
Update nrf52840_dongle.md #754
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @icicle1133, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a recurring issue with flashing firmware onto nRF52840 dongles by updating the relevant documentation. It introduces a critical step to erase storage prior to flashing, which has been found to resolve problems even on new boards. This change aims to provide clearer and more robust instructions for users, preventing common setup frustrations. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the flashing instructions for the nRF52840 dongle to include a necessary step for erasing storage, which is a valuable addition to prevent potential flashing issues for users. My review includes a couple of suggestions to enhance the clarity and correctness of the new instructions. Specifically, I've recommended making the instruction to erase storage more direct and correcting the example command by adding the required programmer argument to ensure it works as intended for the DFU flashing method.
| setup instructions. | ||
|
|
||
| To flash the firmware, run: | ||
| It is highly recommended you use --erase_storage first, especially if you have installed any other software onto your dongle. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrasing "It is highly recommended" might be too weak. Based on your PR description and the general install.md guide, erasing storage seems to be a required step for new boards or boards that have been used for other purposes. To avoid user confusion and flashing issues, it would be better to make this instruction more direct.
| It is highly recommended you use --erase_storage first, especially if you have installed any other software onto your dongle. | |
| To prevent potential issues, you must first erase the dongle's storage. This is especially important for new boards or if other software has been installed on it. |
| It is highly recommended you use --erase_storage first, especially if you have installed any other software onto your dongle. | ||
|
|
||
| ```shell | ||
| ./deploy.py --board=nrf52840_dongle_dfu --erase_storage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The command to flash the erase_storage application is missing the --programmer=nordicdfu argument. Without it, the deploy.py script defaults to using jlink as the programmer. This is incorrect for the DFU flashing method described in this document and will cause an error for users who don't have a J-Link debugger.
| ./deploy.py --board=nrf52840_dongle_dfu --erase_storage | |
| ./deploy.py --board=nrf52840_dongle_dfu --erase_storage --programmer=nordicdfu |
|
The fact that people need |
Fixes closed issue #739
Even with a new board, no other software installed onto it, i ran into the same issues yet again without running --erase_storage first. This commit fixes that in the .md for nordic dongles (NOT DK/Development boards.)