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 |
|---|---|
Enable ANT ultra low power wireless protocol by Garmin Canada Inc. |
|
Support for ANT+ BPWR constants and pages |
|
Enable ANT+ Bicycle Power Simulator |
|
Support for ANT+ Bike Speed and Cadence constants and pages |
|
Enable ANT+ Bike Speed and Cadence Simulator |
|
ANT burst queue size. |
|
Helper functions for ANT channel configuration |
|
Support for ANT+ common constants and pages |
|
Allocated ANT encrypted channels. |
|
Negotiation for encrypted ANT slave (rx) channels |
|
Number of encrypted channels to configure. Must be <= CONFIG_ANT_ENCRYPTED_CHANNELS |
|
Helper functions for ANT encrypt configuration |
|
Use ANT Evaluation License Key. |
|
Event queue size. |
|
High priority search timeout |
|
Support for ANT+ HRM constants and pages |
|
Enable ANT+ HRM Simulator |
|
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. |
|
ANT Internal |
|
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. |
|
This configuration is required for all single core builds and for network core builds on dual-core systems. |
|
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 |
|
Low priority search timeout |
|
Serialize API calls for execution on remote CPU. |
|
ANT Host (application core) configuration for multicore applications. |
|
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. |
|
ANT Remote (network core) configuration for multicore applications. |
|
ANT over RPC |
|
ant_rpc sample as a child image (network core). |
|
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. |
|
Helper functions for ANT search configuration |
|
Controls LEDs based on ANT connection states |
|
SWI1 |
|
SWI2 |
|
SWI3 |
|
SWI4 |
|
SWI5 |
|
Allocated ANT channels. |
|
Size of the work handler thread stack, used to process work in ANT priority context. |
|
Allows for manual incrementing of a sensor value or generates a triangular waveform. |
Logging configuration options
Symbol name |
Help/prompt |
|---|---|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |
|
Debug |
|
Default |
|
Error |
|
Info |
|
Off |
|
Warning |