Simplified doc-site generation
[AGL/documentation.git] / docs / ATTIC / 3_Developer_Guides / 4_X(cross)_Development_System:_User's_Guide / 1_Installing_XDS / 3.4.1.3_AGL_SDKs.md
1 # AGL SDKs
2
3 To build your AGL services or AGL applications using XDS,
4 you must install a Software Development Kit (SDK) that
5 matches your target/board.
6
7 An SDK is a package that includes all the tools you need
8 to cross-build and cross-debug your service or application.
9 You install an SDK by running the SDK Installer.
10
11 You can build an AGL SDK Installer for your board or you can download
12 a pre-built installer.
13
14 This section describes how you can download a pre-built SDK
15 Installer using either the command line or the XDS Dashboard.
16 For information on how to build an SDK Installer, see the
17 "[Download or Build Your SDK Installer](../../../../getting_started/reference/getting-started/app-workflow-sdk.html)"
18 section.
19
20 <!-- section-note -->
21 **NOTES:**
22 - In order to use the command line or the XDS Dashboard
23   to download an SDK Installer, you must
24   have the XDS UI set up in your toolchain (i.e. 'xds-cli').
25   If you did not install 'xds-cli', see the
26   "[Client Part](client-part.html)" section for instruction on how
27   to install XDS UI.
28
29 - See the
30   "[xds-server](../part-2/1_xds-server/0_abstract.html)" chapter
31   for more information on SDK management.
32 <!-- end-section-note -->
33
34 ## Command Line Operations
35
36 This section describes how to download and install an SDK,
37 abort an installation, install an SDK from a local directory,
38 and view all installed SDKs.
39
40 ### Download and Install an SDK Using the Command Line
41
42 Use the following commands to choose and install a pre-built SDK
43 Installer:
44
45 ```bash
46 # List all available SDKs
47 xds-cli sdks ls -a
48
49 List of available SDKs:
50 ID            NAME                                            STATUS          VERSION         ARCH
51 ec15afe0      AGL-release-eel-4.99.4-raspberrypi3             Not Installed   4.99.4          armv7vehf-neon-vfpv4
52 944d2d5a      AGL-snapshots-master-latest-intel-corei7-64     Not Installed   4.99.3+snapshot corei7-64
53 cf3a4365      AGL-release-dab-4.0.2-qemux86-64                Not Installed   4.0.2           corei7-64
54 d65fe750      AGL-release-eel-latest-qemux86-64               Not Installed   4.99.3          corei7-64
55 a0ae663d      poky-agl-corei7-64-3.99.1+snapshot              Installed       3.99.1+snapshot corei7-64
56 87f0400b      AGL-release-dab-3.99.3-m3ulcb-nogfx             Installed       3.99.3          aarch64
57 8c2f2841      AGL-release-dab-4.0.2-dragonboard-410c          Not Installed   4.0.2           aarch64
58 ...
59
60 # Download and Install an SDK
61 xds-cli sdks install d65fe750
62
63 Installation of 'AGL-release-eel-latest-qemux86-64' SDK successfully started.
64 Downloading poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain-4.99.5.sh ...
65 --2018-01-02 11:22:23--  https://download.automotivelinux.org/AGL/release/eel/latest/qemux86-64/deploy/sdk/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain-4.99.5.sh
66 Resolving download.automotivelinux.org (download.automotivelinux.org)... 199.19.213.77
67 Connecting to download.automotivelinux.org (download.automotivelinux.org)|199.19.213.77|:443... connected.
68 HTTP request sent, awaiting response... 200 OK
69 Length: 665996704 (635M) [application/x-sh]
70 Saving to: ‘/tmp/tmp.wuQzLdImCS/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain-4.99.5.sh’
71
72      0K .......... .......... .......... .......... ..........  0% 82,7K 2h11m
73     50K .......... .......... .......... .......... ..........  0% 89,1K 2h6m
74    100K .......... .......... .......... .......... ..........  0% 82,0K 2h8m
75 ...
76  50300K .......... .......... .......... .......... .......... 99% 2,15M 0s
77  650350K .......... .......... .......... .......              100% 4,04M=10m35s
78
79 2018-01-02 12:17:06 (1024 KB/s) - ‘/tmp/tmp.CWyEj3z76Q/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain-4.99.5.sh’ saved [665996704/665996704]
80
81 Automotive Grade Linux SDK installer version 4.99.5
82 ===================================================
83 You are about to install the SDK to "/xdt/sdk/poky-agl/4.99.5/corei7-64". Proceed[Y/n]? Y
84 Extracting SDK....................................................................................................................done
85 Setting it up...done
86 SDK has been successfully set up and is ready to be used.
87 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
88  $ . /xdt/sdk/poky-agl/4.99.5/corei7-64/environment-setup-corei7-64-agl-linux
89
90 SDK ID d65fe750-d3a7-38f5-83d8-3d3806054f8d successfully installed.
91 ```
92
93 ### Abort an Installation that is in Progress
94
95 If for some reason you need to abort an ongoing installation, you can
96 use the `sdks abort` command:
97
98 ```bash
99 xds-cli sdks abort -id d65fe750
100 ```
101
102 ### Install an SDK Using a Local SDK Package or File
103
104 If you have an SDK Installer that is already local to your system,
105 you can use the command line to install it from your local directory:
106
107 ```bash
108 xds-cli sdks install --file $HOME/xds-workspace/sdks/poky-agl-glibc-x86_64-agl-demo-platform-crosssdk-corei7-64-toolchain-4.99.5.sh
109 ```
110
111 <!-- section-note -->
112 **NOTE:**
113 Installation based on a local SDK Installer is only supported when the
114 SDK Installer is in the `$HOME/xds-workspace/sdks` directory.
115 <!-- end-section-note -->
116
117 ### List Installed SDKs
118
119 To list the installed SDKs, use the following command:
120
121 ```bash
122 xds-cli sdks ls
123
124 List of installed SDKs:
125 ID       NAME                                            STATUS          VERSION ARCH
126 e45ac787 AGL-corei7-64-4.99.5+snapshot                   Installed       4.99.5  x86_64
127 d65fe750 AGL-release-eel-latest-qemux86-64               Installed       4.99.3  corei7-64
128 ```
129
130 ## Install an SDK Using the XDS Dashboard
131
132 Follow these steps to locate, download, and install an SDK
133 using the XDS Dashboard:
134
135 1. Open the XDS Dashboard in a Web Browser and select
136    `SDKs` in left-hand menu.
137
138 2. Switch to `SDKs MANAGEMENT` view.
139    Following is an example:
140
141    ![](../part-1/pictures/xds-dashboard-sdks-mgt.png){:: style="margin:auto; display:flex"}
142
143 3. Use filter boxes to find the SDK you want to install.
144
145 4. Click on the "plus" icon in the "Actions" column to
146    start the installation.
147
148    The SDK Installer downloads and the installation process begins.
149    In can take several minutes for the installation to complete.
150    Following is an example of the output:
151
152    ![](../part-1/pictures/xds-dashboard-sdks-install.png){:: style="margin:auto; display:flex"}
153
154 ## Aborting an SDK Installation
155
156 If for some reason you need to abort an ongoing SDK installation,
157 you can do so by clicking the `CANCEL` button.