Configuration options

This page lists the Kconfig options provided by the Matter add-on.

To use the add-on in a Matter application, enable the CONFIG_CHIP Kconfig option. This option enables the Matter protocol stack and other associated features and components.

See Configuring and building in the nRF Connect SDK documentation for information about how to permanently or temporarily change the configuration.

Add-on Kconfig options

CONFIG_MATTER_APP_TASK_QUEUE_SIZE

(int) Maximum number of tasks delegated to be run in the application queue

Define the maximum size of the queue dedicated for application tasks that have to be run in the application thread context.

CONFIG_MATTER_APP_TASK_MAX_SIZE

(int) Maximum size of application task in bytes

Defines the maximum size of a functor that can be put in the application thread’s task queue.

CONFIG_MATTER_CUSTOM_BLUETOOTH_ADVERTISING

(bool) Define the custom behavior of the Bluetooth advertisement in the application code

Disable the default Bluetooth advertising start which is defined in the board.cpp file and allows to use the custom one.

CONFIG_MATTER_OPERATIONAL_KEYS_MIGRATION_TO_ITS

(bool) Operational keys migration feature

Enables migration of the operational keys stored in the persistent storage to the PSA ITS secure storage. Enable this feature while updating the firmware of in-field devices that run Mbed TLS cryptography backend to the firmware based on PSA Crypto API.

CONFIG_MATTER_FACTORY_RESET_ON_KEY_MIGRATION_FAILURE

(bool) Perform factory reset if the operational key migration failed

Allow device to perform factory reset if the operational key for Fabric has not been migrated properly to PSA ITS storage.

CONFIG_MATTER_LEDS

(bool) LEDs usage

Enables LEDs module to be used in the application.

CONFIG_MATTER_SETTINGS_SHELL

(bool) Settings shell for Matter purposes

Allows using matter_settings shell commands. You can use the following commands: peak - to read the maximum settings usage. reset - to reset peak value. get_size - to read the size of specific value. current - to read current settings usage. free - to read free settings space.

CONFIG_MATTER_TEST_EVENT_TRIGGERS

(bool) Test event triggers support

Enables support for test event triggers for the specific use-cases.

CONFIG_MATTER_TEST_EVENT_TRIGGERS_MAX

(int) Maximum amount of event triggers

Defines the maximum amount of event triggers.

CONFIG_MATTER_TEST_EVENT_TRIGGERS_REGISTER_DEFAULTS

(bool) Register default triggers for Matter sample

Automatically register default triggers such as factory reset, device reboot, OTA start query.

CONFIG_MATTER_TEST_EVENT_TRIGGERS_MAX_TRIGGERS_DELEGATES

(int) Maximum amount of the trigger delegates

Defines the maximum number for the TestEventTriggerDelegate implementations to be registered in the nRF test event triggers class.

CONFIG_MATTER_TEST_SHELL

(bool) Test - specific shell commands support for Matter samples

Enables support for test - specific shell commands in Matter samples.

CONFIG_MATTER_PERSISTENT_STORAGE

(bool) Persistent storage support for Matter samples

Matter persistent storage support with the configurable backend.

CONFIG_MATTER_ZAP_FILE_PATH

(string) Path in sample, under which ZAP file is located

Absolute path to location under which ZAP file is located. It shall contain the file name and .zap extension.

CONFIG_MATTER_CERTIFICATION

(bool) Patches for Matter platform certification

It enables including software patches required for the Matter platform certification purposes. Currently it works only with the Matter template sample.

CONFIG_DISABLE_THREAD_DIAGNOSTIC_RLOC16

(bool) Exclude Rloc16 from Thread Network Diagnostics attribute list

When enabled, the Thread Network Diagnostics cluster replaces the default Matter SDK implementation and omits the Rloc16 attribute from the published attribute list.

CONFIG_DISABLE_THREAD_DIAGNOSTIC_EXTADDR

(bool) Exclude ExtAddress from Thread Network Diagnostics attribute list

When enabled, the Thread Network Diagnostics cluster replaces the default Matter SDK implementation and omits the ExtAddress attribute from the published attribute list.

CONFIG_MATTER_USE_DEFAULT_BUTTON_HANDLER

(bool) Use default button handler alongside the application one

When enabled, the button handler responsible for factory reset and DFU is used alongside application handler. In order to override this handler, disable this config.

CONFIG_MATTER_ZAP_GENERATION_BUILD_TIME

(bool) Generate ZAP artifacts at build time

CONFIG_MATTER_ZAP_GENERATION_STATIC

(bool) Use pre-generated ZAP artifacts

CONFIG_MATTER_SETTINGS_STORAGE_BACKEND

(bool) Settings based storage implementation for Matter samples

CONFIG_MATTER_SECURE_STORAGE_BACKEND

(bool) Secure storage implementation for Matter samples [DEPRECATED]

Enables the secure persistent storage wrapper API that imitates Zephyr Settings’ key-value data format. If building with CMSE enabled (/ns), the TF-M and Secure Domain PSA Protected Storage implementation is leveraged by default. If building with CMSE disabled (/cpuapp), the Trusted Storage library must be used.

CONFIG_MATTER_STORAGE_MAX_KEY_LEN

(int) Maximum length (bytes) of the key under which the asset can be stored

CONFIG_MATTER_SECURE_STORAGE_MAX_ENTRY_NUMBER

(int) Maximum number of entries that can be stored securely

CONFIG_MATTER_SECURE_STORAGE_PSA_KEY_VALUE_OFFSET

(hex) The PSA key offset dedicated for Matter application

CONFIG_TRUSTED_STORAGE_BACKEND_AEAD_MAX_DATA_SIZE

(unknown)

CONFIG_MATTER_WATCHDOG

(bool) Watchdog for Matter applications

CONFIG_MATTER_WATCHDOG_PAUSE_IN_SLEEP

(bool) Pause watchdog while CPU is in sleep state

If enabled, the watchdog will be paused while the CPU is in idle (sleep) state.

CONFIG_MATTER_WATCHDOG_PAUSE_ON_DEBUG

(bool) Pause watchdog while the CPU is halted by the debugger

If disabled, the watchdog will not be paused while the CPU is halted by the debugger and the device reset will be triggered, if the feeding signal is not received within the specified time.

CONFIG_MATTER_WATCHDOG_DEFAULT

(bool) Use watchdog object dedicated for Main and Matter threads

The default watchdog objects are created in the matter_init.cpp file. The watchdog objects are dedicated for Main and Matter threads and are initialized using the MATTER_WATCHDOG_DEFAULT_FEED_TIME value.

CONFIG_MATTER_WATCHDOG_TIMEOUT

(int) Default maximum window time in milliseconds for receiving the feeding signal

The default maximum window time defines a time within which the feeding signal must be received from all created Watchdog sources to reset the watchdog object’s timer. If the signals come after elapsing this time, the watchdog timer will not be reset and the reboot occur.

CONFIG_MATTER_WATCHDOG_DEFAULT_FEED_TIME

(int) Default interval of feeding time in milliseconds

The default interval in milliseconds for calling the feeding callback if it exists.

CONFIG_MATTER_WATCHDOG_EVENT_TRIGGERS

(bool) Default event triggers for watchdog purposes

Enables test event triggers to block Main and Matter stacks for the specific amount of time and test Watchdog in this way.

CONFIG_MATTER_DIAGNOSTIC_LOGS

(bool) Diagnostics logs support

Provides support for diagnostics logs. Diagnostics logs allow the Matter controller to read end-user, network and crash logs from the Matter device. Diagnostic logs are usable only if the DiagnosticCluster is available and active on the device’s root endpoint. Otherwise, the compilation error occurs.

CONFIG_MATTER_DIAGNOSTIC_LOGS_MAX_SIMULTANEOUS_SESSIONS

(int) Define maximum simultaneous sessions

The maximum simultaneous sessions, which is the capability for sending diagnostic logs to Matter controller using multiple sessions at the same time for different diagnostic intents. When a session finishes, it releases its slot for a new one.

CONFIG_MATTER_DIAGNOSTIC_LOGS_CRASH_LOGS

(bool) Crash logs support

Enables support for storing crash logs when the crash occurs.

CONFIG_MATTER_DIAGNOSTIC_LOGS_REMOVE_CRASH_AFTER_READ

(bool) Remove the last crash data after read

Removes the last crash data after reading it by Matter controller. Disable this option to read the last crash multiple times.

CONFIG_MATTER_DIAGNOSTIC_LOGS_END_USER_LOGS

(bool) End user logs support

Enables support for capturing end user diagnostic logs.

CONFIG_MATTER_DIAGNOSTIC_LOGS_NETWORK_LOGS

(bool) Network logs support

Enables support for capturing network diagnostic logs.

CONFIG_MATTER_DIAGNOSTIC_LOGS_TEST

(bool) Testing module for Diagnostic logs cluster

Enables testing module for diagnostic logs cluster.

CONFIG_MATTER_DIAGNOSTIC_LOGS_REDIRECT

(bool) Redirection of logs to the diagnostic logs module

Enable redirection of the logs formed using logger LOG macro to the Matter diagnostic logs module. This option enables only redirection logs from the “chip” module, as a diagnostic network logs and from the “app” module, as a diagnostic end user logs.