Skip to content

NimBLELog support logging without IDF logging, allow custom colors. #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

NimBLELog support logging without IDF logging, allow custom colors. #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 109 additions & 2 deletions Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,113 @@ config NIMBLE_CPP_LOG_LEVEL
default 3 if NIMBLE_CPP_LOG_LEVEL_INFO
default 4 if NIMBLE_CPP_LOG_LEVEL_DEBUG

config NIMBLE_LOG_OVERRIDE
bool "Enable log override, decoupled from general IDF logging."
default "n"
help
Enabling this option will allow NimBLE logging to be printed without
being tied to IDF log level.

menu "NIMBLE Log Override Colors"
depends on NIMBLE_LOG_OVERRIDE

choice NIMBLE_LOG_OVERRIDE_COLOR_ERR
prompt "NimBLE CPP log override color Error"
default NIMBLE_LOG_OVERRIDE_COLOR_ERR_NONE
help
Select NimBLE CPP log override error color.

config NIMBLE_LOG_OVERRIDE_COLOR_ERR_NONE
bool "None"
config NIMBLE_LOG_OVERRIDE_COLOR_ERR_BLACK
bool "Black"
config NIMBLE_LOG_OVERRIDE_COLOR_ERR_RED
bool "Red"
config NIMBLE_LOG_OVERRIDE_COLOR_ERR_GREEN
bool "Green"
config NIMBLE_LOG_OVERRIDE_COLOR_ERR_YELLOW
bool "Yellow"
config NIMBLE_LOG_OVERRIDE_COLOR_ERR_BLUE
bool "Blue"
config NIMBLE_LOG_OVERRIDE_COLOR_ERR_PURPLE
bool "Purple"
config NIMBLE_LOG_OVERRIDE_COLOR_ERR_CYAN
bool "Cyan"
endchoice #NIMBLE_LOG_OVERRIDE_COLOR_ERR

choice NIMBLE_LOG_OVERRIDE_COLOR_WARN
prompt "NimBLE CPP log override color Warning"
default NIMBLE_LOG_OVERRIDE_COLOR_WARN_NONE
help
Select NimBLE CPP log override warning color.

config NIMBLE_LOG_OVERRIDE_COLOR_WARN_NONE
bool "None"
config NIMBLE_LOG_OVERRIDE_COLOR_WARN_BLACK
bool "Black"
config NIMBLE_LOG_OVERRIDE_COLOR_WARN_RED
bool "Red"
config NIMBLE_LOG_OVERRIDE_COLOR_WARN_GREEN
bool "Green"
config NIMBLE_LOG_OVERRIDE_COLOR_WARN_YELLOW
bool "Yellow"
config NIMBLE_LOG_OVERRIDE_COLOR_WARN_BLUE
bool "Blue"
config NIMBLE_LOG_OVERRIDE_COLOR_WARN_PURPLE
bool "Purple"
config NIMBLE_LOG_OVERRIDE_COLOR_WARN_CYAN
bool "Cyan"
endchoice #NIMBLE_LOG_OVERRIDE_COLOR_WARN

choice NIMBLE_LOG_OVERRIDE_COLOR_INFO
prompt "NimBLE CPP log override color Info"
default NIMBLE_LOG_OVERRIDE_COLOR_INFO_NONE
help
Select NimBLE CPP log override info color.

config NIMBLE_LOG_OVERRIDE_COLOR_INFO_NONE
bool "None"
config NIMBLE_LOG_OVERRIDE_COLOR_INFO_BLACK
bool "Black"
config NIMBLE_LOG_OVERRIDE_COLOR_INFO_RED
bool "Red"
config NIMBLE_LOG_OVERRIDE_COLOR_INFO_GREEN
bool "Green"
config NIMBLE_LOG_OVERRIDE_COLOR_INFO_YELLOW
bool "Yellow"
config NIMBLE_LOG_OVERRIDE_COLOR_INFO_BLUE
bool "Blue"
config NIMBLE_LOG_OVERRIDE_COLOR_INFO_PURPLE
bool "Purple"
config NIMBLE_LOG_OVERRIDE_COLOR_INFO_CYAN
bool "Cyan"
endchoice #NIMBLE_LOG_OVERRIDE_COLOR_INFO

choice NIMBLE_LOG_OVERRIDE_COLOR_DEBUG
prompt "NimBLE CPP log override color Debug"
default NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_NONE
help
Select NimBLE CPP log override debug color.

config NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_NONE
bool "None"
config NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_BLACK
bool "Black"
config NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_RED
bool "Red"
config NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_GREEN
bool "Green"
config NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_YELLOW
bool "Yellow"
config NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_BLUE
bool "Blue"
config NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_PURPLE
bool "Purple"
config NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_CYAN
bool "Cyan"
endchoice #NIMBLE_LOG_OVERRIDE_COLOR_DEBUG
endmenu

config NIMBLE_CPP_ENABLE_RETURN_CODE_TEXT
bool "Show NimBLE return codes as text in debug log."
default "n"
Expand Down Expand Up @@ -77,12 +184,12 @@ config NIMBLE_CPP_DEBUG_ASSERT_ENABLED
This will use approximately 1kB of flash memory.

config NIMBLE_CPP_FREERTOS_TASK_BLOCK_BIT
int "FreeRTOS task block bit"
int "FreeRTOS task block bit."
default 31
help
Configure the bit to set in the task notification value when a task is blocked waiting for an event.
This should be set to a bit that is not used by other notifications in the system.

#
# BT config
#
Expand Down
226 changes: 169 additions & 57 deletions src/NimBLELog.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,70 +10,182 @@

#include "nimconfig.h"

#if defined(CONFIG_BT_ENABLED)

#if defined(CONFIG_NIMBLE_CPP_IDF) // using esp-idf
# include "esp_log.h"
# include "console/console.h"
# ifndef CONFIG_NIMBLE_CPP_LOG_LEVEL
# if defined(CONFIG_BT_ENABLED)
# if defined(CONFIG_NIMBLE_CPP_IDF) // using esp-idf
# include "esp_log.h"
# include "console/console.h"
# ifndef CONFIG_NIMBLE_CPP_LOG_LEVEL
# define CONFIG_NIMBLE_CPP_LOG_LEVEL 0
# endif

# define NIMBLE_CPP_LOG_PRINT(level, tag, format, ...) do { \
if (CONFIG_NIMBLE_CPP_LOG_LEVEL >= level) \
ESP_LOG_LEVEL_LOCAL(level, tag, format, ##__VA_ARGS__); \
} while(0)

# define NIMBLE_LOGD(tag, format, ...) \
NIMBLE_CPP_LOG_PRINT(ESP_LOG_DEBUG, tag, format, ##__VA_ARGS__)

# define NIMBLE_LOGI(tag, format, ...) \
NIMBLE_CPP_LOG_PRINT(ESP_LOG_INFO, tag, format, ##__VA_ARGS__)

# define NIMBLE_LOGW(tag, format, ...) \
NIMBLE_CPP_LOG_PRINT(ESP_LOG_WARN, tag, format, ##__VA_ARGS__)

# define NIMBLE_LOGE(tag, format, ...) \
NIMBLE_CPP_LOG_PRINT(ESP_LOG_ERROR, tag, format, ##__VA_ARGS__)

#else // using Arduino
# include "nimble/porting/nimble/include/syscfg/syscfg.h"
# include "nimble/console/console.h"
# ifndef CONFIG_NIMBLE_CPP_LOG_LEVEL
# if defined(ARDUINO_ARCH_ESP32) && defined(CORE_DEBUG_LEVEL)
# define CONFIG_NIMBLE_CPP_LOG_LEVEL CORE_DEBUG_LEVEL
# endif

# if defined(CONFIG_NIMBLE_LOG_OVERRIDE)

# define NIMBLE_GET_LOG_COLOR(letter)

# if CONFIG_LOG_COLORS
# if defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_ERR_BLACK)
# define NIMBLE_LOG_COLOR_E LOG_COLOR(LOG_COLOR_BLACK)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_ERR_RED)
# define NIMBLE_LOG_COLOR_E LOG_COLOR(LOG_COLOR_RED)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_ERR_GREEN)
# define NIMBLE_LOG_COLOR_E LOG_COLOR(LOG_COLOR_GREEN)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_ERR_YELLOW)
# define NIMBLE_LOG_COLOR_E LOG_COLOR(LOG_COLOR_BROWN)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_ERR_BLUE)
# define NIMBLE_LOG_COLOR_E LOG_COLOR(LOG_COLOR_BLUE)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_ERR_PURPLE)
# define NIMBLE_LOG_COLOR_E LOG_COLOR(LOG_COLOR_PURPLE)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_ERR_CYAN)
# define NIMBLE_LOG_COLOR_E LOG_COLOR(LOG_COLOR_CYAN)
# else
# define NIMBLE_LOG_COLOR_E
# endif

# if defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_WARN_BLACK)
# define NIMBLE_LOG_COLOR_W LOG_COLOR(LOG_COLOR_BLACK)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_WARN_RED)
# define NIMBLE_LOG_COLOR_W LOG_COLOR(LOG_COLOR_RED)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_WARN_GREEN)
# define NIMBLE_LOG_COLOR_W LOG_COLOR(LOG_COLOR_GREEN)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_WARN_YELLOW)
# define NIMBLE_LOG_COLOR_W LOG_COLOR(LOG_COLOR_BROWN)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_WARN_BLUE)
# define NIMBLE_LOG_COLOR_W LOG_COLOR(LOG_COLOR_BLUE)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_WARN_PURPLE)
# define NIMBLE_LOG_COLOR_W LOG_COLOR(LOG_COLOR_PURPLE)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_WARN_CYAN)
# define NIMBLE_LOG_COLOR_W LOG_COLOR(LOG_COLOR_CYAN)
# else
# define NIMBLE_LOG_COLOR_W
# endif

# if defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_INFO_BLACK)
# define NIMBLE_LOG_COLOR_I LOG_COLOR(LOG_COLOR_BLACK)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_INFO_RED)
# define NIMBLE_LOG_COLOR_I LOG_COLOR(LOG_COLOR_RED)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_INFO_GREEN)
# define NIMBLE_LOG_COLOR_I LOG_COLOR(LOG_COLOR_GREEN)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_INFO_YELLOW)
# define NIMBLE_LOG_COLOR_I LOG_COLOR(LOG_COLOR_BROWN)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_INFO_BLUE)
# define NIMBLE_LOG_COLOR_I LOG_COLOR(LOG_COLOR_BLUE)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_INFO_PURPLE)
# define NIMBLE_LOG_COLOR_I LOG_COLOR(LOG_COLOR_PURPLE)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_INFO_CYAN)
# define NIMBLE_LOG_COLOR_I LOG_COLOR(LOG_COLOR_CYAN)
# else
# define NIMBLE_LOG_COLOR_I
# endif

# if defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_BLACK)
# define NIMBLE_LOG_COLOR_D LOG_COLOR(LOG_COLOR_BLACK)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_RED)
# define NIMBLE_LOG_COLOR_D LOG_COLOR(LOG_COLOR_RED)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_GREEN)
# define NIMBLE_LOG_COLOR_D LOG_COLOR(LOG_COLOR_GREEN)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_YELLOW)
# define NIMBLE_LOG_COLOR_D LOG_COLOR(LOG_COLOR_BROWN)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_BLUE)
# define NIMBLE_LOG_COLOR_D LOG_COLOR(LOG_COLOR_BLUE)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_PURPLE)
# define NIMBLE_LOG_COLOR_D LOG_COLOR(LOG_COLOR_PURPLE)
# elif defined(CONFIG_NIMBLE_LOG_OVERRIDE_COLOR_DEBUG_CYAN)
# define NIMBLE_LOG_COLOR_D LOG_COLOR(LOG_COLOR_CYAN)
# else
# define NIMBLE_LOG_COLOR_D
# endif
# else //CONFIG_LOG_COLORS
# define NIMBLE_LOG_COLOR_E
# define NIMBLE_LOG_COLOR_W
# define NIMBLE_LOG_COLOR_I
# define NIMBLE_LOG_COLOR_D
# endif //CONFIG_LOG_COLORS

# define NIMBLE_LOG_FORMAT(letter, tag, fmt) \
NIMBLE_LOG_COLOR_##letter #letter " (%lu) %s: " fmt LOG_RESET_COLOR "\r\n", esp_log_timestamp(), tag

# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 4
# define NIMBLE_LOGD( tag, format, ... ) console_printf(NIMBLE_LOG_FORMAT(D, tag, format), ##__VA_ARGS__)
# else
# define CONFIG_NIMBLE_CPP_LOG_LEVEL 0
# define NIMBLE_LOGD( tag, format, ... )
# endif
# endif

# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 4
# define NIMBLE_LOGD( tag, format, ... ) console_printf("D %s: " format "\n", tag, ##__VA_ARGS__)
# else
# define NIMBLE_LOGD( tag, format, ... ) (void)tag
# endif

# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 3
# define NIMBLE_LOGI( tag, format, ... ) console_printf("I %s: " format "\n", tag, ##__VA_ARGS__)
# else
# define NIMBLE_LOGI( tag, format, ... ) (void)tag
# endif
# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 3
# define NIMBLE_LOGI( tag, format, ... ) console_printf(NIMBLE_LOG_FORMAT(I, tag, format), ##__VA_ARGS__)
# else
# define NIMBLE_LOGI( tag, format, ... )
# endif

# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 2
# define NIMBLE_LOGW( tag, format, ... ) console_printf("W %s: " format "\n", tag, ##__VA_ARGS__)
# else
# define NIMBLE_LOGW( tag, format, ... ) (void)tag
# endif
# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 2
# define NIMBLE_LOGW( tag, format, ... ) console_printf(NIMBLE_LOG_FORMAT(W, tag, format), ##__VA_ARGS__)
# else
# define NIMBLE_LOGW( tag, format, ... )
# endif

# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 1
# define NIMBLE_LOGE( tag, format, ... ) console_printf("E %s: " format "\n", tag, ##__VA_ARGS__)
# else
# define NIMBLE_LOGE( tag, format, ... ) (void)tag
# endif
# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 1
# define NIMBLE_LOGE( tag, format, ... ) console_printf(NIMBLE_LOG_FORMAT(E, tag, format), ##__VA_ARGS__)
# else
# define NIMBLE_LOGE( tag, format, ... )
# endif

#endif /* CONFIG_NIMBLE_CPP_IDF */

#define NIMBLE_LOGC( tag, format, ... ) console_printf("CRIT %s: " format "\n", tag, ##__VA_ARGS__)
# else
# define NIMBLE_CPP_LOG_PRINT(level, tag, format, ...) do { \
if (CONFIG_NIMBLE_CPP_LOG_LEVEL >= level) \
ESP_LOG_LEVEL_LOCAL(level, tag, format, ##__VA_ARGS__); \
} while(0)

#endif /* CONFIG_BT_ENABLED */
# define NIMBLE_LOGD(tag, format, ...) \
NIMBLE_CPP_LOG_PRINT(ESP_LOG_DEBUG, tag, format, ##__VA_ARGS__)

# define NIMBLE_LOGI(tag, format, ...) \
NIMBLE_CPP_LOG_PRINT(ESP_LOG_INFO, tag, format, ##__VA_ARGS__)

# define NIMBLE_LOGW(tag, format, ...) \
NIMBLE_CPP_LOG_PRINT(ESP_LOG_WARN, tag, format, ##__VA_ARGS__)

# define NIMBLE_LOGE(tag, format, ...) \
NIMBLE_CPP_LOG_PRINT(ESP_LOG_ERROR, tag, format, ##__VA_ARGS__)
# endif

# else // using Arduino
# include "nimble/porting/nimble/include/syscfg/syscfg.h"
# include "nimble/console/console.h"
# ifndef CONFIG_NIMBLE_CPP_LOG_LEVEL
# if defined(ARDUINO_ARCH_ESP32) && defined(CORE_DEBUG_LEVEL)
# define CONFIG_NIMBLE_CPP_LOG_LEVEL CORE_DEBUG_LEVEL
# else
# define CONFIG_NIMBLE_CPP_LOG_LEVEL 0
# endif
# endif

# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 4
# define NIMBLE_LOGD( tag, format, ... ) console_printf("D %s: " format "\n", tag, ##__VA_ARGS__)
# else
# define NIMBLE_LOGD( tag, format, ... ) (void)tag
# endif

# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 3
# define NIMBLE_LOGI( tag, format, ... ) console_printf("I %s: " format "\n", tag, ##__VA_ARGS__)
# else
# define NIMBLE_LOGI( tag, format, ... ) (void)tag
# endif

# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 2
# define NIMBLE_LOGW( tag, format, ... ) console_printf("W %s: " format "\n", tag, ##__VA_ARGS__)
# else
# define NIMBLE_LOGW( tag, format, ... ) (void)tag
# endif

# if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 1
# define NIMBLE_LOGE( tag, format, ... ) console_printf("E %s: " format "\n", tag, ##__VA_ARGS__)
# else
# define NIMBLE_LOGE( tag, format, ... ) (void)tag
# endif

# endif /* CONFIG_NIMBLE_CPP_IDF */

# define NIMBLE_LOGC( tag, format, ... ) console_printf("CRIT %s: " format "\n", tag, ##__VA_ARGS__)

# endif /* CONFIG_BT_ENABLED */
#endif /* MAIN_NIMBLELOG_H_ */
Loading