Oculus Developer Hub

Oculus Developer Hub (ODH) is a companion development tool that positions Oculus Quest and Oculus Quest 2 in the development workflow to provide a cohesive end-to-end development experience. The tool is compatible with Windows and macOS operating systems. It surfaces a collection of frequently used solutions in different forms and sizes such as:

  • Capturing screenshots and recording videos of what you see in the headset for debugging purposes

  • Casting the headset display to the computer for sharing your VR experience

  • Never missing an update through active notifications

It offers an engaging developer experience and accelerates the overall iteration process through simple mechanisms such as connecting the headset wirelessly to the computer and disabling the proximity sensor and guardian. Its cockpit view offers an instant view of the headset, displays the battery levels, and provides quick access to basic actions such as capturing screenshot, recording video, or casting. If you’re developing on the Windows operating system, its package manager is a one-stop-shop for downloading several Oculus tools and SDKs and notifies you when there’s an update available.

This topic contains the following sections to guide you through ODH:

Install ODH

ODH is available for macOS and Windows operating systems.

  1. Download the macOS or Windows installer.
  2. Install the application.
  3. Open the application and log in using your Oculus credentials, which must be the same as you’ve used for logging in the headset.

Connect an Oculus Device to ODH

To use ODH features, you must connect an Oculus device to the computer.

  1. Turn on the device you want to use for development.
  2. Open the Oculus app on your phone and then go to Settings.
  3. Tap the device and then go to More Settings > Developer Mode.
  4. Turn on the Developer Mode toggle.
  5. Connect your device to your computer using a USB-C cable and then wear the device.
  6. Accept Allow USB Debugging and Always allow from this computer when prompted to on the device.

  7. Launch Oculus Developer Hub, go to My Device, and check the device status.

    It shows the device ID and status as connected and active.

    ODH Connected Device Status

Enable ADB over WiFi

ODH offers an option to connect the headset wirelessly to the computer using ADB over WiFi.

  1. After you’ve connected the headset to ODH over a USB-C cable, on My Device, under Main Actions, turn on ADB over Wi-Fi.

    The status under ADB over WiFi changes to enabled.

    ODH ADB Status

  2. Disconnect the USB cable from the headset.

Note: ODH comes bundled with ADB, which means that you don’t need to install ADB version on your own. However, if you already have a different ADB version running on your computer, there are chances you may encounter conflict between ADB instances. In such case, you can use the existing ADB version from your computer by changing the ADB path. Go to Settings and modify the ADB path to let ODH use the ADB instance located on your computer.

Disable proximity sensor and guardian

By default, the proximity sensor is enabled to ensure that the headset goes to sleep when not in use. Guardian creates a virtual boundary to ensure your safety when you’re immersed in the VR experience. However, during the development phase, you can safely disable these features so that you don’t have to worry about wearing your device and calibrating it to capture screenshots or record videos.

  • On My Device, under Main Actions, turn off Proximity Sensor and Guardian to keep the headset in the active state.

    Note: Disabling the proximity sensor means your device will not go to sleep and can result in unexpected battery drainage. We highly recommend that you either leave the device charging or enable the proximity sensor when you’re finished capturing media.

Select organization

If you are a member of multiple developer organizations, ODH lets you switch between any of your organizations to view apps from the specific organization.

From the top-left corner, under Org Manager, select the organization to view specific apps under Your Apps section on the Home screen.

Cast Oculus device

Casting the headset display to the computer lets you use screen sharing tools to share your VR experience with others.

  1. Make sure the headset is connected to the computer either through a USB-C cable or ADB over WiFi.
  2. On My Device, under Main Actions, next to Cast Device, click Cast.

    ODH Cast to Device

    ODH starts casting the headset in a different window.

    ODH Casting

  3. To stop casting, either close the casting window or click the stop icon next to Cast Device.

Note: Casting automatically disables the proximity sensor. Once you stop casting, turn on the proximity sensor to avoid unexpected battery drainage.

Record media

Capturing a screenshot or recording a video of the headset display comes handy during debugging or in accelerating the iteration process. ODH stores the recorded media in the /Users/janedoe/Library/Application Support/odh/captures folder, which you can open from ODH itself.

  • On My Device, under Main Actions, do the following:

    ODH Record Media

    • To capture a screenshot, next to Screenshot, click Capture.

    • To record a video, next to Record Video, click Record, and to finish recording, click the stop icon.

      ODH displays the captured media in a different window.

    • To access screenshots or video files, next to Media Directory, click Open.

Install OVR Metrics

ODH lets you install and control the OVR Metrics tool, which provides performance metrics of any Oculus app running on the headset. If you’ve already installed the latest version of OVR Metrics, ODH automatically detects it and lets you control the tool’s visibility and settings from ODH. However, if you’re running an earlier version of OVR Metrics, you need to first install the latest version from ODH.

To install OVR Metrics from ODH:

  1. On My Device, under Main Actions, next to OVR Metrics, click Install.

    It redirects you to the OVR Metrics download page from where you need to download the tool.

  2. On the OVR Metrics download page, click the terms and conditions checkbox, and click Download.
  3. Extract contents from the downloaded OVR Metrics zip file.
  4. From the extracted contents, drag the OVR Metrics .APK file, and drop it under Unknown Sources area for installation.
  5. After the OVR Metrics .APK file is installed, restart the headset.

To enable OVR Metrics from ODH:

  1. On My Device, turn on OVR Metrics to make it visible on the headset.

    The OVR Metrics status changes to visible and the OVR Metrics tool overlays on the headset display, tracking the app’s performance.

    ODH OVR Metrics

  2. To configure OVR Metrics settings on the headset, look for com.oculus.ovrmonitormetricsservice from the list of .APK files under Unknown Sources, and click Launch.

    ODH OVR Metrics Launch

  3. To uninstall OVR Metrics from the headset, look for com.oculus.ovrmonitormetricsservice from the list of .APK files under Unknown Sources, and click Uninstall.

Install and uninstall APKs

When you’re developing apps for Oculus Quest, it becomes a norm to run and test your work-in-progress on the headset. ODH makes it very easy to install and uninstall .APK files from ODH, instead of using command line tools for installation.

  1. Locate the .APK file on the computer.
  2. On My Devices, drag and drop the .APK file under the Unknown Sources area.

    After the .APK file is installed, the app is available in the Unknown Sources list on the headset.

  3. To uninstall an unknown source app from the headset, look for the app you want to uninstall from the list of .APK files under Unknown Sources in ODH, and click Uninstall.

Download SDKs and tools

ODH for Windows offers a collection of the latest SDKs and tools that are either required or recommended for Oculus app development. As the number of Oculus SDKs and tools grows over time, it becomes easier to manage if you have a single source of download, release notes, and technical documentation.

When you download an SDK or a tool via ODH, it downloads the package in a particular folder, C:\Users\janedoe\AppData\Roaming\ODH\packages. ODH scans this folder regularly to check if there is any update available. If an update is available, it prompts you to download the latest version. We highly recommend re-installing the tools and packages via ODH to receive automatic updates and notifications.

  1. On Package Manager, under Available, from the list of available SDKs, look for the SDK you want to install, and click Install.

    ODH PM Available

    After the package is installed, it shows under Installed.

    ODH PM Installed

  2. To install an update, under Updates, click Update for the tool or SDK you’d like to update.

Note: Package Manager is not supported on the macOS operating system.

Configure notifications

Notifications are essential in the development workflow to stay connected with the Oculus develoment ecosystem. ODH notifies you based on the interests and subscriptions you’ve signed up from the Oculus Dashboard settings page.

  1. Click Notifications.
  2. On the side bar, click the gear icon to open the notifications settings in the browser window.
  3. On the settings page, select your interest for which you’d like to receive notification, and click Save.

    Based on your subscribed list of interests, ODH sends you notifications.

    ODH Notifications

  4. To mute notifications, from the bottom of the Notification side bar, turn on Mute Notifications.

Check device logs

ODH lets you check and filter log output generated from Android’s Logcat command-line tool. Logs contain useful system messages, including stack traces when a garbage collection occurs and messages that you added to your app.

  1. After you’ve connected your device with ODH, in the bottom-left corner, click Device Logs.
  2. From the Type list, select the log type. By default, Verbose shows all the log messages.
  3. Optionally select Regex to filter messages using a regular expression search pattern.
  4. To download messages, click the Download icon to export messages in a text format.

Report a bug

By reporting a bug, you’re helping us improve the ODH developer experience. We take this opportunity to thank you for letting us know about the issues or bugs you encounter so that we can fix it.

  1. Make sure you’re using the latest version of ODH. If you see an auto-update notification on the top of ODH, it’s time to update to the latest version.
  2. Click Report a Bug from the bottom-left corner to open the bug report form.
  3. Describe the exact steps to reproduce.
  4. Attach a screenshot from the ODH to show what you are observing. It’s usually very helpful in describing the bug.
  5. By default, ODH attaches the logs that shows ODH-specific information.
  6. Click Send to file the bug.

Note: As you report a bug, we would like to remind you that the bug report form is not a support forum. If you have questions about how to use the tool, read this guide or get in touch with the Oculus support team.

Troubleshooting

This section covers the most common errors that you may encounter while using ODH.

  • I’ve multiple Oculus accounts. Does it matter which one I use to log in ODH?

    You must use the same Oculus account to log in ODH as you’ve used for logging in the Oculus headset.

  • Do I have to use ADB over WiFi to connect the headset to the computer?

    No, it’s optional. ADB over WiFi lets you connect your Oculus device to the computer wirelessly, which means it’s not tethered to your computer through a USB cable. It’s a matter of preference whether you like it connected wirelessly or via a USB cable.

  • ODH doesn’t detect my headset even when it is connected to the computer over a USB-C cable.

    There can be two reasons why ODH is unable to detect your headset:

    • After you connect your headset to the computer over a USB-C cable, wear your Oculus device and look for the prompt to let the computer access the headset over the USB-C cable.

    • You may not have turned on the developer mode from the Oculus mobile app. Follow step 1 and 2 from the Connect Oculus device to ODH section.

  • I am unable to connect the headset to the computer using ADB over WiFi.

    ODH uses ADB v1.0.41 and requires you to turn on the developer mode from the Oculus mobile app. You may have connected the headset to the computer over USB-C cable, but may not have turned on the developer mode from the Oculus mobile app. Follow steps 1 and 2 from the Connect Oculus device to ODH section.

    Check if you’re connected to any virtual private network (VPN). At times, VPN connectivity may interrupt with ADB connectivity. Disconnect from the VPN, restart ODH, and enable ADB over WiFi.

  • I can’t view certain app content while casting my device.

    Casting can be restricted for licensed app content.

  • Casting is stuck in the waiting for connection state.

    Make sure there is no notification in your Oculus device that requires your action. At times, if there’s an unresponsive app that requires further action, casting may stay suspended.

  • OVR Metrics tool is installed, but it’s stuck in the refreshing state.

    After OVR Metrics is installed, you must restart the device before the tool is available for use.

  • I already have OVR Metrics installed on my Oculus device but ODH is unable to detect it.

    ODH works with the latest version of tools and SDKs. The reason ODH is unable to detect the OVR Metrics tool is because you may not have the latest version of the tool available. Install the latest version from ODH.

  • I’ve one of the Oculus tools already installed. However, ODK doesn’t list the tool under the Installed tab.

    ODH lists packages under the Installed tab only if you’ve installed it from ODH. It doesn’t recognize packages downloaded directly from the Downloads page.

  • I’m an Oculus for Business developer and ODH doesn’t seem to work with the headset.

    Currently, ODH doesn’t support Oculus for Business firmware.