How to analyze system log from Dolphin modules?

This article applies to:
Any Dolphin module implementing SystemLog ( TCM300, TCM310 )

QUESTION

How to read out system log from Dolphin modules and what for is it used?

ANSWER

The DolphinAPI offers a method to store application and library log information in the Flash. These logs can help you identify and diagnose the source of problems with the firmware or module HW. The logs are especially useful for tracking down problems in the field. The logs can be queried both using the EOPX through the programming interface or using Remote Management through the radio interface.

The log codes and their addresses are defined in the API_ERRLOG enum. This enum has a special format. Using the DolphinStudio the system log and it's contents can be analysed.

This is done in following way:

  • Specify the header in DolphinStudio in the tab “EOPX→System log” where the API_ERRLOG is stored (find the header files attached to this article below).
  • Push the button “Read System Log”

DolphinStudio will read the header and search for the comment

//>>Section

When found the enum structure is parsed and according the address following the

 //>>SectionEO3000I-API:0x7E80

the LOG_AREA flash page is read. The parsed values and comments are than showed in the list box. Eventually you can read the error log from a .hex file you have stored in your PC before.

Once the logs are read, you can copy the result to the clipboard and paste it to a protocol.

RELATED TO:
For more information read EO3000I_API .chm→Error Diagnostic→System Log. This manual is part of the DolphinAPI installation.

DOWNLOAD:
TCM310 SystemLog
TCM300/TCM320 SystemLog