Set-up the Qcomm AR Development Environment

8/9/2019 Set-up the Qcomm AR Development Environment

1/26

Step 1: Set-up the Development Environment

Supported Development Platforms

The QCAR SDK supports Android OS 2.1 and above.

The recommended development environment is Microsot !indo"s # $2%&'bit or !indo"s

().

The components to build the actual code *+DK, -clipseADT and /cc0 are available across

multiple platorms. !hile buildin/ on inu 3buntu and MacOS( environments is possible, "e

"ill be unable to support those platorms "ith detailed documentation. 4o"ever, "e have

included hints and notes to platorm speciic issues that "ill help 5ou set up 5our development

environment on inu 3buntu 16.6' or MacOS( 16.&. This set7up /uide has been "ritten or

the !in# $2%&'bit platorm "ith special notes or !in().

NOTE8 9 5ou alread5 have both the Android SDK and the :DK setup, then please /o directl5

to Step 28 9nstall the QCAR SDK.

Setup the Android Development Environment

The QCAR SDK re;uires both the Android SDK and the :DK. The Android :DK is an

etension to the Android SDK that lets Android developers build perormance7critical parts o

their applications in native code. SDK and :DK communicate over the +ava7:ative79nterace

*+:90.

To set7up the development environment please install the ollo"in/ components in the order

the5 appear belo"8

1. +ava Development Kit *+DK0

2. -clipse 9D-

$. Android SDK Do"nloader

'. Android ADT pac


2/26

&. C5/"in

#. Android :DK

Step 2: Install the QA! SD"

lean Installation

QCAR SDK is distributed usin/ installers or the ollo"in/ platorms8 !indo"s, Mac OS (,

and inu.

To start developin/ "ith the QCAR SDK 5ou "ill need to,

Do"nload > 9nstall QCAR7SDK under .

Ad?ust QCAR -nvironment settin/s in -clipse.

Ater acceptin/ the license a/reements the installer creates a director5 structure in 5our

Android development environment. This structure "ill ensure that sample apps can be easil5

built and deplo5ed usin/ the Android :DK and the -clipse +ava developer environment.

#p$radin$ from a Previous %ersion

!hen installin/ an updated version o the QCAR SDK, "e su//est that 5ou install it under a

ne" director5 tree, ?ust as the installer recommends. To compile the ne" set o sample

applications it is re;uired to ad?ust the -clipse "or


3/26

9n the previous steps "e used a startin/ director5 or the SDK and the :DK installation that

"e called

= C:\Development\Android.

The do"nloaded installer creates a director5 structure that "ill inte/rate into 5our Android

development environment. @ollo"in/ the recommended installation location the development

environment should inall5 result in the structure belo". 4ere 7557 and .55. stand or

the version number o the QCAR SDK.

Do(nload SD"

Platform Pa&)a$e *ast #pdated

!indo"s +&ar-sd)-,1,,e.e 1#7Dec72616

Mac +&ar-sd)-,1,,/ip 1#7Dec72616

inu +&ar-sd)-,1,,0in 1#7Dec72616

@ollo" the instructions in Bet Started to set7up5our development environment, install the

QCAR7SDK, and run > compile5our irst sample app.

QA! v,1,, ETA2 !elease Notes:

u$fi.es 3 4eatures

Added support or multi7ima/e tar/et reconi/uration *add % remove % reconi/ure parts

on the l50

Added support or virtual button reconi/uration *add % remove % reconi/ure buttons

on the l50

3pdated eistin/ sample applications

Added dialo/ boes to displa5 QCAR initialiation errors

Removed Shared librar5 and moved shared code into individual sample apps to

create independent stand7alone pro?ects

"no(n issues
https://ar.qualcomm.com/qdevnet/sdk/download/NFT/windows/qcar-sdk-0.10.0.exehttps://ar.qualcomm.com/qdevnet/sdk/download/NFT/mac/qcar-sdk-0.10.0.ziphttps://ar.qualcomm.com/qdevnet/sdk/download/NFT/linux/qcar-sdk-0.10.0.binhttps://ar.qualcomm.com/qdevnet/sdk/1043https://ar.qualcomm.com/qdevnet/sdk/311https://ar.qualcomm.com/qdevnet/sdk/372https://ar.qualcomm.com/qdevnet/sdk/376https://ar.qualcomm.com/qdevnet/sdk/download/NFT/windows/qcar-sdk-0.10.0.exehttps://ar.qualcomm.com/qdevnet/sdk/download/NFT/mac/qcar-sdk-0.10.0.ziphttps://ar.qualcomm.com/qdevnet/sdk/download/NFT/linux/qcar-sdk-0.10.0.binhttps://ar.qualcomm.com/qdevnet/sdk/1043https://ar.qualcomm.com/qdevnet/sdk/311https://ar.qualcomm.com/qdevnet/sdk/372https://ar.qualcomm.com/qdevnet/sdk/376


4/26

Rare application reee and C)3 ma5 be pe//ed issue has been observed on

@ro5o. This has been observed b5 others "or


5/26

a##et#\ Additional assets re;uired to use QCAR SDK

readme2t't Startin/ read7me document

relea#enote#

''2((2))2pd3

atest SDK release notes

Step 5: ompile 6 !un a QA! Sample App

!e are no" /oin/ to build a sample application included in the QCAR SDK pac


6/26

7D"

Do"nload the 7ava SE Development "it 8*+DK0 7 currentl5 version +DK & 3pdate 2$ 7 rom

the ollo"in/ site8

http8%%""".oracle.com%technet"or


7/26

inormation is t5picall5 stored in the userHs home director5, "hich is the deault value here8

C:\Do&+ment# and 5ettin.#\65ERNAME\$or!#pa&e. Chec< 3se this as the deault

and do not as< a/ain.

;IN8


8/26

C:\Development\Android\android#d!$indo$#\tool#\

NOTE8 The last \ at the end o the Pat1variable has to be included.

Android ADT installation in the net step "ill use this path to identi5 the Android development

environment.

Trou0leshootin$

@or troubleshootin/ Android related issues and or more detailed instructions on the Android

SDK set7up, please reer to the ollo"in/8

Quic< Start Android SDKset7up

9nstallin/ the Android SDK.

9A8 3pdate pat1variable to point to the 4ma!e4utilit5 and the Android SDK tools

director5. Add the ollo"in/ to the 76#er#772tr& 8

#et pat1 = pat1 7Developer7+#r7*in 76#er#77Development7Android7android#d!ma&_'?97tool# @

Android ADT

Android Development Tools *ADT0 is a po"erul etension to -clipse that connects it "ith the

Android SDK and helps "ith app development. This pac


9/26

Eclipse component selection

Ater revie"in/ this selection and acceptin/ the license terms, the do"nloader etches the

iles and puts them in 5our -clipse director5. Ater acceptin/ the certiicate and an automatic

restart o -clipse, the installation o the Android ADT is complete.

Android SD" Platform Support


10/26

To develop or Android, support or the appropriate Android platorm must be installed. The

Android SD" and A%D 9ana$eris used to install additional components and support or

dierent platorms. There are t"o methods to invo


11/26

Android SDK component selection

To install the selected options 5ou must hit -n#tall 5ele&tedand accept all licenses on

the net "indo". 3se A&&ept All as a shortcut and hit -n#tall.


12/26

Android component license acceptance

The -clipse environment is no" read5 or Android development.

'$(in Environment

9A3*IN#=8 This section is not relevant or Mac and inu users.

A B:3 compiler is re;uired to compile d5namic applications as shared libraries or the

Android :DK. Android ma!eiles are desi/ned to run "ith .&&. On !indo"s, a convenient

"a5 to have the complete environment prepared or this, is to install C(.$in7 currentl5

version 1.#.#.

C(.$inuses an installer helper to mana/e the installation process. Bo tohttp8%%""".c5/"in.com% and select -n#tall or +pdate no$F belo" the introduction, or

use the direct lin


13/26

same director5 so as to have a C5/"in installer director5. Choose a do"nload site "ith a

Gma!e: T1e N6 ver#ion o3 t1e 4ma!e4 +tilit(G

Select the "ord #!ip to chan/e it to the actual version number, "hich is currentl5 $.N172.

@inish the installation b5 clic


14/26

the director5 to the end o the path, separated via semicolon rom the one beore. 9n the

above eample, 5ou "ould have to add8

C:\Development\Android\androidnd!r"\

NOTE8 )ath has semicolon at the be/innin/. Do not use pathnames (ith spa&es

Alternativel5, 5ou can also set a 6#er varia*le"ith the name Pat1, but this is onl5 valid

or the current user. The last \ at the end o the Pat1variable has to be included.

To test 5our installation 5ou can compile an5 o the :DK sample applications. 3sin/ a C5/"in

bash shell, navi/ate to the root director5 o an5 demo application *e./. or the Hsan7an/elesH

sample app "ith out installation path above08

&d 7&(.drive7&7Development7Android7androidnd!r"7#ample#7#an

an.ele#

nd!*+ild

The compiler should produce a d5namicall5 lin


15/26

Do(nload

QCAR SDK is distributed throu/h the Qualcomm Au/mented Realit5 Developer )latormsite.

@ollo" the instructions belo" to access the installer.

NOTE8 Althou/h "e distribute installers or the platorms listed belo", support or QCAR SDK

development is limited to the !in # $2%&' bit platorm.

Installation on ;indo(s

Althou/h "e recommend that 5ou develop on !indo"s # $2%&'bit or !indo"s (), the QCAR

SDK has also been successull5 run on !indo"s () &'bit environments. 4o"ever, "e

currentl5 do not oer speciic support or this platorms.

1. Do"nload installer -(-7ile rom the Do"nload SDK pa/e.

2. Run installer

Installation on 9a& OS =

9nstallation has been tested on Ma OS ( 16.&.

1. Do"nload archive ile rom the Do"nload SDK pa/e.

2. 3narchive and run installer

Installin$ on *inu.

9nstallation has been tested on 3buntu 16.'.

1. Re;uires +M to be installed

2. Do"nload the installer ile rom the Do"nload SDK pa/e.

$. Open terminal "indo" and chan/e director5 to the installer ile location

'. -ecute the installer ile on the command line

Set the QA! Environment %aria0le
http://ar.qualcomm.com/http://ar.qualcomm.com/


16/26

Our recommended director5 structure allo"s or SDK up/rades independent o application

development. Iour uture AR pro?ects "ill be in the recommended structure under

. One "or


17/26

On the phone, /o to 5ettin.#>Appli&ation# and choose 6n!no$n #o+r&e# as

sho"n belo". Accept the "arnin/ sho"n on the ri/ht. This settin/ allo"s the direct installation

o unsi/ned A)Ks rom "ithin -clipse.

Allowing unknown sources for software installation

Bo to the Development dialo/ on the above screen and choose the t"o settin/s as sho"n

belo"8


18/26

USB debugging is mandatory. The stay awake setting will help with deelopment.

Install the #S Driver

Connect 5our phone to the development )C via the 3SG cable.

On the irst connection, !indo"s "ill reco/nie the phone as a ne" device and as< or a

driver. The Android SDK alread5 includes the appropriate 3SG drivers 7 compatible "ith

:eus One. 9n the !indo"s device driver dialo/, select manual install "ithout 9nternet

connection and bro"se to the ollo"in/ director5

\android#d!$indo$#\+#*_driver

!hen the device installation inishes 5ou are read5 to use 5our test device.

On some machines the 3SG driver installation "ill as< 5ou to reboot the machine. Iou can

s


19/26

NOTE8 The 3SG driver in the Android SDK "ill not support the 4TC erion 9ncredible and

the 4TC Desire. Iou should contact the phone manuacturer to /et the correct 3SG driver.

*IN#=8 Adb does not reco/nie the :eus One phone correctl5, coni/uration must be

chan/ed. To do this ollo" the steps belo"

#+do vi 7et&7+dev7r+le#2d7Jandroid2r+le#

and add the ollo"in/ lines8

5605K5TEM==G+#*+#*_devi&eG 5K5/5idVendor==G8?d8G

MODE=G999G RO6P=Gpl+.devG 5605K5TEM==G+#*+#*_devi&eG

ATTRidVendor==G8?d8G ATTRidProd+&t==Ge8;G

5KML-N=Gandroid_ad*G 5605K5TEM==G+#*+#*_devi&eG

ATTRidVendor==G**G ATTRidProd+&t==G333G

5KML-N=Gandroid_3a#t*ootG

Then call8

#+do re#tart +dev

ompile the Shared O0>e&t

ompile the Shared O0>e&t (ith Appli&ation

ode

Android :DK applications are deplo5ed as shared ob?ects "ith a +ava bootloader. 9n this step

"e create the binar5 Q2#oile that is later pac


20/26

nd!*+ild

d*#erver : armea*i22S 7&(.drive7&7Development7Android7%&ar#d!''(())7

#ample#7-ma.eTar.et#7li*#7armea*i7.d*#erver

d*#et+p : 7&(.drive7&7Development7Android7%&ar#d!''(())7

#ample#7-ma.eTar.et#7li*#7armea*i7.d*2#et+p

d*#et+p : #o+r&e dire&tor( 7&(.drive7&7Development7Android7%&ar#d!''(())7

#ample#7-ma.eTar.et#7,ni

d*#erver : armea*i22S 7&(.drive7&7Development7Android7%&ar#d!''(())7

#ample#7-ma.eTar.et#7li*#7armea*iva7.d*#erver

d*#et+p : 7&(.drive7&7Development7Android7%&ar#d!''(())7

#ample#7-ma.eTar.et#7li*#7armea*iva7.d*2#et+p

d*#et+p : #o+r&e dire&tor( 7&(.drive7&7Development7Android7%&ar#d!''(())7

#ample#7-ma.eTar.et#7,ni

Compile arm : -ma.eTar.et# 7&(.drive7&7Development7Android7%&ar#d!''(())7

#ample#7-ma.eTar.et#7li*#7armea*i

Compile arm : -ma.eTar.et# 7&(.drive7&7Development7Android7%&ar#d!''(())7

#ample#7-ma.eTar.et#7li*#7armea*iva

!e are no" read5 to compile the +ava bootloader and deplo5 the application.

9A3*IN#=8 To overcome a


21/26


22/26

Eclipse !"ew Android #ro$ect! panel

The standard installation o -clipse has automatic compilation turned on. The ver5 irst time

5ou compile the app, 5ou ma5 receive some error messa/es rom -clipse. Pro,e&t

>Clean222>Clean All Pro,e&t#should i these errors as -clipse has to build some

standard directories. This also creates the A)K pac


23/26

The samples include a script ile that copies the QCAR shared libraries to the sample

director5 or the pac


24/26

chips 9ma/e Tar/et

Deplo' 6 !un the Appli&ation

!ith the phone connected, select the 9ma/eTar/ets pro?ect rom the )acR+n rom menu. Select Android Appli&ationrom the R+n

A#"indo".

-clipse automaticall5 pac


25/26

%ou hae successfully deployed your first application with the &'A()SDK*

Ater a splash screen the live camera ima/e is sho"n. 3se 5our phone to loo< at the printed

tar/et. Iou should see a tetured teapot centered on top o the tar/et, re/istered to the plane.

The -ma.eTar.et#app sho"s ho" the SDK can detect and trac< a sin/le ima/e rom a

pre7deined set o ima/es. !ith a small code chan/e, it can also be compiled to detect and

trac< multiple ima/es simultaneousl5. Chec< the Tips > Tric


26/26

Set-up the Qcomm AR Development Environment

Documents

Transcript of Set-up the Qcomm AR Development Environment