🎉 New ARwayKit SDK V2.0 launch! Contact us for access! 🎉
FAQ Quick Select
FAQ Documents
Creator Portal
Q: What is the Creator Portal?
The ARWay Creator Portal is an online web platform and editor that can be used to create and manage AR maps associated with different geographic locations, which can then be viewed through the app built with our SDK (ARwayKit).
Q: How does the creator portal work with the ARwayKit SDK?
The Creator Portal helps you in managing large-scale environments like shopping malls, airports, etc. You have access to all your maps, which you can enhance by uploading corresponding floorplans, placing AR content, creating guided tours, and viewing analytics. Manage your accounts and generate API keys to build your AR wayfinding apps through the Creator Portal.
Q: How does the Creator Portal work?
The ARWay Creator Portal is your all-in-one place to manage, edit and track the performance of your maps. It gives you the ability to place content such as 3D models, images, videos, text, navigation paths, guided tours and more remotely through the Studio and be experienced in real life in real time. The data from the creator portal can be accessed through REST API's in simple JSON format.
ARwayKit SDK
Q: What is the ARwayKit SDK?
ARway Software Development Kit (ARwayKit SDK) is an all-in-one set of cross-platform software tools and programs built on Unity that allows developers to leverage ARway’s Visual Positioning System (VPS) capabilities to build AR applications for localization and navigation.
ARwayKit comes with many sample codes to get you started for use cases such as Localization, Navigation, AR Games, Multiplayer and Multi-Maps (for large scale AR experiences), as well as other guiding documentation that developers can use and integrate into their apps. Developers can use ARwayKit to build and maintain maps with AR experiences without having to write everything from scratch.
Q: What is the ARwayKit SDK size?
For Android builds, the ARwayKit dll which contains the library of the ARwayKit functions is < 1MB. On iOS builds, the ARwayKitSDK adds < 200MB. The sample apps for Android and iOS build to about 50MB and 100MB respectively.
iOS and Android -
Q: Do I need to create an account for using ARwayKit?
Yes, you will need to create an account and generate your access token on our Creator Portal in order to develop apps using ARwayKit.
Q: Do I need to create any separate 3rd party accounts?
No 3rd party account is needed. The only account needed is an account in the ARway portal to generate an API Secret Key for your app.
Q: Which version of Unity do I need to use the ARwayKit SDK?
Our Unity SDK is tested with Unity Version 2021.3.1f1 or Above (LTS).
Q: Do I need any specific device to develop apps with ARwayKit?
Yes, you need to have an ARCore or ARKit supported Android or iOS device.
Q: Does the SDK make any API calls (use the Internet)?
Yes. The SDK makes calls to the ARway service to fetch information about the maps and download any assets needed to render the AR experience.
Q: Does the SDK download any external data at runtime?
Like the ARway app, the SDK accesses data from the ARway API service during runtime. While the end user is experiencing a map, the SDK also downloads assets, such as images, audio clips and 3D models as the user encounters them in the map.
Q: What permissions are required by the SDK?
The ARway SDK requires permissions to use the camera and location services on your device. The SDK also requires access to the photo gallery if the user chooses to record video or snapshots of their experience.
Q: What is the minimum version of the OS (iOS and Android) supported by the SDK?
Please refer to Product Spec Sheet below.
ARway App
Q: What is ARway App?
ARway App is a smartphone application available on iOS and android for authoring, sharing, and viewing location-persistent AR experiences and AR Navigation. It is a self-serve solution, and all is done on a smartphone device in a matter of minutes.
Q: How does ARway App work?
ARway App builds upon AI-enabled computer vision for smartphone camera devices to recognize their surroundings and display hyper-accurate location-anchored AR content. No additional hardware or markers are needed.
Q: Is it available for both iOS and Android?
Yes, ARway App is available on ARCore or ARKit supported Android or iOS devices.
Q: How does Localization work?
During Localization, the user sends the camera image(s) to the ARWay cloud service and queries for the user's current Pose (position and rotation) in the previously mapped area, if the process is successful, then in response you get the correct local Pose.
It's important to note that the Pose is local with respect to the previously mapped area and can be converted into Global Pose given an offset.
You can either use this Pose to update your ARCamera transform in your scene or use the inverse of the Pose to update the transform of your AR Content.
Q: How accurate is the Localization?
Localization is accurate to centimetre precision when a QR code or Image Access Point is scanned. After walking some distance after a localization scan, the user may experience ‘drift’ – content and wayfinding moving from actual placement by a few meters depending on the cell phone device.
Please see Product Specifications to see recommended devices to minimize drift.
Accuracy can be increased to centimetre precision again by ‘re-localizing.’ Within the same session, the user can scan another QR code or Image Access Point associated with the map. Additionally, when the device starts to experience ‘drift’ in the session, the user will receive prompts to scan a nearby QR code to restore accuracy.
To maintain a high level of precision of accuracy of AR Content and Map Utilities on a given map, place QR codes and/or Image Access Points at regular intervals of 20-30 m (65.6- 98.4 ft.) to any deviation in location. Each QR code should cover an area between 400-900 m2 (4303.4-9682.6 ft2) to further avoid localization drift.
Please see ARway Mapping Best Practices to minimize drift.
Q: What is ARway App Mapping?
Use the ARway app to generate a unique QR code and place it within your location. Scan the QR code to anchor it to that location and drop location pins around the venue. Save the map and reopen it in the Creator Portal. Once opened in the Creator Portal web Studio, upload a floorplan that corresponds to that location and populate it with AR content like navigation paths, guided tours, 3D models, images, videos, text, audio and more. Once done populating it with your desired content, publish the map to allow your visitors to navigate your venue with it while interacting with the content.
Activating your ARway Map
Q: What are the best practices for mapping?
ARway Mapping Best Practices
Q: Are there any limitations when creating AR maps?
There are no limitations to the size of the map.
Q: How many QR codes do I need to map a venue?
It is recommended to install a QR code every 100 ft or one QR code per 10,000 sqft to ensure accuracy and reduce drift.
Q: How can I share my AR map?
The best way to share maps is through QR codes placed in the location – upon scanning, users will be deeplinked to the map of the facility. AR maps can be shared by sending the link to the map via messenger, email, or social media platforms, which will redirect the recipient to the corresponding application and map. Alternatively, a map can also be shared by sending the map code, which map visitors can type into the search bar in the ARway app or respective white label app.
Q: How do I access a map?
First, make sure you are in the location associated with the AR map. Once in the right location, scan the map QR code with your smartphone camera, which will redirect you to the ARway app - if you don’t have it downloaded, it will prompt you to do so. Then you will rescan the QR code to activate the AR map. Once activated, feel free to search for the location you want to be navigated to in the location directory, while viewing and interacting with AR content in your surroundings.
Q: Do I need to create an account for using ARway App?
As a guest user, you can view AR Maps that were shared with you. To create AR Maps, you will need to create an account within the app.
Q: Can I use the app indoors or outdoors?
You can use the app both indoors and outdoors in optimal lighting conditions.
Q: What are the best practices for Image Access Points?
Image Access Point Best Practices
Q: What is the recommended amount of content (3D models, videos, images) in an area? Users' mobile network bandwidth can be limited, and having multiple pieces of content in one area may cause slow loading times for some objects. To prevent this, it is recommended to have a maximum of 5 pieces of content in a 25 meters squared area.
Q: Is occlusion supported in the app?
Yes, occlusion is supported in both Android and iOS versions of the app. Real-time occlusion in iOS allows virtual objects to be blocked by real-world objects, while app clipping is used in Android to hide virtual objects behind physical objects in the real world.
Q: What types of AR content work with occlusion?
All types of AR content can be occluded, including 3D models, videos, location pins, guided tours, hotspots, audio indicators, and text.
