scratch/libretiny
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] Clarify family configuration variables

Browse Source
This commit is contained in:
Kuba Szczodrzyński
2022-06-25 10:19:43 +02:00
parent 79ccd47f71
commit 0d636a3285
1 changed files with 33 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
docs/config.md
View File

@@ -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()`)