stevenfour/OculusSdk · Datasets at Hugging Face

text stringlengths 0 1.11k
The platform for which this article is written (Unity) does not match your preferred platform (Nativa).
Click here to view the version of this page for your preferred platform.

See also Tips for Using Spatial Anchors.

This topic provides troubleshooting tips for a variety of common situations known to affect Shared Spatial Anchors for the Meta Quest OS.

Prerequisites

Shared Spatial Anchors is available for Meta Quest Pro on v47 or higher, and Meta Quest 2 on v49 or higher. Most of the issues on this page require device logs to diagnose. Refer to Set up your environment for using adb logcat to retrieve logs.

Common Troubleshooting Scenarios

This section lists several scenarios that you may encounter during development. It briefly explains the cause and provides the resolution to fix the issue.

Ensuring Share Point Cloud Data is enabled

The device setting ‘Share Point Cloud Data’ must be enabled for Shared Spatial Anchors to function. Users can find it under Settings > Privacy > Device Permissions > Share Point Cloud Data.

Your app can detect when this setting is disabled and inform users to turn it on. Your app will receive the error code

OVRSpatialAnchor.OperationResult.Failure_SpaceCloudStorageDisabled

upon sharing an SSA or saving an SSA to the cloud when this setting is disabled. Your app should check for this error and inform users that enabling Share Point Cloud Data is required for SSA to function in your experience.

Inability to Load and Locate a Spatial Anchor

There are a couple of instances when the system cannot locate a previously stored spatial anchor:

It does not recognize the space the user is in.
When attempting to load an anchor from storage location Cloud, verify the Share Point Cloud Data setting is enabled.
To recover from this, you need to either:

reconstruct the scene, by having the user place the content where it belongs, or have the user walk to known locations to help the system recover the content.
in the case of Shared Spatial Anchors, inform users to turn on Share Point Cloud Data.
Your App is Untrusted

Operations on Persisted Anchors fail indicating package is not trusted.

When accessing local or shared spatial anchors, we verify the identity of the application requesting access to persisted Spatial Anchors. Because this verification uses information registered in the Store, your application will not be able to persist or share Spatial Anchors until you register your app on dashboard.oculus.com.

If you are encountering this issue, the logs will contain the message: Package <your application’s package ID> is not trusted, status: <error code>, sessionUuid: <id>"

Resolution

Navigate to dashboard.oculus.com.
Click “Create New App” under your developer organization.
Choose either “Quest (Store)” or “Quest (App Lab)”. (If you will use Meta Quest Link to run the app from your PC, repeat these steps to also create a Rift app.)
Navigate to “Data Use Checkup” (from the left panel) and request access to the “User ID” and “User Profile” platform features.
Navigate to “API” (from the left panel) and note the “App ID”.
In your Unity project, navigate to Oculus / Platform / Edit Settings.
Specify the Quest “App Id” from above as “Oculus Go/Quest”.
If you want to test with Meta Quest Link, specify the Rift “App Id” as “Oculus Rift”.
Put the headset in the developer mode.
Make sure you are logged in as a developer or with a test account from the developer organization that owns the application you are developing.
Anchor Download Fails

Client fails to download the specified anchors. Common reasons that lead to this error are:

The anchors do not exist on the cloud, or the user attempting to download the anchors does not have access to the anchors.
The anchors were downloaded, but the device was unable to localize itself into the point cloud received from the sharing device, because the user has not observed enough of the environment.
To determine which issue you are hitting, look for the following messages in the log.

If you see any of these messages, the download step itself has failed:
xr_cloud_anchor_service: Downloaded 0 anchors
xr_cloud_anchor_service: Failed to download Map for spatial anchors
xr_cloud_anchor_service: Failed to download spatial anchor with error:
If the log from log channel, SlamAnchorRuntimeIpcServer, contains the message below, it means the user was able to download the anchors, but the device was unable to localize itself in the spatial data received from the sharing device. You may see the error code OVRSpatialAnchor.OperationResult.Failure_SpaceMappingInsufficient and a message Import task failed with code: <error> message: <message>.
If you see the error code OVRSpatialAnchor.OperationResult.Failure_SpaceNetworkRequestFailed or OVRSpatialAnchor.OperationResult.Failure_SpaceNetworkTimeout, it means there was a network issue connecting to the cloud. Make sure your device wi-fi connection is working and try again.
Resolution

The following are common reasons why anchors may not be present in the cloud, or the user may not have access, causing the download to fail:

The map/anchors have expired. There is Time to Live (TTL) for any anchor that is uploaded to the cloud. After the TTL expires, the anchor is erased from the cloud.
The Spatial Anchor was not successfully uploaded to the cloud.
The intended recipient of the anchor does not have access. The sender may not have shared the anchor, or the share operation may have failed.
The device is not connected to the network. Make sure your device wi-fi is working and try again.
To resolve this issue, the sender of the anchor needs to upload and share the anchor again by following these steps:

Create a new anchor with new UUID, save and share again.
Confirm the upload was successful by searching for the following messages in logcat: xr_cloud_anchor_service: Successfully uploaded spatial anchors: and xr_cloud_anchor_service: UUID: <some uuid> If the upload was not successful, follow the troubleshooting steps from the Anchor upload fails.
Confirm sharing was successful by searching for following message in logcat: xr_cloud_anchor_service: Share spatial anchor success. If the sharing was not successful, follow the troubleshooting steps from the Anchor sharing fails section.
Anchor Upload Fails

The Spatial Anchors are failing to upload. Search for the following messages to identify the mode of failure: xr_cloud_anchor_service: Number of anchors uploaded did not match number of anchors returned and xr_cloud_anchor_service: Failed to upload spatial anchor with error <error>. The error messages indicate that the upload of Spatial Anchors to the cloud has failed. A common reason is that an internal service issue is encountered, such as resource limits or the endpoint being unavailable.

Resolution

Check the actual error description for details on why the operation failed. If the error description indicates an issue with the Spatial Anchor itself, try creating and uploading a new Spatial Anchor.

Anchor Sharing Fails

Sharing Spatial Anchors with other users fails. This can be due to a few reasons:

The specified user ID does not exist, or is not valid
The Spatial Anchor was not uploaded to the cloud
The first step to debugging issues with sharing is to check the result codes returned by the Share() functions. See below for possible causes and mitigations for several common error conditions.

To further diagnose this issue, search for the following message in logs: xr_cloud_anchor_service: Failed to share spatial anchor with error <error from cloud>.

The platform for which this article is written (Unity) does not match your preferred platform (Nativa).

Click here to view the version of this page for your preferred platform.

See also Tips for Using Spatial Anchors.

This topic provides troubleshooting tips for a variety of common situations known to affect Shared Spatial Anchors for the Meta Quest OS.

Prerequisites

Shared Spatial Anchors is available for Meta Quest Pro on v47 or higher, and Meta Quest 2 on v49 or higher. Most of the issues on this page require device logs to diagnose. Refer to Set up your environment for using adb logcat to retrieve logs.

Common Troubleshooting Scenarios

This section lists several scenarios that you may encounter during development. It briefly explains the cause and provides the resolution to fix the issue.

Ensuring Share Point Cloud Data is enabled

The device setting ‘Share Point Cloud Data’ must be enabled for Shared Spatial Anchors to function. Users can find it under Settings > Privacy > Device Permissions > Share Point Cloud Data.

Your app can detect when this setting is disabled and inform users to turn it on. Your app will receive the error code

OVRSpatialAnchor.OperationResult.Failure_SpaceCloudStorageDisabled

upon sharing an SSA or saving an SSA to the cloud when this setting is disabled. Your app should check for this error and inform users that enabling Share Point Cloud Data is required for SSA to function in your experience.

Inability to Load and Locate a Spatial Anchor

There are a couple of instances when the system cannot locate a previously stored spatial anchor:

It does not recognize the space the user is in.

When attempting to load an anchor from storage location Cloud, verify the Share Point Cloud Data setting is enabled.

To recover from this, you need to either:

reconstruct the scene, by having the user place the content where it belongs, or have the user walk to known locations to help the system recover the content.

in the case of Shared Spatial Anchors, inform users to turn on Share Point Cloud Data.

Your App is Untrusted

Operations on Persisted Anchors fail indicating package is not trusted.

When accessing local or shared spatial anchors, we verify the identity of the application requesting access to persisted Spatial Anchors. Because this verification uses information registered in the Store, your application will not be able to persist or share Spatial Anchors until you register your app on dashboard.oculus.com.

If you are encountering this issue, the logs will contain the message: Package <your application’s package ID> is not trusted, status: <error code>, sessionUuid: <id>"

Resolution

Navigate to dashboard.oculus.com.

Click “Create New App” under your developer organization.

Choose either “Quest (Store)” or “Quest (App Lab)”. (If you will use Meta Quest Link to run the app from your PC, repeat these steps to also create a Rift app.)

Navigate to “Data Use Checkup” (from the left panel) and request access to the “User ID” and “User Profile” platform features.

Navigate to “API” (from the left panel) and note the “App ID”.

In your Unity project, navigate to Oculus / Platform / Edit Settings.

Specify the Quest “App Id” from above as “Oculus Go/Quest”.

If you want to test with Meta Quest Link, specify the Rift “App Id” as “Oculus Rift”.

Put the headset in the developer mode.

Make sure you are logged in as a developer or with a test account from the developer organization that owns the application you are developing.

Anchor Download Fails

Client fails to download the specified anchors. Common reasons that lead to this error are:

The anchors do not exist on the cloud, or the user attempting to download the anchors does not have access to the anchors.

The anchors were downloaded, but the device was unable to localize itself into the point cloud received from the sharing device, because the user has not observed enough of the environment.

To determine which issue you are hitting, look for the following messages in the log.

If you see any of these messages, the download step itself has failed:

xr_cloud_anchor_service: Downloaded 0 anchors

xr_cloud_anchor_service: Failed to download Map for spatial anchors

xr_cloud_anchor_service: Failed to download spatial anchor with error:

If the log from log channel, SlamAnchorRuntimeIpcServer, contains the message below, it means the user was able to download the anchors, but the device was unable to localize itself in the spatial data received from the sharing device. You may see the error code OVRSpatialAnchor.OperationResult.Failure_SpaceMappingInsufficient and a message Import task failed with code: <error> message: <message>.

If you see the error code OVRSpatialAnchor.OperationResult.Failure_SpaceNetworkRequestFailed or OVRSpatialAnchor.OperationResult.Failure_SpaceNetworkTimeout, it means there was a network issue connecting to the cloud. Make sure your device wi-fi connection is working and try again.

Resolution

The following are common reasons why anchors may not be present in the cloud, or the user may not have access, causing the download to fail:

The map/anchors have expired. There is Time to Live (TTL) for any anchor that is uploaded to the cloud. After the TTL expires, the anchor is erased from the cloud.

The Spatial Anchor was not successfully uploaded to the cloud.

The intended recipient of the anchor does not have access. The sender may not have shared the anchor, or the share operation may have failed.

The device is not connected to the network. Make sure your device wi-fi is working and try again.

To resolve this issue, the sender of the anchor needs to upload and share the anchor again by following these steps:

Create a new anchor with new UUID, save and share again.

Confirm the upload was successful by searching for the following messages in logcat: xr_cloud_anchor_service: Successfully uploaded spatial anchors: and xr_cloud_anchor_service: UUID: <some uuid> If the upload was not successful, follow the troubleshooting steps from the Anchor upload fails.

Confirm sharing was successful by searching for following message in logcat: xr_cloud_anchor_service: Share spatial anchor success. If the sharing was not successful, follow the troubleshooting steps from the Anchor sharing fails section.

Anchor Upload Fails

The Spatial Anchors are failing to upload. Search for the following messages to identify the mode of failure: xr_cloud_anchor_service: Number of anchors uploaded did not match number of anchors returned and xr_cloud_anchor_service: Failed to upload spatial anchor with error <error>. The error messages indicate that the upload of Spatial Anchors to the cloud has failed. A common reason is that an internal service issue is encountered, such as resource limits or the endpoint being unavailable.

Resolution

Check the actual error description for details on why the operation failed. If the error description indicates an issue with the Spatial Anchor itself, try creating and uploading a new Spatial Anchor.

Anchor Sharing Fails

Sharing Spatial Anchors with other users fails. This can be due to a few reasons:

The specified user ID does not exist, or is not valid

The Spatial Anchor was not uploaded to the cloud

The first step to debugging issues with sharing is to check the result codes returned by the Share() functions. See below for possible causes and mitigations for several common error conditions.

To further diagnose this issue, search for the following message in logs: xr_cloud_anchor_service: Failed to share spatial anchor with error <error from cloud>.