Skip to content

Location doc #736

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.

Sign up for GitHub

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

Jump to bottom
Merged
ktaborowski merged 1 commit into from
Nov 28, 2025
Merged

Location doc #736

ktaborowski merged 1 commit into from
Nov 28, 2025

Conversation

@ktaborowski
Copy link
Contributor

@ktaborowski ktaborowski commented Nov 12, 2025

CI parameters

Jenkins:
  test-sdk-sidewalk: master
  # To reconfigure functional tests:
  # use GH labels func-* (default is func-commit)
  # or
  # Use YAML Filters. Helper side to set filters: https://tester-pc.nordicsemi.no:8080/test_mgmt
  # Filters (place copied YAML filters here):
  #  - filter1:
  #     board: nrf52

Description

JIRA ticket:

Self review

  • There is no commented code.
  • There are no TODO/FIXME comments without associated issue ticket.
  • Commits are properly organized.
  • Change has been tested.
  • Tests were updated (if applicable).

@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. source PR changing src files labels Nov 12, 2025
@github-actions
Copy link

github-actions bot commented Nov 12, 2025 •
edited
Loading

Sample diff used total

Memory usage did not change for any of the samples.

@ktaborowski ktaborowski marked this pull request as ready for review November 26, 2025 13:45
@ktaborowski ktaborowski requested a review from annwoj November 26, 2025 13:46
@ktaborowski ktaborowski force-pushed the location-doc branch 2 times, most recently from 1664a39 to 9194732 Compare November 27, 2025 09:26
LuDuda
LuDuda reviewed Nov 27, 2025
View reviewed changes
Copy link

@LuDuda LuDuda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks great!

This is first round of review. I would like to add some new sections. Will add them in the following review.

doc/samples/variants/dut.rst Outdated
.. note::

To perform a WiFi or GNSS scan, more time is required.
It may take up to a few minutes to send location data depending on available signal strength.
Copy link

@LuDuda LuDuda Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it true for Wi-Fi as well? I guess it's more for GNSS, as Wi-Fi will send location data depends on the found networks.

Copy link
Contributor Author

@ktaborowski ktaborowski Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is true for WiFi as well. Although WiFi scans takes noticeably less time than GNSS it also take time to scan networks and prepare the message.
Also sending the location message over LoRa takes much more time then in BLE (especially if device is already connected) .
I can rephrase this note, I mention WiFi and GNSS in one sentence to keep it short. I can describe it separably as well.

doc/setting_up_sidewalk_environment/setting_up_hardware.rst

.. tab:: nRF54L15 DK

The nRF54L15 DK requires the ``simple_arduino_adapter`` shield to connect the LR1110 shield.
Copy link

@LuDuda LuDuda Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the simple_arduino_adapter we don't distribute it to the customers, right? In such case, we can still have it for testing, but I'm not sure we should document it.

Copy link
Contributor Author

@ktaborowski ktaborowski Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

simple_arduino_adapter is defined here: https://github.com/nrfconnect/sdk-sidewalk/blob/main/boards/shields/simple_arduino_adapter/boards/nrf54l15dk_common.overlay
It can be realized with a cable connection between the DK and the Arduino shield.

doc/location_services.rst Outdated
Comment on lines 56 to 57
.. note::
LR1110 support for WiFi and GNSS location services is experimental.
Copy link

@LuDuda LuDuda Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is no longer true.

Suggested change
.. note::
LR1110 support for WiFi and GNSS location services is experimental.

@ktaborowski ktaborowski force-pushed the location-doc branch 2 times, most recently from 4d5f441 to abf8ab9 Compare November 27, 2025 22:17
LuDuda
LuDuda reviewed Nov 28, 2025
View reviewed changes
doc/known_issues.rst Outdated

**Affected platforms:** nRF52840, nRF54L15 with LR1110 shield

**Impact:** Moderate
Copy link

@LuDuda LuDuda Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we please add the workaround paragraph and paste the patch?

I think we should do the same with the issue with IRQ we approached recently, with proposed patch as a current workaround.

Copy link
Contributor Author

@ktaborowski ktaborowski Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the issue with IRQ, the path will be applied in #737

LuDuda
LuDuda reviewed Nov 28, 2025
View reviewed changes
Copy link

@LuDuda LuDuda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additionally, looking at the entire documentation, I think we should update release notes with information about support for Location Services as well as LR1110.

https://docs.nordicsemi.com/bundle/addon-sidewalk-latest/page/releases_and_migration/release_notes_addon_v110.html

@ktaborowski @annwoj
doc: add Sidewalk location service information
5120b17 
[KRKNWK-21107]
Add Sidewalk location service doc
including overview, testing and known issues.

Signed-off-by: Krzysztof Taborowski <[email protected]>
Co-authored-by: Anna Wojdylo <[email protected]>
@ktaborowski ktaborowski merged commit 585ce8e into nrfconnect:main Nov 28, 2025
61 of 63 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@annwoj annwoj Awaiting requested review from annwoj

1 more reviewer

@LuDuda LuDuda LuDuda left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

doc-required PR must not be merged without tech writer approval. source PR changing src files

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ktaborowski @LuDuda