log.rst 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. include:: ../../../components/log/README.rst
  2. Application Example
  3. -------------------
  4. Log library is commonly used by most of esp-idf components and examples. For demonstration of log functionality check :idf:`examples` folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that among others, contains the following examples:
  5. * :example:`system/ota`
  6. * :example:`storage/sd_card`
  7. * :example:`protocols/https_request`
  8. API Reference
  9. -------------
  10. Header Files
  11. ^^^^^^^^^^^^
  12. * :component_file:`log/include/esp_log.h`
  13. Macros
  14. ^^^^^^
  15. .. doxygendefine:: LOG_COLOR_E
  16. .. doxygendefine:: LOG_COLOR_W
  17. .. doxygendefine:: LOG_COLOR_I
  18. .. doxygendefine:: LOG_COLOR_D
  19. .. doxygendefine:: LOG_COLOR_V
  20. .. doxygendefine:: LOG_RESET_COLOR
  21. .. doxygendefine:: LOG_FORMAT
  22. .. doxygendefine:: LOG_LOCAL_LEVEL
  23. .. doxygendefine:: ESP_EARLY_LOGE
  24. .. doxygendefine:: ESP_EARLY_LOGW
  25. .. doxygendefine:: ESP_EARLY_LOGI
  26. .. doxygendefine:: ESP_EARLY_LOGD
  27. .. doxygendefine:: ESP_EARLY_LOGV
  28. .. doxygendefine:: ESP_LOGE
  29. .. doxygendefine:: ESP_LOGW
  30. .. doxygendefine:: ESP_LOGI
  31. .. doxygendefine:: ESP_LOGD
  32. .. doxygendefine:: ESP_LOGV
  33. Type Definitions
  34. ^^^^^^^^^^^^^^^^
  35. .. doxygentypedef:: vprintf_like_t
  36. Enumerations
  37. ^^^^^^^^^^^^
  38. .. doxygenenum:: esp_log_level_t
  39. Functions
  40. ^^^^^^^^^
  41. .. doxygenfunction:: esp_log_level_set
  42. .. doxygenfunction:: esp_log_set_vprintf
  43. .. doxygenfunction:: esp_log_timestamp
  44. .. doxygenfunction:: esp_log_write