Quest.pdf

QUEST How to guide Version 08/23 Welcome! This Guide will provide tips on how to use and test with a Oculus Quest headset – Quest 1, 2, 3 and Quest Pro. Most of the information on this guide is for all Oculus Quest headsets, but you might notice a difference sometimes between Quest 1, 2 & 3 and Qu...

QUEST How to guide Version 08/23 Welcome! This Guide will provide tips on how to use and test with a Oculus Quest headset – Quest 1, 2, 3 and Quest Pro. Most of the information on this guide is for all Oculus Quest headsets, but you might notice a difference sometimes between Quest 1, 2 & 3 and Quest Pro. This will be indicated with a icon on the top left corner + a sub header: If you don’t see any icon or sub header, it means the content apply to all headsets. Happy learning! Table of Content – Page 1/2 Ctrl + click on hyperlink to access content • 1. Setting up your device • Setting up your device – 3 steps • Step 1: Phone Set up and Log in (5 slides) • Step 2: Factoring Resetting • Step 3: Turning Developer Mode ON • • • • • Guardian System System Alerts Headset Battery and Charging Controller Batteries *Quest Pro - Charging the HMD using the stand • 2. Software Installation & ADB • • • • • Software Requirements What is ADB? Useful ADB Commands Installation Steps *Quest Pro - Installing/Playing Application • 3. Crash Dumps • Generating Logs • Acquiring Logs • Demo (Video) • Crash dumps Table of Content – Page 2/2 Ctrl + click on hyperlink to access content • 4. OVR Metrics Tools • What is it? • Installing OVR Metrics • • What are FPS? • FPS Graph Creation (4 slides) Demo (Video) • *Quest 1/2/3: Setting up OVR Metrics • *Quest Pro: Setting Up OVR Metrics Overlays • • 6. FPS Graph Creation Demo (Video) • 5. Recording Media • How to record media • *Quest Pro: How to record media with headset • Transfer your Media to your PC via USB cable • 7. *Quest Pro Testing • Virtual Reality Check (VRC) • Guidelines • List • Mixed Reality • 8. Useful Resources • Useful Resources Setting up your device Here are the steps you need to set up your devices. Ctrl + Click the picture to access a specific step, or keep scrolling to follow all steps. 1. Phone Set up & Log in 2. Factoring Resetting 3. Turning Developer Mode ON Setting Up With VR To get started on VR you will need the following items : A VR headset (Oculus Quest/ Quest 2/ Rift/ PSVR/ etc) • Your Lead will request a device for you A Company Phone • With the Meta App installed An Oculus tester account • Can usually be found in the Teams Channel Wiki tab • This should also already be on the headset A USB to USB-C cable • We need to connect the headset to the PC to install specific testing software 1. Using The Oculus App 1. 2. Video placeholder Log in with the provided email and password. 3. Open the Oculus app from the mobile device Open up the Home dashboard, scroll to the bottom and sign out of the account currently signed in. From the options, select “Login with email address” and proceed. 4. Enter the project email and password assigned to you (which can be found in the wiki or One Note in the Teams Channel). 5. Click menu in the bottom right hand corner once you’ve logged in 6. Open the app now signed into the correct device, navigate to the Devices tab, select the Options button (three dots in the top right hand corner) and select “Connect a new device”. 1. Using The Oculus App 7. 8. 9. Select the Oculus Quest 2, and you should be presented with a prompt to enter a 5 digit code. This is where we’ll reset the headset you currently have. Once you have set up the headset and downloaded the update, scroll down to settings and select “Developer Options”. Toggle Developer Mode on. This will be important for later! 2. Factory Resetting The Headset 1. 2. 3. 4. Turn the headset off and then: Hold Power button + Volume Down button for roughly 2 seconds Once in the USB Update Mode, select “Factory Reset” Locate the 5-digit code & type it into the Oculus app to pair the headset Follow the in-headset instructions 1. Choose USS_INT for the wifi connection 2. Watch the safety video 3. Wait for the update to fully download 4. Turn Developer Mode on from the app The 5-digit pair code looks like this in the headset 50369 3. Turning Developer Mode ON After factory resetting the device and going through the setup you will need to head back to the phone and enable developer mode. To do this, use the phone whilst on the Meta Quest App and go to: Devices > Developer Mode > Turn Developer Mode “ON”​ Developer mode allows you to use ADB commands to extract data from the HMD and is needed to install OVR Metrics​. The Guardian System The headset contains a Guardian system feature, a virtual boundary designed to assist you with staying in your play space and avoiding collisions with objects in your physical world while you are in your virtual environment. If you cross these boundaries, the Pass-Through Camera feature will be activated, and allow you to see the physical world. This is only designed for brief usage. Do not remain in the pass-through mode for prolonged use. System Alerts For your protection, you should take immediate action and let your supervisor know as soon as possible when these system alerts are prompted. The headset may provide you with the following alerts:  Overheating Alert: And audible and visual alert when the headset is overheating. Please remove immediately and let it cool down before continuing.  Sound Volume Alert: A visual alert in the event of high volume levels. Do not listen at high volume levels for long periods of time and lower the volume.  Outside of Play Space Alert: A visual alert if you are outside of your play space. If prompted, please remove your headset or go back to your play space (as desired).  Tracking Error Systems Alerts: A visual alert if the headset’s tracking system is not operating properly. If this appears, remove the headset and move to a safe space and follow the on-screen instructions. Headset Battery and Charging The headset contains a rechargeable Lithium-Ion battery and comes with a power adapter and charging cable. Improper use of the battery or power adapter may cause various hazards. To reduce the risk of injury to yourself, others and the equipment, please follow the following instructions: The battery in your headset is not user-replaceable. Do not attempt to open the headset to access the battery. Do not disassemble, crush, bend or deform, puncture, shred or put a high degree of pressure on the headset. Only charge your headset with the included power adapter and cable, or an approved power adapter and cable. Avoid dropping your headset. Dropping it on a hard surface can cause damage to the headset and battery. Periodically inspect connection cords, connector tips and the power adapter for damage or signs of wear. Do not attempt to charge or use the headset if it does not turn on after attempted charging, if it gets abnormally warm, or if the battery compartment is swollen, leaking liquid or smoking. Do not let your headset or controllers get wet or come in contact with liquids. In the event of a battery leak, do not allow the liquid to come in contact with the skin or eyes. If contact has been made, wash the affected area with large amounts of water and seek medical advice. Controller Batteries The Oculus Touch controllers contain AA batteries. • Batteries in the controllers are user-replaceable. • Do not mix old and new batteries. Replace all batteries of a set at the same time. • Remove exhausted batteries from the product promptly and dispose of them properly. Charging the HMD using the stand Quest Pro only • Quest Pro headset & controllers are charged on a stand • Stand is plugged into the socket as normal • 2 small slots for controllers, placed first • Headset placed on the ridge after Software Installation With the Quest set up and ready for playing, let’s figure out how to install some builds/apps on the machine. Requirements • Windows 10 PC • USB-C Cable • USB Permissions on PC • Oculus ADB Drivers: Install the Oculus ADB Drivers via https://developer.oculus.com/downloads/package/oculus-adbdrivers/ (right click the “android_winusb” file and click install) • Platform-Tools for Windows: Download Platform-Tools for Windows via https://developer.android.com/studio/releases/platform-tools • Oculus Developer account: Join or create an organisation via https://dashboard.oculus.com/ What is ADB? “Android Debug Bridge (ADB) is a command-line tool included with the Android SDK that is the main tool used to communicate with a Meta Quest headsets during all stages of development. ADB is a highly versatile tool required to install apps and issue other important commands from the computer to the headset.” – Developer Oculus More information can be found here: Use ADB with Meta Quest: Native/android | Oculus Developers Useful ADB Commands adb shell pm list packages • This command will list all the currently installed applications on the headset adb shell pm path “com.package” • This command will identify the path to the selected package adb pull “/data……..” • This command will pull the apk file using the path you identified from the command above adb logcat > output.log • This command will generate an output log inside your Platform Tools folder adb logcat > crash.log • This command will generate a crash log inside your Platform Tools folder (this is the same log as output, just named differently). Software Installation With the Quest set up and ready for playing, let’s figure out how to install some builds/apps on the machine. Installation Steps 1. 2. 3. Enable Developer mode (Check how to do it here) Connect Quest to PC via USB-C Cable Open Command Prompt with the directory changed to where the Platform-Tools file is located via “cd <platform tools folder>” command 4. 5. 6. 7. Type “adb devices” Allow authorisation in headset If connected properly, adb will show Install any apk file via “adb install <apk path>” For example: Quest Pro - Installing/Playing Applications Check demo video fore more info You will have been told what application you are playing on. This can be found in the applications library (if already installed). If it isn’t, you will need to locate it using the “Store”. Be sure to double check the name of the application, as it could have a different name inside the store. Once you locate the appropriate game, select it and press "Install". After doing so, it will appear in your library. Generating Logs Logs can be generated from the headset using ADB commands. They can be particularly useful for rare occurring issues, or even crashes. Developers may specifically request logs in tickets for certain projects, so its good to get into the habit of generating logs for your tickets. The command to generate logs is “adb logcat > output.log”. You can also use the command “adb logcat > crash.log” which generates the same file with a different name. Acquiring Logs Acquiring Logs - Demo Crash dumps Logcat can be used to determine the cause of a crash. • Connect the Quest via adb as shown in the steps above and type “adb logcat > crash.log” • The crash log will be saved in a .txt file in the directory of the Platform-Tools. To change directory of where the crash log is saved type “adb logcat > <directory path>/crash.txt” • Search the log for “backtrace:” to locate the stack trace beginning with the crash. If too much time has elapsed since the crash and the log does not show the backtrace, a full dump state of the crash should still exist. • Type “adb shell dumpstate > dumpstate.log” • The crash log will be saved in a .txt file in the directory of the Platform-Tools. To change directory of where the crash log is saved type “adb shell dumpstate > <directory path>/crash.txt” • Search the log for “backtrace:” to locate the stack trace beginning with the crash. OVR Metrics Tool What is it? The OVR Metrics Tool is external testing software, that we need to install onto the headset after each factory reset. It’s an application that reports frame rate, heat, GPU and CPU usage and more. It is essential to have this tool running whilst doing any testing. The OVR Metrics Tool can also be installed from the Oculus store as well however it is good practice to keep the OVR folder in case of an emergency. Once installed, you can connect it to your quest via Bluetooth and using the settings on the app (or from the Quest) you can choose which metrics to record. The main ones you should be recording are: • Frame rate • GPU/CPU usage • Temperature Installing OVR Metrics What you need to install it OVR Metric Installation via CMD 1. 2. 3. 4. 1. Open Command Prompt in the Platform Tools folder 2. Click on the File Directory while in the Platform tools folder, then type CMD & hit enter 3. Connect headset to PC via USB-C cable 4. Select “Allow” on all in-headset pop-ups 5. In Command window, type “adb devices” 6. If headset is connected, it will show in the “Lists of devices attached” list 7. In the Command window, type “adb install” and drag & drop the OVRMetricsTool.apk file in. 8. Hit enter to install OVR on your headset Install the Oculus ADB Drivers Download the OVR Metrics Tools Install & extract the Platform-Tools for Windows Put it in a folder you’ll remember as you’ll be using this tool frequently. OVR Metrics can be installed through the headset. It can be located on the store page called “OVR Metrics Tool”. If the application does not appear on the store page, it can be manually installed via CMD using an APK file. Installing OVR Metrics - Demo Setting Up OVR Metrics Quest 1, 2 & 3 only In the headset, go to your App Library > Other Sources > Select OVR Metrics Or Open the OVR Metrics app from the Apps dashboard Make sure to tick: • Enable “FPS Graph overlay” • Enable “ Record to CSV file” • Enable “Allow settings to be modified over Bluetooth” • Enable “Average FPS” graph • Enable “Render Scale” graph You can change where the OVR overlay sits in your headset in the OVR Settings. Setting Up OVR Metrics Overlays - Quest Pro only You need to ensure the following options are toggled on before doing anything else: Enable Persistent Overlay (check demo here for more info) Record all capture metrics to csv files (you will need to accept a prompt which will appear on-screen) After, you will be presented with a screen with various buttons and options to enable overlays to enable. The most common graph and stats used are “Average FPS”, “Spacewarp FPS” and “Render Scale (%)”. The “Quick-set Enabled Stats” allows you to quickly enable certain stats without having to manually select each one. This can be either “Basic”, “Advanced” or “Advanced with Memory”. Setting Up OVR Metrics Overlays – Demo - Quest Pro only Recording Media Media recording is mostly done within the headset. 1. Press the Oculus Home button on your right Tough controller, 2. Select the Share Menu 3. Within the Share Menu you will have a record button & a screenshot button 4. You can also press the right Oculus button and the right trigger at the same time to avoid needing to use any menus You should always be recording your gameplay, unless you’re creating a FPS graph! Recording Media Quest Pro only There are a couple of ways to capture media through the headset: • Via the “Camera” application. This will allow you to cast, take photo’s and record videos. It will also display all your recent captures once you start producing recordings. • Via the “Universal Menu” whilst playing an application, there will be a record/photo icon. • Check the demo for more info. Remember to always be recording whilst playing an application. Transfer your Media to your PC via USB cable 1. Connect your headset to the PC via USB cable and enable all permissions inside the headset (if they do not appear, it is possible that dev mode is not enabled) 2. A window will open, locate your file within your headset’s file system 3. You can also open the CMD Prompt box and type “adb pull /sdcard/Oculus/Videoshots” to extract videos to your Folder. Performance testing when on Oculus VR Performance testing is very important in VR! A game should never run under 72 FPS unless it’s a loading screen, a pause menu or the Oculus Dashboard. FPS Graph Creation We’ll need to create a FPS graph to attach to our Jira bugs that require it. You’ll need to save your own copy of the Graph template which can be found at: T:\Facebook\Training & Documentation 1. Navigate to your extracted CapturedMetrics folder and find/open the excel file that you want to extract the graph out of. Also have the Graph template open. 2. In your CapturedMetrics excel, copy the entire “Time Stamp” column (Column A) in to Column A of the Graph template excel. FPS Graph Creation 3. In your CapturedMetrics exel, copy the entire “average_frame_rate” column (Column T) in to Column D of the Graph template excel. 4. In the Graph template excel, change the ranges of Column B and C by highlighting the last two values in them and dragging the box to match the other columns. All columns should have the same row count. Make a note of what the row # is. FPS Graph Creation You will now see that the template Graph plots have automatically changed to your values, but not fully. We need to change what cells the Graph is pulling data from. 1. Click on the plot-line on the Graph, you will see the Graph dataset in the text entry box at the top. Replace the values of Column C and D with the Row # you made a note of in the previous step. FPS Graph Creation A nearly completed Graph should now be presented before you. There’s just a couple more things to edit now. 1. Change the heading of the Graph to the relevant project/app name 2. Label the Graph of the events happening in it. 3. Use Snipping Tool to take a screenshot of your completed Graph. Virtual Reality Check (VRC) – Guidelines Quest Pro only App Lab and Meta Quest Store apps must meet or exceed Virtual Reality Check (VRC) guidelines to be considered for distribution. These VRC guidelines are provided to help you build high quality apps for Meta Quest headsets. VRCs are divided into categories of evaluation such as assets that accompany your app, its performance, function, and how it handles input. While we present the VRCs in the form of a checklist, your focus should be on the user experience of your app and not just to check off a box. A check mark (✓) in the App Lab or Meta Quest Store column indicates that the VRC is required for that distribution method. A plus sign (+) in a column indicates the VRC is a recommendation. We encourage you to develop your apps to meet the recommended guidelines to deliver value to your audience. VRC List Quest Pro only Meta Quest Virtual Reality Check (VRC) Guidelines | Oculus Developers Audio - This VRC suggests that your app support spatialized audio. Performance - These VRCs ensure your app is responsive, performant, and able to render graphics at the quality expected for a Meta Quest app. Functional - These VRCs ensure your app functions according to expected standards. Security - These VRCs ensure your app protects the privacy and integrity of customer data. Tracking - These VRCs ensure that your app meets all tracking requirements. Input - These VRCs ensure your app provides a user experience consistent with Meta Quest user interaction standards. Accessibility - These recommended VRCs ensure your app is accessible to and can accommodate a variety of users. There are other VRC guidelines which include Packaging, Asset, Streaming, Privacy, Content and Publishing. However, we are not required to check these unless it has been specifically requested by the client. Mixed Reality Quest Pro only Meta Quest Pro lets you record and cast your surroundings through mixed reality. This means that when you choose to you can combine your real environment with virtual elements. This feature also allows you to share your mixed reality experience with others across different social platforms such as Instagram or Facebook. Some tips to help you and those around you feel comfortable when you're recording or casting your mixed reality experience include: The first time you turn on mixed reality for Meta Quest Pro, a message will appear with important reminders about how to protect the privacy of yourself and others. When you enable Pass-through, your Quest Pro will show a blue LED light to indicate to bystanders that the Pass-through cameras are active. Let the people around you know that you will be using the headset to cast or record your mixed reality experience and request their permission before including them in a recording. Let the people around you or captured in your mixed reality experience know if you plan to share your image or recording to a social platform or anywhere else online. Useful Resources In the links below, you can find any of the official downloads or setup guides provided by Oculus. • Oculus ADB Guide: https://developer.oculus.com/documentation/quest/latest/concepts/mobileadb/#mobile-android-debug-intro • OVR Metrics Tool Guide: https://developer.oculus.com/documentation/quest/latest/concepts/mobileovrmetricstool/ • Oculus Downloads Page: https://developer.oculus.com/downloads/native-android/ • Oculus Logcat Guide: https://developer.oculus.com/documentation/quest/latest/concepts/mobilelogcat/ • Platform-Tools for Windows: https://developer.android.com/studio/releases/platform-tools We want to keep this guide up to date and relevant for all departments. Want to add or edit some information? Want to remove outdated information? Send an email to [email protected] with the subject: How to guide – Suggestion – [HowtoguideName]