API reference: Difference between revisions

From OLPC
Jump to navigation Jump to search
(Add sugar snippets and presence api)
m (Link to the wiki page for sugar.graphics.)
Line 20: Line 20:
* [[Sugar Architecture]] [http://www.vrplumber.com/sugar-docs/sugar.html (PyDoc)] -- core UI and service libraries
* [[Sugar Architecture]] [http://www.vrplumber.com/sugar-docs/sugar.html (PyDoc)] -- core UI and service libraries
** [http://www.vrplumber.com/sugar-docs/sugar.activity.html Activity Support] -- support mechanisms for writing activities
** [http://www.vrplumber.com/sugar-docs/sugar.activity.html Activity Support] -- support mechanisms for writing activities
** [http://www.vrplumber.com/sugar-docs/sugar.graphics.html Graphics] -- UI library based on Hippo Canvas
** [[Graphics API]] [http://www.vrplumber.com/sugar-docs/sugar.graphics.html (PyDoc)] -- UI library based on Hippo Canvas
** [http://www.vrplumber.com/sugar-docs/sugar.presence.html Presence] [http://www.vrplumber.com/sugar-docs/sugar.chat.html Chat] [http://www.vrplumber.com/sugar-docs/sugar.p2p.html P2P]-- activity's interfaces to the Telepathy engine
** [http://www.vrplumber.com/sugar-docs/sugar.presence.html Presence] [http://www.vrplumber.com/sugar-docs/sugar.chat.html Chat] [http://www.vrplumber.com/sugar-docs/sugar.p2p.html P2P]-- activity's interfaces to the Telepathy engine
** [http://www.vrplumber.com/sugar-docs/sugar.chat.html Clipboard] -- activity's interface to the UI's clipboard interface
** [http://www.vrplumber.com/sugar-docs/sugar.chat.html Clipboard] -- activity's interface to the UI's clipboard interface
Line 80: Line 80:


== C Libraries ==
== C Libraries ==

== System Services ==

* [[Forth Lessons]] -- Series of tutorial-style lessons on the Forth language and the [[Open Firmware]] bios-replacement system on the laptop


== D-BUS Services ==
== D-BUS Services ==
Line 91: Line 87:
* [http://people.freedesktop.org/~david/hal-spec/hal-spec.html#interfaces Hardware Abstraction Layer Daemon (hald)] -- control of standard hardware functionality
* [http://people.freedesktop.org/~david/hal-spec/hal-spec.html#interfaces Hardware Abstraction Layer Daemon (hald)] -- control of standard hardware functionality
* [[Presence Service DBus API|Presence Service]] -- friend and shared-activity discovery service
* [[Presence Service DBus API|Presence Service]] -- friend and shared-activity discovery service

== System Services/Hardware ==

* [[Forth Lessons]] -- Series of tutorial-style lessons on the Forth language and the [[Open Firmware]] bios-replacement system on the laptop
* [[DCON]] -- the display controller ASIC and its interface (note that normally you would use the HardwareManager D-BUS interface to manipulate the DCON)
* [[Geode]] -- the Geode CPU (assembly-language optimization guide, links to data-sheets)

Revision as of 05:54, 2 September 2007

The OLPC platform includes a large number of libraries and services. This page attempts to gather links to reference works which can be used when programming the XO laptops. This reference is primarily intended for Software Developers.

Platform Requirements

  • Software components is a somewhat old document describing the various pieces of software and libraries involved in the system.

Python Libraries

Where official reference documentation isn't available, PyDoc-generated documentation is provided. You can generate local copies of the PyDoc-generated documentation from a running official image. Script is available via bzr branch http://www.vrplumber.com/bzr/autodoc

GUI Libraries

Libraries for creating standard Windows-Icon-Menu-Pointer (WIMP) GUI applications.

High-Level Widgets

GUI (GTK) controls which expose the functionality of entire complex applications for use by other projects.

  • Abiword -- GTK widget embedding the Abiword Word-Processor
  • HulaHop -- embeds a Gecko 1.9 (Firefox 3.0 ocore) rendering widget XXX confirm that's what it really is
  • Evince -- PDF (and similar) document viewer as a GTK widget

Multimedia Libraries

Libraries that deal with multimedia and gaming functionality.

  • GStreamer (PyDoc) -- multimedia streaming library
  • CSound -- the CSound audio-generation library
  • OLPC Games -- PyGame wrapper that makes working within the OLPC-XO environment relatively straightforward (Strongly recommended for PyGame usage on the XO!)
  • PyGame -- GUI library suitable for Sprite-based 2D game development

Communications and Networking

Libraries for connecting to other processes, either on the local machine or across the network

  • D-BUS (PyDoc) -- desktop messaging (Remote Procedure Call (RPC) and Asynchronous Signalling) engine
  • Telepathy -- buddy and connection management including cross-machine RPC over D-BUS
  • PyXPCOM -- Library for controlling XPCOM applications (currently just XULRunner on the XO) XXX Should be available, but doesn't appear to be (that is, import xpcom doesn't work)

Support Libraries

Libraries which aren't neither GUI nor multi-media

  • SECore -- search engine implementation
  • JSON -- Javascript Object Notation parser/linearisation library
  • UrlGrabber -- url downloading library
  • OLPC -- the data-store implementation
  • Unicode -- the laptop must provide internationalized software, as a result you will need to use Python's Unicode support

Extraneous Libraries

Libraries which are present in the current builds, but not particularly "part" of the Sugar environment and which may be removed eventually.

  • Yum -- package manager for RPM-based distributions
  • RPM -- RPM manipulation library

Smalltalk Libraries

C Libraries

D-BUS Services

System Services/Hardware

  • Forth Lessons -- Series of tutorial-style lessons on the Forth language and the Open Firmware bios-replacement system on the laptop
  • DCON -- the display controller ASIC and its interface (note that normally you would use the HardwareManager D-BUS interface to manipulate the DCON)
  • Geode -- the Geode CPU (assembly-language optimization guide, links to data-sheets)