doc: samples: lwm2m_carrier: Add overlay and doc for SoftBank and LG U+ #18706
+209
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
doc-required
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:sdk-nrf: PR head: 7dbb149cca3923ed19704ebde67c612fd030e38b more detailssdk-nrf:
Github labels
List of changed files detected by CI (13)Outputs:ToolchainVersion: b44b7a08c9 Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
Add overlay and improve the Kconfigs and documentation to calrify the extra configurations needed to successfully use SoftBank and/or LG U+. Signed-off-by: Håvard Vermeer <[email protected]>
nordic-hani
force-pushed
the
softbank_dependency
branch
from
40058b0
to
0efd366
Compare
|
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 Publishing GitHub Action. |
nordic-hani
force-pushed
the
softbank_dependency
branch
3 times, most recently
from
c1f08f5
to
e5986c9
Compare
* Add overlay and improve the Kconfigs and documentation to clarify the extra configurations needed to successfully use SoftBank and/or LG U+. * Add missing entry for shell overlay in the sample.yaml. * Improve requirement documentation to mention the specific setups. Signed-off-by: Håvard Vermeer <[email protected]>
nordic-hani
force-pushed
the
softbank_dependency
branch
from
e5986c9
to
7dbb149
Compare
peknis
requested changes
Nov 14, 2024
Comment on lines
+312
to
+319
| See :ref:`slm_carrier_library_support` for more information on how to connect to an operator's device management platform. | ||
|
|
||
| * :file:`overlay-carrier-softbank.conf`;:file:`sysbuild-softbank.conf` - Configuration files that adds SoftBank configurations needed by the carrier libray. | ||
| Used in conjunction with :file:`overlay-carrier.conf`. | ||
| For more information see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation. | ||
| * :file:`overlay-carrier-lgu.conf` - Configuration file that adds LG U+ configurations needed by the carrier libray. | ||
| Used in conjunction with :file:`overlay-carrier.conf`. | ||
| For more information see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation. |
There was a problem hiding this comment.
Suggested change
| See :ref:`slm_carrier_library_support` for more information on how to connect to an operator's device management platform. | |
| * :file:`overlay-carrier-softbank.conf`;:file:`sysbuild-softbank.conf` - Configuration files that adds SoftBank configurations needed by the carrier libray. | |
| Used in conjunction with :file:`overlay-carrier.conf`. | |
| For more information see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation. | |
| * :file:`overlay-carrier-lgu.conf` - Configuration file that adds LG U+ configurations needed by the carrier libray. | |
| Used in conjunction with :file:`overlay-carrier.conf`. | |
| For more information see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation. | |
| See :ref:`slm_carrier_library_support` for more information on how to connect to an operator's device management platform. | |
| * :file:`overlay-carrier-softbank.conf` and :file:`sysbuild-softbank.conf` - Configuration files that add SoftBank configurations needed by the carrier library. | |
| Used in conjunction with :file:`overlay-carrier.conf`. | |
| For more information, see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation. | |
| * :file:`overlay-carrier-lgu.conf` - This configuration file adds LG U+ configurations needed by the carrier library. | |
| Used in conjunction with :file:`overlay-carrier.conf`. | |
| For more information, see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation. |
| * If the application is using the TLS socket, it must immediately close it when the :c:macro:`LWM2M_CARRIER_EVENT_FOTA_START` event is received. | ||
| * The socket is released by the library again upon the next reboot, or in the event of a FOTA error. | ||
| * If the application always needs a TLS socket, it can use `Mbed TLS`_. | ||
|
|
||
| * When in the Verizon network, the LwM2M carrier library uses both the DTLS sessions made available through the modem. | ||
| Therefore, the application cannot run any DTLS or TLS sessions. | ||
|
|
Comment on lines
+63
to
+64
| Carrier Dependent | ||
| ***************** |
There was a problem hiding this comment.
Suggested change
| Carrier Dependent | |
| ***************** | |
| Carrier dependency | |
| ****************** |
| Carrier Dependent | ||
| ***************** | ||
|
|
||
| In order for your device to comply with the carrier's specifications, the following additional requirements apply to your application to use the carrier's LwM2M device management: |
There was a problem hiding this comment.
Suggested change
| In order for your device to comply with the carrier's specifications, the following additional requirements apply to your application to use the carrier's LwM2M device management: | |
| To ensure your device complies with the carrier's specifications, your application must meet the following additional requirements to use the carrier's LwM2M device management: |
|
|
||
| .. group-tab:: Verizon | ||
|
|
||
| * When in the Verizon network, the LwM2M carrier library uses both the DTLS sessions made available through the modem. |
There was a problem hiding this comment.
Suggested change
| * When in the Verizon network, the LwM2M carrier library uses both the DTLS sessions made available through the modem. | |
| * In the Verizon network, the :ref:`liblwm2m_carrier_readme` library uses both DTLS sessions made available through the modem. |
Comment on lines
+89
to
+90
| * If you are using the :ref:`serial_lte_modem` application, this should be set in the file :file:`slm_auto_connect.h, which is included with :kconfig:option:`CONFIG_SLM_AUTO_CONNECT`. | ||
| For more information, see :ref:`CONFIG_SLM_AUTO_CONNECT` in the :ref:`serial_lte_modem` documentation. |
There was a problem hiding this comment.
Suggested change
| * If you are using the :ref:`serial_lte_modem` application, this should be set in the file :file:`slm_auto_connect.h, which is included with :kconfig:option:`CONFIG_SLM_AUTO_CONNECT`. | |
| For more information, see :ref:`CONFIG_SLM_AUTO_CONNECT` in the :ref:`serial_lte_modem` documentation. | |
| * If you are using the :ref:`serial_lte_modem` application, set the mode in the :file:`slm_auto_connect.h` file that is included with the :ref:`CONFIG_SLM_AUTO_CONNECT <CONFIG_SLM_AUTO_CONNECT>` Kconfig option. |
|
|
||
| * The application must support application FOTA. | ||
| The :ref:`serial_lte_modem` application and :ref:`lwm2m_carrier` sample contain extra config files to enable the :kconfig:option:`CONFIG_LWM2M_CARRIER_LG_UPLUS` dependencies. | ||
| * The appplication must set the LG U+ specific configurations listed in :c:struct:`lwm2m_carrier_lg_uplus_config_t`. |
There was a problem hiding this comment.
Suggested change
| * The appplication must set the LG U+ specific configurations listed in :c:struct:`lwm2m_carrier_lg_uplus_config_t`. | |
| * The application must set the LG U+-specific configurations listed in the :c:struct:`lwm2m_carrier_lg_uplus_config_t` structure. |
| * The application must support application FOTA. | ||
| The :ref:`serial_lte_modem` application and :ref:`lwm2m_carrier` sample contain extra config files to enable the :kconfig:option:`CONFIG_LWM2M_CARRIER_LG_UPLUS` dependencies. | ||
| * The appplication must set the LG U+ specific configurations listed in :c:struct:`lwm2m_carrier_lg_uplus_config_t`. | ||
| If you are unsure about which values to supply during certification, reach out to your carrier or your local Nordic Sales representative. |
There was a problem hiding this comment.
Suggested change
| If you are unsure about which values to supply during certification, reach out to your carrier or your local Nordic Sales representative. | |
| If you are unsure about which values to supply during certification, reach out to your carrier or your local Nordic Semiconductor sales representative. |
| @@ -101,6 +101,10 @@ The following files are available: | |||
|
|
|||
| * :file:`prj.conf` - Standard default configuration file. | |||
| * :file:`overlay-shell.conf` - Enables the :ref:`lwm2m_carrier_shell` and :ref:`lib_at_shell`. | |||
| * :file:`overlay-softbank.conf`;:file:`sysbuild-softbank.conf` - Enables configurations for SoftBank. | |||
There was a problem hiding this comment.
Suggested change
| * :file:`overlay-softbank.conf`;:file:`sysbuild-softbank.conf` - Enables configurations for SoftBank. | |
| * :file:`overlay-softbank.conf` and :file:`sysbuild-softbank.conf` - Enable configurations for SoftBank. |
| @@ -101,6 +101,10 @@ The following files are available: | |||
|
|
|||
| * :file:`prj.conf` - Standard default configuration file. | |||
| * :file:`overlay-shell.conf` - Enables the :ref:`lwm2m_carrier_shell` and :ref:`lib_at_shell`. | |||
| * :file:`overlay-softbank.conf`;:file:`sysbuild-softbank.conf` - Enables configurations for SoftBank. | |||
| For more information see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation. | |||
| * :file:`overlay-lgu.conf`;:file:`sysbuild-lgu.conf` - Enables configurations for LG U+. | |||
There was a problem hiding this comment.
Suggested change
| * :file:`overlay-lgu.conf`;:file:`sysbuild-lgu.conf` - Enables configurations for LG U+. | |
| * :file:`overlay-lgu.conf` and :file:`sysbuild-lgu.conf` - Enable configurations for LG U+. |
|
Might be worth a changelog entry. |
MarkusLassila
approved these changes
Nov 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add overlay and improve the Kconfigs and documentation to calrify the extra configurations needed to successfully use SoftBank and/or LG U+.