Getting started programming: Difference between revisions
Jump to navigation
Jump to search
(Redirecting to Developers manual) |
|||
| (95 intermediate revisions by 21 users not shown) | |||
| Line 1: | Line 1: | ||
#REDIRECT [[Developers manual]] |
|||
Thank you for considering working on the One Laptop Per Child project. This page tries to provide you with the answers you need to get started either by contributing to existing projects or starting your own. |
|||
{{Translations}} |
|||
== Setting up a Development Environment == |
|||
The OLPC's software environment is a heavily modified Fedora Core Linux system running a custom [[Sugar|GUI shell]] (Sugar). To develop for the platform you will eventually need access to a platform which runs in a manner substantially similar to the OLPC environment. Luckily there are many available options. |
|||
=== Emulation (Recommended for New Developers) === |
|||
By far the most time-efficient and effective way to start developing for the OLPC system is to [[OS images for emulation|download an operating system image]] that can be run in one of the popular emulation/virtualisation systems, such as [[QEMU|Qemu]], VMWare or Parallels. These images allow you to run a virtual OLPC-configured machine on your regular development workstation. |
|||
There are two major classes of images available, one group is as close as possible to the OLPC installation. These official images do not provide GUI IDEs or [[SVG]] graphics editors. They normally would be used either with command-line tools (e.g. VIM) or with an NFS (or similar) share to a workstation on which you will do your actual coding. As a result, the official images tend to involve either more Unix developer-toolchain familiarity or more setup in your development environment. |
|||
The second group of images are the [[Developer Images]], which are intended to be used as virtual desktop machines. The images have far more software than is installed on the OLPC laptops. They resemble a developer's desktop machine which has been upgraded to support the Sugar environment. They tend to have GUI IDEs, full Gnome desktop installations and the like, which make it easy for developers to work entirely within the emulated environment. |
|||
Developers working on Developer Images should be sure to test their creations on real OLPC Laptops or official images in order to be sure that they do not have dependencies on software not available on the actual laptops. |
|||
=== Native Linux Installation === |
|||
There are two major approaches to a native Linux installation of the OLPC Sugar system. In the first, you use the |
|||
sugar-jhbuild build-base |
|||
command to build a parallel set of the libraries required to run the OLPC software. This [[Sugar with sugar-jhbuild|approach]] generally works reasonably well on most modern Linux distributions, though the build system (jhbuild) tends to be very fragile, so you may spend quite some time rebuilding and fixing errors to get a final working system. |
|||
In the [[Setting Up a Sugar Development Environment on *IX OSes|second approach]] you update your Linux operating system to such a point that it resembles the OLPC environment. You then need only use the more fragile build system for a tiny fraction of the packages required. You should be aware that such upgrades often will require you to update well beyond the "stable" configurations for your Linux distribution, and as such may make your system unstable. |
|||
: As of 2007-04-08 only Fedora Core 6/7, Gentoo and Ubuntu Feisty Fawn are known to upgrade reasonably well. |
|||
=== Hardware Developer's Program === |
|||
While there are only a small number of test units being produced, developers can submit proposals to receive one of those units for testing and development. XXX where did that page go? |
|||
== Operating Environment == |
|||
Technically, these applications could be developed in any language supported by Linux, however the OLPC simply does not support the storage required to support all the possible runtime environments. |
|||
Therefore, application developers should restrict themselves to using C or the [[OLPC Python Environment]]. You also need to keep in mind the restrictions on the [[Hardware]]. Although reasonably powerful, the working environment for an OLPC in some ways resembles a space-constrained embedded device. |
|||
For web applications it's possible to use JavaScript (the children's web-browser is based on the Gecko engine). Application developers should be careful about using exotic libraries, even those which may be standard issue with Python. The OLPC team may decide to remove any component which is deemed to be redundant. This leads to the following principles: |
|||
*Check to see what libraries are included before you begin development. Even some "universally available" libraries, such as OpenGL, are not available! |
|||
*Carefully choose support modules to minimize your storage footprint, for instance if you need a database, choose Sqlite rather than MySQL. Or better yet, use dbm. |
|||
*Test your application in an official image (or a physical laptop) |
|||
*If you are unsure what is supported, ask. |
|||
*To conserve memory, consider replacing Python with C. For example, a [http://dev.laptop.org/ticket/1303 rewrite of the hardware manager service] in C saved 1.8 megabytes of private dirty memory. On a machine with only 128 to 256 megabytes of RAM and no swap space, efficient use of memory can make the difference between a usable system and a system made unreliable by out-of-memory failures. |
|||
*Distribute your source code under the GPL, LGPL or MIT license. |
|||
== Joining or Starting a Project == |
|||
Most developers will probably be working on an Activity for use on the OLPC. This kind of development can normally be done with little interaction with other development groups, save for the core Sugar developers (whose work directly affects activity developers). |
|||
=== Communications Channels === |
|||
Most of the core developers use IRC for instant-messaging-style communications: |
|||
irc.freenode.net #sugar |
|||
the Sugar mailing list is also used for broader comment and collaboration: |
|||
[http://mailman.laptop.org/mailman/listinfo/ List Information] |
|||
=== Requests and Ideas for Projects === |
|||
[[Software ideas]] describes activity and tool types that are currently needed. If you have an idea for an activity, add it to the list in the appropriate category (create a new category if necessary). You can create a new wiki page to describe your idea in more detail. |
|||
=== Existing Projects === |
|||
[[Software projects]] describes the currently active projects that may need help. Once you have decided on a project, add yourself to the list along with your contact information, homepage (which may be a wiki page on the OLPC wiki), etceteras. |
|||
=== Available Resources === |
|||
The [[Developers Program]] provides general [[Project hosting| project management]] facilities for OLPC projects. |
|||
== Documentation == |
|||
=== Tutorials === |
|||
* Original [[Sugar Activity Tutorial|HelloWorld Tutorial]] using regular GTK |
|||
* Tuquito's [[Hello World!]] using GTK+Glade rather than hand-coded GTK |
|||
* Red Hat Magazine [http://www.redhatmagazine.com/2007/04/05/building-the-xo-porting-a-pygtk-game-to-sugar-part-one Porting a PyGTK Game to the XO] by John Palmieri |
|||
=== References === |
|||
These documents are frequently referenced during the development process. |
|||
* [[Sugar Architecture]] covers Sugar APIs and specifications |
|||
* [[HIG|Human interaction guidelines (HIG)]] for Sugar activities |
|||
* [[Bitfrost|Bitfrost summary]] ([[OLPC Bitfrost|full spec]]) the security system which will control activities and their interaction with the system and other users |
|||
* [http://www.vrplumber.com/sugar-docs/sugar.html Sugar PyDoc] just provides the raw API documentation, which is severely lacking in documentation strings (Good familiarisation project might be working with Marco to improve that situation) |
|||
* [http://www.vrplumber.com/sugar-docs/hippo.html Hippo PyDoc] again, just raw API documentation, needs lots of documentation effort |
|||
* [[Software components]] is a somewhat old document describing the various pieces of software and libraries involved in the system. |
|||
* [[Sugar Instructions | Instructions]] on using the Sugar user interface |
|||
* [[Understanding sugar code]] provides an overview of how Sugar interacts with activities, including startup and shutdown, useful to understand the environment in which your activity will run |
|||
* [[Activity Bundles]] describes the packaging structure |
|||
=== Resources === |
|||
* The [[:Category:Developers | Developer's Category]] collects everything in the wiki that's been tagged as pertaining to developers (it's a bit hard to navigate) |
|||
* [[Developers Program]] focuses on development for the core system, but with information useful for activity developers as well |
|||
* [[Sugar Code Snippets]] |
|||
* [[Getting involved in OLPC]] - general guide to where help is needed, though written a while ago, before direct development was particularly easy (thus the emphasis on working on upstream projects AFAICS) |
|||
=== Frequently Asked Questions === |
|||
==== How do I do networking in Sugar? ==== |
|||
* Internal (to other laptops) |
|||
* External (to the wider internet) |
|||
* [[Activity Sharing]] (session establishment) |
|||
* Otherwise general Python networking |
|||
** Twisted (will this be available on the images?) |
|||
** Asyncore |
|||
** PyRO (Python remote objects) |
|||
** XMLRPC/SOAP |
|||
==== How do I create a persistent server/service? ==== |
|||
* How do I register for start-time loading? |
|||
* Is there any dbus event service for loading only on response to messages? That is, not loading until there is an event of a given type, such as a presence event? |
|||
** Yes, of a sort, services are defined in .service files, these match a named service to an executable which is to provide that service. Thus one can register to handle requests for a given named service, but you still need to arrange to have that service called by something. |
|||
==== How do I access the special hardware? ==== |
|||
===== Camera ===== |
|||
* Have to script v4l2 via gstreamer to capture a single frame from the camera. See sugar/shell/intro/glive.py for sample code |
|||
* Try this from the command line: <tt>gst-launch-0.10 v4l2src ! ffmpegcolorspace ! pngenc ! filesink location=foo.png</tt> |
|||
* See also: [[Programming the camera]] |
|||
===== Camera-as-video-camera (v4l2?) ===== |
|||
* Is a regular v4l2 device available via gstreamer (gst module) |
|||
* Try this from a terminal in the developer console: <tt>gst-launch-0.10 v4l2src ! ximagesink</tt> (The image will appear <i>behind </i>the developer console window so you'll need to move the window aside.) |
|||
* See also: [[Programming the camera]] |
|||
===== Directional pad/buttons ===== |
|||
* Have their own X key names |
|||
* Currently 4-button set mapped to arrow (cursor) keys |
|||
* Two separate buttons mapped to ??? (pageup/pagedown) |
|||
===== Touchpad ===== |
|||
===== Drawing pad (stylus pad) ===== |
|||
* How to switch in/out of stylus mode? |
|||
* How to set interpretation parameters? |
|||
===== Audio-port probe ===== |
|||
* How to get access? |
|||
** What's going to come out when I get access (keeping in mind I (the developer) likely won't have the actual hardware available) |
|||
===== Mode-switching code for the screen ===== |
|||
* backlight on/off |
|||
* backlight brightness |
|||
* set all 8 (4 distinct) settings for MODE_MONO_LUMA, MODE_CSWIZZLE, MODE_COL_AA |
|||
* query, change, and restrict screen orientation |
|||
* drop to a lower resolution for performance or ease of porting, such as 600x450 or 400x300 |
|||
==== How do I create my activity GUI? ==== |
|||
* How does [[HippoCanvas]] work? |
|||
* Can I just use [[Cairo]], [[PyGame]] or [[GTK]] directly? (How can a non-Python app fully interact with Sugar?) |
|||
** At the moment it cannot. This appears to be an arbitrary restriction that can currently be "fixed" by creating a wrapper in Python (e.g. the ClassicGnome activity). |
|||
** Sugar is using custom dbus messages to communicate with a server that must be present for every activity. That restriction may be relaxed in the future. |
|||
* How flexible does the GUI need to be? (e.g. resize and rotate) |
|||
* How do I share code between activities? |
|||
* What's the best development approach: |
|||
** Write outside Sugar, finish and debug, then port? |
|||
** Write to Sugar, test and debug within the system? |
|||
==== How do I package my activity? ==== |
|||
* How do I work from an in-process activity (develop registration)? |
|||
** setup.py develop |
|||
** You can use sugar-activity to start the activity, but you have to manually close it (using the Sugar GUI: show the frame, then move to the activity icon on the top bar, hover for a second, then click close (yes, it's really that awkward)) |
|||
* How do I produce a binary extension? |
|||
* How do I make my package available for users to download dynamically? |
|||
* How do I tell users about updates to the packages? |
|||
==== How do I get access to user-generated content (share files between applications)? ==== |
|||
==== How do I test a Sugar activity? ==== |
|||
* Start sugar, start a bash shell, run "sugar-jhbuild shell" to set up the sugar environment variables, then use "sugar-activity YourActivityName" to run the activity with output going to your local shell |
|||
==== How do I debug a Sugar activity? ==== |
|||
==== How do I create an asymmetric application? (Publisher for others to consume) ==== |
|||
==== How do I edit with emacs on the laptop? ==== |
|||
* Install [http://www.mtxia.com/fancyIndex/Tools/Editors/MicroEMACS/ MicroEMACS] by copying [http://www.mtxia.com/fancyIndex/Tools/Editors/MicroEMACS/me404linux.bin this file] to the laptop. Actually, [http://zile.sourceforge.net/ zile] works more as I expected, try installing [ftp://rpmfind.net/linux/fedora/extras/6/i386/zile-2.2.19-1.fc6.i386.rpm this rpm file] instead. |
|||
[[Category:Developers]] |
|||
[[Category:Software development]] |
|||