EasyAR HMD Support¶
EasyAR and Head Mounted Display SDK¶
Most EasyAR features and device features are not overlapped. So EasyAR do not delegate device functionalities in most cases. When you need to use some device features like gesture recognition, you need to follow the way the hardware officially offers, and learn usages and application scope of these features from its official documents.
To EasyAR, device SDK offers motion tracking capability on their devices, and this is the only feature EasyAR take use of from the device. Please read Motion Tracking and EasyAR Features for the relationship between EasyAR and motion tracking, and which EasyAR features can be used when motion tracking is available.
To Pico, Apple Vision Pro, Rokid, XREAL and other AR/VR display devices, they do not use EasyAR to make devices to work. EasyAR adds more possibilities to the device in some scenarios.
Supported Head Mounted Display¶
Import Device SDK and Prepare to Use¶
Import Device SDK¶
Please get device SDK from hardware official channel. Here we list download or document link of a few devices known to work. Please contact the hardware maker if there are any difference or link not found.
Rokid UXR2 SDK, please contect the device company for the exact document location.
Xrany SDK (developed and maintained by the device company), please contect the device company for the exact document location.
Attention
Special device SDK version is required when using Pico or XREAL, please read HMD Project Configuration
Make sure device demo works correctly¶
If this is the first time using device SDK in present project, make sure to use its own demo first without EasyAR. Usually these demos require some special project settings, please follow official documents. Physical Camera input demo are provided by many device SDK, like RKCameraPreview from Rokid. EasyAR require input from physical camera. Many other demos does not use physical camera, so the device itself or these samples can work and display contents is not enough to say the device or project is ready for EasyAR.
Tip
EasyAR will display some message in front of camera which will show up if the device SDK is correctly configured. If you see nothing when running EasyAR, it is quite possible the device SDK is not correctly configured and the device demo will fail to run reasonablely. For example, on XREAL, you need to fix all errors showed by menu* NRSDK > Project Tips
in some versions of XREAL SDK. There are similar configurations when using other device SDKs.
Import EasyAR Sense Unity Plugin¶
Use Unity’s Package Manager window to install the plugin from a local tarball file.
Choose the com.easyar.sense-*.tgz
file in the popup dialogue.
Import EasyAR Sense Unity Plugin Extension for the device¶
EasyAR Sense Unity Plugin Extension is requried for some devices. Different extensions should be used when using difference device SDK. Use Unity’s Package Manager window to install the plugin from a local tarball file. Here we list package names for some known extensions,
Apple Vision Pro: built-in in
com.easyar.sense-*.tgz
, no extra extension is neededXREAL SDK: built-in in
com.easyar.sense-*.tgz
, no extra extension is neededPICO: need to import unity package
com.easyar.sense.ext.pico-*.tgz
Rokid: need to import unity package
com.easyar.sense.ext.rokid.uxr-*.tgz
Xrany: need to import unity package, please follow documents provided by the device company
How to Use EasyAR on HMD¶
Create My Own EasyAR HMD Extension¶
Please read How to Create EasyAR HMD Extension