Debug mode [Enerest ToGo]

Owned by Stefanie Domzig
Last updated: Mar 28, 2023
3 min read

The debug mode displays the API calls that have been made and the errors that have occurred. To be able to use this mode, the user must be granted permission.

Activation

The debug mode can be activated in the settings in the "Help & Support" section.

 

 

Change view

 

While the debug mode is active, you can navigate through the app normally.

By clicking on the red bar at the top of the screen, the view is changed and the results of the debug mode are displayed,

Clicking on the bar displays the results log. Here the previously executed API calls and information are listed. Further functions of this view are explained in the next section.

Features

There are various functions in the debug mode.

When the mode has been activated, the app can be used as usual. In the background, the data is collected and listed. By clicking on the red bar at the top of the screen, the report of API calls and collected information is displayed.

Afterwards, the footer bar can be used to select which information is to be displayed:

Search

 

The input field can be used to filter the entire report for specific keywords or API calls.

If a certain error occurs or an explicit call has to be searched for, this filter / search field can be used for this purpose.

After the input, the report is updated and the desired information is displayed. If the term is not found, no text appears in the output and the report appears empty.

 

Filter

 

The filter can be used to display only certain information in the report:

  • Verbose = All information

  • Debug = Developer information, if debug steps have been included

  • Info = All successful API calls and information while using the app.

  • Warning = Warnings from the system

  • Error = Failed API calls and errors that occurred.

Zoom / Font size

 

Here you can adjust the font size of the report.

 

The smaller the font size, the more text can be displayed on the page. The larger the text, the easier it is to read.

The font size is not important for export, but only for better readability for the user.

Share

 

The output of the debug mode can be shared. This helps especially when users use this mode while the error occurs, so possible failed API calls or occurring errors are logged directly.

This report can be shared with the usual apps. The most useful thing to do here is to send the report to the support team via email if they have requested the report.

Deactivation

 

 

The debug mode is deactivated in the settings in the "Help & Support" section.

All data collected before will not be saved and will be lost after deactivation. If the report is to be saved, it must be exported or shared. (See Share)