From 1281066d49fa4de60defbe46d9173c519a986a72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damian=20Kr=C3=B3lik?= <66667989+Damian-Nordic@users.noreply.github.com> Date: Thu, 19 Jan 2023 16:03:14 +0100 Subject: [PATCH] [zephyr] Improve Kconfig help texts (#24484) Review Kconfig prompts and help texts for nRF Connect platform. Signed-off-by: Grzegorz Ferenc Signed-off-by: Damian Krolik Signed-off-by: Grzegorz Ferenc Signed-off-by: Damian Krolik --- config/nrfconnect/chip-module/Kconfig | 126 +++---- .../nrfconnect/chip-module/Kconfig.features | 12 +- config/zephyr/Kconfig | 323 +++++++++--------- 3 files changed, 239 insertions(+), 222 deletions(-) diff --git a/config/nrfconnect/chip-module/Kconfig b/config/nrfconnect/chip-module/Kconfig index ad61ab9e848112..b0ab15b75a9f4e 100644 --- a/config/nrfconnect/chip-module/Kconfig +++ b/config/nrfconnect/chip-module/Kconfig @@ -23,17 +23,16 @@ config CHIP_DEVICE_VENDOR_NAME default "Nordic Semiconductor ASA" config CHIP_APP_LOG_LEVEL - int "Set logging level in application" + int "Logging level in application" default LOG_DEFAULT_LEVEL depends on LOG help - Sets the logging level in Matter application. - This config should be used only within application. - To set the logging level for Matter stack use MATTER_LOG_LEVEL - config. + Sets the logging level in the Matter application. Use this configuration + option only within the application. To set the logging level for the + Matter stack, use the MATTER_LOG_LEVEL configuration option. config CHIP_NFC_COMMISSIONING - bool "Enable NFC commissioning support" + bool "Share onboarding payload in NFC tag" default n imply NFC_T2T_NRFXLIB imply NFC_NDEF @@ -42,7 +41,7 @@ config CHIP_NFC_COMMISSIONING imply NFC_NDEF_URI_REC imply NFC_NDEF_URI_MSG help - Enables NFC commissioning by sharing onboarding payload in NFC tag. + Enables sharing the onboarding payload in the NFC tag. # See config/zephyr/Kconfig for full definition config CHIP_OTA_REQUESTOR @@ -59,8 +58,8 @@ config CHIP_OTA_REQUESTOR_BUFFER_SIZE default 1024 depends on CHIP_OTA_REQUESTOR help - Configures size of the buffer used by OTA Requestor when downloading and - writing a new firmware image to flash. + Configures the size of the buffer used by OTA Requestor when downloading + and writing a new firmware image to flash. config CHIP_OTA_REQUESTOR_REBOOT_ON_APPLY bool "Auto-reboot when firmware update is applied" @@ -68,9 +67,9 @@ config CHIP_OTA_REQUESTOR_REBOOT_ON_APPLY depends on CHIP_OTA_REQUESTOR imply REBOOT help - When a user consents to apply a firmware update, and the update package is - downloaded, reboot the device automatically to swap the old and the new - firmware images. + Reboots the device automatically after downloading a new firmware update + to swap the old and the new firmware images. The reboot happens only when + a user consents to apply the firmware update. # See config/zephyr/Kconfig for full definition config CHIP_OTA_IMAGE_BUILD @@ -87,54 +86,55 @@ config CHIP_DEBUG_SYMBOLS bool "Generate debug symbols" default y help - Build the application with debug symbols. + Enables building the application with debug symbols. config CHIP_FACTORY_DATA - bool "Enable Factory Data support" + bool "Factory data provider" select ZCBOR select FPROTECT help - Enables support for reading factory data from flash memory partition. - It requires factory_data partition to exist in the partition manager - configuration file pm_static.yml. + Enables the default nRF Connect factory data provider implementation that + supports reading the factory data encoded in the CBOR format from the + flash memory partition. This option requires the factory_data partition in + Partition Manager configuration file (pm_static.yml). config CHIP_FACTORY_DATA_CUSTOM_BACKEND - bool "Enable Factory Data custom backend" + bool "Custom factory data provider" depends on !CHIP_FACTORY_DATA help - Enables user custom factory data implementation. It cannot be used - with the CHIP_FACTORY_DATA that enabled default nRF Connect factory data - implementation. + Enables user's custom factory data provider implementation. This option + cannot be used with the CHIP_FACTORY_DATA, which enables the default nRF + Connect factory data provider implementation. config CHIP_FACTORY_DATA_BUILD - bool "Enable Factory Data build" + bool "Generate factory data contents" default n help - Enables generation of factory data during the building. - It requires factory_data partition to exist in the partition manager - configuration file pm_static.yml. - As a result a new output file factory_data.hex will be created. + Enables generation of the factory data contents during the building. This + option requires the factory_data partition in Partition Manager + configuration file (pm_static.yml). As a result, a new output file is + created (factory_data.hex). config CHIP_FACTORY_DATA_VERSION int default 1 help - The Factory data version contains a current version of a factory data - parameter set that the user cannot change. - After moving to the next version of the factory data set, change the default value. - This config is used to validate the version of a factory data set on a device-side - with the version of factory data saved in the Flash memory. + Provides the version of the generated factory data parameter set. This is + a hidden configuration option that the user cannot change. You can use + this value in the factory data provider implementation to verify that the + factory data saved in the flash memory has the expected version. if CHIP_FACTORY_DATA_BUILD # Factory data definitions config CHIP_FACTORY_DATA_MERGE_WITH_FIRMWARE - bool "Enable merging generated factory data with the build target .hex file" + bool "Merge generated factory data with merged.hex output build file" default y help - Enables merging generated factory data with the build target merged.hex file. - As a result, a new output file merged.hex will consist of all partitions including - factory data. + Enables merging the generated factory data with the merged.hex output + build file. As a result, the merged.hex build output file, which is used + when flashing the firmware using the west tool, includes the factory data + as well. # Select source of the certificates choice CHIP_FACTORY_DATA_CERT_SOURCE @@ -144,52 +144,56 @@ choice CHIP_FACTORY_DATA_CERT_SOURCE config CHIP_FACTORY_DATA_USE_DEFAULT_CERTS bool "Use pre-generated development certificates" help - Use pre-generated certificate files from the credentials/development/attestation/ - directory that match the configured Product ID. This can be used for development - purpose. + Uses pre-generated certificate files from the + credentials/development/attestation/ directory that match the + configured Product ID. This can be used for development purpose. + config CHIP_FACTORY_DATA_CERT_SOURCE_GENERATED bool "Auto-generate certificates" help - Generate new certificates instead of using pre-generated ones. - The certificates are generated on every build. + Generates new certificates instead of using pre-generated ones. The + certificates are generated on every build. + config CHIP_FACTORY_DATA_CERT_SOURCE_USER bool "Use user-provided certificate files" help - Use user-provided certificate files. - The user needs to specify the absolute path to all necessary files. + Uses user-provided certificate files. The user needs to specify the + absolute paths to all necessary files. + endchoice if CHIP_FACTORY_DATA_CERT_SOURCE_USER config CHIP_FACTORY_DATA_USER_CERTS_DAC_CERT - string "Path to the DAC certificate *.der-file" + string "Path to the DAC certificate (DER format)" help - Absolute path to the DAC certificate file in binary format. + Provides the absolute path to the DAC certificate file in the DER format. + config CHIP_FACTORY_DATA_USER_CERTS_DAC_KEY - string "Path to the DAC private key *.der-file" + string "Path to the DAC private key (DER format)" help - Absolute path to the DAC keysfile in binary format. - Note that both public and private keys must be present (will be extracted automatically). + Provides the absolute path to the DAC keypair file in the DER format. Both + public and private keys must be present (the private key will be extracted + automatically). + config CHIP_FACTORY_DATA_USER_CERTS_PAI_CERT - string "Path to the PAI certificate *.der-file" + string "Path to the PAI certificate (DER format)" help - Absolute path pointing to the PAI certificate in binary format. + Provides the absolute path to the PAI certificate in the DER format. endif -# Configs for SPAKE2 generation +# Configs for SPAKE2+ generation config CHIP_FACTORY_DATA_GENERATE_SPAKE2_VERIFIER - bool "Enable spake2 verifier generation" + bool "Generate SPAKE2+ verifier" help - Enables generation of spake2 verifier according to - given iteration counter, salt and passcode. - To generate Spake2 verifier a spake2p executable must be available - from system variables environment. + Enables the generation of the SPAKE2+ verifier for the configured SPAKE2+ + passcode, iteration count and salt. config CHIP_DEVICE_GENERATE_ROTATING_DEVICE_UID - bool "Enable generation of a new Rotating device id unique id" + bool "Generate Rotating device ID unique ID" default y help - Enables generation of a new Rotating device id unique id. + Enables the generation of a random Rotating device ID unique ID. endif #CHIP_FACTORY_DATA_BUILD @@ -203,7 +207,7 @@ endif config CHIP_LOG_SIZE_OPTIMIZATION bool "Disable some detailed logs to decrease flash usage" help - Disables some log levels for the specific log modules - providing detailed information that are not used in most cases. - You can find full configuration enabled by this option - in the platform/nrfconnect/CHIPPlatformConfig.h file. + Disables some log levels for specific Matter log modules that provide + information that is too detailed to be used in most cases. You can find + full configuration enabled by this option in the + platform/nrfconnect/CHIPPlatformConfig.h file. diff --git a/config/nrfconnect/chip-module/Kconfig.features b/config/nrfconnect/chip-module/Kconfig.features index 662d7074ebe0b3..36f102c1af5399 100644 --- a/config/nrfconnect/chip-module/Kconfig.features +++ b/config/nrfconnect/chip-module/Kconfig.features @@ -43,8 +43,8 @@ config CHIP_WIFI config CHIP_QSPI_NOR bool "Enable QSPI NOR feature set" help - Enables QSPI NOR with the set of options - configuring pages and buffer sizes. + Enables QSPI NOR flash with a set of options for configuring pages and + buffer sizes. if CHIP_QSPI_NOR @@ -63,8 +63,8 @@ config CHIP_SPI_NOR imply MULTITHREADING imply PM_OVERRIDE_EXTERNAL_DRIVER_CHECK help - Enables SPI NOR with the set of options - configuring pages and buffer sizes. + Enables SPI NOR flash with a set of options for configuring pages and + buffer sizes. if CHIP_SPI_NOR @@ -86,8 +86,8 @@ config CHIP_DFU_OVER_BT_SMP select MCUMGR_GRP_ZEPHYR_BASIC if SOC_SERIES_NRF53X select MCUMGR_GRP_BASIC_CMD_STORAGE_ERASE if SOC_SERIES_NRF53X help - Enables Device Firmware Upgrade over Bluetoot LE with SMP - and configures set of options related to that feature. + Enables Device Firmware Upgrade over Bluetooth LE with SMP and configures + the set of options related to that feature. if CHIP_DFU_OVER_BT_SMP diff --git a/config/zephyr/Kconfig b/config/zephyr/Kconfig index 45b04b9a1e2216..59b87a77b551ef 100644 --- a/config/zephyr/Kconfig +++ b/config/zephyr/Kconfig @@ -15,7 +15,7 @@ # menuconfig CHIP - bool "Connected Home over IP protocol stack" + bool "Matter protocol stack" default n select CPLUSPLUS imply LIB_CPLUSPLUS @@ -37,256 +37,265 @@ menuconfig CHIP imply NVS imply SETTINGS help - This option enables Connected Home over IP libraries. + Enables Matter libraries required for the Matter protocol stack to work. if CHIP # Device and firmware identifers config CHIP_DEVICE_VENDOR_ID - int "Device vendor ID" + int "Device Vendor ID" default 65521 # 0xFFF1 range 0 65535 help - Identifier of the device manufacturer, assigned by Connectivity Standards - Alliance. It is used in various CHIP areas, such as the Basic Information - cluster or OTA (Over-the-air update) image header. + Provides the 16-bit numeric identifier of the device manufacturer, + assigned by Connectivity Standards Alliance. The identifier is exposed as + an attribute of the Basic Informationcluster, and included in the header + of the generated Matter Over-the-air (OTA) update image. config CHIP_DEVICE_VENDOR_NAME - string "Human-readable vendor name" + string "Device vendor name" help - A human-readable vendor name which provides a simple string - containing identification of device's vendor for the Content APP. - This information should be included in the Matter Basic Cluster. + Provides a human-readable name of the device manufacturer. The name is + exposed as an attribute of the Basic Information cluster. config CHIP_DEVICE_PRODUCT_ID - int "Device product ID" + int "Product ID" default 32768 # 0x8000 range 0 65535 help - Identifier of the product, assigned by the device manufacturer. It is used - in various CHIP areas, such as the Basic Information cluster or OTA - (Over-the-air update) image header. + Provides the 16-bit numeric identifier of the product, assigned by the + device manufacturer. The identifier is exposed as an attribute of the + Basic Information cluster, and included in the header of the generated + Matter over-the-air (OTA) update image. config CHIP_DEVICE_PRODUCT_NAME - string "Human-readable product name" + string "Product name" default "not-specified" help - A human-readable product name which provides a simple string - containing identification of the product for the Content APP. + Provides a human-readable product name, such as the model number, assigned + by the device manufacturer. The name is exposed as an attribute of the + Basic Information cluster. config CHIP_DEVICE_HARDWARE_VERSION - int "Integer representation of hardware version" + int "Hardware version" default 0 help - A hardware version number specifies the version number - of the hardware of the device. The meaning of its value, - and the versioning scheme, are vendor defined. + Provides the 16-bit hardware version number, assigned by the device + manufacturer. The number is exposed as an attribute of the Basic + Information cluster. config CHIP_DEVICE_HARDWARE_VERSION_STRING - string "user-friendly string representation of hardware version" + string "Hardware version string" default "prerelease" help - A hardware version string parameter specifies the version - of the hardware of the device as a more user-friendly value - than that represented by the hardware version integer value. - The meaning of its value, and the versioning scheme, are - vendor defined. + Provides a human-readable representation of the hardware version number. + This must be an ASCII string of a length between 1 and 64 characters. The + hardware version string is exposed as an attribute of the Basic + Information cluster. config CHIP_DEVICE_SOFTWARE_VERSION - int "Device software version" + int "Software version" default 0 range 0 4294967295 help - A number identifying the software version. It is used in various CHIP - areas, such as the Basic Information cluster or OTA (Over-the-air update) - image header. Note that due to the rollback protection a device will only - accept a software update whose version is greater than the current one. + Provides the 32-bit software version number. The number is exposed as an + attribute of the Basic Information cluster, and included in the header of + the generated Matter Over-the-air (OTA) update image. The exact numbering + scheme is up to the device manufacturer. However, when using the Matter + OTA mechanism, only updates to higher versions than the current one are + accepted. config CHIP_DEVICE_SOFTWARE_VERSION_STRING - string "Device software version string" + string "Software version string" default "prerelease" help - A string between 1 and 64 characters that provides a user-friendly - description of the numeric software version specified in - CHIP_DEVICE_SOFTWARE_VERSION. It is used in various CHIP areas, such as - the Basic Information cluster or OTA (Over-the-air update) image header. + Provides a human-readable representation of the software version number. + This must be an ASCII string of a length between 1 and 64 characters. The + software version string is exposed as an attribute of the Basic + Information cluster, and included in the header of the generated Matter + over-the-air (OTA) update image. config CHIP_DEVICE_MANUFACTURING_DATE - string "Manufacturing date in ISO 8601" + string "Manufacturing date (ISO 8601 format)" default "2022-01-01" help - A manufacturing date specifies the date that the device was manufactured. - The format used for providing a manufacturing date is ISO 8601 e.g. YYYY-MM-DD. + Provides the device manufacturing date in the ISO 8601 format: YYYY-MM-DD. config CHIP_DEVICE_SERIAL_NUMBER - string "Serial number of device" + string "Device serial number" default "11223344556677889900" help - A serial number parameter defines an unique number of manufactured device. - Maximum length of serial number is 32 characters. + Provides a human-readable representation of the device serial number that + uniquely identifies the device. This must be an ASCII string of no more + than 32 characters. config CHIP_DEVICE_ROTATING_DEVICE_UID - string "A rotating device id unique id" + string "Rotating device ID unique ID (HEX format)" default "91a9c12a7c80700a31ddcfa7fce63e44" help - A device rotating id unique id which will be generated if - this config is not set in prj.conf file. + Provides a unique identifier of the device. This ID is used to derive the + rotating device identifier, which allows commissioners to discover the + device in a privacy-preserving way. The identifier must be a string of at + least 16 bytes encoded in HEX. config CHIP_DEVICE_TYPE - int "Device type" + int "Primary device type" default 65535 range 0 65535 help - Type of device that uses the CHIP Device Type Identifier. The default value means invalid device type. + Provides the primary device type implemented by the node. This must be one + of the device type identifiers defined in the Matter Device Library + specification. config CHIP_DEVICE_DISCRIMINATOR hex "Device pairing discriminator" default 0xF00 help - A 12-bit value matching the field of the same name in - the setup code. Discriminator is used during - a discovery process. + Provides a 12-bit identifier that is used to discover the device during + the commissioning. config CHIP_DEVICE_SPAKE2_PASSCODE - int "Spake2+ passcode" + int "SPAKE2+ passcode" default 20202021 range 1 99999998 help - A pairing passcode is a 27-bit unsigned integer which serves - as a proof of possession during commissioning. - Its value shall be restricted to the values 0x0000001 to 0x5F5E0FE - (00000001 to 99999998 in decimal), excluding the invalid Passcode values: - - 00000000, 11111111, 22222222, 33333333, 44444444, 55555555, + Provides a pairing passcode. This is a 27-bit unsigned integer that serves + as a proof of possession during the commissioning. The passcode must be + a value between 1 and 99999998, excluding the following invalid passcodes: + 00000000, 11111111, 22222222, 33333333, 44444444, 55555555, 66666666, 77777777, 88888888, 99999999, 12345678, 87654321. config CHIP_DEVICE_SPAKE2_IT - int "Spake2+ iteration count" + int "SPAKE2+ iteration count" default 1000 help - The Spake2 iteration count is associated with the ephemeral - PAKE passcode verifier to be used for the commissioning. - The iteration count is used as a crypto parameter to process - spake2 verifier. + Provides the SPAKE2+ iteration count, which is one of the input parameters + for the PBKDF operation, used to generate the SPAKE2+ verifier. config CHIP_DEVICE_SPAKE2_SALT - string "Spake2+ salt in string format" + string "SPAKE2+ salt (base64 format)" default "U1BBS0UyUCBLZXkgU2FsdA==" help - The spake2 salt is random data that is used as an additional input - to a one-way function that “hashes” data. - A new salt should be randomly generated for each password. - The minimum length of spake2 salt is 16 Bytes. - The maximum length of spake2 salt is 32 Bytes. + Provides the SPAKE2+ salt, which is one of the input parameters for the + PBKDF operation, used to generate the SPAKE2+ verifier. The salt must be + of a length between 16 and 32 bytes and it should be randomly generated + for each SPAKE2+ passcode. config CHIP_DEVICE_SPAKE2_TEST_VERIFIER - string "Testing spake2+ verifier" + string "SPAKE2+ verifier for testing purposes (base64 format)" default "uWFwqugDNGiEck/po7KHwwMwwqZgN10XuyBajPGuyzUEV/iree4lOrao5GuwnlQ65CJzbeUB49s31EH+NEkg0JVI5MGCQGMMT/SRPFNRODm3wH/MBiehuFc6FJ/NH6Rmzw==" help - The spake 2 verifier generated using default SPAKE2 salt, - iteration count and passcode. This value can be used for development - or testing purposes. - Generated with: - spake2p gen-verifier -o - -i 1000 -s "U1BBS0UyUCBLZXkgU2FsdA==" -p 20202021 + Provides the SPAKE2+ verifier that was generated using the configured + SPAKE2+ passcode, iteration count and salt. This configuration option can + be used for development or testing purposes. The default value was + generated using the following command: + ./scripts/tools/spake2p/spake2p.py gen-verifier -i 1000 -s U1BBS0UyUCBLZXkgU2FsdA== -p 20202021 config CHIP_DEVICE_ENABLE_KEY - string "Enable Key for triggering test actions on device" + string "Enable Key for triggering test actions (HEX format)" default "00112233445566778899AABBCCDDEEFF" help - The Enable Key is a 128-bit value that triggers test action - while invoking the TestEventTrigger Command. - Pattern: "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF" - This value is used during Certification Tests, - and should not be present on production devices. + Provides the Enable Key, which is a 16-byte value encoded in HEX that + must be provided in the TestEventTrigger command to trigger a requested + test action. This value is used during certification tests, and should not + be present on devices in production environment. # Matter optional features and parameters config CHIP_ENABLE_PAIRING_AUTOSTART - bool "Enable pairing autostart" + bool "Open commissioning window on boot" default n help - Open pairing window automatically at application boot time. + Opens the commissioning window automatically at application boot time if + the node is not yet commissioned. config CHIP_OTA_REQUESTOR - bool "Enable OTA requestor" + bool "OTA Software Update Requestor" help - Enables OTA (Over-the-air) Requestor role that allows a device to perform + Enables over-the-air (OTA) Requestor role that allows the node to perform Device Firmware Upgrade by quering and downloading a new firmware image - from an external OTA Provider node. + from a peer OTA Provider node. config CHIP_ROTATING_DEVICE_ID - bool "Enable rotating device ID support" + bool "Generate rotating device ID" help - Enables rotating device identifier that provides a non-trackable identifier - which is unique per device and rotates at pre-defined moments. + Enables the rotating device identifier that provides a non-trackable + identifier. The identifier is unique per device and rotates at pre-defined + moments. config CHIP_COMMISSIONABLE_DEVICE_TYPE - bool "Enable the device type subtype in commissionable node discovery record" - depends on CHIP_ENABLE_DNSSD_SRP + bool "Include device type subtype in commissionable node discovery record" help - Enables including device type subtype in the commissionable node discovery record, - which allows filtering of the results to find the nodes that match the device type. + Includes the device type subtype in the commissionable node discovery + record. This allows a commissioner to find the node when looking for + a specific device type. config CHIP_EXTENDED_DISCOVERY - bool "Enable extended discovery" + bool "Extended discovery" help - Enables the device to advertise commissionable service when not in the - commissioning mode. + Enables advertising of the commissionable node service even if the node + does not have the commissioning window open. config CHIP_OPERATIONAL_TIME_SAVE_INTERVAL - int "Interval of saving node operation time to flash in hours unit" + int "Total operational time save interval (hours unit)" default 10 range 1 4294967295 help - Interval in hours with which the node operation time is saved to the flash - memory. Selected value is a trade off between performing frequent saves to know - precisely operation time in case of device reboot and maximizing flash memory - lifetime. + Provides an interval in hours with which the node operational time is + saved to the flash memory. The provided value is a trade-off between + performing frequent saves to know the precise operational time (in case of + device reboot) and maximizing the flash memory lifetime. config CHIP_CRYPTO_PSA bool "Use PSA crypto API for cryptographic operations" help - Use the backend for the Matter crypto layer that is based on PSA crypto - API instead of the default, based on legacy mbedTLS APIs. + Enables the implementation of the Matter cryptographic operations that is + based on the PSA crypto API (instead of the default implementation, which + is based on the legacy mbedTLS APIs). config CHIP_LIB_SHELL - bool "Enable CHIP shell library" + bool "Matter shell commands" default n imply SHELL help - Link the application with the library containing CHIP shell commands. + Enables linking the application with the library that contains Matter + shell commands. config CHIP_PROJECT_CONFIG - string "Project configuration file for CHIP" + string "Project configuration file for Matter" help - Project configuration file for CHIP. If specified, CHIP generic - configuration files will include the project configuration file which can - be used to override any CHIP default or platform-specific settings. + Provides a path to the project configuration file for Matter. The path can + be either absolute or relative to the application directory. If specified, + Matter's generic configuration files will include the project + configuration file that can be used to override any of Matter's default or + platform-specific settings. # Thread network features config CHIP_ENABLE_DNSSD_SRP - bool "Enable support for service registration" + bool "OpenThread Service Registration Protocol" default y if NET_L2_OPENTHREAD imply OPENTHREAD_ECDSA imply OPENTHREAD_SRP_CLIENT help - Enables DNS-SD SRP client support + Enables using the OpenThread SRP client for the Matter service + advertising. config CHIP_ENABLE_DNS_CLIENT - bool "Enable support for DNS client" - default y + bool "OpenThread DNS client" + default y if NET_L2_OPENTHREAD imply OPENTHREAD_DNS_CLIENT help - Enables DNS client support used for resolving and browsing services. + Enables using the OpenThread DNS client for the Matter service discovery. config CHIP_ENABLE_SLEEPY_END_DEVICE_SUPPORT - bool "Enable sleepy end device support" + bool "Thread Sleepy End Device support" default n depends on OPENTHREAD_MTD imply OPENTHREAD_MTD_SED help - Enables Thread Sleepy End Device support in Matter. + Enables the Thread Sleepy End Device (SED) support in Matter. if CHIP_ENABLE_SLEEPY_END_DEVICE_SUPPORT @@ -294,17 +303,17 @@ config CHIP_SED_IDLE_INTERVAL int "Sleepy End Device idle interval (ms)" default 1000 help - SED wake interval in milliseconds while the device is idle, meaning that - there is no active exchange to or from the device, and its commissioning - window is closed. + Provides the Sleepy End Device wake interval in milliseconds while the + device is idle (which means that there is no active exchange to or from + the device, and its commissioning window is closed). config CHIP_SED_ACTIVE_INTERVAL int "Sleepy End Device active interval (ms)" default 200 help - SED wake interval in milliseconds while the device is active, meaning that - there is an active exchange to or from the device, or its commissioning - window is open. + Provides the Sleepy End Device wake interval in milliseconds while the + device is active (which means that there is an active exchange to or from + the device, or its commissioning window is open). endif # CHIP_ENABLE_SLEEPY_END_DEVICE_SUPPORT @@ -312,33 +321,35 @@ config CHIP_THREAD_SSED bool "Enable Thread Synchronized Sleepy End Device support" depends on OPENTHREAD_CSL_RECEIVER && CHIP_ENABLE_SLEEPY_END_DEVICE_SUPPORT help - Enables Thread Synchronized Sleepy End Device support in Matter. + Enables the Thread Synchronized Sleepy End Device support in Matter. config CHIP_OPENTHREAD_CONFIG string "Custom OpenThread configuration file" help - This option can be used to replace Zephyr-supplied OpenThread - configuration file with a custom one. + Provides a path to an OpenThread configuration file. The path can be + either absolute or relative to the application directory. When this option + is specified, it replaces the OpenThread configuration file supplied by + Zephyr. # Platform additions and configuration config CHIP_CERTIFICATION_DECLARATION_STORAGE - bool "Enable storing Certification Declaration" + bool "Certification Declaration settings storage" depends on CHIP_FACTORY_DATA help - Enables storing Certification Declaration in Zephyr settings - instead of using hardcoded value from firmware. It also adds + Enables storing of the Certification Declaration in Zephyr settings + instead of using the hardcoded value from firmware. This option also adds support for including new Certification Declaration into a firmware - update image package sent via OTA Software Update. + update image package that is sent as part of the OTA software update. if CHIP_CERTIFICATION_DECLARATION_STORAGE config CHIP_CERTIFiCATION_DECLARATION_OTA_IMAGE_ID - int "Certification declaration OTA image id" + int "Certification declaration OTA image ID" default 205 #0xcd help - The image id of Certification Declaration image - for sending it via OTA Software Update purposes. + Provides the image ID of the Certification Declaration image for sending + it as part of the OTA software update. endif @@ -346,37 +357,38 @@ config CHIP_FACTORY_RESET_ERASE_NVS bool "Erase NVS flash pages on factory reset" depends on SETTINGS_NVS help - When factory reset is requested, erase flash pages occupied by non-volatile storage - instead of removing Matter-related settings only. This provides a more robust - factory reset mechanism and allows to regain the original storage performance if any - firmware issue has brought it to an unexpected state. For this reason, it is - advisable to set this option if all configuration, including device-specific - entries, is supposed to be cleared on a factory reset. + Erases flash pages occupied by non-volatile storage when a factory reset + is requested, instead of removing Matter-related settings only. Enabling + this option provides a more robust factory reset mechanism and allows to + regain the original storage performance if any firmware issue has brought + it to an unexpected state. For this reason, set this option if the entire + configuration is supposed to be cleared on a factory reset, including + device-specific entries. config CHIP_MALLOC_SYS_HEAP bool "Memory allocator based on Zephyr sys_heap" imply SYS_HEAP_RUNTIME_STATS help - Enable memory allocation functions, imitating with the default malloc, + Enables memory allocation functions that imitate the default malloc, calloc, realloc and free, based on sys_heap from Zephyr RTOS. if CHIP_MALLOC_SYS_HEAP config CHIP_MALLOC_SYS_HEAP_OVERRIDE - bool "Override default allocator with custom one based on Zephyr sys_heap" + bool "Override default allocator with memory allocator based on Zephyr sys_heap" default y help - Replace the default memory allocation functions, such as malloc, calloc, - realloc, free and their reentrant versions, with their counterparts based + Replaces the default memory allocation functions (such as malloc, calloc, + realloc, free, and their reentrant versions) with their counterparts based on sys_heap from Zephyr RTOS. config CHIP_MALLOC_SYS_HEAP_SIZE int "Heap size used by memory allocator based on Zephyr sys_heap" default 16384 # 16kB help - This value controls how much of the device RAM is reserved for the heap - used by the memory allocation functions based on sys_heap from Zephyr - RTOS. + Provides a value that controls how much of the device RAM is reserved for + the heap used by the memory allocation functions based on sys_heap from + Zephyr RTOS. endif @@ -387,28 +399,29 @@ source "${ZEPHYR_BASE}/subsys/logging/Kconfig.template.log_config" # Build system options config APP_LINK_WITH_CHIP - bool "Link 'app' with Connected Home over IP" + bool "Link application with Matter libraries" default y help - Add Connected Home over IP header files to the 'app' include path - and link the 'app' with Connected Home over IP libraries. + Adds Matter directories to the 'app' target include paths and links the + 'app' target with Matter libraries. config CHIP_PW_RPC - bool "Enable Pigweed RPC library" + bool "Pigweed RPC library" default n help - Link the application with the library containing Pigweed RPC functionalities. + Links the application with the libraries containing Pigweed RPC + functionalities. config CHIP_BUILD_TESTS - bool "Build CHIP unit tests" + bool "Build Matter unit tests" default n help - This option enables building CHIP unit tests. + Enables building Matter unit tests. config CHIP_OTA_IMAGE_BUILD bool "Generate OTA image" help - Enable building Matter OTA (Over-the-air update) image. + Enables building Matter over-the-air (OTA) update image. if CHIP_OTA_IMAGE_BUILD @@ -416,13 +429,13 @@ config CHIP_OTA_IMAGE_FILE_NAME string "OTA image file name" default "matter.ota" help - File name of the generated Matter OTA image. + Provides the file name of the generated Matter OTA image. config CHIP_OTA_IMAGE_EXTRA_ARGS string "OTA image creator extra arguments" help - This option allows one to pass optional arguments to the ota_image_tool.py - script, used for building OTA image. + Provides optional arguments to the ota_image_tool.py script, used for + building Matter OTA image. endif