Okundu Omeni / Mbed OS wifi-https-ble-sm-uart-atcmd-5-13-1

Dependencies:   mbed-http

Embed: (wiki syntax)

« Back to documentation index

debug.h File Reference

debug.h File Reference

Header file containing API for debug.c. More...

Go to the source code of this file.

Enumerations

enum  data_mode_e
 

Enumeration of the different data modes allowed.

More...
enum  debug_log_level_e
 

Enumeration of the different debug log levels allowed.

More...

Functions

void initialise_debug (uint8_t debug_level)
 Starting function to supervise the

  • Initialisation of UART2 responsible for acting as the debug port for the firmware
  • Initialisation of the UART2 transmit and receive buffers
  • Initial read from UART2.

void set_debug_level (uint8_t debug_level)
 Function to set the debug level.
uint8_t get_debug_level (void)
 Function to get the current debug level set.
const char * get_dbg_tx_terminate_string (void)
uint8_t get_dbg_tx_terminate_string_len (void)
const char * get_fw_ver_string (void)
 Function to get the firmware version.

Detailed Description

Header file containing API for debug.c.

Author:
TTP (c) 2017 TTP (The Technology Partnership) plc

Definition in file debug.h.


Enumeration Type Documentation

Enumeration of the different data modes allowed.

Definition at line 42 of file debug.h.

Enumeration of the different debug log levels allowed.

Definition at line 54 of file debug.h.


Function Documentation

const char* get_dbg_tx_terminate_string ( void   )
Parameters:
@param
Return values:

Definition at line 119 of file debug2.cpp.

uint8_t get_dbg_tx_terminate_string_len ( void   )
Parameters:
@param
Return values:

Definition at line 137 of file debug2.cpp.

uint8_t get_debug_level ( void   )

Function to get the current debug level set.

Parameters:
None
Return values:
(uint8_t)current_debug_level

Definition at line 246 of file debug2.cpp.

const char* get_fw_ver_string ( void   )

Function to get the firmware version.

Parameters:
None
Return values:
(constchar *) fw_ver_string

Definition at line 291 of file debug2.cpp.

void initialise_debug ( uint8_t  debug_level = NONE )

Starting function to supervise the

  • Initialisation of UART2 responsible for acting as the debug port for the firmware
  • Initialisation of the UART2 transmit and receive buffers
  • Initial read from UART2.

Parameters:
None
Return values:
None

Definition at line 95 of file debug2.cpp.

void set_debug_level ( uint8_t  debug_level )

Function to set the debug level.

Currently only 2 debug levels are provided as mentioned in debug_log_level_e. LOG is constantly enabled

Parameters:
(uint8_t)debug_level
Return values:
None

Definition at line 234 of file debug2.cpp.