View source for Documentation/Maemo Eclipse Tutorial/Installation Methods


= Installation Methods =

= PC Connectivity =

In order to communicate with your Maemo device, a set of daemons and utilities needs to be installed to the host PC and Maemo device.

Find the complete description and installation instructions on the [http://pc-connectivity.garage.maemo.org/ PC Connectivity project web site] and ''Maemo PC Connectivity Tutorial'' <ref name=r2>Maemo PC Connectivity Tutorial. http://library.maemodocs.nokia.com</ref>.

== Maemo PC Connectivity ==

On the Maemo device, you need the other half of PC Connectivity, Maemo PC Connectivity, containing the servers that match the clients installed on the host PC side with Host PC Connectivity. The Maemo PC Connectivity requires either Diablo or Fremantle based Maemo device (N800, N810 or N900).

{|
|-
| [[Image:dialog-information.png]]
| '''Note:'''  You can update your Maemo device operating system using the '''File &gt; New &gt; Other &gt; Maemo Installers &gt; Flash Images to Device''' Eclipse IDE wizard or Maemo Flasher-3.5 command line tool.
|}

Install the Maemo PC Connectivity on the Mameo device before installing Maemo ESbox or PluThon Eclipse IDE environments.

== Host PC Connectivity ==

Host PC Connectivity provides host-side software, like SSH and SBRSH clients, Rsync, FTP client, and the TightVNC viewer. These are packaged together conveniently for installation on Linux, Windows, and Mac OS X Intel.

Install the Host PC Connectivity on the host PC before installing Maemo ESbox or PluThon Eclipse IDE environments.

= Installation via Product Archives =

The Product Archives come in two parts: a common archive, containing the bulk of the installation, and an OS-specific archive. If your host OS is not represented, please use Maemo update sites installation for the best results.

The distributed archives can be extracted anywhere on your system to provide a full Eclipse Ganymede SR2 environment with ESbox or PluThon and all its dependencies pre-installed.

The installation from product archives is upgradeable to new versions using Maemo Update Site.

== Product Archives ==

For ESbox download archives from [https://garage.maemo.org/frs/?group_id=192 ESbox Garage project download] page.

For PluThon download archives from [https://garage.maemo.org/frs/?group_id=247 PluThon Garage project download] page.

=== Linux/x86 ===

ESbox archives:

* <span><font face="monospace">esbox_2.0.0-R20091216-common.zip</font></span>
* <span><font face="monospace">esbox_2.0.0-R20091216-linux.gtk.x86.zip</font></span>

PluThon archives:

* <span><font face="monospace">pluthon_2.0.0-R20091216-common.zip</font></span>
* <span><font face="monospace">pluthon_2.0.0-R20091216-linux.gtk.x86.zip</font></span>

{|
|-
| [[Image:dialog-information.png]]
| '''Note:'''  In Ubuntu 9.10, Fedora 11, or other platforms using GTK+ 2.18 and/or Mozilla xulrunner 1.19, you must launch ESbox with the script <span><font face="monospace">esbox.sh</font></span> and PluThon with the script <span><font face="monospace">pluthon.sh</font></span> included in the archives. Otherwise, Eclipse will fail to start and/or will have erratic UI. See [http://mou.me.uk/2009/10/31/fixing-eclipse-in-ubuntu-9-10-karmic-koala/ this post for GTK+ details] and [http://mou.me.uk/2009/10/31/fixing-eclipse-in-ubuntu-9-10-karmic-koala/ this bug for xulrunner information].
|}

=== Windows/x86 ===

ESbox archives:

* <span><font face="monospace">esbox_2.0.0-R20091216-common.zip</font></span>
* <span><font face="monospace">esbox_2.0.0-R20091216-win32.win32.x86.zip</font></span>

PluThon archives:

* pluthon_2.0.0-R20091216-common.zip
* <span><font face="monospace">pluthon_2.0.0-R20091216-win32.win32.x86.zip</font></span>

=== Mac OS X/Intel ===

ESbox archives:

* <span><font face="monospace">esbox_2.0.0-R20091216-common.zip</font></span>
* <span><font face="monospace">esbox_2.0.0-R20091216-macosx.carbon.x86.zip</font></span>

PluThon archives:

* pluthon_2.0.0-R20091216-common.zip
* <span><font face="monospace">pluthon_2.0.0-R20091216-macosx.carbon.x86.zip</font></span>

== Installing and Running ==

Extract and install the archives for your operating system: Unzip the <span><font face="monospace"><nowiki>*-common.zip</nowiki></font></span> and <span><font face="monospace"><nowiki>*-&lt;host OS&gt;.zip</nowiki></font></span> archive into the same directory of your choice.

If you use a Sun Java JRE, you can edit <span><font face="monospace">esbox.ini</font></span> or <span><font face="monospace">pluthon.ini</font></span> to adjust maximum memory usage (<span><font face="monospace">-Xmx</font></span>, <span><font face="monospace">-XX:MaxPermSize</font></span>).

Run the main executable or script:

; '''Linux'''
: <span><font face="monospace">./esbox.sh</font></span> or <span><font face="monospace">./pluthon.sh</font></span>
; '''Win32'''
: <span><font face="monospace">./esbox.exe</font></span> or <span><font face="monospace">./pluthon.exe</font></span>
; '''Mac OS X'''
: <span><font face="monospace">./esbox.app/Contents/MacOS/esbox</font></span> or <span><font face="monospace">./pluthon.app/Contents/MacOS/esbox</font></span>

= Installation via Maemo Update Site =

When you install ESbox, PluThon and Mica components through the Maemo update site, all needed dependencies (like CDT, PyDev, RSE, DSF, etc.) are installed automatically.

== Eclipse Installation ==

If you do not yet have Eclipse IDE installed, follow these instructions.

Download Eclipse Ganymede SR2 (3.4.2) for your host. We suggest a package bundled with CDT:

* [http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/ganymede/SR2/eclipse-cpp-ganymede-SR2-win32.zip Win32]
* [http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/ganymede/SR2/eclipse-cpp-ganymede-SR2-linux-gtk.tar.gz Linux 32-bit]
* [http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/ganymede/SR2/eclipse-cpp-ganymede-SR2-macosx-carbon.tar.gz Max OS X]
* ...or visit the [http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/ganymede/SR2/ Eclipse Ganymede SR2 Build page]. You must use Eclipse 3.4.2.
* The Maemo update site will ensure all needed additional packages are installed, so you can also start from a different Eclipse package.
* Other hosts are not officially supported for Maemo development but you are welcome to try installation or trying to use the Maemo SDK Virtual Image to run Maemo Eclipse development environment.

Extract the archive somewhere on your machine (for example <span><font face="monospace">/home/user</font></span> on Linux).

For Linux or Mac OS X:

 $ cd /home/user
  $ tar xvzf eclipse-cpp-ganymede-SR2-host-windowsystem.tar.gz

or, for Win32, use Winzip or another zip utility to extract the archive.

Start Eclipse by running the Eclipse executable included with the release. The executable file is called <span><font face="monospace">eclipse</font></span>, and is located in the <span><font face="monospace">eclipse</font></span> sub-directory of the install:

 $ /home/user/eclipse/eclipse

In recent Linux distributions like Ubuntu 9.10 or Fedora 11, GTK+ 2.18 and Mozilla's xulrunner have changed in ways that cause problems with Eclipse. See more information about [http://mou.me.uk/2009/10/31/fixing-eclipse-in-ubuntu-9-10-karmic-koala/ GTK+ issues from this email] and [https://garage.maemo.org/tracker/index.php?func=detail&aid=4689&group_id=192&atid=1420 xulrunner issue from this bug report].

If the xulrunner problem affects you, you will need to launch Eclipse as shown below:

 $ GDK_NATIVE_WINDOWS=true /home/user/eclipse/eclipse -vmargs -Dorg.eclipse.swt.browser.XULRunnerPath=path...

where <span><font face="monospace">path...</font></span> is the path to xulrunner 1.8, usually under <span><font face="monospace">/usr/lib/xulrunner/xulrunner</font></span> or <span><font face="monospace">/usr/bin/xulrunner</font></span>. In Ubuntu this package is named <span><font face="monospace">xulrunner</font></span>.

See [http://mou.me.uk/2009/10/31/fixing-eclipse-in-ubuntu-9-10-karmic-koala/ this post for GTK+ details] and [https://garage.maemo.org/tracker/index.php?func=detail&aid=4689&group_id=192&atid=1420 this bug for xulrunner information].

For the sake of convenience, there are ready made scripts available to use for ESbox and PluThon that implement this workaround. For ESbox, use [https://garage.maemo.org/svn/mica/build/continuous_integration/esbox.sh this] <span><font face="monospace">esbox.sh</font></span> script and for PluThon, use [https://garage.maemo.org/svn/mica/build/continuous_integration/pluthon.sh this] <span><font face="monospace">pluthon.sh</font></span> script to launch Eclipse IDE.

For more detailed information about Eclipse 3.4 environment, see the [http://www.eclipse.org/eclipse/development/readme_eclipse_3.4.2.html Eclipse 3.4.2 Project Release Notes].

== ESbox and PluThon Installation ==

Verify that your network proxy is configured (if needed) in '''Window &gt; Preferences &gt; General &gt; Network Connections'''.

Select '''Help &gt; Software Updates...''' from the main menu bar, figure [[#fig:update_site_update_menu|3.1]].

These instructions given are for ESbox installation through the Maemo Update Site, but can also be applied for the PluThon installation.



{| summary="Software Updates"
|+ align="BOTTOM" |'''Figure 3.1:''' Software Updates
|-
|
[[Image:esbox-update-menu.png|Image esbox-update-menu]]
|}



Select the '''Available Software''' tab, figure [[#fig:update_site_update_available|3.2]].



{| summary="Software Updates and Add-ons"
|+ align="BOTTOM" |'''Figure 3.2:''' Software Updates and Add-ons
|-
|
[[Image:esbox-update-available.png|Image esbox-update-available]]
|}



Add three update sites via '''Add site....'''

* ESbox update site is: <span><font face="monospace">http://maemoide.nokia.com/updates/2.0/esbox</font></span>, figure [[#fig:update_site_add_esbox|3.3]].
* PluThon update site is: <span><font face="monospace">http://maemoide.nokia.com/updates/2.0/pluthon</font></span>.
* Mica update site is: <span><font face="monospace">http://maemoide.nokia.com/updates/2.0/mica</font></span>, figure [[#fig:update_site_add_mica|3.4]].

Example how to add ESbox update site:



{| summary="Update Site, Add ESbox"
|+ align="BOTTOM" |'''Figure 3.3:''' Update Site, Add ESbox
|-
|
[[Image:esbox-update-site-add-esbox.png|Image esbox-update-site-add-esbox]]
|}



Example how to add Mica update site:



{| summary="Update Site, Add Mica"
|+ align="BOTTOM" |'''Figure 3.4:''' Update Site, Add Mica
|-
|
[[Image:esbox-update-site-add-mica.png|Image esbox-update-site-add-mica]]
|}



Mica is a generic framework named Maemo IDE Common Architecture underneath the ESbox and PluThon products.

Open the '''ESbox''' (or '''PluThon''') tree and select '''ESbox 2nd Edition''' (or '''PluThon 2nd Edition''') inside, then click '''Install''', figure [[#fig:update_site_selection|3.5]].



{| summary="Software Updates and Add-ons, ESbox 2nd Edition"
|+ align="BOTTOM" |'''Figure 3.5:''' Software Updates and Add-ons, ESbox 2nd Edition
|-
|
[[Image:esbox-update-selection.png|Image esbox-update-selection]]
|}



You can select the '''ESbox 2nd Edition Source''', '''PluThon 2nd Edition Source''' and '''Mica 2nd Edition Source''' as well as following the [http://mica.garage.maemo.org/2nd_edition/setup.html Mica development setup instructions] if you want to develop against ESbox or PluThon.

Verify the installed items, then click '''Next''', figure [[#fig:update_site_install|3.6]].



{| summary="Install"
|+ align="BOTTOM" |'''Figure 3.6:''' Install
|-
|
[[Image:esbox-update-install.png|Image esbox-update-install]]
|}



Review the licenses, then click '''Next''', figure [[#fig:update_site_install_licenses|3.7]].



{| summary="Review licenses"
|+ align="BOTTOM" |'''Figure 3.7:''' Review licenses
|-
|
[[Image:esbox-update-install-licenses.png|Image esbox-update-install-licenses]]
|}



The '''ESbox 2nd Edition''' selection brings in everything from ESbox and Mica, and the '''PluThon 2nd Edition''' selection brings in everything from PluThon and Mica. You can individually select the items under the '''ESbox''', '''PluThon''' and '''Mica''' nodes on the '''Available Software''' page, if you desire. This will make it easier to uninstall individual components later.

Click '''Finish''' and the installation will be performed. Accept the offer to restart Eclipse, figure [[#fig:update_site_restart|3.8]].



{| summary="Restart Eclipse"
|+ align="BOTTOM" |'''Figure 3.8:''' Restart Eclipse
|-
|
[[Image:esbox-update-restart.png|Image esbox-update-restart]]
|}



== Updating from an earlier than R2.0.0 release ==

If you used the archive files for installation, you can follow the instructions below to update your installation to the latest ESbox or PluThon version.

Select '''Help &gt; Software Updates...''' from the main menu bar, figure [[#fig:update_site_update_menu_2|3.9]].



{| summary="Software Updates"
|+ align="BOTTOM" |'''Figure 3.9:''' Software Updates
|-
|
[[Image:esbox-update-menu.png|Image esbox-update-menu]]
|}



If you installed directly from a repository archive (<span><font face="monospace"><nowiki>*.zip</nowiki></font></span>) file, rather than from the web, follow the below steps first:

# Select the '''Available Software''' tab.
# Click the '''Manage Repositories...''' button.
# Remove the old archive entries (<span><font face="monospace">esbox-repository*.zip</font></span>, <span><font face="monospace">pluthon-repository*.zip</font></span>, <span><font face="monospace">mica-repository*.zip</font></span>)
# Add new update sites through '''Add site...''' pointing to the new repository archives.

Select the '''Installed Software''' tab, figure [[#fig:update_site_update_installed|3.10]].



{| summary="Installed Software"
|+ align="BOTTOM" |'''Figure 3.10:''' Installed Software
|-
|
[[Image:esbox-update-installed.png|Image esbox-update-installed]]
|}



Click the '''Update...''' button.

Eclipse should display an '''Operation in progress...''' dialog and take a little time to query the configured update sites and should find the new versions of ESbox, PluThon and Mica features (as well as possibly other installed features).

Verify that ESbox, PluThon and Mica features are listed and checked, then click '''Next''', figure [[#fig:update_site_update_available_2|3.11]].



{| summary="Available Updates"
|+ align="BOTTOM" |'''Figure 3.11:''' Available Updates
|-
|
[[Image:esbox-update-available-2.png|Image esbox-update-available-2]]
|}



Review the licenses, then click '''Next''', figure [[#fig:update_site_update_licenses|3.12]].



{| summary="Review licenses"
|+ align="BOTTOM" |'''Figure 3.12:''' Review licenses
|-
|
[[Image:esbox-update-install-licenses.png|Image esbox-update-install-licenses]]
|}



Click '''Finish''' and the update is performed. Accept the offer to restart Eclipse, figure [[#fig:update_site_restart_2|3.13]].



{| summary="Restart Eclipse"
|+ align="BOTTOM" |'''Figure 3.13:''' Restart Eclipse
|-
|
[[Image:esbox-update-restart.png|Image esbox-update-restart]]
|}



== Troubleshooting ==

If you see this dialog: figure [[#fig:update_site_can_not_complete|3.14]]



{| summary="Cannot complete the request"
|+ align="BOTTOM" |'''Figure 3.14:''' Cannot complete the request
|-
|
[[Image:esbox-update-cannot-complete.png|Image esbox-update-cannot-complete]]
|}



followed by this dialog: figure [[#fig:update_site_already_installed|3.15]]



{| summary="Cannot complete the request, details"
|+ align="BOTTOM" |'''Figure 3.15:''' Cannot complete the request, details
|-
|
[[Image:esbox-update-already-installed.png|Image esbox-update-already-installed]]
|}



Messages about '''Cannot find a solution...''' usually means the given features or plugins are already installed, or that older versions were installed from a different site. Try using '''Software Updates... &gt; Installed Software &gt; Update...''' instead.

If you have an older ESbox or PluThon installation with features and plugins installed from another URL, use '''Software Updates... &gt; Installed Software &gt; Uninstall...''' to remove the ESbox or PluThon installation. This may make Eclipse unlaunchable - if so, launch Eclipse as shown below:

 $ ./esbox.sh -application org.eclipse.sdk.ide

until Eclipse is reinstalled from the current location.

= Installing Help Content =

Both ESbox and PluThon support the use of Maemo release documentation from the Eclipse IDE, both remotely and locally. You can configure the Eclipse environment to access Maemo online release documentation from the Maemo Info Center service. The same documentation available from the Maemo Info Center can also be downloaded to the host PC and installed locally on the Eclipse help system.

== Remote Help Content ==

The Mica framework included in ESbox and PluThon can use the Eclipse hover remote help system to access online documentation. For Maemo platform releases, the online documentation for each release is available from [http://maemoide.nokia.com/ Maemo Info Center service].

For more information about Hover help, see the ESbox or the PluThon Help topic '''Getting Started &gt; Using Hover Help for Maemo API Libraries'''.

You need to configure the Maemo Info Center to use the Maemo 5 Fremantle SDK help inside Eclipse:

Open the '''Help &gt; Content''' preference page, figure [[#fig:update_site_help_infocenter_prefs|3.16]].



{| summary="Help Content Preferences"
|+ align="BOTTOM" |'''Figure 3.16:''' Help Content Preferences
|-
|
[[Image:help-infocenter-prefs.png|Image help-infocenter-prefs]]
|}



Add a Maemo Info Center site, noting to update the host (no <span><font face="monospace">http://</font></span> prefix) and the path, which is Maemo platform specific (<span><font face="monospace">/fremantle</font></span> for Maemo 5 Fremantle release), figure [[#fig:update_site_help_infocenter_prefs_add|3.17]].



{| summary="Edit Maemo Docs Library Information"
|+ align="BOTTOM" |'''Figure 3.17:''' Edit Maemo Docs Library Information
|-
|
[[Image:help-infocenter-prefs-add.png|Image help-infocenter-prefs-add]]
|}



Then, use '''Help &gt; Content''' and you will see the entries under '''Maemo 5''' categories.

== Local Content ==

If you prefer, you may also install all Maemo release documentation locally so that no network connection is needed when accessing Maemo documentation. Locally installed documentation is also faster to access and search than online documentation from the Maemo Info Center.

This content is only available from the Maemo update site. You can also install Maemo release documentation locally in case you installed ESbox or PluThon from a full-product archive instead of Maemo update site.

These instructions assume you have already installed the Eclipse ESBox or PluThon product using either Maemo Eclipse product archives or update sites.

Verify that your network proxy is configured (if needed) in '''Window &gt; Preferences &gt; General &gt; Network Connections'''.

Select '''Help &gt; Software Updates...''' from the main menu bar, figure [[#fig:update_site_help_pluthon_update_menu|3.18]].



{| summary="Software Updates..."
|+ align="BOTTOM" |'''Figure 3.18:''' Software Updates...
|-
|
[[Image:pluthon-update-menu.png|Image pluthon-update-menu]]
|}



Select the '''Available Software''' tab, figure [[#fig:update_site_help_update_available|3.19]].



{| summary="Software Updates and Add-ons"
|+ align="BOTTOM" |'''Figure 3.19:''' Software Updates and Add-ons
|-
|
[[Image:help-update-available.png|Image help-update-available]]
|}



Add a Documentation update site via '''Add site....'''. Maemo Fremantle documentation update site is <span><font face="monospace">http://maemoide.nokia.com/downloads/fremantle/</font></span>, figure [[#fig:update_site_help_update_site_add|3.20]].



{| summary="Update Site - Add Documentation"
|+ align="BOTTOM" |'''Figure 3.20:''' Update Site - Add Documentation
|-
|
[[Image:help-update-site-add.png|Image help-update-site-add]]
|}



Select one or more of the '''Maemo ... Help''' features and then click ''''''Install, figure [[#fig:update_site_help_update_selection|3.21]].



{| summary="Software Updates and Add-Ons, Selection"
|+ align="BOTTOM" |'''Figure 3.21:''' Software Updates and Add-Ons, Selection
|-
|
[[Image:help-update-selection.png|Image help-update-selection]]
|}



Verify the installed items, then click '''Next''', figure [[#fig:update_site_help_update_install|3.22]].



{| summary="Confirm Installation"
|+ align="BOTTOM" |'''Figure 3.22:''' Confirm Installation
|-
|
[[Image:help-update-install.png|Image help-update-install]]
|}



Review the licenses, then click '''Next''', figure [[#fig:update_site_help_update_install_licenses|3.23]].



{| summary="Accept Licenses"
|+ align="BOTTOM" |'''Figure 3.23:''' Accept Licenses
|-
|
[[Image:help-update-install-licenses.png|Image help-update-install-licenses]]
|}



Click '''Finish''' and the installation is performed. You may be able to '''Apply Changes''' if you have not already opened help or turned on hover help. Otherwise accept the offer to restart Eclipse, figure [[#fig:update_site_help_pluthon_update_restart|3.24]].



{| summary="Apply Changes Or Restart"
|+ align="BOTTOM" |'''Figure 3.24:''' Apply Changes Or Restart
|-
|
[[Image:pluthon-update-restart.png|Image pluthon-update-restart]]
|}


== References ==
<references />