Skip to content
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

lib: lte_link_control: Misc doc updates #19768

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

trantanen
Copy link
Contributor

Adding a note that LTE LC and nrf_modem_at APIs should be used together with caution.

A comment in lte_lc_connect* that reconnection happens automatically.

@trantanen trantanen requested review from a team as code owners January 7, 2025 13:19
@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 7, 2025
@trantanen trantanen requested a review from tokangas January 7, 2025 13:20
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jan 7, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 5

Inputs:

Sources:

sdk-nrf: PR head: 118fc33c9ab49c4d375e13efa8b0862715ef8eb2

more details

sdk-nrf:

PR head: 118fc33c9ab49c4d375e13efa8b0862715ef8eb2
merge base: 42f77d47ea3b7313410aa62e9d0dae606ce42e05
target head (main): 7084bd619b16e9e2f2f0381848102fe0b6d59b41
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (2)
doc
│  ├── nrf
│  │  ├── libraries
│  │  │  ├── modem
│  │  │  │  │ lte_lc.rst
include
│  ├── modem
│  │  │ lte_lc.h

Outputs:

Toolchain

Version: b77d8c1312
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:b77d8c1312_912848a074

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain - Skipped: existing toolchain is used
  • ✅ Build twister
    • sdk-nrf test count: 326
  • ❌ Integration tests
    • ✅ test-fw-nrfconnect-nrf-iot_samples
    • ❌ test-fw-nrfconnect-nrf-iot_lwm2m
    • ✅ test-fw-nrfconnect-nrf-iot_mosh
    • ✅ test-fw-nrfconnect-nrf-iot_positioning
    • ⚠️ test-fw-nrfconnect-nrf-iot_cloud
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_nrf_provisioning
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-fw-nrfconnect-zigbee
    • test-low-level
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-sidewalk
    • test-sdk-wifi
    • test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

doc/nrf/libraries/modem/lte_lc.rst Outdated Show resolved Hide resolved
@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publish GitHub Action.

Copy link
Contributor

@eivindj-nordic eivindj-nordic left a comment

Choose a reason for hiding this comment

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

LGTM when comment from @peknis is addressed.

doc/nrf/libraries/modem/lte_lc.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/modem/lte_lc.rst Outdated Show resolved Hide resolved
@trantanen trantanen removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 9, 2025
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 9, 2025
@trantanen trantanen removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 10, 2025
Adding a note that LTE LC and nrf_modem_at APIs should be used
together with caution.

A comment in lte_lc_connect* that reconnection happens automatically.

Signed-off-by: Tommi Rantanen <tommi.rantanen@nordicsemi.no>
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 10, 2025
@trantanen trantanen requested a review from peknis January 10, 2025 07:47
@trantanen trantanen removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 10, 2025
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.

6 participants