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 diagnostic panel

The developer mode diagnostic panel opens by default after tapping the screen 8 times quickly (modifiable via DiagnosticsController.DeveloperModeSwitch). After opening, it appears on the right side of the screen.

diagnostics developer mode 2

The diagnostic panel functions are as follows:

  • session: session information controls for monitoring session status and issues
    • Toggle: switches SessionDump message display
    • copy: copies current frame session dump information
  • eif: eif recording controls. eif files are used for Unity AR simulation
    • Auto/Obsolete: toggles eif format, where Obsolete uses the original EIF format, and Auto automatically selects EIF MKV format or original EIF format based on platform support
    • rec: starts/stops eif recording
  • eed: eed recording controls. eed files capture critical runtime data for EasyAR technical support analysis
    • rec: starts/stops eed recording

Modify developer mode switch

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

The available modes are as follows:

  • Default: On mobile devices, quickly tap the screen 8 times to enter developer mode and open the diagnostic panel on the right side of the screen.
  • Custom: You can use the CustomDeveloperModeSwitch interface to customize the conditions for enabling developer mode. If undefined, the diagnostic panel cannot be opened during runtime.

To disable enabling developer mode, set DiagnosticsController.DeveloperModeSwitch to Custom and do not modify CustomDeveloperModeSwitch.

For example, the following code shows how to disable enabling developer mode in a script:

Session.Diagnostics.DeveloperModeSwitch = DiagnosticsController.DeveloperModeSwitchType.Custom;
Tip
  • It is recommended to use the default configuration Default during development and testing phases.
  • It is recommended to use the configuration Default or Custom during the release phase.
  • When using Custom mode, it is recommended to modify CustomDeveloperModeSwitch to provide alternative ways to enable the diagnostic panel, or to offer other custom methods for collecting runtime data.