Configuration Options

Kconfig files describe build-time configuration options (called symbols in Kconfig-speak), how they’re grouped into menus and sub-menus, and dependencies between them that determine what configurations are valid.

Some dependencies listed here are part of the nRF Connect SDK or Zephyr projects. If an option is not described in detail, you can search for it in Nordic Semiconductor’s Kconfig search: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/kconfig/

Kconfig files appear throughout the directory tree. For example, init/Kconfig defines initialization related options.

This documentation is generated from the Kconfig files. Click on symbols for more information.

Configuration options

Symbol name

Help/prompt

CONFIG_ANT

Enable ANT ultra low power wireless protocol by Garmin Canada Inc.

CONFIG_ANT_BPWR

Support for ANT+ BPWR constants and pages

CONFIG_ANT_BPWR_SIMULATOR

Enable ANT+ Bicycle Power Simulator

CONFIG_ANT_BSC

Support for ANT+ Bike Speed and Cadence constants and pages

CONFIG_ANT_BSC_SIMULATOR

Enable ANT+ Bike Speed and Cadence Simulator

CONFIG_ANT_BURST_QUEUE_SIZE

ANT burst queue size.

CONFIG_ANT_CHANNEL_CONFIG

Helper functions for ANT channel configuration

CONFIG_ANT_COMMON

Support for ANT+ common constants and pages

CONFIG_ANT_ENCRYPTED_CHANNELS

Allocated ANT encrypted channels.

CONFIG_ANT_ENCRYPTION_NEGOTIATION_SLAVE

Negotiation for encrypted ANT slave (rx) channels

CONFIG_ANT_ENCRYPTION_NUM_CHANNELS

Number of encrypted channels to configure. Must be <= CONFIG_ANT_ENCRYPTED_CHANNELS

CONFIG_ANT_ENCRYPT_CONFIG

Helper functions for ANT encrypt configuration

CONFIG_ANT_EVALUATION_KEY

Use ANT Evaluation License Key.

CONFIG_ANT_EVENT_QUEUE_SIZE

Event queue size.

CONFIG_ANT_HIGH_PRIORITY_TIMEOUT

High priority search timeout

CONFIG_ANT_HRM

Support for ANT+ HRM constants and pages

CONFIG_ANT_HRM_SIMULATOR

Enable ANT+ HRM Simulator

CONFIG_ANT_INCLUDE_NP_CHILD_IMAGE

Enabling this setting will include an ANT-only network stack to run on the network core to communicate over nRF RPC with the application core. The application core does not have access to the radio peripheral.

This setting conflicts with CONFIG_BT since dual protocol samples (ANT and BLE) are built on the on the default network core sample (typically hci_ipc, see NCS_INCLUDE_RPMSG_CHILD_IMAGE for details) with additional configurations to enable ANT.

CONFIG_ANT_INTERNAL

ANT Internal

CONFIG_ANT_KEY_MANAGER

Helper functions for setting ANT Network Keys. The ANT+ network key is to be used by devices that will communicate on the ANT+ network and strictly adhere to the ANT+ Device Profiles. The ANT-FS network key is similarly used strictly for ANT-FS applications.

CONFIG_ANT_LIBRARY_CORE

This configuration is required for all single core builds and for network core builds on dual-core systems.

CONFIG_ANT_LICENSE_KEY

This key is used in library initialization. You MUST obtain a valid commercial license key BEFORE releasing a product to market that uses ANT. You may enable the Evaluation license key for non-commericial use by setting CONFIG ANT_EVALUATION_KEY=y or defining CONFIG_ANT_LICENSE_KEY in the configuration file. For more information about ANT licensing, visit the following website: https://www.thisisant.com/developer/ant/licensing

CONFIG_ANT_LOW_PRIORITY_TIMEOUT

Low priority search timeout

CONFIG_ANT_NP

Serialize API calls for execution on remote CPU.

CONFIG_ANT_NP_HOST

ANT Host (application core) configuration for multicore applications.

CONFIG_ANT_NP_HOST_SYS_INIT

In most cases, the network processor host module handles initialization using the SYS_INIT macro. This Kconfig is provided to bypass initialization and expose the ant_rpc_app_init function for applications that have unique initialization requirements. When enabled, it becomes the responisbility of the application to ensure that ant_init() is called on the application core prior to any ANT API usage so RPC messages from the network core can be processed.

CONFIG_ANT_NP_REMOTE

ANT Remote (network core) configuration for multicore applications.

CONFIG_ANT_RPC

ANT over RPC

CONFIG_ANT_SAMPLE_RPC_CHILD_IMAGE

ant_rpc sample as a child image (network core).

CONFIG_ANT_SDC_INIT

Allow ANT initialization on the network core to also initialize the softdevice controller. This is to allow the ANT library stack to utlize the sdc_soc interface for cryptographic purposes. If sdc_init() is run prior to ANT initialization (eg. for BT), then this configuration is not needed as long as it is run before using any ANT library stack cryptographic functions.

CONFIG_ANT_SEARCH_CONFIG

Helper functions for ANT search configuration

CONFIG_ANT_STATE_INDICATOR

Controls LEDs based on ANT connection states

CONFIG_ANT_SWI1

SWI1

CONFIG_ANT_SWI2

SWI2

CONFIG_ANT_SWI3

SWI3

CONFIG_ANT_SWI4

SWI4

CONFIG_ANT_SWI5

SWI5

CONFIG_ANT_THREAD_COOP_PRIO

CONFIG_ANT_TOTAL_CHANNELS_ALLOCATED

Allocated ANT channels.

CONFIG_ANT_WORK_STACK_SIZE

Size of the work handler thread stack, used to process work in ANT priority context.

CONFIG_SENSORSIM

Allows for manual incrementing of a sensor value or generates a triangular waveform.

Logging configuration options

Symbol name

Help/prompt

CONFIG_ANT_BPWR_LOG_LEVEL

CONFIG_ANT_BPWR_LOG_LEVEL_DBG

Debug

CONFIG_ANT_BPWR_LOG_LEVEL_DEFAULT

Default

CONFIG_ANT_BPWR_LOG_LEVEL_ERR

Error

CONFIG_ANT_BPWR_LOG_LEVEL_INF

Info

CONFIG_ANT_BPWR_LOG_LEVEL_OFF

Off

CONFIG_ANT_BPWR_LOG_LEVEL_WRN

Warning

CONFIG_ANT_BSC_LOG_LEVEL

CONFIG_ANT_BSC_LOG_LEVEL_DBG

Debug

CONFIG_ANT_BSC_LOG_LEVEL_DEFAULT

Default

CONFIG_ANT_BSC_LOG_LEVEL_ERR

Error

CONFIG_ANT_BSC_LOG_LEVEL_INF

Info

CONFIG_ANT_BSC_LOG_LEVEL_OFF

Off

CONFIG_ANT_BSC_LOG_LEVEL_WRN

Warning

CONFIG_ANT_CHANNEL_CONFIG_LOG_LEVEL

CONFIG_ANT_CHANNEL_CONFIG_LOG_LEVEL_DBG

Debug

CONFIG_ANT_CHANNEL_CONFIG_LOG_LEVEL_DEFAULT

Default

CONFIG_ANT_CHANNEL_CONFIG_LOG_LEVEL_ERR

Error

CONFIG_ANT_CHANNEL_CONFIG_LOG_LEVEL_INF

Info

CONFIG_ANT_CHANNEL_CONFIG_LOG_LEVEL_OFF

Off

CONFIG_ANT_CHANNEL_CONFIG_LOG_LEVEL_WRN

Warning

CONFIG_ANT_ENCRYPT_CONFIG_LOG_LEVEL

CONFIG_ANT_ENCRYPT_CONFIG_LOG_LEVEL_DBG

Debug

CONFIG_ANT_ENCRYPT_CONFIG_LOG_LEVEL_DEFAULT

Default

CONFIG_ANT_ENCRYPT_CONFIG_LOG_LEVEL_ERR

Error

CONFIG_ANT_ENCRYPT_CONFIG_LOG_LEVEL_INF

Info

CONFIG_ANT_ENCRYPT_CONFIG_LOG_LEVEL_OFF

Off

CONFIG_ANT_ENCRYPT_CONFIG_LOG_LEVEL_WRN

Warning

CONFIG_ANT_HRM_LOG_LEVEL

CONFIG_ANT_HRM_LOG_LEVEL_DBG

Debug

CONFIG_ANT_HRM_LOG_LEVEL_DEFAULT

Default

CONFIG_ANT_HRM_LOG_LEVEL_ERR

Error

CONFIG_ANT_HRM_LOG_LEVEL_INF

Info

CONFIG_ANT_HRM_LOG_LEVEL_OFF

Off

CONFIG_ANT_HRM_LOG_LEVEL_WRN

Warning

CONFIG_ANT_KEY_MANAGER_LOG_LEVEL

CONFIG_ANT_KEY_MANAGER_LOG_LEVEL_DBG

Debug

CONFIG_ANT_KEY_MANAGER_LOG_LEVEL_DEFAULT

Default

CONFIG_ANT_KEY_MANAGER_LOG_LEVEL_ERR

Error

CONFIG_ANT_KEY_MANAGER_LOG_LEVEL_INF

Info

CONFIG_ANT_KEY_MANAGER_LOG_LEVEL_OFF

Off

CONFIG_ANT_KEY_MANAGER_LOG_LEVEL_WRN

Warning

CONFIG_ANT_LOG_LEVEL

CONFIG_ANT_LOG_LEVEL_DBG

Debug

CONFIG_ANT_LOG_LEVEL_DEFAULT

Default

CONFIG_ANT_LOG_LEVEL_ERR

Error

CONFIG_ANT_LOG_LEVEL_INF

Info

CONFIG_ANT_LOG_LEVEL_OFF

Off

CONFIG_ANT_LOG_LEVEL_WRN

Warning

CONFIG_ANT_SEARCH_CONFIG_LOG_LEVEL

CONFIG_ANT_SEARCH_CONFIG_LOG_LEVEL_DBG

Debug

CONFIG_ANT_SEARCH_CONFIG_LOG_LEVEL_DEFAULT

Default

CONFIG_ANT_SEARCH_CONFIG_LOG_LEVEL_ERR

Error

CONFIG_ANT_SEARCH_CONFIG_LOG_LEVEL_INF

Info

CONFIG_ANT_SEARCH_CONFIG_LOG_LEVEL_OFF

Off

CONFIG_ANT_SEARCH_CONFIG_LOG_LEVEL_WRN

Warning

CONFIG_ANT_STATE_INDICATOR_LOG_LEVEL

CONFIG_ANT_STATE_INDICATOR_LOG_LEVEL_DBG

Debug

CONFIG_ANT_STATE_INDICATOR_LOG_LEVEL_DEFAULT

Default

CONFIG_ANT_STATE_INDICATOR_LOG_LEVEL_ERR

Error

CONFIG_ANT_STATE_INDICATOR_LOG_LEVEL_INF

Info

CONFIG_ANT_STATE_INDICATOR_LOG_LEVEL_OFF

Off

CONFIG_ANT_STATE_INDICATOR_LOG_LEVEL_WRN

Warning

CONFIG_BPWR_PAGES_LOG_LEVEL

CONFIG_BPWR_PAGES_LOG_LEVEL_DBG

Debug

CONFIG_BPWR_PAGES_LOG_LEVEL_DEFAULT

Default

CONFIG_BPWR_PAGES_LOG_LEVEL_ERR

Error

CONFIG_BPWR_PAGES_LOG_LEVEL_INF

Info

CONFIG_BPWR_PAGES_LOG_LEVEL_OFF

Off

CONFIG_BPWR_PAGES_LOG_LEVEL_WRN

Warning

CONFIG_BPWR_SIMULATOR_LOG_LEVEL

CONFIG_BPWR_SIMULATOR_LOG_LEVEL_DBG

Debug

CONFIG_BPWR_SIMULATOR_LOG_LEVEL_DEFAULT

Default

CONFIG_BPWR_SIMULATOR_LOG_LEVEL_ERR

Error

CONFIG_BPWR_SIMULATOR_LOG_LEVEL_INF

Info

CONFIG_BPWR_SIMULATOR_LOG_LEVEL_OFF

Off

CONFIG_BPWR_SIMULATOR_LOG_LEVEL_WRN

Warning

CONFIG_BSC_PAGES_LOG_LEVEL

CONFIG_BSC_PAGES_LOG_LEVEL_DBG

Debug

CONFIG_BSC_PAGES_LOG_LEVEL_DEFAULT

Default

CONFIG_BSC_PAGES_LOG_LEVEL_ERR

Error

CONFIG_BSC_PAGES_LOG_LEVEL_INF

Info

CONFIG_BSC_PAGES_LOG_LEVEL_OFF

Off

CONFIG_BSC_PAGES_LOG_LEVEL_WRN

Warning

CONFIG_BSC_SIMULATOR_LOG_LEVEL

CONFIG_BSC_SIMULATOR_LOG_LEVEL_DBG

Debug

CONFIG_BSC_SIMULATOR_LOG_LEVEL_DEFAULT

Default

CONFIG_BSC_SIMULATOR_LOG_LEVEL_ERR

Error

CONFIG_BSC_SIMULATOR_LOG_LEVEL_INF

Info

CONFIG_BSC_SIMULATOR_LOG_LEVEL_OFF

Off

CONFIG_BSC_SIMULATOR_LOG_LEVEL_WRN

Warning

CONFIG_HRM_PAGES_LOG_LEVEL

CONFIG_HRM_PAGES_LOG_LEVEL_DBG

Debug

CONFIG_HRM_PAGES_LOG_LEVEL_DEFAULT

Default

CONFIG_HRM_PAGES_LOG_LEVEL_ERR

Error

CONFIG_HRM_PAGES_LOG_LEVEL_INF

Info

CONFIG_HRM_PAGES_LOG_LEVEL_OFF

Off

CONFIG_HRM_PAGES_LOG_LEVEL_WRN

Warning

CONFIG_HRM_SIMULATOR_LOG_LEVEL

CONFIG_HRM_SIMULATOR_LOG_LEVEL_DBG

Debug

CONFIG_HRM_SIMULATOR_LOG_LEVEL_DEFAULT

Default

CONFIG_HRM_SIMULATOR_LOG_LEVEL_ERR

Error

CONFIG_HRM_SIMULATOR_LOG_LEVEL_INF

Info

CONFIG_HRM_SIMULATOR_LOG_LEVEL_OFF

Off

CONFIG_HRM_SIMULATOR_LOG_LEVEL_WRN

Warning

CONFIG_SENSORSIM_LOG_LEVEL

CONFIG_SENSORSIM_LOG_LEVEL_DBG

Debug

CONFIG_SENSORSIM_LOG_LEVEL_DEFAULT

Default

CONFIG_SENSORSIM_LOG_LEVEL_ERR

Error

CONFIG_SENSORSIM_LOG_LEVEL_INF

Info

CONFIG_SENSORSIM_LOG_LEVEL_OFF

Off

CONFIG_SENSORSIM_LOG_LEVEL_WRN

Warning