nimconfig.h File Reference

Go to the source code of this file.

Macros
#define	CONFIG_BT_NIMBLE_MAX_CONNECTIONS   3
	Un-comment to change the number of simultaneous connections (esp controller max is 9)
#define	CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED   0
	Un-comment to enable storing the timestamp when an attribute value is updated This allows for checking the last update time using getTimeStamp() or getValue(time_t*) If disabled, the timestamp returned from these functions will be 0. Disabling timestamps will reduce the memory used for each value. 1 = Enabled, 0 = Disabled; Default = Disabled.
#define	CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH   20
	Uncomment to set the default allocation size (bytes) for each attribute if not specified when the constructor is called. This is also the size used when a remote characteristic or descriptor is constructed before a value is read/notifed. Increasing this will reduce reallocations but increase memory footprint. Default value is 20. Range: 1 : 512 (BLE_ATT_ATTR_MAX_LEN)
#define	CONFIG_BT_NIMBLE_ATT_PREFERRED_MTU   255
	Un-comment to change the default MTU size.
#define	CONFIG_BT_NIMBLE_SVC_GAP_DEVICE_NAME   "nimble"
	Un-comment to change default device name.
#define	CONFIG_BT_NIMBLE_LOG_LEVEL   5
	Un-comment to set the debug log messages level from the NimBLE host stack. Values: 0 = DEBUG, 1 = INFO, 2 = WARNING, 3 = ERROR, 4 = CRITICAL, 5+ = NONE Uses approx. 32kB of flash memory.
#define	CONFIG_NIMBLE_CPP_LOG_LEVEL   0
	Un-comment to set the debug log messages level from the NimBLE CPP Wrapper. Values: 0 = NONE, 1 = ERROR, 2 = WARNING, 3 = INFO, 4+ = DEBUG Uses approx. 32kB of flash memory.
#define	CONFIG_NIMBLE_CPP_ENABLE_RETURN_CODE_TEXT
	Un-comment to see NimBLE host return codes as text debug log messages. Uses approx. 7kB of flash memory.
#define	CONFIG_NIMBLE_CPP_ENABLE_GAP_EVENT_CODE_TEXT
	Un-comment to see GAP event codes as text in debug log messages. Uses approx. 1kB of flash memory.
#define	CONFIG_NIMBLE_CPP_ENABLE_ADVERTISMENT_TYPE_TEXT
	Un-comment to see advertisment types as text while scanning in debug log messages. Uses approx. 250 bytes of flash memory.
#define	CONFIG_BT_NIMBLE_SVC_GAP_APPEARANCE   0x0
	Un-comment to change the default GAP appearance.
#define	CONFIG_BT_NIMBLE_ROLE_CENTRAL_DISABLED
	Un-comment if not using NimBLE Client functions Reduces flash size by approx. 7kB.
#define	CONFIG_BT_NIMBLE_ROLE_OBSERVER_DISABLED
	Un-comment if not using NimBLE Scan functions Reduces flash size by approx. 26kB.
#define	CONFIG_BT_NIMBLE_ROLE_PERIPHERAL_DISABLED
	Un-comment if not using NimBLE Server functions Reduces flash size by approx. 16kB.
#define	CONFIG_BT_NIMBLE_ROLE_BROADCASTER_DISABLED
	Un-comment if not using NimBLE Advertising functions Reduces flash size by approx. 5kB.
#define	CONFIG_BT_NIMBLE_MAX_BONDS   3
	Un-comment to change the number of devices allowed to store/bond with.
#define	CONFIG_BT_NIMBLE_MAX_CCCDS   8
	Un-comment to change the maximum number of CCCD subscriptions to store.
#define	CONFIG_BT_NIMBLE_RPA_TIMEOUT   900
	Un-comment to change the random address refresh time (in seconds)
#define	CONFIG_BT_NIMBLE_MSYS1_BLOCK_COUNT   12
	Un-comment to change the number of MSYS buffers available.
#define	CONFIG_BT_NIMBLE_MEM_ALLOC_MODE_EXTERNAL   1
	Un-comment to use external PSRAM for the NimBLE host.
#define	CONFIG_BT_NIMBLE_PINNED_TO_CORE   0
	Un-comment to change the core NimBLE host runs on.
#define	CONFIG_BT_NIMBLE_TASK_STACK_SIZE   4096
	Un-comment to change the stack size for the NimBLE host task.

Detailed Description

IGNORE THIS FILE IF USING ESP-IDF, USE MENUCONFIG TO SET NIMBLE OPTIONS.

The config options here are for doxygen documentation only.

Macro Definition Documentation

CONFIG_BT_NIMBLE_MSYS1_BLOCK_COUNT

#define CONFIG_BT_NIMBLE_MSYS1_BLOCK_COUNT   12

Un-comment to change the number of MSYS buffers available.

MSYS is a system level mbuf registry. For prepare write & prepare
responses MBUFs are allocated out of msys_1 pool. This may need to be increased if
you are sending large blocks of data with a low MTU. E.g: 512 bytes with 23 MTU will fail.