Debugging the app

The Dolby Conference Phone software version 3.0 and later includes an SDK that allows service providers to create downloadable applications and thereby customize the user’s experience. This document discusses debugging techniques to use when developing an app.

Loading issues

If an app fails to load onto a Dolby Conference Phone, it may be due to errors such as a signature mismatch, checksum failure, SSL errors, or other network errors. The app's name, load status, and version, can be viewed on the Dolby Conference Phone settings menu or via the web UI. Note that the settings menu is not available when a device is in OOBE.

To inspect the app status on the Dolby Conference Phone UI, follow these instructions:

  • Tap Settings on Home screen
  • Tap the (...) three-dot icon in the left column
  • Tap About
  • Tap Status
  • Tap Conference app to check the app status

A a screen similar to the following will be displayed.

To view the app status via the web UI, follow these instructions:

  • Log into the Dolby Conference Phone Web UI (use the Dolby Conference Phone IP address and the admin/1739 login values)
  • Click on Status > System > Device

A web page similar to the following will be displayed. The app status, version and name values are shown at the bottom of the page (see red box).

Logging

The app can use the logging API to log events. Logged events are recorded in the non-volatile memory of the Dolby Conference Phone and can be retrieved in a number of ways. For more details on accessing the logs on the Dolby Conference Phone, refer to the Conferencing app deployment guide.

The Dolby Conference Phone SDK IDE contains a syslog server. This syslog server is automatically started when the IDE is launched. In order to configure the Dolby Conference Phone to send log events to the syslog server, follow these instructions:

  • Log in to the Dolby Conference Phone Web UI.
  • Click on Settings > Logging > Syslog service.
  • Enable syslog.
  • Enter the IDE virtual appliance's IP address in the Syslog Server IP Address field.

On the Dolby Conference Phone SDK IDE, click on "Applications", select "System tools", then click on "Log File Viewer" to launch the log viewer.

Once the log viewer is started, click on File, select Open, then navigate to the /var/log/dolby folder. Once the Dolby Conference Phone successfully connects to the syslog server, you will see a file name in the form of ip.messages, where the ip is the IP address of the Dolby Conference Phone. Click on this file to view its log. The information in this window is dynamically updated. The following screenshot shows the log viewer application.

"Log viewer"

The app log level

By default, the app log level is set to INFO which ignores all events that are tagged as DEBUG or DEBUG1. To capture these events, change the log level using the following instructions.

  • Log in to the Dolby Conference Phone Web UI.
  • Click on Settings > Logging > Log Level
  • Find UI Module, and change the log level for this module to either DEBUG or DEBUG1.

Note: Activating the debug log level will usually impact the performance of the Dolby Conference Phone. A system level warning is turned on to remind the user that the debug log level setting may affect the phone's performance.

Other common modules for debugging

To debug Dolby Voice conference call-related issues, set the SIP Module log level to DEBUG.

To debug configuration-related issues, set the CFG Module log level to DEBUG.

QML warnings

A bug in the app will often trigger a QML warning. All QML warnings are logged by the Dolby Conference Phone. Optionally, the Dolby Conference Phone can also display a pop-up notification as the result of a QML error. This feature can be enabled by setting the configuration parameter Dvms.DeveloperMode.Enabled to true. To toggle the developer mode parameter, follow these instructions:

  • Log into the Dolby Conference Phone Web UI.
  • Click on Settings > Dolby Voice Conferencing Service >Developer Mode
  • Toggle "Enable developer mode" switch.

Once enabled, when the Dolby Conference Phone encounters a QML error, it will display a screen similar to the following.

"Application error"

Reload the app

If the app enters a bad state, press and hold the mute button for 10 seconds to force the Dolby Conference Phone to reload the app. The Dolby Conference Phone will unload the app, download the app from the app deployment server, and then load it into memory.

Memory and CPU load

The Dolby Conference Phone constantly tracks the memory and CPU usage. To find out how the app affects the memory and CPU usage, follow these instructions:

  • Log into the Dolby Conference Phone Web UI.
  • Click on Status > System > Device

A web page similar to the following will be displayed. Six key performance parameters are defined below (see brown boxes).

"Status monitoring"