Table of Contents

Make the most of UI diagnostic information and tools

This article introduces how to quickly configure and use UI diagnostic information and developer mode tools to better debug and optimize applications during development and testing.

Reading UI messages

By default, when running an EasyAR Sense Unity Plugin application, diagnostic information is displayed through UI messages near the top of the screen. This helps developers understand the session's running status and identify issues.

alt text

Tip

These texts are not watermarks and can be shown or hidden as needed.

This information helps developers understand the session's running status and troubleshoot issues. It is recommended to keep it visible during development and testing phases.

You can select 'AR Session (EasyAR)' in the editor and modify 'Message Output' in the 'Inspector' window to configure the display of UI messages. Among them, 'Message Output'>'Session Dump' can control the display of session status information, while other options can control the display of diagnostic messages at different levels.

alt text

Recommended configurations:
During development and testing:

  • Message Output > Session Dump: UI
  • Message Output > Sense Error: UIAndLog
  • Message Output > Session Error: UIAndLog
  • Message Output > Error: UIAndLog
  • Message Output > Warning: UIAndLog

For release builds:

  • Message Output > Session Dump: None
  • Message Output > Sense Error: Log
  • Message Output > Session Error: Log
  • Message Output > Error: Log
  • Message Output > Warning: Log

Using developer mode tools

By default, when running an EasyAR Sense Unity Plugin application, quickly tapping the screen 8 times will bring up the developer mode panel near the upper-right center of the screen. This allows developers to view and debug the session's runtime status, as well as record data for simulation runs.

alt text

  • Toggle the switch button next to session to show or hide information at the top of the screen.
  • Press the rec button next to eif to start or stop EIF recording. Recorded EIF files are saved in the application's persistent data path, accessible via Application.persistentDataPath.

To disable the developer mode panel, select AR Session (EasyAR) in the editor, then change Developer Mode Switch to Custom in the Inspector window.

alt text

Recommended configurations:

  • During development and testing phases:
    • Developer Mode Switch: Default
  • For release phase:
    • Developer Mode Switch: Default or Custom

If selecting Custom, ensure the production application can access diagnostic panels or collect runtime data through alternative methods.

Further reading