From 0d636a3285c0ae7ca3d2661eddbd3875421ec256 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kuba=20Szczodrzy=C5=84ski?= Date: Sat, 25 Jun 2022 10:19:43 +0200 Subject: [PATCH] [docs] Clarify family configuration variables --- docs/config.md | 55 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 22 deletions(-) diff --git a/docs/config.md b/docs/config.md index 53b4bb1..8218640 100644 --- a/docs/config.md +++ b/docs/config.md @@ -26,19 +26,20 @@ build_flags = ### Logging -- LT_LOGGER - enable/disable LibreTuya logger globally. Enabled by default. -- LT_LOGLEVEL - global LT loglevel: - - LT_LEVEL_TRACE (same as LT_LEVEL_VERBOSE) - - LT_LEVEL_DEBUG - - LT_LEVEL_INFO - default - - LT_LEVEL_WARN - - LT_LEVEL_ERROR - - LT_LEVEL_FATAL -- LT_LOGGER_TIMESTAMP - print program runtime in printk-like format -- LT_LOGGER_FILE - print calling source filename -- LT_LOGGER_TASK - print calling FreeRTOS task (if available) -- LT_LOGGER_COLOR - output ANSI terminal colors -- LT_PRINTF_BROKEN - whether printf outputs "0." for floats with value 0 +- `LT_LOGGER` - enable/disable LibreTuya logger globally. Enabled by default. +- `LT_LOGLEVEL` - global LT loglevel: + - `LT_LEVEL_TRACE` (same as LT_LEVEL_VERBOSE) + - `LT_LEVEL_DEBUG` + - `LT_LEVEL_INFO` - default + - `LT_LEVEL_WARN` + - `LT_LEVEL_ERROR` + - `LT_LEVEL_FATAL` +- `LT_LOGGER_TIMESTAMP` - print program runtime in printk-like format +- `LT_LOGGER_CALLER` - print calling method name +- `LT_LOGGER_TASK` - print calling FreeRTOS task (if available) +- `LT_LOGGER_COLOR` - output ANSI terminal colors +- `LT_PRINTF_BROKEN` - whether printf outputs "0." for floats with value 0 +- `LT_LOG_HEAP` - print free heap size using `LT_HEAP_I()` ### Debug logging @@ -46,15 +47,25 @@ The following options enable library-specific debugging messages. They are only Families should generally call i.e. WiFiClient debugging for client-related code, even if the `WiFiClient.cpp` file is physically absent. -- LT_DEBUG_WIFI - `WiFi.cpp` -- LT_DEBUG_WIFI_CLIENT - `WiFiClient.cpp` -- LT_DEBUG_WIFI_SERVER - `WiFiServer.cpp` -- LT_DEBUG_WIFI_STA - `WiFiSTA.cpp` -- LT_DEBUG_WIFI_AP - `WiFiAP.cpp` +- `LT_DEBUG_WIFI` - `WiFi.cpp` +- `LT_DEBUG_WIFI_CLIENT` - `WiFiClient.cpp` +- `LT_DEBUG_WIFI_SERVER` - `WiFiServer.cpp` +- `LT_DEBUG_WIFI_STA` - `WiFiSTA.cpp` +- `LT_DEBUG_WIFI_AP` - `WiFiAP.cpp` +- `LT_DEBUG_SSL` - `WiFiClientSecure` ### Family options -- LT_HAS_LWIP - whether family SDK has LwIP. This causes `LwIPRxBuffer.cpp` to be compiled for family libraries to use. -- LT_HAS_LWIP2 - whether family has LwIP v2.0.0 or newer. This causes `LwIPmDNS.cpp` to be compiled. -- LT_HAS_FREERTOS - whether family supports FreeRTOS -- LT_HAS_MBEDTLS - whether family has mbedTLS +These options are selectively set by all families, as part of the build process. They are used for enabling LT core API parts, if the family has support for it. + +The `LT_ARD_*` options are only used with Arduino frameworks. + +The meaning of most flags is as follows: + +- `LT_HAS_LWIP` - LwIP in SDK (any version) +- `LT_HAS_LWIP2` - LwIP v2.0.0 or newer +- `LT_HAS_FREERTOS` - FreeRTOS supported and used +- `LT_HAS_MBEDTLS` - mbedTLS in SDK +- `LT_ARD_HAS_MD5` - MD5 library implemented, `MD5Impl.h` available +- `LT_ARD_HAS_WIFI` - WiFi library implemented, `WiFiData.h` available +- `LT_HEAP_FUNC` - function name used to get available heap size (for `LT_HEAP_I()`)