AR Cloud from Magic Leap allows for shared experiences using features such as mapping, localization, and spatial anchors. For Magic Leap 1, all devices used the same cloud offered by Magic Leap. Magic Leap 2 devices using AR Cloud require a Developer Pro or Enterprise license.
Note: OS releases prior to 1.1.0-dev2 are not compatible with AR Cloud 1.7.84 or above. Maps stored in AR Cloud deployments created with OS releases prior to this will not be compatible, and will need to be replaced by new maps.
AR Cloud Overview
AR Cloud is a connected service that allows Magic Leap 2 devices to access large scale spatial data. This spatial data can be managed on the web based console where digital twin administrators create Shared Spaces, manage device-side scans, and merge scans to contribute to larger-scale Spaces. AR Cloud admins are able to import and export spatial maps, manage large-scale digital twin deployments, and monitor Magic Leap 2 device access.
AR Cloud Benefits
AR Cloud allows users to go beyond the limitations of their Magic Leap 2 devices. The following features help enhance a user’s Magic Leap 2 experience:
- Co-present experiences – allows multiple users to experience the same digital content in the same place through shared maps and their spatial anchors.
- Large spatial maps (>10,000m²) – without AR Cloud, each device has a limit of five Local Spaces of ~250m².
- Device access to an unlimited amount of Spaces – Magic Leap 2 devices can gain unlimited access to shared Spaces, as opposed to the 5 stored locally.
Deploying AR Cloud
Setting up Magic Leap AR Cloud is a three step process.
- Review and setup the system requirements.
- Request a secret from Customer Care
- Download from https://developer-docs.magicleap.cloud/docs/guides/arcloud and follow the installation instructions
- Verify your installation.
Note: AR Cloud setup is intended for IT admins.
System Requirements
On-Premise Deployment Requirements
For best results – at this time, we only recommend using Linux.
|
Linux System Requirements |
||
|
|
Minimum |
Recommended |
|
OS Version |
Ubuntu 20.04 |
Ubuntu 20.04 |
|
Container Type |
Kubernetes1.23
|
Kubernetes 1.23
|
|
RAM |
16GB/node |
32GB/node |
|
CPU |
x64 4 Core |
x64 8 Core |
|
GPU |
N/A |
N/A |
|
Storage minimum for service app |
500GB |
1TB |
|
Space required for multiple maps |
500GB |
1TB |
|
Bandwidth up/down |
1 GB Wifi 6 |
1GB Wifi 6 |
Cloud Deployment System Requirements
For best results – at this time, we only recommend using Google Cloud Platform.
|
Google Cloud Platform Requirements |
||
|
|
Minimum |
Recommended |
|
OS Version |
Container Operating System |
Container Operating System |
|
Container Type |
Kubernetes 1.23 Nodes: 3 |
Kubernetes 1.23 Nodes: 8 |
|
RAM |
16GB/node |
32GB/node |
|
CPU |
x64 4 Core |
x64 8 Core |
|
GPU |
N/A |
N/A |
|
Storage minimum for service app |
|
|
|
Cloud bandwidth |
1GB/second |
1GB/second or higher |
|
Network bandwidth |
1GB WiFi 6 |
1GB WiFi 6 |
Using the Enterprise Console
With your Magic Leap Enterprise Console user account, you will gain access and control of the Enterprise Console. Users gain visibility into the status of their system, devices, spaces/scans and services with the Enterprise Console. With access to the enterprise console you are able to:
- Check the status of the system.
- Enroll Magic Leap 2 devices to an AR Cloud instance.
- Manage (add/delete/merge) spaces and the scans they are composed of.
- Control space access on a per device basis.
User Administration
All user account management operations are done through Keycloak. Operations such as adding, deleting, defining users and their roles can be found in their Server Administration Guide.
Creating Accounts
- Download Keycloak at www.keycloak.org
- After the administrator downloads Keycloak and the server is running, the administrator will need to access this link: http://localhost:8080/ in the browser to set up an account.
- The administrator creates a separate account by creating a unique login username and password.
- Refer to Keycloak’s Server Administration Guide for more information regarding account management.
Accessing the Enterprise Console
Login Page
- Go to the URL that was configured during the initial AR Cloud setup.
For example: http://arcloud.example.com - Upon arrival to the page, you will be greeted by a log-in prompt. Here, users are able to enter their Keycloak credentials into the username and password fields.
- After credentials are entered, click ‘Sign In’ to gain access to the Enterprise Console.
Forgot Your Password
- In the event that you forget your password, select the ‘Forgot Password?’ link under the login fields.
- Enter your username or email address and click ‘Submit’.
- You will receive instructions on how to create a new password to your email address.
Your Enterprise Console Dashboard
Initial Dashboard UI
The first time you log in, the Dashboard will appear with a ‘Welcome to your Console’ message. This UI indicates that this is the first time you’ve visited your dashboard. On this initial dashboard, you will find descriptions on some of the areas on the page – providing insight on what the respective section contains.
This is called the initial UI because after you navigate from the dashboard to another page for the first time, it will change. The new dashboard’s UI is similar to the initial one, however, the descriptions will disappear and the layout will slightly condense (see below).
There are 3 sections on the Dashboard: Shared Spaces, Devices, and AR Cloud Status.
1. Shared Spaces
Shared Spaces are cloud-based digital twins made of one or more scans that allow for colocation. The Shared Spaces card shows the number of enabled spaces and the amount of spaces that have auto-merge turned off.
2. Devices
The Devices card shows the number of total devices (connected and disconnected) within the instance. Using the shortcuts on the cards, users are able to ‘Manage’ and ‘Configure’ the devices.
3. AR Cloud Status
The AR Cloud Status card enables users to view the status of the services used by the Enterprise Console.
Users are also able to navigate through the Enterprise Console using the top Navigation Bar:
Enroll Your Device
Magic Leap 2 devices can be added to the instance through configuration.
Navigate to the Configuration page from the Navigation Header or the Dashboard:
Navigation Header > Device Management > Configure
or
Dashboard > Devices > Device Configuration > Configure
After clicking ‘Configure’, you will be directed to the Configuration page. A unique (per instance) QR code will be displayed with instructions on how to configure your device.
Note: QR Codes are blurred out in this article.
There are also options to print the QR code or download it as a PDF in the event that users may want to share the QR code.
Configuring Your Device
To connect your Magic Leap 2 devices to AR Cloud, the user account on the device must first be authorized to use AR Cloud. This is done by logging into AR Cloud from the Magic Leap 2 device. As a prerequisite, you first need to set up the user account in KeyCloak. After configuring AR Cloud using the QR code, a step is required to log in from the Settings app. Review the instructions below for details.
From your Magic Leap 2 device, configure AR Cloud by opening the Settings app:
Settings App > Perception > AR Cloud
The AR Cloud selection will display “Not Configured” if no previous setup exists.
Select the QR code icon then scan the configuration QR code.
If authentication is unsuccessful, please confirm that the device is online and that the credential information entered matches the account information in Keycloak.
If authentication succeeds, the AR Cloud selection will now show as configured. Select the “Login” button to start the authentication process. You will be redirected to the web browser to enter the AR Cloud user credentials created in Keycloak.
Manage Your Device
Navigate to the Devices page from the Navigation Header or the Dashboard:
Navigation Header > Device Management > Devices
or
Dashboard > Devices > Managed devices > Manage
If there are no devices configured, then the Devices page will look like the following:
After you’ve configured a device, the ‘Devices’ page will display information on each device that you’ve added to your instance in a list view. Users will be able to see the serial number, connectivity status, version, build, and last date of connection for each device.
Here’s an example of how the Devices page looks with multiple devices configured:
Next to the ‘Devices’ title, the total number of devices will be displayed. This would be the same number that was displayed on the Dashboard’s Device card under ‘Managed devices.’ Each device will show its Serial Number, whether or not it’s connected, version, build fingerprint, and the last time of connection.
NOTE: A device is considered ‘connected’ if it is connected to the Device Gateway service and the Streaming service. When it connects to both services, we get an updated "Last connected" timestamp which is used to determine the green check. The device needs to be enrolled/powered on to be shown on the Device page. A device can be powered on without being connected to AR Cloud, however, a device cannot be connected if it is powered off.
The build fingerprint (shown as Build) contains information about whether the device build is production signed or an internal build (production signed builds can only run on secure hardware), if the build has security enforcement disabled (allows users to change files on the device), and other useful debug information. The device version and build fingerprint (shown as Build) are mainly used for troubleshooting purposes.
If the user clicks on the “Configure Device” button, then they will be navigated to the Configure page. The user can also access the Configure page through the Device Management dropdown and click “Configure.” An example of the Configure page looks like the following:
The ‘Print’ feature will prompt the user with the following:
Manage Spaces and Scans
To manage your Spaces and Scans, go to the ‘Shared Spaces’ page from the Navigation Header or the Dashboard.
Navigation Header > Shared Spaces
or
Dashboard > Shared Spaces > Manage
If there have been no spaces added, it will look like the following:
Adding a New Space
To add a new Space, click on the ‘+ New Space’ button
Users will then be presented with a dialog box allowing them to name their new Space:
Once a Space has been created, the Shared Spaces page begins to populate in a list format while providing an overview of each Space that is added. The list displays the name of the Space, its ID number, the date it was created, when it was last updated, whether the Space is enabled, and its current status.
The Shared Spaces table is automatically sorted in alphabetical order by the “Name” column. Users can sort by any of the other headers (Date Created, Last Updated, Enabled, Status) by clicking on the column name. To indicate which column the table is being sorted by, there will be an icon of an arrow pointing upwards next to the column title. See below – the table is being sorted by the ‘Date Created’ column.
Each space has an ID number, a name, when it was created, when it was last updated, if it’s enabled, and if auto-merge is on.
Note: If a space is disabled, it will no longer be sent to devices. Users can disable a space using the checkbox.
Users are able to edit the name or delete a Space by utilizing the dotted icon towards the far right of each Space’s row.
By clicking on the triangle icon to the left of each Space’s name, a dropdown will show the Scans within a Space. If there are no scans, then “No scans available” will be displayed in the dropdown:
If scans have been added to a Space, users will be able to see them in the dropdown list. Each Space can only have one active scan, which means the rest of the scans within the Space are considered inactive. Active scans are indicated by the radio button in the ‘Active’ column. Each scan is displayed with a unique scan ID under the scan label (e.g. “Local Space 4506”). The dropdown list also displays additional information such as the date the scan was created and its version. Users are also granted the ability to delete and download scans from this same list view.
Users can set a new active scan for a Space by using the radio button next to the scan name. They will be prompted with this dialog box asking if they want to proceed.
Scans come in the format of “.map”. The .map files are used internally. When a user clicks the download button, they will be presented with an option to choose the type of file to download. Downloading scans can be helpful for users in the possible events of troubleshooting, comparing maps between devices, or import/export operations for 3rd party apps.
Users can merge their scans through the “Enable scans to merge” switch in the scans header.
Note: If the Map Merge feature is disabled, users will not see the “Enable scans to merge” toggle.
System Status
Navigate to the AR Cloud Status page from the Navigation Header or the Dashboard:
Navigation Header > AR Cloud Status
Dashboard > AR Cloud Status > View
The AR Cloud Status Card showcases a preview of the full AR Cloud Status page.
The table shows the 7 services supported by AR Cloud: Space Management, Session Manager, Streaming, Scan Merging, Spatial Anchors, Device Gateway, User Identity. A green checkmark indicates that the service is running correctly. Currently there are no descriptions for each service, but this may be added in the future. For now, this page is used for troubleshooting.
However, if the service is not running correctly, “Not Running” is displayed in the Status column.
The chart also highlights each service’s version. User Identity is the only service without that value, so it reads as N/A.
Users
Navigation Header > Users
The Users link in the Navigation Header directs users to an external site, Keycloak. All user administration operations are managed here.
Support
Navigation Header > Support
Clicking "Support" brings you here, to our Customer Care portal. If you need further assistance with AR Cloud related issues, feel free to reach out to us here.