Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
debug.h File Reference
All debug related features to be used with the High Level API are defined here. More...
Go to the source code of this file.
Functions | |
| sensor_error | loggingOpen () |
| Initialize debug sequence. | |
| sensor_error | loggingClose () |
| Initialize debug sequence. | |
| sensor_error | loggingStart (uint8_t DebugLevel) |
| Start logging all activities. | |
| sensor_error | loggingStop () |
| Stop logging all activities. | |
| sensor_error | logDebugMessageStart (const char *pFunctionName) |
| Write start section to log debug message. | |
| sensor_error | logDebugMessageEnd () |
| Write end section to log debug message. | |
| sensor_error | logErrorMessageStart (const char *pFunctionName) |
| Write start section to log error message. | |
| sensor_error | logErrorMessageEnd () |
| Write end section to log error message. | |
| sensor_error | loggingFunctionStart (const char *pFunctionName, void **pFuncArguments) |
| log start of an API function | |
| sensor_error | loggingFunctionEnd (const char *pFunctionName, sensor_error ReturnedValue, void **pFuncArguments) |
| log end of an API function | |
| sensor_error | loggingOutput (char *pBuffer) |
| Write messge bugger to actual output. | |
| sensor_error | loggingOfflineOutput () |
| Write messge bugger from offline buffer to actual output. | |
Detailed Description
All debug related features to be used with the High Level API are defined here.
Definition in file debug.h.
Function Documentation
| sensor_error logDebugMessageEnd | ( | ) |
| sensor_error logDebugMessageStart | ( | const char * | pFunctionName ) |
| sensor_error logErrorMessageEnd | ( | ) |
| sensor_error logErrorMessageStart | ( | const char * | pFunctionName ) |
| sensor_error loggingClose | ( | ) |
Initialize debug sequence.
This function shall be called once logging functionalities are no more required. This function will free the memory allocated during the call to logingOpen function
- Return values:
-
SENSOR_ERROR_NONE : Success Other Error Code : Failure
| sensor_error loggingFunctionEnd | ( | const char * | pFunctionName, |
| sensor_error | ReturnedValue, | ||
| void ** | pFuncArguments | ||
| ) |
| sensor_error loggingFunctionStart | ( | const char * | pFunctionName, |
| void ** | pFuncArguments | ||
| ) |
| sensor_error loggingOfflineOutput | ( | void | ) |
| sensor_error loggingOpen | ( | ) |
Initialize debug sequence.
This function should be called at the beginning of the debugging session. It initializes everything that is necessary. This function allocates a big size buffer in order to store all logged data.
- Return values:
-
SENSOR_ERROR_NONE : Success Other Error Code : Failure
| sensor_error loggingOutput | ( | char * | pBuffer ) |
| sensor_error loggingStart | ( | uint8_t | DebugLevel ) |
Start logging all activities.
All device activity will be logged once this function is called. This function shall be called after loggingOpen().
- Parameters:
-
[in] DebugLevel
- Return values:
-
SENSOR_ERROR_NONE : Success Other Error Code : Failure
| sensor_error loggingStop | ( | ) |
Stop logging all activities.
All device activity will stop to be logged once this function is called. This function shall be called after loggingStart().
- Return values:
-
SENSOR_ERROR_NONE : Success Other Error Code : Failure
Generated on Tue Jul 12 2022 22:19:50 by
1.7.2