Documentation/Maemo Eclipse Tutorial/Using ESbox
Using ESbox
ESbox supports C, C++, Python and Qt4 projects. This chapter briefly describes how to create different types of projects and applications and how to run, test and debug applications using Maemo SDK and a Maemo device.
ESbox requires that C/C++, Python and Qt4 development environments are installed on the host PC where Maemo SDK is run and on the Maemo device. For detailed instructions on how to install ESbox and the required development environments, see ESbox installation chapters. You need PC Connectivity to connect the Maemo device to the host PC and ESbox. For instructions on how to install and configure Maemo PC Connectivity on the Maemo device and Maemo Host PC Connectivity on the host PC where the ESbox Eclipse environment is run, see PC Connectivity documentation.
Before creating your first project with ESbox, make sure that you can connect to your Maemo device from the host PC (that PC Connectivity has been properly installed and configured).
Creating C/C++ and Qt4 Projects
C/C++ and Qt4 Templates
Templates define the basic structure of the project. Most of the templates are examples but you can also use them as a basic structure for your project.
To create a new C or C++ project, select File > New > Project, figure 8.1.
- C > C Maemo Project
- C++ > C++ Maemo Project
For Qt4 projects, select C++ project.
ESbox supports simple Qt4, Makefile and Autotools projects, figure 8.2.
Select any of the available templates on the Template Project Type page, figure 8.3.
| File:Dialog-information.png | Note: Maemo 4 templates are only for Diablo targets and Maemo 5 templates for Fremantle. Select the correct template depending on your installation. |
C/C++ and Qt4 Targets
You can select multiple targets for a project. Optimized targets are compiled using compiler optimization while debug targets are compiled with debug options.
If you want to run a project on a Maemo device, select the ARMEL target. To run a project on the emulator, select the X86 target.
Select all targets for a project, figure 8.4. You can change the targets after you have created the project.
If you do not see any targets on the Project Configuration page, check that Maemo SDK targets are installed and install them if necessary. For more information on how to install Maemo SDK and targets for ESbox, see ESbox installation chapters.
C/C++ and Qt4 Metadata
Other project pages define different metadata the template uses. You can specify additional information in the fields or use the default values, figure 8.5.
After defining the values, click Finish to create a project.
Validating C/C++ and Qt4 Project Packages for Maemo SDK
When you have created a new project, ESbox suggests package validation, figure 8.6. If you are not sure that the required development environments have been installed for your targets, click Yes.
ESbox installs all the required dependencies for your project for the selected targets, if they are not installed already, figure 8.7.
If ESbox asks you about changing the target, click Yes to accept. Accept and install any packages ESbox suggests, and close the package validation wizard when the installation is complete.
You can also validate project packages afterwards. To start the validation, select Project > Project Menu > Validate Installed Packages.
During validation, the projects are scanned for dependencies using the following information:
- Autotools projects: PKG_CONFIG_CHECK macros in configure.ac
- Makefile projects: default metapackages for the project type and libraries detected through
pkg-configinvocations
Running C/C++ and Qt4 Applications on Maemo SDK
First, select the build configuration. Change the build configuration to DIABLO_X86 (Debug) or FREMANTLE_X86 (Debug).
To activate the selected configuration, right-click the project and select Build Configurations > Set active, figure 8.8.
To add or remove targets, select Manage in the same menu.
The project is ready to be launched on Maemo SDK. To launch it, right-click the project and select Run As > Maemo Local Application, figure 8.9.
If Maemo Application Framework is not running, ESbox asks you to launch it. When you have launched the Application Framework successfully, you can see the Application Framework and the program running, figure 8.10.
Running C/C++ and Qt4 Applications on a Maemo Device
To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.
Because the device uses ARMEL binaries, you must to change the target platform to DIABLO_ARMEL or FREMANTLE_ARMEL and rebuild your application for the Maemo device.
First, make sure that DIABLO_ARMEL or FREMANTLE_ARMEL target is selected by right-clicking the project and selecting Properties > Build Configurations > Manage, figure 8.11.
Set the target to DIABLO_ARMEL or FREMANTLE_ARMEL, figure 8.12.
Right-click the project, select Build Configurations > Set Active and activate DIABLO_ARMEL (Debug) or FREMANTLE_ARMEL (Debug), figure 8.13.
Validating C/C++ and Qt4 Project Packages on a Maemo Device
To be able to run your application on the Maemo device, you need to make sure that all the required runtime dependencies for your application are available on the device.
Select Project Menu > Validate Installed Packages. On the first page, select the project to be validated, figure 8.14.
On the Target Selection page, select the correct Maemo device connection and ARMEL target, Figure 8.15.
To start the validation, click Finish on the last page. This installs the required packages for the selected project on the Maemo device.
You can also validate project packages afterwards. To start the validation, select Project > Project Menu > Validate Installed Packages.
Running C/C++ and Qt4 Projects on a Maemo Device
To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.
After you have set the target to ARMEL and built your application as ARMEL, you can run your application on the Maemo device. To run the application, right-click the project and select Run As > Maemo Remote Application, figure 8.16.
Select SSH as the connection type (using the SBRSH connection type requires additional configuration), figure 8.17.
Select the device connection, figure 8.16. Use USB connection because it is faster than Bluetooth or WLAN.
You can now see your application running on the Maemo device.
You can use VNC Viewer to control the Maemo device and your application running on it. Select Window > Show View > Other > VNC Viewer.
| File:Dialog-information.png | Note: To use VNC Viewer, the x11vnc service must be installed on the Maemo device either separately (apt-get install x11vnc) or as part of Maemo PC Connectivity. |
Debugging C/C++ and Qt4 Applications
To be able to debug a project, you must set at least one breakpoint into one of the source files. To add a breakpoint somewhere, open a source file, right-click on the left source side panel and select Add Breakpoint, figure 8.19.
To launch your project in debug mode, right-click the project and select Debug As > Maemo Local or Remote Application. When prompted, accept changing to the debug perspective, figure 8.20.
In the debug perspective, you can stop and continue the execution, step lines, inspect variables, and so on. See Figures 8.21 and 8.22.
| File:Dialog-information.png | Note: You can switch back and forth between perspectives by selecting from the top right corner. |
Creating Python Projects
ESbox Python projects require that Python is installed on the host PC. For more information, see ESbox installation chapters.
Python Templates
Templates define the basic structure of the project. Most of the templates are examples but you can also use them as a basic structure for your project.
To create a new Python project, select File > New > Project and then Python Maemo Project, figure 8.23.
Select any of the Python example templates on the Template page, figure 8.24.
Python Targets
Select DIABLO_X86 or FREMANTLE_X86 as the target, figure 8.25.
Python Metadata
The Basic Settings page defines different metadata the selected template uses. You can specify additional information in the fields or use the default values, figure 8.26.
Python Configuration
You can define the Python configuration settings on the last page. If the wizard cannot find an existing Python configuration, it suggests to create a new configuration.
You can use the default values and click Finish to a create project, figure 8.27.
If there is no previous configuration for your project, ESbox asks you to create a new configuration. To create one, click Yes.
For the Python interpreter configuration, you can add all the Python paths and confirm this by clicking OK, figure 8.28.
Validating Python Project Packages
When you have created a new project, ESbox suggests package validation. Click Yes to accept, figure 8.29.
Click Finish on the Package Validation Wizard dialog, figure 8.30. ESbox installs all the required dependencies for the selected targets.
If ESbox asks you about changing the target, click Yes to accept. Accept and install any packages ESbox suggests, and close the package validation wizard when the installation is complete.
You can also validate project packages afterwards. To start the validation, select Project > Project Menu > Validate Installed Packages.
During validation, the projects are scanned for dependencies using Python package imports from the source files.
Running Python Applications on Maemo SDK
First, select the build configuration. Change the build configuration to DIABLO_X86 or FREMANTLE_X86.
Right-click the project and select Properties, figures 8.31.
Select Maemo Build Configurations and activate the configuration, figures 8.32
To launch the project on Maemo SDK, right-click the project and select Run As > Python Maemo Local Application, figure 8.33.
Select the file you want to run on Maemo SDK. Do not select setup.py because it is used only for Debian package creation, figure 8.34.
If Maemo Application Framework is not running, ESbox asks you to launch it. When you have launched Maemo Application Framework successfully, you can see the Application Framework and the program running, figure 8.35.
Running Python Applications on a Maemo Device
To be able to run your Python application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.
First, make sure that DIABLO_ARMEL or FREMANTLE_ARMEL target is selected by right-clicking the project and selecting Maemo Build Configurations. Select DIABLO_ARMEL or FREMANTLE_ARMEL as the target, figure 8.36.
If there is no configuration for the target, ESbox asks you to create one. To configure a new target, click Select all.
Validating Python Project Packages on a Maemo Device
To be able to run your application on a Maemo device, you need to make sure that all the required runtime dependencies for your application are available on the device.
Select Project Menu > Validate Installed Packages. On the first page, select the project to be validated, figure 8.37.
On the Target Selection page, select the correct Maemo device connection and ARMEL target, Figure 8.38.
To start the validation, click Finish on the last page. This installs the required packages for the selected project on the Maemo device.
During validation, the projects are scanned for dependencies using Python package imports from the source files.
Running Python Projects on a Maemo Device
To be able to run your application on a Maemo device, Maemo PC Connectivity must be installed on the device and Maemo Host PC Connectivity on the host PC. For more information, see ESbox installation chapters.
After you have set the target to ARMEL you can run your application on the Maemo device. To run the application, right-click the project and select Run As > Maemo Remote Application, figure 8.39.
Select the Python file you want to run. Do not select setup.py because it is used only for Debian package creation. Select SSH as the connection type (using SBRSH requires additional configuration). Select the correct device connection.
You can now see your application running on the Maemo device.
You can use VNC Viewer to control the Maemo device and your application running on it. Select Window > Show View > Other > VNC Viewer.
| File:Dialog-information.png | Note: To be able to use VNC Viewer, the x11vnc service must be installed on the Maemo device either separately (apt-get install x11vnc) or as part of Maemo PC Connectivity. |
Debugging Python Applications
To be able to debug a project, you must set at least one breakpoint into one of the source files. To add a breakpoint somewhere, open a source file, right-click on the left source side panel and select Add Breakpoint, figure 8.40.
To launch your project in debug mode, right-click the project and select Debug As > Maemo Local or Remote Application. When prompted, accept changing to the debug perspective, figure 8.41.
In the debug perspective, you can stop and continue the execution, step lines, inspect variables, and so on. See Figures 8.42 and 8.43.
| File:Dialog-information.png | Note: You can switch back and forth between perspectives by selecting from the top right corner. |
Debian Packaging ESbox Project
You can create Debian installation packages for your C/C++, Qt4 and Python projects using ESbox wizards. ESbox also provides some tools to help in creating the Debian package structure, and building and installing the package.
Debian Package Structure
Debian structure is debian folder under project directory. If you do not have Debian structure in your project you can create it by right clicking project and choosing Debian Package > Create Debian Structure.
Python projects need setup.py script to create a Debian package and it should be in the project root folder. You can create setup.py from the last page of the Structure wizard.
ESbox does not automate the whole Debian structure creation process, so you might need to manually modify the files in debian folder. A Debian installation package is built using Makefile located at debian/rules directory. Other files are usually install scripts and metadata.
You can find complete information on the Debian installation package structure from Debian New Maintainers' Guide
Building Debian Package
ESbox can create a Debian installation package from your project by right clicking project and choosing Debian Package > Build Debian Package. If the project does not have Debian structure defined, the wizard helps you to create one. You must select the destination where the new Debian package is created.
Installing Debian Package
After you have built a Debian installation package, you can install it inside ESbox by right-clicking project and choosing Debian Package > Install Debian Package.
Importing Projects from Repository
Background
This feature assumes you know a little bit about the workings of Debian packages. If not, the full details are in The Debian GNU/Linux FAQ; Chapter 7 - Basics of the Debian package management system.
Repositories and package types
In the Debian package manager apt (used in Scratchbox and Maemo devices), the sources.list repository configuration files contain two kinds of entries: deb and deb-src repositories. Both point to external or local repositories of packages (called system packages here). deb repositories point to binary packages while deb-src repositories point to the (usually in sync) source packages for those binary packages.
One source package may generate several binary packages; for instance, one for programs and primary data, one for auxiliary data, one for libraries, and one for development.
In apt, when fetching the sources for a binary package, you start with an interesting binary package and find its corresponding source package (for example, apt-get source <package>).
Source package structure
The sources for a package come usually in three files: a control file (*.dsc), an archive (*.tar.gz or *.tar.bz2), and a patch (*.diff.gz). apt-get source command invokes the dpkg-source command to expand the archive and apply the patch. The control file is used when rebuilding the binary package.
Once extracted, the contents of the original patched sources vary wildly. The contents may contain a bare-bones Makefile project, an autotools-based project, a nest of programs and libraries and test code, or even another archive.
There is one guarantee, though: the package expands to contain a debian directory and its various control files (see the "Source packages" chapter of the Debian Policy Manual for more details).
The debian/rules file is an executable Makefile which is the primary means of interaction with the source from the perspective of a Debian package. In other words, even if the extracted sources contain autoconf files or Makefiles, you must use debian/rules to configure, build, clean, install, and re-package the package.
For example, debian/rules configure, debian/rules build, debian/rules install are typical ways to use a source package.
It must be mentioned that even debian/rules can have varying degrees of fluctuation in the targets it provides. Most packages not developed in the Debian project itself come from a large community of people who think differently, and the targets vary accordingly. While the utility dh_make tries to promote a standard set of guidelines, some projects may, for instance, lack a configure target (or have several), lack a build target (or have several), and so on.
ESbox attempts to corral this kind of diversity with its import wizard.
Using the Wizard
Find the wizard under File > Import > ESbox > Project from Debian Repository, figure 8.44.
Select the package to import, figure 8.45.
The target providing packages is one of the Scratchbox targets on the host PC.
| File:Dialog-information.png | Note: The target must have the necessary deb-src entries in sources.list. Standard Maemo SDK configurations have such entries by default. |
The package selector shows a tree of packages organized by category. You can search by typing in the filter (for words in the name or description) or typing in the tree (for the name alone).
The Fetch build dependencies option ensures that, in addition to fetching the source for the selected package, any packages needed to build the source are installed as well.
The Always re-fetch source components option asks the wizard to always go to the network and find the source components (the .dsc file, archives, and patches) for the package. This may be necessary if you have modified the package locally.
The Delete source components option deletes the .dsc file, source archives, and patches after extraction.
Next, select the build targets for the package, figure 8.46.
The next page prepares for the source fetch, figure 8.47.
Visit the link to ensure your proxy is configured, or else the download does not work.
Press Next to start the process, figure 8.48.
If the fetch fails â usually indicated by a long pause after the Building dependency tree message - press Cancel to abort the process. You can select View Log from the dialog, press Back, then press Next again to retry.
The next page lets you choose the project type and builder for the package.
This is a normal case, figure 8.49.
Here, the project (sysstat from earlier pages) expands into a project with a Makefile. Also (off-screen) there are C sources and headers. Thus, the wizard is able to guess the project type. This page, therefore, is merely informative and you can press Next.
An imported package may, however, be provided as a compressed archive with patches. In this case, you can preconfigure the project to extract the sources and decide whether the project is really the one you are looking for.
The following screenshot shows the inimitable bash shell, which is packaged as an archive, figure 8.50.
To handle this case, the wizard selects a build rule, which appears to be a configuration rule. This would be expected to extract the archive and apply the patches.
You can manually select the rule for configuration, if desired. For example, bash can be built in several configurations for different footprints. Here are the rules found in bash's debian/rules, figure 8.51.
Select a rule and click Setup project... to run the build for the given rule. The build results go to the Console behind the wizard.
For bash, and probably other packages, this configure step actually proceeds to build the entire program and run its tests â you may Cancel after the archive has been extracted and the patches have been applied, then proceed with the wizard, figure 8.52.
Once the configuration step has been run, the conversion page updates its guess about the project, figure 8.53.
Once the project type and builder type are known, you can Finish the wizard.
Projects imported from Debian packages can be edited, navigated, built, and launched like normal ESbox projects. You can, of course, also recreate Debian packages from them.