Nokia Asha SDK Installation Guide Document created on 19 Mar 2014 Version 1.2.0
About SDK installation This guide describes how to install Nokia Asha SDK 1.2. It also explains how to configure different IDEs (such as Nokia IDE for Java ME (Eclipse), Eclipse, and NetBeans) for Nokia Asha SDK 1.2. Nokia Asha SDK 1.2 is a development tool that enables you to preview how mobile application looks and works when it is deployed to a Nokia mobile handset. The Nokia Asha SDK can be downloaded from the Nokia Developer website. Target audience This guide is intended for developers who want to create and test applications for mobile devices that conform to the Java Runtime for Nokia Asha software platform (1.2.0) family of devices. To know about the devices that conform to Java Runtime for Nokia Asha software platform (1.2.0), refer to Device Specifications at Nokia Developer website. Where to start What do you want to do? I want to know about the system requirements to install the SDK I want to download the SDK. I want to install the SDK I want to integrate the SDK with an IDE I want to learn how to launch the SDK emulator. I want to update or remove the SDK components, or uninstall the SDK. I want to configure Eclipse IDE for the SDK. I want to configure NetBeans IDE for the SDK. Begin here System requirements Downloading SDK Running SDK installer Integrating SDK with an IDE Launching SDK emulator Managing SDK components Configuring Eclipse for SDK Configuring NetBeans for SDK Typographical conventions This help uses the following typographical conventions: Conversion Explanation Code Ph Text that you enter (as opposed to system prompts and responses ) ; for example, file paths, commands, and program code Italic Names of books and documents Bold URL Link New terminology Names of Windows menus, commands, buttons, and icons Active Link About SDK installation 2
Installing SDK System requirements Before installing the SDK, verify that you have the minimum system requirements listed below. With these minimum requirements, you can run the SDK as a standalone application. If you plan to use the SDK within an IDE, make sure you also have the requirements mandated by the IDE. To install the SDK properly, you must have administrator privileges on your computer. Also, be sure to use your normal logon ID (the one you use to run the SDK). At a minimum, you need administrator privileges assigned temporarily for the installation. Hardware requirements The recommended hardware requirements to install and run the SDK as a standalone tool are: PC with a 2.8 GHz Pentium-class processor 4 GB of memory Display monitor capable of displaying 24-bit color at 1280x1024 pixel resolution Approximately 10 GB of free hard disk space Network interface card Sound card If you plan to work with sound (from MIDlets, for example), you need a sound card that has one channel for each SDK instance you run. If you do not have enough channels, SDK instances that you start after you run out of channels do not have sound. Software requirements The software requirements to install and run the SDK as a standalone tool are: Microsoft Windows 7 Professional/Enterprise/Ultimate Service Pack 1 (32/64-bit) - Recommended. Microsoft Windows 8 Pro/Enterprise (32/64-bit). Java SE Development Kit (JDK) 7 or 6 (32 bit). The JDK can be downloaded and installed from java.oracle.com. Note: JDK is required, as an installation of Java Runtime Environment (JRE) can only help to run and not develop Java applications. This release of the Nokia Asha SDK is not tested on Microsoft Surface tablets. Installing SDK 3
Downloading SDK Before installing the SDK, you must first download the SDK installer on your computer from http:// www.developer.nokia.com/develop/java/tools/. This link allows you to download two types of installers: Nokia_Asha_SDK_1_2_installer_em (online installer). Nokia_Asha_SDK_1_2_installer_offline_em (offline installer). The online installer requires an internet connection to download the contents required for installation, while the offline installer does not require an internet connection. Note: The SDK is available from the Nokia Developer website at no cost. If you are not a registered member of Nokia Developer, you need to register (also at no cost) before you can download the SDK. Running SDK installer Before you install the SDK, verify that you have installed the supported applications in the correct order to ensure the applications can find the SDK. For more information refer to Integrating SDK with an IDE. Perform the following steps to install the SDK. 1 Start the installation process by running the executable file Nokia_Asha_SDK_1_2_installer_em.exe for online installation, and Nokia_Asha_SDK_1_2_installer_offline_em.exe for offline installation. In the Welcome page, click Next to begin the Setup Wizard. Installing SDK 4
Note: The online installer requires an internet connection to download the contents required for installation, while the offline installer does not require an internet connection. 2 In the Installation Path page, the default path to install the SDK is displayed. Click Next to continue. Installing SDK 5
Note: The installation path must be <Drive>:\Nokia\Devices\Nokia_Asha_SDK_1_2. Only the <Drive> name is configurable. 3 In the SDK Components page, select the components you want to install, and then click Next. Installing SDK 6
Note: By default, all components are selected. The available components are tabulated below: Component Name Nokia Asha SDK 1.2 Libraries Emulator Nokia IDE for Java ME (Eclipse) v3.1 Description This component installs the complete Nokia Asha Software Development Kit (SDK). This component installs the Nokia Asha software platform Java API libraries, which include supported APIs and Javadocs. This component installs the Nokia Asha software platform emulator, which helps to test and run developed MIDlets on a virtual device. This component installs the Nokia Integrated Development Environment (IDE) for Java Platform, Micro Edition (Java ME) based on Eclipse IDE, which helps to develop MIDlets for Nokia devices. For more information on the benefits of Nokia IDE for Java ME (Eclipse) v3.1, refer to Integrating SDK with an IDE. Note: If you have selected Nokia IDE for Java ME (Eclipse) v3.1, then the Eclipse Documentation gets automatically installed. Installing SDK 7
Component Name Description If Nokia IDE for Java ME (Eclipse) v3.1 is selected, then the Installer does not prompt for the Eclipse IDE integration. You can view the documentation from Nokia IDE for Java ME (Eclipse) v3.1. Nokia Asha On- Device Debugger v1.2 This component installs the Nokia Asha On-Device Debugger, which helps to debug MIDlets on the device. Nokia Plug-ins This component installs the complete Nokia plug-ins, which help to enhance MIDlets. By default, both the library and the documentation are selected for installation. Nokia plug-ins included with this release includes: Nokia LWUIT - for creating rich user interfaces HERE Maps API for Java ME - for building interactive maps Tantalum - for creating concurrent networked applications Nokia In-App Payment - for creating Nokia In-App Payment enabled MIDlets Note: Plug-in documentation depends on the standalone documentation component. By default, the standalone DocBrowser is installed and the plug-in documentation files are copied to the %Root Dir%doc \docbrowser\eclipse\plugins\ folder. Documentation This component installs the complete Nokia Asha SDK documentation. Documentation included with this release includes: Eclipse for integrating documentation with Eclipse IDE Standalone for integrating documentation with DocBrowser Note: By default, the documentation is installed for the standalone DocBrowser. Documentation is also installed for Eclipse IDE, if found installed, during the SDK installation. SDK Manager This component installs the SDK Manager, which helps to update and remove installed components. 4 In the License Agreement page, read the license agreement and accept to continue with the installation. To accept the license agreement, select I have read and accept the license agreement, and then click Next. Installing SDK 8
5 In the Start Menu Shortcuts page, select the Start menu folder where you want to create the program's shortcuts, and then click Next. Installing SDK 9
Note: By default, a new folder Nokia Asha SDK 1.2 is created for the program's shortcuts. 6 In the SDK Installation page, click Install to begin installing the SDK. Installing SDK 10
Installing SDK 11
Note: Click Show Details to show detailed information, and click Hide Details to hide detailed information, during the installation. 7 In the Thank You page, click Finish to complete the setup wizard. Installing SDK 12
Note: In the Thank You page, select View Release notes to view the release notes, and select Launch Nokia IDE for Java ME (Eclipse) v3.1 to run the IDE, after closing the Setup Wizard. By default, both options are selected. Integrating SDK with an IDE In addition to using the SDK as a standalone tool, you can use the SDK within an IDE. Nokia Asha SDK 1.2 has been tested with the following IDEs but may work with other IDEs as well: Nokia IDE for Java ME (Eclipse) v3.1 Eclipse Indigo with Mobile Tools for Java (MTJ) Netbeans 7.0 or Later Nokia Asha SDK 1.2 Installer provides an option to install Nokia IDE for Java ME (Eclipse). Nokia IDE for Java ME (Eclipse) is designed to develop Java applications for Nokia devices based on the Nokia Asha software platform 1.4. It is based on Eclipse Mobile Toolkit for Java (MTJ) and provides the following additional features: Installing SDK 13
Automatically detects and integrates with the Nokia Asha software platform 1.4 SDK installed on your system. Enables you to install Nokia Asha software platform 1.4 SDK on your system using Device SDK Manager feature of the IDE. Provides additional Nokia-specific JAD attributes to manage and describe MIDlets for Nokia devices. To use other IDEs with the SDK, install the applications in the following order: 1 Java SE Development Kit (JDK) 2 IDE For Eclipse, install Eclipse Indigo from http://www.eclipse.org/downloads/ and then install Mobile Toolkit for Java (MTJ) plugin. For NetBeans, install NetBeans from http://www.netbeans.org/downloads/. 3 Nokia Asha SDK For more information, see Configuring your IDE for SDK. Launching SDK emulator You can launch the Nokia Asha SDK 1.2 Emulator directly, or from an IDE. Launching the SDK emulator directly To launch the SDK emulator directly, click Start > All Programs > Nokia Asha SDK 1.2 > Nokia Asha SDK 1.2 Emulator. Launching the SDK emulator from an IDE You must configure some IDEs to recognize the SDK as a supported device before you can launch the SDK emulator from within the IDE interface. For more information on how to configure your IDE for the SDK, refer to Configuring your IDE for SDK. For more information on how to launch the SDK within an IDE, refer to the help of the corresponding IDE: Nokia IDE for Java ME (Eclipse): To launch an SDK emulator from Nokia IDE for Java ME (Eclipse), refer to Nokia IDE for Java ME (Eclipse) v3.1 User Guide > Getting Started > Running a MIDlet in Nokia IDE for Java ME (Eclipse) help. Eclipse: To launch an SDK emulator from Eclipse, refer to Java ME development user guide > Getting Started > Basic tutorial > Running your programs in Eclipse help. Alternatively, see http:// help.eclipse.org/galileo/topic/org.eclipse.mtj.doc.user/html/gettingstarted/run.html. NetBeans: To launch SDK emulator from NetBeans, refer to Java ME Applications > Running MIDP Applications > Running MIDP Applications in NetBeans help. Alternatively, see http://netbeans.org/ kb/docs/javame/quickstart.html. Installing SDK 14
Managing SDK components You can manage SDK components using Nokia Asha SDK Manager. To launch Nokia Asha SDK Manager, click Start > All Programs > Nokia Asha SDK 1.2 > Nokia Asha SDK Manager. Nokia Asha SDK Manager enables you to perform the following: Updating SDK components Perform the following steps to update the SDK components: 1 Click Start > All Programs > Nokia Asha SDK 1.2 > Nokia Asha SDK Manager to launch the SDK Manager. 2 Select Updates to scan the repository for updated components. Note: The SDK Manager requires an Internet connection to check, download, and install updates. By default, all components available for update are selected. Click Collapse/Expand All to expand Managing SDK components 15
or collapse the SDK package-component tree. For individual packages, click Down Arrow to expand and Up Arrow to collapse, the SDK package-component tree. 3 Select components you want to update, and then click Update. Note: The status of the update is shown in the progress bar. For detailed information click Triangle, next to the progress bar, to expand the information view. 4 Click Finish to close the SDK Manager. Managing SDK components 16
Note: Nokia Asha SDK Manager also supports update notifications. When a component is available for update, you are notified about it via a notification. In the notification area, click Nokia Asha SDK Manager notification area icon or Nokia Asha SDK Manager notification, if available, to launch the SDK Manager. Removing SDK components Perform the following steps to remove the SDK components: Managing SDK components 17
1 Click Start > All Programs > Nokia Asha SDK 1.2 > Nokia Asha SDK Manager to launch the SDK Manager. 2 Select Installed to scan the repository for installed components. Note: By default, all components installed on your computer are selected. Click Collapse/Expand All to expand or collapse the SDK package-component tree. For individual packages, click Down Arrow to expand and Up Arrow to collapse, the SDK package-component tree. 3 Clear components you want to remove, and then click Update. Managing SDK components 18
Note: The status of the update is shown in the progress bar. For detailed information click Triangle, next to the progress bar, to expand the information view. 4 Click Finish to close the SDK Manager. Managing SDK components 19
Uninstalling SDK Perform the following steps to uninstall the SDK. 1 Click Start > All Programs > Nokia Asha SDK 1.2 > Nokia Asha SDK Uninstaller to launch the Uninstaller. 2 In the Welcome page, select Uninstall SDK, and then click Next to begin the Setup Wizard. Managing SDK components 20
3 In the SDK Uninstallation page, click Uninstall to begin uninstalling the SDK. Managing SDK components 21
Managing SDK components 22
Note: The installation folder will be deleted completely, including all content in the folder. Click Show Details to show detailed information, and click Hide Details to hide detailed information, during the uninstallation. 4 In the SDK Uninstallation page, click Next to complete the uninstallation. Managing SDK components 23
5 In the Thank You page, click Finish to end the Setup Wizard. Managing SDK components 24
Note: A few files in the installation folder could not be removed. However, you can safely delete them. Managing SDK components 25
What's next? If you plan to work within an IDE, you need to configure the supporting applications to work with the SDK. To prepare an IDE in which to create: MIDlets (Java Application Descriptor (JAD) and Java ARchive (JAR) files) - Games or applications that can be downloaded from the Internet and used on a mobile phone. See Configuring your IDE for SDK. If you have installed the documentation (see Step 3 in Running SDK Installer), click Start > All Programs > Nokia Asha SDK 1.2 > SDK Help to learn about Nokia Asha SDK 1.2. What's next? 26
Configuring your IDE for SDK You can work more efficiently by configuring an IDE to develop a MIDlet and test it on the SDK. Some IDEs automatically detect the SDK as a device. You need to configure other IDEs to recognise the SDK before you can start the SDK from within the application s interface. Note: For more information on installation of IDEs, see the respective IDE documentation. For more information on using the SDK in MIDP development, see Overview under Creating and testing MIDlets in Nokia Asha SDK User Guide. You need to configure the MIDP development applications to use the SDK. For more information, see: Configuring Nokia IDE for Java ME (Eclipse) Nokia IDE for Java ME (Eclipse) v3.1 gets installed with the default installation of Nokia Asha SDK 1.2 (see Step 3 in Running SDK Installer). It automatically detects the Nokia Asha SDKs. Therefore, no configuration is required for Nokia IDE for Java ME (Eclipse). Configuring Eclipse for SDK Download Eclipse IDE from http://www.eclipse.org/downloads. To configure the SDK for Eclipse with Mobile Tools for Java (MTJ): 1 In Eclipse, click Window > Preferences. In the Preferences window, click Java ME > Device Management, and then click Manual Install. Configuring your IDE for SDK 27
2 In the Manual Device Installation window, click Browse to select the folder where you want to search for installed SDKs. Select the required SDK, and click Finish. 3 The selected SDK is now available in the Device Management page. Click OK to complete the configuration. Configuring your IDE for SDK 28
Configuring NetBeans for SDK Download NetBeans IDE from http://www.netbeans.org/downloads/. To configure the SDK for Netbeans with Mobility Pack: 1 In NetBeans, click Tools > Java Platforms. In the Java Platform Manager window, click Add Platform to begin the Add Java Platform wizard. 2 In the Select platform type page, select Java ME MIDP Platform Emulator, and then click Next. Configuring your IDE for SDK 29
3 In the Platform Folders page, select the required version of Nokia Asha SDK, ensure other SDKs are deselected, and then click Next. 4 In the Detected Platforms page, click Next, and then click Finish to end the Add Java Platform wizard. Configuring your IDE for SDK 30
5 The selected SDK is now available in the Java Platform Manager. Click Close to complete the configuration. Configuring your IDE for SDK 31
Developer resources The following documents contain additional information about the SDK: Nokia Asha SDK 1.2 Help Nokia Asha SDK 1.2 Release Notes The Nokia Asha SDK 1.2 Help documents are available at: Nokia Asha SDK 1.2 installation folder (for a default installation, the doc folder is located at C: \Nokia\Devices\Nokia_Asha_SDK_1_2\doc\). Nokia IDE for Java ME (Eclipse) v3.1 from Help > Help Contents. Nokia Asha SDK 1.2 Emulator from Help > SDK Help. Start menu from Start > All Programs > Nokia Asha SDK 1.2 > SDK Help. Additional documents about this product and related technologies may also be available at Nokia Developer website. Developer resources 32
Discussion about this resource You can provide feedback, comments, and suggestions about the SDK to Nokia and other SDK users using the Nokia Developer Discussion Boards: http://www.developer.nokia.com/community/ Discussion/. Discussion about this resource 33