Skip to content

Commit 20b12f4

Browse files
divipillairlubos
authored andcommitted
doc: Define App and sample-specific Kconfig options
Define App and sample-specific Kconfig options that are mentioned in the 2.8 release notes. NCSDK-30408 Signed-off-by: divya pillai <[email protected]>
1 parent 04e8d7d commit 20b12f4

File tree

5 files changed

+50
-13
lines changed

5 files changed

+50
-13
lines changed

applications/nrf5340_audio/doc/configuration.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ CONFIG_BT_AUDIO_USE_BROADCAST_NAME_ALT
4141
CONFIG_BT_AUDIO_BROADCAST_NAME_ALT
4242
Provides an alternative name for the second gateway in BIS mode.
4343

44+
.. _CONFIG_BT_AUDIO_SCAN_DELEGATOR:
45+
46+
CONFIG_BT_AUDIO_SCAN_DELEGATOR
47+
Enables scan delegator.
48+
When the scan delegator feature is enabled, the broadcast sink will not search for a predefined broadcast source.
49+
Instead, it will wait for a broadcast assistant to connect and control it.
50+
4451
.. _CONFIG_AUDIO_SOURCE_I2S:
4552

4653
CONFIG_AUDIO_SOURCE_I2S

applications/serial_lte_modem/doc/slm_description.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,15 @@ CONFIG_SLM_UART_TX_BUF_SIZE - Send buffer size for UART.
264264
This option defines the size of the buffer for sending (TX) UART traffic.
265265
The default value is 256.
266266

267+
.. _CONFIG_SLM_PPP_FALLBACK_MTU:
268+
269+
CONFIG_SLM_PPP_FALLBACK_MTU - Control the MTU used by PPP.
270+
This option controls the MTU used by PPP.
271+
PPP tries to retrieve the cellular link MTU from the modem (using ``AT+CGCONTRDP=0``).
272+
If MTU is not returned by the modem, this value will be used as a fallback.
273+
The MTU will be used for sending and receiving data on both the PPP and cellular links.
274+
The default value is 1280.
275+
267276
.. _slm_additional_config:
268277

269278
Additional configuration

doc/nrf/releases_and_maturity/releases/release-notes-2.8.0-preview1.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ Serial LTE modem
392392
* Added:
393393

394394
* DTLS support for the ``#XUDPSVR`` and ``#XSSOCKET`` (UDP server sockets) AT commands when the :file:`overlay-native_tls.conf` configuration file is used.
395-
* The :kconfig:option:`CONFIG_SLM_PPP_FALLBACK_MTU` Kconfig option that is used to control the MTU used by PPP when the cellular link MTU is not returned by the modem in response to the ``AT+CGCONTRDP=0`` AT command.
395+
* The :ref:`CONFIG_SLM_PPP_FALLBACK_MTU <CONFIG_SLM_PPP_FALLBACK_MTU>` Kconfig option that is used to control the MTU used by PPP when the cellular link MTU is not returned by the modem in response to the ``AT+CGCONTRDP=0`` AT command.
396396
* Handler for new nRF Cloud event type ``NRF_CLOUD_EVT_RX_DATA_DISCON``.
397397
* Support for socket option ``AT_SO_IPV6_DELAYED_ADDR_REFRESH``.
398398

@@ -539,12 +539,12 @@ Cellular samples
539539

540540
* Added:
541541

542-
* The :kconfig:option:`CONFIG_TEST_COUNTER_MULTIPLIER` Kconfig option to multiply the number of test counter messages sent, for testing purposes.
542+
* The :ref:`CONFIG_TEST_COUNTER_MULTIPLIER <CONFIG_TEST_COUNTER_MULTIPLIER>` Kconfig option to multiply the number of test counter messages sent, for testing purposes.
543543
* A handler for new nRF Cloud event type ``NRF_CLOUD_EVT_RX_DATA_DISCON`` to stop sensors and location services.
544544
* Board support files to enable Wi-Fi scanning for the Thingy:91 X.
545-
* The :kconfig:option:`CONFIG_SEND_ONLINE_ALERT` Kconfig option to enable calling the :c:func:`nrf_cloud_alert` function on startup.
545+
* The :ref:`CONFIG_SEND_ONLINE_ALERT <CONFIG_SEND_ONLINE_ALERT>` Kconfig option to enable calling the :c:func:`nrf_cloud_alert` function on startup.
546546
* Logging of the `reset reason code <nRF9160 RESETREAS_>`_.
547-
* The :kconfig:option:`CONFIG_POST_PROVISIONING_INTERVAL_M` Kconfig option to reduce the provisioning connection interval once the device successfully connects.
547+
* The :ref:`CONFIG_POST_PROVISIONING_INTERVAL_M <CONFIG_POST_PROVISIONING_INTERVAL_M>` Kconfig option to reduce the provisioning connection interval once the device successfully connects.
548548

549549
* Updated:
550550

@@ -564,7 +564,7 @@ Cellular samples
564564
* Added:
565565

566566
* Support for dictionary logs using REST.
567-
* The :kconfig:option:`CONFIG_SEND_ONLINE_ALERT` Kconfig option to enable calling the :c:func:`nrf_cloud_alert` function on startup.
567+
* The :ref:`CONFIG_SEND_ONLINE_ALERT <CONFIG_SEND_ONLINE_ALERT>` Kconfig option to enable calling the :c:func:`nrf_cloud_alert` function on startup.
568568
* Logging of the `reset reason code <nRF9160 RESETREAS_>`_.
569569

570570
* Updated:

doc/nrf/releases_and_maturity/releases/release-notes-2.8.0.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -530,11 +530,11 @@ nRF5340 Audio
530530

531531
* The functions ``bt_hci_err_to_str()`` and ``bt_security_err_to_str()`` that are used to allow printing error codes as strings.
532532
Each function returns string representations of the error codes when the corresponding Kconfig option, :kconfig:option:`CONFIG_BT_HCI_ERR_TO_STR` or :kconfig:option:`CONFIG_BT_SECURITY_ERR_TO_STR`, is enabled.
533-
* CSIS to the BIS sink if the scan delegator feature, ``CONFIG_BT_AUDIO_SCAN_DELEGATOR``, is enabled.
533+
* CSIS to the BIS sink if the scan delegator feature, :ref:`CONFIG_BT_AUDIO_SCAN_DELEGATOR <CONFIG_BT_AUDIO_SCAN_DELEGATOR>`, is enabled.
534534
Once a phone is connected to a BIS sink, the phone will find and connect to the second headset.
535535
Also, the phone can control the BIS headset in a group and deliver the PAST to both headsets at the same time.
536536
* Create CIG after reading the PACS from the first connected unicast server.
537-
* A minimal scan delegator to the unicast server if the feature, ``CONFIG_BT_AUDIO_SCAN_DELEGATOR``, is enabled.
537+
* A minimal scan delegator to the unicast server if the feature, :ref:`CONFIG_BT_AUDIO_SCAN_DELEGATOR <CONFIG_BT_AUDIO_SCAN_DELEGATOR>`, is enabled.
538538
* Available or support context type to PACS in broadcast sink and unicast client if the feature, :kconfig:option:`CONFIG_BT_PAC_SRC_NOTIFIABLE` is enabled.
539539
* The :ref:`nrf_auraconfig` sample.
540540

@@ -619,7 +619,7 @@ Serial LTE modem
619619
* Added:
620620

621621
* DTLS support for the ``#XUDPSVR`` and ``#XSSOCKET`` (UDP server sockets) AT commands when the :file:`overlay-native_tls.conf` configuration file is used.
622-
* The :kconfig:option:`CONFIG_SLM_PPP_FALLBACK_MTU` Kconfig option that is used to control the MTU used by PPP when the cellular link MTU is not returned by the modem in response to the ``AT+CGCONTRDP=0`` AT command.
622+
* The :ref:`CONFIG_SLM_PPP_FALLBACK_MTU <CONFIG_SLM_PPP_FALLBACK_MTU>` Kconfig option that is used to control the MTU used by PPP when the cellular link MTU is not returned by the modem in response to the ``AT+CGCONTRDP=0`` AT command.
623623
* Handler for new nRF Cloud event type :c:enumerator:`NRF_CLOUD_EVT_RX_DATA_DISCON`.
624624
* Support for socket option ``AT_SO_IPV6_DELAYED_ADDR_REFRESH``.
625625

@@ -777,12 +777,12 @@ Cellular samples
777777

778778
* Added:
779779

780-
* The :kconfig:option:`CONFIG_TEST_COUNTER_MULTIPLIER` Kconfig option to multiply the number of test counter messages sent, for testing purposes.
780+
* The :ref:`CONFIG_TEST_COUNTER_MULTIPLIER <CONFIG_TEST_COUNTER_MULTIPLIER>` Kconfig option to multiply the number of test counter messages sent, for testing purposes.
781781
* A handler for new nRF Cloud event type :c:enumerator:`NRF_CLOUD_EVT_RX_DATA_DISCON` to stop sensors and location services.
782782
* Board support files to enable Wi-Fi scanning for the Thingy:91 X.
783-
* The :kconfig:option:`CONFIG_SEND_ONLINE_ALERT` Kconfig option to enable calling the :c:func:`nrf_cloud_alert` function on startup.
783+
* The :ref:`CONFIG_SEND_ONLINE_ALERT <CONFIG_SEND_ONLINE_ALERT>` Kconfig option to enable calling the :c:func:`nrf_cloud_alert` function on startup.
784784
* Logging of the `reset reason code <nRF9160 RESETREAS_>`_.
785-
* The :kconfig:option:`CONFIG_POST_PROVISIONING_INTERVAL_M` Kconfig option to reduce the provisioning connection interval once the device successfully connects.
785+
* The :ref:`CONFIG_POST_PROVISIONING_INTERVAL_M <CONFIG_POST_PROVISIONING_INTERVAL_M>` Kconfig option to reduce the provisioning connection interval once the device successfully connects.
786786

787787
* Updated:
788788

@@ -802,7 +802,7 @@ Cellular samples
802802
* Added:
803803

804804
* Support for dictionary logs using REST.
805-
* The :kconfig:option:`CONFIG_SEND_ONLINE_ALERT` Kconfig option to enable calling the :c:func:`nrf_cloud_alert` function on startup.
805+
* The :ref:`CONFIG_SEND_ONLINE_ALERT <CONFIG_SEND_ONLINE_ALERT>` Kconfig option to enable calling the :c:func:`nrf_cloud_alert` function on startup.
806806
* Logging of the `reset reason code <nRF9160 RESETREAS_>`_.
807807

808808
* Updated:

samples/cellular/nrf_cloud_multi_service/README.rst

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Application thread and main application loop
124124
The application thread is implemented in the :file:`src/application.c` file, and is responsible for the high-level behavior of this sample.
125125

126126
When it starts, it logs the `reset reason code <nRF9160 RESETREAS_>`_.
127-
If the :kconfig:option:`CONFIG_SEND_ONLINE_ALERT` Kconfig option is enabled, it sends an alert to nRF Cloud containing the reset reason as the value field.
127+
If the :ref:`CONFIG_SEND_ONLINE_ALERT <CONFIG_SEND_ONLINE_ALERT>` Kconfig option is enabled, it sends an alert to nRF Cloud containing the reset reason as the value field.
128128

129129
It performs the following major tasks:
130130

@@ -634,6 +634,14 @@ CONFIG_TEST_COUNTER - Enable test counter
634634
Enable the test counter.
635635
When enabled, the test counter configuration setting in the shadow is ignored.
636636

637+
.. _CONFIG_TEST_COUNTER_MULTIPLIER:
638+
639+
CONFIG_TEST_COUNTER_MULTIPLIER - Set the number of test counter messages sent on each update
640+
Sets the number of test counter messages sent on each update.
641+
This is a way to increase the number of device messages sent by the sample.
642+
It is useful for load testing.
643+
The value ranges from ``1`` to ``1000`` and the default value is ``1``.
644+
637645
.. _CONFIG_AT_CMD_REQUESTS:
638646

639647
CONFIG_AT_CMD_REQUESTS - Enable AT command requests
@@ -704,6 +712,19 @@ CONFIG_COAP_FOTA_JOB_CHECK_RATE_MINUTES - FOTA job check interval (minutes)
704712
CONFIG_COAP_FOTA_THREAD_STACK_SIZE - CoAP FOTA Thread Stack Size (bytes)
705713
Sets the stack size (in bytes) for the FOTA job checking thread of the sample.
706714

715+
.. _CONFIG_SEND_ONLINE_ALERT:
716+
717+
CONFIG_SEND_ONLINE_ALERT - Send a routine ``ALERT_TYPE_DEVICE_NOW_ONLINE`` on startup
718+
This option, on enabling, demonstrates the alert feature of nRF Cloud.
719+
Reception of this alert indicates that the device has rebooted.
720+
721+
.. _CONFIG_POST_PROVISIONING_INTERVAL_M:
722+
723+
CONFIG_POST_PROVISIONING_INTERVAL_M - Sets a delay (in minutes) between provisioning checks once connected
724+
This option uses a slower rate to check for provisioning after you have successfully connected.
725+
Until then you can use :kconfig:option:`CONFIG_NRF_PROVISIONING_INTERVAL_S`.
726+
The default value is 30 minutes.
727+
707728
.. include:: /libraries/modem/nrf_modem_lib/nrf_modem_lib_trace.rst
708729
:start-after: modem_lib_sending_traces_UART_start
709730
:end-before: modem_lib_sending_traces_UART_end

0 commit comments

Comments
 (0)