Revision as of 18:20, 19 February 2024 by Registered User
This message will disappear after all relevant tasks have been resolved.
Semantic MediaWiki
There are 1 incomplete or
pending task to finish installation of
Semantic MediaWiki. An administrator or user with sufficient rights can complete it. This should be done before adding new data to avoid inconsistencies.
|
Coming soon
|
Information
|
This page is not yet finished but will be soon.
|
1. Introduction
The log module is a module that provides a logging mechanism for embedded systems. It allows developers to print logs with different verbose levels and regions, making it easier to debug and troubleshoot issues in your project.
The module is highly customizable and can be configured to meet the specific user needs.
2. Concepts
The Log module relies on different main concepts:
- Log module configuration
- Configuration of the future logs regarding verbose levels, regions and colors.
- Verbose levels are used to categorize logs based on their importance, while regions are used to separate logs into different places. The module also defines color codes that can be used to highlight logs from different regions.
- Timestamp registration
- Allows the user to provide a function to add a timestamp for the logs output.
- Printing functions
- Log printings functions with some toping macros dedicated to specific logging regions.
2.1. Timestamp management
TBD.
2.2. Verbose level and region management
TBD.
2.3. Printing functions
TBD.
3. Interface
3.1. Functions
Log_Module_Init
|
- Description
- Initializes the log module with the given configuration.
- Syntax
- void Log_Module_Init(Log_Module_t log_configuration);
- Parameters
-
- [in] log_configuration
- Type: Log_Module_t
- Description: The configuration of the log module.
- Return Value
-
- None
|
Log_Module_DeInit
|
- Description
- Deinitializes the log module.
- Syntax
- void Log_Module_DeInit(void);
- Parameters
-
- None
- Return Value
-
- None
|
Log_Module_Set_Verbose_Level
|
- Description
- Sets the verbose level of the log.
- Syntax
- void Log_Module_Set_Verbose_Level(Log_Verbose_Level_t new_verbose_level);
- Parameters
-
- [in] new_verbose_level
- Type: Log_Verbose_Level_t
- Description: The new verbose level to be set.
- Return Value
-
- None
|
Log_Module_Set_Region
|
- Description
- Replaces the current region mask to use and sets only the given region.
- Syntax
- void Log_Module_Set_Region(Log_Region_t new_region);
- Parameters
-
- [in] new_region
- Type: Log_Region_t
- Description: The new region to use.
- Return Value
-
- None
|
Log_Module_Add_Region
|
- Description
- Adds the given region to the current region mask.
- Syntax
- void Log_Module_Add_Region(Log_Region_t new_region);
- Parameters
-
- [in] new_region
- Type: Log_Region_t
- Description: The new region to use, alongside the others.
- Return Value
-
- None
|
Log_Module_Enable_All_Regions
|
- Description
- Enables all the regions.
- Syntax
- void Log_Module_Enable_All_Regions(void);
- Parameters
-
- None
- Return Value
-
- None
|
Log_Module_Set_Color
|
- Description
- Sets/Replaces the color for a region.
- Syntax
- void Log_Module_Set_Color(Log_Region_t eRegion, Log_Color_t eNewColor);
- Parameters
-
- [in] eRegion
- Type: Log_Region_t
- Description: The region where to apply the color.
- [in] eNewColor
- Type: Log_Color_t
- Description: The color to apply to the selected region.
- Return Value
-
- None
|
Log_Module_RegisterTimeStampFunction
|
- Description
- Registers a callback function to insert the 'TimeStamp' to the log.
- Syntax
- void Log_Module_RegisterTimeStampFunction(CallBack_TimeStamp * pCallbackFunc);
- Parameters
-
- [in] pCallbackFunc
- Type: CallBack_TimeStamp *
- Description: Callback function to insert Time Stamp.
- Return Value
-
- None
|
Log_Module_Print
|
- Description
- Prints a log with the given verbose level and region.
- Syntax
- void Log_Module_Print(Log_Verbose_Level_t eVerboseLevel, Log_Region_t eRegion, const char * pText, ...);
- Parameters
-
- [in] eVerboseLevel
- Type: Log_Verbose_Level_t
- Description: The level of verbose for this log.
- [in] eRegion
- Type: Log_Region_t
- Description: The region where the log is issued.
- [in] pText
- Type: const char *
- Description: Pointer to the text to be printed.
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
Log_Module_PrintWithArg
|
- Description
- Prints a log with already an arg list.
- Syntax
- void Log_Module_PrintWithArg(Log_Verbose_Level_t eVerboseLevel, Log_Region_t eRegion, const char * pText, va_list args);
- Parameters
-
- [in] eVerboseLevel
- Type: Log_Verbose_Level_t
- Description: The level of verbose for this log.
- [in] eRegion
- Type: Log_Region_t
- Description: The region where the log is issued.
- [in] pText
- Type: const char *
- Description: Pointer to the text to be printed.
- [in] args
- Type: va_list
- Description: Arguments list.
- Return Value
-
- None
|
3.2. Macros
LOG_INFO_BLE
|
- Description
- Macro to print an info log for the BLE region.
- Syntax
- LOG_INFO_BLE(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_ERROR_BLE
|
- Description
- Macro to print an error log for the BLE region.
- Syntax
- LOG_ERROR_BLE(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_WARNING_BLE
|
- Description
- Macro to print a warning log for the BLE region.
- Syntax
- LOG_WARNING_BLE(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_DEBUG_BLE
|
- Description
- Macro to print a debug log for the BLE region.
- Syntax
- LOG_DEBUG_BLE(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_INFO_SYSTEM
|
- Description
- Macro to print an info log for the System region.
- Syntax
- LOG_INFO_SYSTEM(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_ERROR_SYSTEM
|
- Description
- Macro to print an error log for the System region.
- Syntax
- LOG_ERROR_SYSTEM(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_WARNING_SYSTEM
|
- Description
- Macro to print a warning log for the System region.
- Syntax
- LOG_WARNING_SYSTEM(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_DEBUG_SYSTEM
|
- Description
- Macro to print a debug log for the System region.
- Syntax
- LOG_DEBUG_SYSTEM(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_INFO_APP
|
- Description
- Macro to print an info log for the App region.
- Syntax
- LOG_INFO_APP(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_ERROR_APP
|
- Description
- Macro to print an error log for the App region.
- Syntax
- LOG_ERROR_APP(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_WARNING_APP
|
- Description
- Macro to print a warning log for the App region.
- Syntax
- LOG_WARNING_APP(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
LOG_DEBUG_APP
|
- Description
- Macro to print a debug log for the App region.
- Syntax
- LOG_DEBUG_APP(...);
- Parameters
-
- [in] ...
- Type: ...
- Description: Any other parameters to be printed with the text.
- Return Value
-
- None
|
4. How to
TBD.