Skip to content

Conversation

NordicBuilder
Copy link
Contributor

Automatically created by libmodem Github workflow.

SHA: e91806dc2b3f1594a2c272cdcfa685cf97618d21

Automatically created by libmodem Github workflow.

Signed-off-by: Nordic Builder <[email protected]>
Added API documentation for RS Capture API.

Signed-off-by: Tommi Rantanen <[email protected]>
@CLAassistant
Copy link

CLAassistant commented Sep 26, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Sep 26, 2025
Copy link

@lemrey lemrey requested a review from divipillai September 26, 2025 12:21

All notable changes to this project are documented in this file.

nrf_modem 3.2.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
nrf_modem 3.2.0
nrf_modem

Copy link
Contributor

Choose a reason for hiding this comment

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

We could remove the version as it is added later towards the end of the release in the doc version PR.

uint16_t mnc;
/** Index of the configuration used to capture the sample. Range: 0 ... 255
*
* Index matches to the one given in @ref nrf_modem_rs_capture_prs_config.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Index matches to the one given in @ref nrf_modem_rs_capture_prs_config.
* Index matches the one given in @ref nrf_modem_rs_capture_prs_config.

* Only OFDM symbols containing PRS are stored except in 4 TX antenna configuration, where
* every eight symbols is invalid.
*
* If present based on @ref num_samples variable, number of samples is
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* If present based on @ref num_samples variable, number of samples is
* If present based on @ref num_samples variable, number of samples are


All notable changes to this project are documented in this file.

nrf_modem 3.2.0
Copy link
Contributor

Choose a reason for hiding this comment

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

We could remove the version as it is added later towards the end of the release in the doc version PR.

* Offsets are relative to the normal LTE gain settings for the serving cell.
*
* This pattern is repeated one after the other in the RS capture procedure.
* The table must be filled entirely but same value can be set into several indices.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* The table must be filled entirely but same value can be set into several indices.
* The table must be filled entirely, but the same value can be set into several indices.

* Narrowband 0 is reserved for the central narrowband exactly in the middle of system BW.
*
* This pattern is repeated one after the other in the RS capture procedure.
* The table must be filled entirely but same value can be set into several indices.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* The table must be filled entirely but same value can be set into several indices.
* The table must be filled entirely, but the same value can be set into several indices.

Choose a reason for hiding this comment

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

Should we mention somewhere that this API is only supported on 91x1/mfw 2.x.x?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants