1. Amber Garage
  2. Public API
  3. HoloKitSDK

Overview

HTTPS SSH

HoloKitSDK v1.0 (iOS Branch)

HoloKitSDK is to build AR apps for HoloKit. Currently, we provide the SDK as Unity package.

For Google Tango, please checkout "tango" branch. For Apple iOS, please checkout "master" branch.

For detailed manual, please see HoloKitSDK Reference Manual.

Prerequists

  • You must be an Apple Developer.
  • An iOS device that supports ARKit and running iOS 11 beta 5.
    • We tested HoloKitSDK with iPhone 7 Plus.
    • See below for guidance on upgrading to iOS 11 beta 5.
  • Unity 2017.1.0f3 or later. Make sure you installed iOS components.
  • XCode 9 Beta 5. You need to log in with your Apple Developer account.

Quick Start

  1. Import "HoloKitSDK" folder under "Assets" folder into a new Unity project.
  2. You might be prompted to switch to iOS platform. If so please go ahead and switch.
  3. Open the example scene "HoloKitSDK/Examples/CubeOnTheFloor".
  4. Open "File" -> "Build Settings" and click "Build".
    • Screenshot
  5. Choose a location to put the XCode project. After the build is done, open "Unity-iPhone.xcodeproj". Make sure you open it with XCode 9 Beta.
  6. In Xcode, change your build target to your actual device.
    • Screenshot
  7. Click "Unity-iPhone" in the file explorer to see its settings, and select the proper Team. If you don't have any Team listed, go to "XCode" -> "Preferences" -> "Accounts" and add your Apple Developer account.
    • Screenshot
  8. Click "Run" to build and launch the example on your device.
  9. If you get build failure regarding code signing, try to understand Launching Your App on Devices. For other problems see Troubleshooting below.
  10. After the app runs, you should see a cube and a sphere floating in the air somewhere. You may gaze at the sphere and it'll turn to red.
    • Sample
  11. The app detects planes, and you may click on the screen to place the cube on the plane.
    • Sample
  12. You may touch the small "C" button to switch to HoloKit mode.
    • Sample

Create your own experience

  1. Create a new scene in Unity.
  2. Drag and drop everything in "HoloKitSDK/StarterPrefabs" to the scene, and delete the default "Main Camera" and "Directional Light".
    • Screenshot
  3. Put anything you like under "HoloKitPlacementRoot", and your model should have a comparable size as "DebugCube". Then feel free to turn off or delete "DebugCube".
    • Screenshot
  4. Build your scene and run!
  5. If you don't like the ambient light, please disable HoloKitAmbientLight in your scene.

How to upgrade to iOS 11 Beta

  1. Backup your device. See "Prepare your device before you update to beta software" section in About iOS beta software
  2. Follow iOS beta Software Installation Guide to install iOS 11 Beta. Briefly,
    1. Use Safari on your iOS device to open https://developer.apple.com and login with your Apple Developer account.
    2. Go to https://developer.apple.com/download and click "Download" button for iOS 11 beta.
      • Screenshot
    3. In the pop-up window, click "Install"
      • Screenshot
    4. After accepting the agreement and restarting your device, you could install iOS 11 Beta from "Settings" -> "General" -> "Software Update".
      • Screenshot

Troubleshooting

  • I don't have an Apple Developer account.
    • You need one.
  • I cannot see any "Team" in my XCode project settings.
    • Make sure "Automatically manage signing" is checked, and you've logged in with your developer account in "XCode" -> "Preferences" -> "Accounts".
  • [WIP]

Attribution

You shall read the How to Attribute section.

App developer shall mark with the words, "Works with HoloKit", or display either of the following two Holokit Logos in your app.

<img src="https://holokit.io/images/HoloKit_Logo1.png" width="250px">

or <img src="https://holokit.io/images/HoloKit_Logo2.png" width="90px">

For academic work, please cite Monocular Visual-Inertial State Estimation for Mobile Augmented Reality, P.Li et al (ISMAR 2017, accepted)