Table of Contents

Developer mode

Developer mode is used to set whether to enable the runtime diagnostics panel. The diagnostics panel can be used to toggle the display of debug information and record EIF and EED files.

diagnostics developer mode 1

Developer mode diagnostics panel

The developer mode diagnostics panel is opened by default with 8 quick taps on the screen (can be modified via DiagnosticsController.DeveloperModeSwitch). Once opened, it displays the diagnostics panel on the right side of the screen.

diagnostics developer mode 2

The diagnostics panel functions are as follows:

  • session: session information controls, used to understand session status and issues
    • Toggle: toggle SessionDump message display
    • copy: copy current frame session dump information
  • eif: eif recording controls, eif files are used for Unity AR simulation run
    • Auto/Obsolete: toggle eif format, where Obsolete uses the original EIF format, Auto automatically selects EIF MKV format or original EIF format based on platform support
    • rec: start/stop eif recording
  • eed: eed recording controls, eed files are used to capture key runtime data for EasyAR technical support analysis
    • rec: start/stop eed recording

Modify developer mode switch

Can be configured via the DiagnosticsController component on the session in the editor, or using the DiagnosticsController.DeveloperModeSwitch interface in scripts.

Available modes:

  • Default: On mobile devices, quickly tap the screen 8 times to enter developer mode and open the diagnostics panel on the right side of the screen.
  • Custom: Can use the CustomDeveloperModeSwitch interface to customize developer mode activation conditions. If undefined, the diagnostics panel cannot be opened at runtime.

Disable developer mode by setting DiagnosticsController.DeveloperModeSwitch to Custom without modifying CustomDeveloperModeSwitch.

For example, the following code shows how to disable developer mode in scripts:

Session.Diagnostics.DeveloperModeSwitch = DiagnosticsController.DeveloperModeSwitchType.Custom;
Tip
  • Recommended to use default configuration Default during development and testing.
  • Recommended to use configuration Default or Custom for release.
  • When using Custom mode, modify CustomDeveloperModeSwitch to provide alternative ways to enable the diagnostics panel, or offer custom runtime data collection methods.