Skip to main content

Getting Started for Developers

Set up your XREAL AURA for development.

Prerequisites​

Before starting, ensure you have:

  • XREAL AURA (glasses + Compute Puck)
  • A development computer (Windows, macOS, or Linux)
  • Android Studio installed (latest stable version)
  • USB-C cable (high-quality, data-capable)
  • Google account for Play Store and services

Step 1: Set Up Android Studio​

Install Android XR SDK​

  1. Open Android Studio.
  2. Go to SDK Manager (Tools > SDK Manager).
  3. Select SDK Platforms tab.
  4. Check Android 15 (API 35) or later.
  5. Select SDK Tools tab.
  6. Install the following:
    • Android SDK Build-Tools
    • Android Emulator
    • Android XR extensions (when available)

Install XR Emulator Profile​

For testing without hardware:

  1. Open Device Manager in Android Studio.
  2. Create new Virtual Device.
  3. Select XR device profile.
  4. Choose Android XR system image.
  5. Configure with OST settings for XREAL simulation.

Step 2: Enable Developer Mode on Device​

On your XREAL AURA:

  1. Go to Settings (Open Launcher > Settings).
  2. Navigate to About device.
  3. Tap Build number 7 times.
  4. You'll see "Developer mode enabled."
  5. Go back to Settings.
  6. Open new Developer options menu.
  7. Enable USB debugging.

Step 3: Connect Device to Computer​

  1. Keep the glasses connected to the Glasses Port on the right side of the Compute Puck.
  2. Connect a USB-C cable from your computer to the Charging Port on the left side of the Compute Puck.
important

Both the Glasses Port and the Charging Port support full ADB debugging functionality. Using the Charging Port allows you to perform wired debugging while simultaneously viewing the display through the glasses.

Step 4: Build and Deploy Your First App​

Create New Project​

  1. In Android Studio, select New Project
  2. Choose XR Activity template (if available) or Empty Activity
  3. Set minimum SDK to API 35
  4. Select Kotlin as the programming language

Configure XR Dependencies​

In your build.gradle.kts file:

android {
    defaultConfig {
        minSdk = 35
        targetSdk = 35
    }
}

dependencies {
    // Add XR dependencies
    implementation("androidx.xr:xr-compose:1.0.0")
    // ... other dependencies
}

Deploy to Device​

  1. Select your connected device from the device dropdown
  2. Click Run (green play button)
  3. Wait for the build and installation to complete
  4. Put on the glasses to view your app running

Next Steps​

Troubleshooting​

IssueSolution
Device not recognizedCheck your cable and try a different USB port
Status shows "Unauthorized"Tap “Allow” in the USB debugging prompt on the device
Build failsUpdate Android Studio and SDK platform tools
App crashes on launchCheck logcat for error details and stack traces
Cannot see glasses displayRe-plug the glasses after the ADB session ends

Need more help? Visit the XREAL Developer Discord.