Android#

Prerequisites#

Mandatory#

Before getting started, the following utilities are necessary.

  • NVIDIA Omniverse™ Kit version 2021.3 or greater

  • For Android devices:

    • Android Studio v3.4+ or Android Command Line Tools.

    • Android Tablet with AR capabilities. (need a list of supported devices)

Optional#

For expert Android developers looking for a more complete environment for debugging, the following is suggested.

  • A fully setup Android development environment

    • Android SDK

    • Android NDK and Android Platform Tools

    • OpenJDK 1.8

Android Device setup#

Android SDK#

The Android tools needed by Omniverse can be attained by the more robust Android Studio or by the Command Line Tools.

Install and Configure Android Studio#

Android Studio is needed to get the APK tools and to configure our environment.

  1. Download Android Studio

  2. Once downloaded Install

  3. Once installed launch Android Studio

  4. Upon starting Android Studio, Select “Configure > Configure SDK” to adjust the SDK properties

  5. Select the SDK Platform Tab

    • Check-On Android 11

    • Check-On any additional Android Versions to match your target Android Device(s)

  6. Select the SDK Tools Tab

    • Check-On Google USB Driver

  7. Select OK/Apply to continue and install the necessary components.

  8. Once installed, you can close Android Studio

Omniverse USD Composer Environment Variables#

Once we have Android Studio installed we need to create Environment Variables for the Platform Tools

  1. In Windows, Open a File Explorer window and Select the address Bar

  2. Type %localappdata% to open your local user app data folder.

  3. Open Android, then SDK, then platform-tools

  4. In the address bar and select and copy the path

  5. Press the windows Start Button amd type “Env”

  6. Select “Edit the System Environment Variables” to open the System Properties panel on the Advanced Tab

  7. Select “Environment Variables”

  8. In the System Variables list, Locate Path and select “Edit”

  9. In the resulting window press “New”

  10. Paste the path to the Platform Tools folder and add a trailing \

    • Typical Path C:\Users\USERNAME\AppData\Local\Android\Sdk\platform-tools\

  11. Press OK to commit the system variable

  12. Test adb

    • Open a command prompt and type adb help

    • If the help output is delivered from adb, you have successfully installed the android environment and created the necessary paths.

Connecting Your Android Device#

  1. Enable Developer mode on the target device

  2. Enable Debug Mode on the target device

  3. Connect the target device to the host workstation

  4. Open a command prompt and type adb devices

    • If connected, your device should be listed

Install NVIDIA Omniverse™ CloudXR on Your Device#

  1. Navigate to NVIDIA Omniverse™ CloudXR Installer

    • If installed with defaults, path will be C:\Program Files\NVIDIA Corporation\Omniverse\Kit\ + Installed Kit Version Number + omniverse-xr-installation folder\exts\omni.kit.xr.system.cloudxr21\xrclients\googlear

    • Copy the path from the Windows Explorer Address Bar

  2. Launch Command Prompt in Administrator Mode

    • Press Start Key on Keyboard and type cmd

    • Select “Run As Administrator” on the Command Prompt

  3. Install NVIDIA Omniverse™ CloudXR

    • Type cd + <space> then Paste (Ctrl+V) the path and hit enter.

    • Check that device is still connected and not “locked” or “asleep” then type adb install ar-sample.apk

  4. If the install process hangs on “Error: Device not authorized”

    • Press Ctrl + C to stop adb from executing

    • On the android device, look for authorization notification

    • Accept/Authorize the host computer and repeat Install CloudXR step

  5. On your android device a new application called CloudXR ARCore Client should be available in your application list.

Connecting with the Android Client#

  1. Launch CloudXR ARCore Client on your Android Device.

  2. Enter the IP Address of Host Computer on CloudXR Server IP Address line in NVIDIA Omniverse™ CloudXR Settings.

  3. Use Device to slowly scan your surroundings. Allow device to create a “Grid”.

  4. Tap Screen on any grid location to select where you want NVIDIA Omniverse™ CloudXR to Display your Omniverse Kit Content

  5. The mesh should now appear and allow you to review your model in AR on your device.

Note

Once your model appears, you can reposition your model to another place on your grid by a long tap and hold on the screen. When the grid shows up again tap the new position to re-position the model.

On this page