Mega diagnostic data collection
This guide aims to provide standardized instructions for collecting visual anomaly data. Through standardized data collection and feedback, it helps developers accurately describe issues and assists the EasyAR technical team in efficiently locating, reproducing, and resolving technical faults related to visual positioning.
Content introduction
During the integration of EasyAR Mega positioning services, accurate data collection is the core prerequisite for issue diagnosis. This guide covers the following key steps:
- Issue identification: Categorization and preliminary evaluation of common anomalies.
- Screenshot and screen recording specifications: Visual evidence collection methods for different device platforms.
- Runtime data collection: Extraction and export of runtime environment data across platforms.
- Information feedback standards: Ensuring the "minimum information set" required for the technical team to reproduce issues.
Classification and preliminary judgment of abnormal phenomena
Before reporting an issue, please first clarify the abnormal phenomenon by referring to the following categories:
Common abnormal behaviors
- Complete positioning failure: Unable to recognize the scene, with the status persistently displayed as "NotFound".
- Positioning accuracy deviation: Successful positioning but with insufficient accuracy, showing noticeable spatial offset.
- Unstable positioning: Screen jitter, drift, or frequent tracking loss.
- Regional anomalies: Poor positioning performance in specific areas or points.
- Device compatibility differences: Poor performance on certain specific device models.
Possible cause speculation
- Scene-related: Content placement offset, poor mapping quality, sparse environmental lighting or feature points (such as large white walls), presence of similar point interference.
- Technical environment: Network jitter, service arrears, QPS limit exceeded, SDK version compatibility, API call logic error.
- Hardware permissions: Device sensor (IMU) does not support motion tracking, camera or storage permissions not enabled.
Standardize the feedback process
To improve troubleshooting efficiency, we strongly recommend that you submit a complete feedback package containing the following three parts:
Basic information checklist (minimum information set)
- Resource identification: Account information, Mega AppId, Block Id.
- Version information: EasyAR Sense SDK version or mini-program plugin version.
- Problem description: Detailed description of the abnormal phenomenon and its triggering conditions.
- Environment parameters: Device model, OS version, WeChat version, current network environment (4G/5G/WiFi).
Visual evidence (video and screenshots)
- Reproduction process recording: A complete recording of the positioning process from startup to anomaly occurrence.
- Keyframe screenshots: Capture snapshot images of the moment the anomaly occurs.
- Multi-angle recording: Provide visual references under different positions and lighting conditions.
Runtime data (Core troubleshooting basis)
- EIF data: Runtime records based on EasyAR Sense, supporting playback and analysis on PC.
- Dump data: A unique runtime snapshot for WeChat Mini Programs.
- Application logs: App runtime logs (Logcat/Console) and error stacks.
Tip
Further reading: How to clearly communicate issue details
Operating environment and collection method classification
Data collection methods vary depending on the operating device and platform. Please select the corresponding guidance based on your actual environment.
Device classification description
- Mobile devices: Smartphones (iOS/Android).
- Head-mounted displays:
- OST (Optical See-Through): Optical see-through (e.g., XREAL, Rokid).
- VST (Video See-Through): Video see-through (e.g., Apple Vision Pro, PICO).
Screenshot and screen recording guide
| Platform type | Reference guide |
|---|---|
| Mobile / WeChat Mini Program | Mobile screenshot, screen recording and export |
| OST headset | OST screen recording and export |
| VST headset | VST screen recording and export |
Runtime data collection (EIF/Dump)
| Scenario type | Collection solution |
|---|---|
| EasyAR Sense native app | Mobile app EIF recording / Headset EIF recording |
| WeChat Mini Program | Mini Program Dump data recording and export |
| Quick collection tool | Mega Toolbox EIF recording / Toolbox Dump recording |
Automatic collection feature (coming soon)
We are about to upgrade to support automatic collection and feedback functions, providing a more convenient data submission method:
- Background recording: Start collecting required datasets in the background as needed
- Automatic upload: Automatically package and upload to the EasyAR technical team
- On-demand capture: Self-service real-time capture of abnormal states
- Progress tracking: Classify and continuously track progress
Operation guide navigation summary
Based on your device platform requirements, directly jump to the detailed operation guide:
| Type | Screen recording and screenshot collection guide | Runtime data collection guide |
|---|---|---|
| Mobile app | Mobile screenshot and screen recording with export | Mobile app EIF recording、Mega Toolbox EIF recording、EIF data export instructions |
| OST headset | OST screen recording and export | Headset device EIF recording and export |
| VST headset | VST screen recording and export | Headset device EIF recording and export |
| WeChat Mini Program | Mobile screenshot and screen recording with export | WeChat Mini Program Dump recording and export、WeChat Mini Program Toolbox Dump recording |
Best practice suggestions
- Pre-research process: Before the project goes live, it is recommended that team members familiarize themselves with the data collection process.
- Self-check in advance: Before providing feedback, confirm whether technical environment issues, content placement problems, or device permission issues have been ruled out.
- Data integrity: Standardize the collection of complete data: feedback minimum information set, visual anomaly videos and screenshots, and runtime data.
- Timely communication: After submitting complete data, maintain communication with the EasyAR technical team.
Support channels
- Help documentation: Refer to Mega documentation or Troubleshooting.
- Technical support: Contact us now or email support@sightp.com.
Next topic: Methods for mobile screenshots, screen recordings, and exporting