OpenmokoFramework

From Openmoko

(Difference between revisions)
Jump to: navigation, search
m (High Level)
m (Minor grammatical/typographical edits.)
Line 3: Line 3:
 
{{Distributions|FSO}}
 
{{Distributions|FSO}}
  
FSO is an abbreviation for FreeSmartphone.Org. With FSO Openmoko is trying to make some stable back end software. This distribution will be merged with the 2008.8 distribution (or it's successor) when the system is stable enough. For more information see http://www.freesmartphone.org and http://trac.freesmartphone.org
+
FSO is an abbreviation for FreeSmartphone.Org. With FSO, Openmoko is trying to make some stable back-end software. This distribution will be merged with the 2008.8 distribution (or its successor) when the system is stable enough. For more information see http://www.freesmartphone.org and http://trac.freesmartphone.org .
  
 
=Q/A=
 
=Q/A=
Line 11: Line 11:
 
* ''Answer'': No.
 
* ''Answer'': No.
 
* ''Question'': When can I see this as part of an image?
 
* ''Question'': When can I see this as part of an image?
* ''Answer'': Not before winter '08.
+
* ''Answer'': Not before winter 2008.
 
* ''Question'': What's the current status?
 
* ''Question'': What's the current status?
* ''Answer'': See right below or hop over to http://trac.freesmartphone.org
+
* ''Answer'': See right below or hop over to http://trac.freesmartphone.org .
 
** [[OpenmokoFramework/Status Update 1|Status Update 1]]
 
** [[OpenmokoFramework/Status Update 1|Status Update 1]]
 
** [[OpenmokoFramework/Status Update 2|Status Update 2]]
 
** [[OpenmokoFramework/Status Update 2|Status Update 2]]
Line 21: Line 21:
  
 
= Timeline=
 
= Timeline=
* august/september: [http://n2.nabble.com/FSO-milestone-2-Zhone-sending-digit-tp740432p740546.html milestone 3]
+
* August/September: [http://n2.nabble.com/FSO-milestone-2-Zhone-sending-digit-tp740432p740546.html milestone 3]
* 01/07/2008: [[OpenmokoFramework/Status Update 3|milestone 2]]  archieved
+
* 01/07/2008: [[OpenmokoFramework/Status Update 3|milestone 2]]  achieved
* 01/06/2008: [[OpenmokoFramework/Status Update 2|milestone 1]]  archieved
+
* 01/06/2008: [[OpenmokoFramework/Status Update 2|milestone 1]]  achieved
  
 
=Purposes=
 
=Purposes=
Line 38: Line 38:
  
 
=How to achieve that technically=
 
=How to achieve that technically=
* Choose [[Dbus]] as the collaboration line. Below dbus, we can work together. Above dbus, we can differentiate.
+
* Choose [[Dbus|dbus]] as the collaboration line. Below dbus, we can work together. Above dbus, we can differentiate
* Expose features through dbus APIs implemented by UI-agnostic and language-agnostic services (daemons).
+
* Expose features through dbus APIs implemented by UI-agnostic and language-agnostic services (daemons)
* Optimize for Openmoko devices, but support multiple architectures and purposes through plugin interfaces and suitable hardware abstraction mechanisms.
+
* Optimize for Openmoko devices, but support multiple architectures and purposes through plugin interfaces and suitable hardware abstraction mechanisms
* Be not afraid of reinventing the wheel for a wheel-barrow if all the existing wheels are made for sports cars.
+
* By not being afraid of reinventing the wheel for a wheelbarrow if all the existing wheels are made for sports cars
  
=Mandatory Readings=
+
=Mandatory Reading=
 
* [http://adam.gomaa.us/blog/frameworks-exist-for-conceptual-integrity/ Frameworks exist for conceptual integrity]
 
* [http://adam.gomaa.us/blog/frameworks-exist-for-conceptual-integrity/ Frameworks exist for conceptual integrity]
 
* [http://humanized.com/weblog/2007/10/05/make_oss_humane/ Ten ways to make more humane open source software]
 
* [http://humanized.com/weblog/2007/10/05/make_oss_humane/ Ten ways to make more humane open source software]
Line 61: Line 61:
 
=Software Components=
 
=Software Components=
  
We differenciate between low-level and high-level services -- dbus will be used to communicate horizontally and vertically.
+
We differentiate between low-level and high-level services -- dbus will be used to communicate horizontally and vertically.
  
 
===Low-Level Services===
 
===Low-Level Services===
Line 69: Line 69:
 
* GSM, WiFi, Bluetooth, GPS, as well as
 
* GSM, WiFi, Bluetooth, GPS, as well as
 
* Backlight brightness and power,
 
* Backlight brightness and power,
* turning LEDs on and off, etc.
+
* Turning LEDs on and off, etc.
 
It also deals with
 
It also deals with
* charging, suspend/resume,
+
* Charging, suspend/resume,
* accellerometers, and buttons.
+
* Accelerometers, and buttons.
 
Last but not least, it sends notifications about the user's activity so that listeners have a chance to
 
Last but not least, it sends notifications about the user's activity so that listeners have a chance to
* change to powersaving modes, or
+
* Change to powersaving modes, or
* lock the device.
+
* Lock the device.
 
We implement the following software for that:
 
We implement the following software for that:
 
* [http://www.freesmartphone.org/index.php/Implementations/OpenDeviceDaemon odeviced]
 
* [http://www.freesmartphone.org/index.php/Implementations/OpenDeviceDaemon odeviced]
  
 
====Audio====
 
====Audio====
The low level audio service relies on a working alsa device driver. On top of that, there are two components:
+
The low level audio service relies on a working ALSA device driver. On top of that, there are two components:
 
# [http://gstreamer.freedesktop.org/ gstreamer]
 
# [http://gstreamer.freedesktop.org/ gstreamer]
 
# [http://pulseaudio.org pulseaudio]
 
# [http://pulseaudio.org pulseaudio]
Line 90: Line 90:
 
On further reflection, it seems Pulseaudio will not be used as it currently doesn't provide good performance on this hardware.  Alsa/dmix will be used instead. [http://lists.openmoko.org/pipermail/devel/2008-July/000253.html]
 
On further reflection, it seems Pulseaudio will not be used as it currently doesn't provide good performance on this hardware.  Alsa/dmix will be used instead. [http://lists.openmoko.org/pipermail/devel/2008-July/000253.html]
 
====GSM====
 
====GSM====
The low level GSM services expect a modem complying to GSM 07.07, GSM 07.05, and assorted GSM specifications, talking an AT-protocol over a serial line. If GSM 07.10 is supported, we use the multiplexing daemon
+
The low level GSM services expect a modem complying to GSM 07.07, GSM 07.05, and assorted GSM specifications, talking an AT-protocol over a serial line. If GSM 07.10 is supported, we use the multiplexing daemon...
 
* [http://www.freesmartphone.org/index.php/Implementations/gsm0710muxd gsm0710muxd]
 
* [http://www.freesmartphone.org/index.php/Implementations/gsm0710muxd gsm0710muxd]
to export virtual serial lines over -- again -- AT-protocol can be spoken.
+
...to export virtual serial lines over -- again -- AT-protocol can be spoken.
  
 
====Bluetooth====
 
====Bluetooth====
Line 105: Line 105:
 
The low level networking service assumes network interfaces, such as USB, Ethernet, Wifi, etc. We rely on the following software here:
 
The low level networking service assumes network interfaces, such as USB, Ethernet, Wifi, etc. We rely on the following software here:
 
* Network Manager or Intel Connection Manager (undecided yet)
 
* Network Manager or Intel Connection Manager (undecided yet)
* ppp
+
* PPP
  
 
===High Level===
 
===High Level===
  
 
====Usage====
 
====Usage====
The Usage subsystem is coordinating application I/O requirements preventing. Applications are not supposed to turn on or off devices, since they do not have any knowledge about concurrent applications that may be also using the device -- think ''reference counting'' for I/O requirements.
+
The Usage subsystem is concerned with coordinating application I/O requirements. Applications are not supposed to turn on or off devices, since they do not have any knowledge about concurrent applications that may be also using the device -- think ''reference counting'' for I/O requirements.
  
 
With this added layer, we could later think about monitoring subsystems, subsystem usage statistics, or accounting.
 
With this added layer, we could later think about monitoring subsystems, subsystem usage statistics, or accounting.
Line 117: Line 117:
  
 
====Events====
 
====Events====
* signaling events via I/O (ringing, blinking, vibrating)
+
* Signalling events via I/O (ringing, blinking, vibrating)
* might use fd.o notification API
+
* Might use fd.o notification API
  
 
====PIM====
 
====PIM====
An intelligent storage database server. This is being carried out as a Google Summer of Code project. See complete description [http://www.neo1973-germany.de/wiki/pyPimd here]
+
An intelligent storage database server. This is being carried out as a Google Summer of Code project. See complete description [http://www.neo1973-germany.de/wiki/pyPimd here].
  
 
====Context====
 
====Context====
Line 132: Line 132:
  
 
=== [http://www.freesmartphone.org/index.php/Implementations/OpenPreferencesDaemon Preferences] ===
 
=== [http://www.freesmartphone.org/index.php/Implementations/OpenPreferencesDaemon Preferences] ===
* settings database
+
* Settings database
  
 
====Network====
 
====Network====
* high level networking queries
+
* High-level networking queries
  
 
=Implementation=
 
=Implementation=
Line 141: Line 141:
 
===Completion Status===
 
===Completion Status===
  
====Low Level====
+
====Low-Level====
* device control: 50%
+
* Device control: 50%
* audio: 80%
+
* Audio: 80%
 
* GSM: 90%
 
* GSM: 90%
 
* GPRS: 90%
 
* GPRS: 90%
Line 166: Line 166:
 
=The role of Python=
 
=The role of Python=
  
Where we write new code, we will use Python to implement the dbus services. The reason for that being the rapid prototyping nature of Python and the emphasis on the Dbus APIs. Using Python, the turnaround times to experiment with APIs are incredibly faster than for using a compiled language such as C or C++.
+
Where we write new code, we will use Python to implement the dbus services. The reason for that being the rapid prototyping nature of Python and the emphasis on the [[Dbus|dbus]] APIs. Using Python, the turnaround times to experiment with APIs are incredibly faster than for using a compiled language such as C or C++.
  
 
Once the APIs have been used by application programmers, we can start profiling and possibly reimplement some of the services with daemons written in Vala, ''if'' necessary. We might as well succeed in improving performance by using Pyrex/Cython/Ctypes to keep the benefits of Python.
 
Once the APIs have been used by application programmers, we can start profiling and possibly reimplement some of the services with daemons written in Vala, ''if'' necessary. We might as well succeed in improving performance by using Pyrex/Cython/Ctypes to keep the benefits of Python.

Revision as of 22:20, 24 August 2008

Key pages on:
FSO

(Other distributions)


FSO is one of the many distributions that currently work on the Openmoko phones. You can compare a distribution with an Operating System on normal computers. It gives the phone all the software needed for operating. For more information about the different flavors, see distributions.

FSO is an abbreviation for FreeSmartphone.Org. With FSO, Openmoko is trying to make some stable back-end software. This distribution will be merged with the 2008.8 distribution (or its successor) when the system is stable enough. For more information see http://www.freesmartphone.org and http://trac.freesmartphone.org .

Contents

Q/A

  • Question: Is this an Openmoko-only thing?
  • Answer: No. It's going to be available for all kinds of mobile hardware running Linux, i.e. OpenEZX, XanaduX, HTC/iPAQ, ...
  • Question: Is this a part of the current images yet? Is it perhaps the mystic ASU?
  • Answer: No.
  • Question: When can I see this as part of an image?
  • Answer: Not before winter 2008.
  • Question: What's the current status?
  • Answer: See right below or hop over to http://trac.freesmartphone.org .
  • Question: How do I work the Zhone (FSO demo app) UI?
  • Answer: FSO UI Tutorial

Timeline

Purposes

  • Give people the infrastructure to create solid and exciting software products based on the Openmoko platform
  • Support competing UIs while collaborating on developing services
  • Encourage framework users (e.g. application developers) to also contribute to the framework

Requirements

  • Make it simple
  • Concentrate on core services
  • Be programming language agnostic
  • Be UI toolkit agnostic
  • Try to reuse existing technologies as much as possible, but not at the cost of a bad API

How to achieve that technically

  • Choose dbus as the collaboration line. Below dbus, we can work together. Above dbus, we can differentiate
  • Expose features through dbus APIs implemented by UI-agnostic and language-agnostic services (daemons)
  • Optimize for Openmoko devices, but support multiple architectures and purposes through plugin interfaces and suitable hardware abstraction mechanisms
  • By not being afraid of reinventing the wheel for a wheelbarrow if all the existing wheels are made for sports cars

Mandatory Reading

What this is NOT about

This initiative does not cover low level services such as

  • Bootloader, Kernel, or System Init.

This initiative does not cover high level services such as

  • X-Window-System, Window Manager, UI Toolkits,
  • Application Launchers, Applications, or Fancy UIs.

Architectural Overview

frontside

Software Components

We differentiate between low-level and high-level services -- dbus will be used to communicate horizontally and vertically.

Low-Level Services

Device Control

The low level device control service manages peripheral control, i.e. controlling power for individual subsystems such as

  • GSM, WiFi, Bluetooth, GPS, as well as
  • Backlight brightness and power,
  • Turning LEDs on and off, etc.

It also deals with

  • Charging, suspend/resume,
  • Accelerometers, and buttons.

Last but not least, it sends notifications about the user's activity so that listeners have a chance to

  • Change to powersaving modes, or
  • Lock the device.

We implement the following software for that:

Audio

The low level audio service relies on a working ALSA device driver. On top of that, there are two components:

  1. gstreamer
  2. pulseaudio

Gstreamer is to be used for all kinds of event sounds where a) multiple audio formats need to be supported and b) a latency of about one second is acceptable. This goes for e.g. ring tones, welcome tones, plug indication.

Pulseaudio is to be used for event sounds, where low-latency is necessary, e.g. touch click sounds and UI event acknowledge sounds. Pulseaudio is our general all-purpose mixer. Gstreamer will use the pulseaudio sink to feed audio through.

On further reflection, it seems Pulseaudio will not be used as it currently doesn't provide good performance on this hardware. Alsa/dmix will be used instead. [1]

GSM

The low level GSM services expect a modem complying to GSM 07.07, GSM 07.05, and assorted GSM specifications, talking an AT-protocol over a serial line. If GSM 07.10 is supported, we use the multiplexing daemon...

...to export virtual serial lines over -- again -- AT-protocol can be spoken.

Bluetooth

The low level Bluetooth services rely on the official Linux Bluetooth subsystem:

GPS

The low level GPS services assume a GPS device that talks NMEA over a device node. We rely on the following software:

Network

The low level networking service assumes network interfaces, such as USB, Ethernet, Wifi, etc. We rely on the following software here:

  • Network Manager or Intel Connection Manager (undecided yet)
  • PPP

High Level

Usage

The Usage subsystem is concerned with coordinating application I/O requirements. Applications are not supposed to turn on or off devices, since they do not have any knowledge about concurrent applications that may be also using the device -- think reference counting for I/O requirements.

With this added layer, we could later think about monitoring subsystems, subsystem usage statistics, or accounting.

See discussion page about PolicyKit.

Events

  • Signalling events via I/O (ringing, blinking, vibrating)
  • Might use fd.o notification API

PIM

An intelligent storage database server. This is being carried out as a Google Summer of Code project. See complete description here.

Context

  • Intelligent context API, integrating location as one -- among other -- sources

TBD Reference Geoclue

Phone

The phone subsystem can be used to create and manage voices communications. It makes abstraction of the protocol used.

Preferences

  • Settings database

Network

  • High-level networking queries

Implementation

Completion Status

Low-Level

  • Device control: 50%
  • Audio: 80%
  • GSM: 90%
  • GPRS: 90%
  • Bluetooth: 80%
  • GPS: 80%
  • Network: 50%

High Level

Tools

  • mdbus -- a dbus introspection and interaction utility,
  • cli-framework -- a python dbus command line interface.
  • mickeyterm -- a MUXer-aware minimal terminal emulator.

The role of Python

Where we write new code, we will use Python to implement the dbus services. The reason for that being the rapid prototyping nature of Python and the emphasis on the dbus APIs. Using Python, the turnaround times to experiment with APIs are incredibly faster than for using a compiled language such as C or C++.

Once the APIs have been used by application programmers, we can start profiling and possibly reimplement some of the services with daemons written in Vala, if necessary. We might as well succeed in improving performance by using Pyrex/Cython/Ctypes to keep the benefits of Python.

Team & Roadmap

Team

Subsystem Ownership

Phase 1 subsystems

  • odeviced (mickey)
  • ogsmd (mickey)
  • ousaged (jan)
  • oeventd (jan)
  • ophoned (guillaume)
  • opreferencesd (guillaume)
  • ocontextd (guillaume)
  • ogpsd (daniel)

Phase 2 subsystems

  • network (to be defined)
  • pim (to be defined)

Roadmap

The milestone releases are combined Openmoko Framework and Zhone releases. Remember: A feature that isn't visible, working, and tested in our framework testing application (Zhone) does not exist. Until Framework 1.0.0 (later this year), we will not use any versioning in components. Afterwards, individual components may see individual releases.

Note: The milestones and tasks moved over to our issue tracker.

Personal tools
Key pages on:
FSO

(Other distributions)


FSO is one of the many distributions that currently work on the Openmoko phones. You can compare a distribution with an Operating System on normal computers. It gives the phone all the software needed for operating. For more information about the different flavors, see distributions.

FSO is an abbreviation for FreeSmartphone.Org. With FSO, Openmoko is trying to make some stable back-end software. This distribution will be merged with the 2008.8 distribution (or its successor) when the system is stable enough. For more information see http://www.freesmartphone.org and http://trac.freesmartphone.org .

Q/A

  • Question: Is this an Openmoko-only thing?
  • Answer: No. It's going to be available for all kinds of mobile hardware running Linux, i.e. OpenEZX, XanaduX, HTC/iPAQ, ...
  • Question: Is this a part of the current images yet? Is it perhaps the mystic ASU?
  • Answer: No.
  • Question: When can I see this as part of an image?
  • Answer: Not before winter 2008.
  • Question: What's the current status?
  • Answer: See right below or hop over to http://trac.freesmartphone.org .
  • Question: How do I work the Zhone (FSO demo app) UI?
  • Answer: FSO UI Tutorial

Timeline

Purposes

  • Give people the infrastructure to create solid and exciting software products based on the Openmoko platform
  • Support competing UIs while collaborating on developing services
  • Encourage framework users (e.g. application developers) to also contribute to the framework

Requirements

  • Make it simple
  • Concentrate on core services
  • Be programming language agnostic
  • Be UI toolkit agnostic
  • Try to reuse existing technologies as much as possible, but not at the cost of a bad API

How to achieve that technically

  • Choose dbus as the collaboration line. Below dbus, we can work together. Above dbus, we can differentiate
  • Expose features through dbus APIs implemented by UI-agnostic and language-agnostic services (daemons)
  • Optimize for Openmoko devices, but support multiple architectures and purposes through plugin interfaces and suitable hardware abstraction mechanisms
  • By not being afraid of reinventing the wheel for a wheelbarrow if all the existing wheels are made for sports cars

Mandatory Reading

What this is NOT about

This initiative does not cover low level services such as

  • Bootloader, Kernel, or System Init.

This initiative does not cover high level services such as

  • X-Window-System, Window Manager, UI Toolkits,
  • Application Launchers, Applications, or Fancy UIs.

Architectural Overview

frontside

Software Components

We differentiate between low-level and high-level services -- dbus will be used to communicate horizontally and vertically.

Low-Level Services

Device Control

The low level device control service manages peripheral control, i.e. controlling power for individual subsystems such as

  • GSM, WiFi, Bluetooth, GPS, as well as
  • Backlight brightness and power,
  • Turning LEDs on and off, etc.

It also deals with

  • Charging, suspend/resume,
  • Accelerometers, and buttons.

Last but not least, it sends notifications about the user's activity so that listeners have a chance to

  • Change to powersaving modes, or
  • Lock the device.

We implement the following software for that:

Audio

The low level audio service relies on a working ALSA device driver. On top of that, there are two components:

  1. gstreamer
  2. pulseaudio

Gstreamer is to be used for all kinds of event sounds where a) multiple audio formats need to be supported and b) a latency of about one second is acceptable. This goes for e.g. ring tones, welcome tones, plug indication.

Pulseaudio is to be used for event sounds, where low-latency is necessary, e.g. touch click sounds and UI event acknowledge sounds. Pulseaudio is our general all-purpose mixer. Gstreamer will use the pulseaudio sink to feed audio through.

On further reflection, it seems Pulseaudio will not be used as it currently doesn't provide good performance on this hardware. Alsa/dmix will be used instead. [1]

GSM

The low level GSM services expect a modem complying to GSM 07.07, GSM 07.05, and assorted GSM specifications, talking an AT-protocol over a serial line. If GSM 07.10 is supported, we use the multiplexing daemon...

...to export virtual serial lines over -- again -- AT-protocol can be spoken.

Bluetooth

The low level Bluetooth services rely on the official Linux Bluetooth subsystem:

GPS

The low level GPS services assume a GPS device that talks NMEA over a device node. We rely on the following software:

Network

The low level networking service assumes network interfaces, such as USB, Ethernet, Wifi, etc. We rely on the following software here:

  • Network Manager or Intel Connection Manager (undecided yet)
  • PPP

High Level

Usage

The Usage subsystem is concerned with coordinating application I/O requirements. Applications are not supposed to turn on or off devices, since they do not have any knowledge about concurrent applications that may be also using the device -- think reference counting for I/O requirements.

With this added layer, we could later think about monitoring subsystems, subsystem usage statistics, or accounting.

See discussion page about PolicyKit.

Events

  • Signalling events via I/O (ringing, blinking, vibrating)
  • Might use fd.o notification API

PIM

An intelligent storage database server. This is being carried out as a Google Summer of Code project. See complete description here.

Context

  • Intelligent context API, integrating location as one -- among other -- sources

TBD Reference Geoclue

Phone

The phone subsystem can be used to create and manage voices communications. It makes abstraction of the protocol used.

Preferences

  • Settings database

Network

  • High-level networking queries

Implementation

Completion Status

Low-Level

  • Device control: 50%
  • Audio: 80%
  • GSM: 90%
  • GPRS: 90%
  • Bluetooth: 80%
  • GPS: 80%
  • Network: 50%

High Level

Tools

  • mdbus -- a dbus introspection and interaction utility,
  • cli-framework -- a python dbus command line interface.
  • mickeyterm -- a MUXer-aware minimal terminal emulator.

The role of Python

Where we write new code, we will use Python to implement the dbus services. The reason for that being the rapid prototyping nature of Python and the emphasis on the dbus APIs. Using Python, the turnaround times to experiment with APIs are incredibly faster than for using a compiled language such as C or C++.

Once the APIs have been used by application programmers, we can start profiling and possibly reimplement some of the services with daemons written in Vala, if necessary. We might as well succeed in improving performance by using Pyrex/Cython/Ctypes to keep the benefits of Python.

Team & Roadmap

Team

Subsystem Ownership

Phase 1 subsystems

  • odeviced (mickey)
  • ogsmd (mickey)
  • ousaged (jan)
  • oeventd (jan)
  • ophoned (guillaume)
  • opreferencesd (guillaume)
  • ocontextd (guillaume)
  • ogpsd (daniel)

Phase 2 subsystems

  • network (to be defined)
  • pim (to be defined)

Roadmap

The milestone releases are combined Openmoko Framework and Zhone releases. Remember: A feature that isn't visible, working, and tested in our framework testing application (Zhone) does not exist. Until Framework 1.0.0 (later this year), we will not use any versioning in components. Afterwards, individual components may see individual releases.

Note: The milestones and tasks moved over to our issue tracker.