Skip to content

sberdevices/vps-sdk-unity

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo

VPS SDK (Unity3D)

This is Visual Positioning System SDK for Unity3D engine. Main features are:

  • High-precision global user position localization for your AR apps
  • Easy to use public API and prefabs
  • Supports Android and iOS target platforms
  • Integration in ARFoundation (ARCore and ARKit)

For more information visit our page on SmartMarket. If you want access to other VPS locations or want to scan your own property, please contact us at arvrlab@sberbank.ru.

Requirements

  • Unity 2021.1+
  • ARKit or ARCore supported device

Installation

Just clone this repository. Requires installed Git-LFS.

You can also add git URL to the Unity Package Manager UI in your project dependencies:

https://github.com/sberdevices/vps-sdk-unity.git?path=/Assets

Examples

SDK includes an example scene with a basic VPS setup and graphics. Load project in Unity Editor and open Scenes/TestScene.

You can run this scene in Editor or build it on your mobile device.

Usage

Testing your app

When you start VPS in Editor, it loads an image from Mock Provider. You can change this image by selecting VPS/MockData/FakeCamera component in Example scene hierarchy.

You can also enable Mock Mode for device builds. Just toggle Use Mock property in VPS/VPSLocalisationService and rebuild your app.

VPS Settings

You can adjust VPS behaviour by changing public properties in the VPSLocalisationService component:

Property Name Description Default
Start On Awake Should VPS start on Awake or be activated manually. true
Use Mock Use mock provider when VPS service has started. Allows to test VPS in Editor. false
Force Mock in Editor Always use mock provider in Editor, even if UseMock is false . true
Send Only Features Process images with neural network. Mandatory for production-ready apps. true
Send GPS Send user GPS location. Recomended for outdoor locations. true
Default URL URL to your VPS location server. ...
Save Images Localy Save sent images and meta in streaming assets folder (used for debag) false

License

This project is licensed under Sber Public License at-nc-sa v.2.

TensorFlow library is licensed under Apache License 2.0.