-
Notifications
You must be signed in to change notification settings - Fork 1.4k
samples: nrf_cloud: review docs for cell_location #26088
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: main
Are you sure you want to change the base?
samples: nrf_cloud: review docs for cell_location #26088
Conversation
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.
Pull request overview
This PR updates documentation for three nRF Cloud cell location samples (REST, MQTT, and CoAP) to improve clarity and add troubleshooting information. The changes correct outdated comments and simplify the overview sections while adding practical examples of common connection errors.
Key changes:
- Updated code comments to clarify JWT authentication requirements
- Simplified overview sections to reference the location library directly
- Added troubleshooting examples for missing credentials and registration issues
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| samples/cellular/nrf_cloud_rest_cell_location/src/main.c | Updated comment to clarify JWT authentication time requirement |
| samples/cellular/nrf_cloud_rest_cell_location/README.rst | Simplified overview and added credential-related error examples |
| samples/cellular/nrf_cloud_mqtt_cell_location/src/main.c | Updated comment about time requirement |
| samples/cellular/nrf_cloud_mqtt_cell_location/README.rst | Simplified overview and added MQTT connection error examples |
| samples/cellular/nrf_cloud_coap_cell_location/src/main.c | Updated comment to clarify JWT authentication time requirement |
| samples/cellular/nrf_cloud_coap_cell_location/README.rst | Simplified overview and added CoAP-specific error examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CI InformationTo view the history of this post, click the 'edited' button above Inputs:Sources:sdk-nrf: PR head: b647c4fbc4bd956eea9bf92836d440244edef5ed more detailssdk-nrf:
Github labels
List of changed files detected by CI (6)Outputs:ToolchainVersion: 43683a87ea Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
peknis
left a comment
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.
Make sure this can still go to 3.2.0. Talk to Shantha.
|
You can find the documentation preview for this PR here. Preview links for modified nRF Connect SDK documents: https://ncsdoc.z6.web.core.windows.net/PR-26088/nrf/samples/cellular/nrf_cloud_coap_cell_location/README.html |
b241937 to
a3f8454
Compare
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.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
7ad916a to
c8724c8
Compare
c8724c8 to
9d97909
Compare
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.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
peknis
left a comment
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.
Approved with a minor change. Also fix the one Copilot mentions.
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.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Fix issues found in the documentation of the cell location samples. Add examples of connection errors. Signed-off-by: Maximilian Deubel <[email protected]>
dcae612 to
b647c4f
Compare
| Otherwise, the request is single-cell. | ||
|
|
||
| In either mode, the sample sends a new location request if a change in cell ID is detected. | ||
| After the sample initializes and connects to the network, it sends a cell location request to nRF Cloud. |
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.
multi-cell is still mentioned in the log on line 111. This comes from the code and I guess in the cloud response. This is fine because it's in cloud response so it's not concluded by the device based on NCELLMEAS results etc. anymore.
Fix issues found in the documentation of the cell location samples. Add examples of connection errors.