Tichy

From Openmoko

(Difference between revisions)
Jump to: navigation, search
m
Line 1: Line 1:
 
{{Languages|Tichy}}
 
{{Languages|Tichy}}
 +
 +
<pre>
 +
      _      _         
 +
  _  (_)    | |           
 +
_| |_ _  ____| |__  _  _   
 +
(_  _) |/ ___)  _ \| | | |  A Python Applets Manager
 +
  | |_| ( (___| | | | |_| |
 +
  \__)_|\____)_| |_|\__  |  For OpenMoko
 +
                    (____/
 +
</pre>
  
 
[[Image:Tichy-main.png|thumb|tichy main window]]
 
[[Image:Tichy-main.png|thumb|tichy main window]]
Line 14: Line 24:
 
Tichy provides the following things :
 
Tichy provides the following things :
 
* Graphics User Interface widgets
 
* Graphics User Interface widgets
* Services registering and Requesting (for example an application that want to send a message will request for an application implementing  the message sending service)  
+
* Services registering and Requesting (for example an application that wants to send a message will request for an application implementing  the message sending service)  
* Tasklets system (This allow to write callback blocking application as if they where multi-threads)
+
* Tasklets system (This allow to write callback waiting process as if they were threads)
* Abstraction of Item / View (Just explain what you want to show, tichy will generate the widgets)
+
* Abstraction of Item / View
 +
* A plug in system that make it easy to add new functionalities / applets to tichy
 +
 
 +
== How to write an applets / plug-ins for tichy ? ==
 +
Unfortunately There is currently no documentation.
 +
 
 +
Fortunately it is very easy to do. If you want to write a new applet, you just need to create a new directory in tichy/test/plugins/apps/. You can have a look at the other plug-ins to get an idea of how to do it. A basic app look like this :
 +
 
 +
<pre>
 +
import tichy
 +
import tichy.gui as gui
 +
import tichy.item as item
 +
from tichy.application import Application
 +
 
 +
class MyApp(Application):
 +
    name = "My Application"
 +
    icon = 'icon.png'  # to be found in the app directory
 +
 
 +
    def run(self, parent):
 +
        w = gui.Window(parent, modal = True)  # We run into a new modal window
 +
        # Create a new frame with a "back" button on top
 +
        frame = gui.ApplicationFrame(w, self, back_button=True)
 +
       
 +
        # This box is used to store the widgets
 +
        box = gui.Box(frame, axis=1)
 +
       
 +
        # Create a text item
 +
        text = item.Text('click to edit', editable = True)
 +
        # Put a view of the item on the screen
 +
        text.view(box)
 +
       
 +
        # Add a button
 +
        button = gui.Button(box)
 +
        gui.Label(button, "click me")
 +
       
 +
        def on_click(b):
 +
            # "yield" means "block until the tasklet returns"
 +
            yield gui.Message(w, you just clicked the button)
 +
        button.connect('clicked', on_click)
 +
           
 +
        yield Wait(frame, 'back')    # Wait until the back button is clicked
 +
        w.close()                    # Don't forget to close the window
 +
</pre>
  
 
== Authors ==
 
== Authors ==
Line 27: Line 79:
  
 
== Running on the desktop ==
 
== Running on the desktop ==
Thanks to the service system, that allow to provide several version of the same service, Tichy can run as well on a desktop computer as on the neo.
+
Thanks to the service system, that allows to provide several version of the same service, Tichy can run as well on a desktop computer as on the neo. When run on a desktop, tichy will simulate phone functionalities, when run on the neo, it will use the [[OpenmokoFramework | Framework]].
  
 
To run it on the desktop, just download the sources, then go into test, and run  
 
To run it on the desktop, just download the sources, then go into test, and run  
Line 35: Line 87:
 
You will need to compile some files, see the README for more information on how to do it.
 
You will need to compile some files, see the README for more information on how to do it.
  
 +
== Dependencies ==
 
You need python 2.5 and some libraries installed :
 
You need python 2.5 and some libraries installed :
 
* python-pygame
 
* python-pygame
Line 41: Line 94:
 
* python-gst
 
* python-gst
 
* python-gobject
 
* python-gobject
 +
 +
== ipkg package ==
 +
We don't have a package for tichy yet...
  
 
[[Category:Applications]]
 
[[Category:Applications]]
 
[[Category:Guides]]
 
[[Category:Guides]]

Revision as of 05:43, 13 August 2008


       _       _           
   _  (_)     | |             
 _| |_ _  ____| |__  _   _    
(_   _) |/ ___)  _ \| | | |   A Python Applets Manager
  | |_| ( (___| | | | |_| |
   \__)_|\____)_| |_|\__  |   For OpenMoko
                    (____/ 
tichy main window
tichy drawing app
tichy style app
tichy freedesktop app
tichy keyboard app

Contents

About

Tichy is a python applets manager for embedded devices.

The goal of the project is to make it easy to write many kind of applications for openmoko using the python language.

Tichy provides the following things :

  • Graphics User Interface widgets
  • Services registering and Requesting (for example an application that wants to send a message will request for an application implementing the message sending service)
  • Tasklets system (This allow to write callback waiting process as if they were threads)
  • Abstraction of Item / View
  • A plug in system that make it easy to add new functionalities / applets to tichy

How to write an applets / plug-ins for tichy ?

Unfortunately There is currently no documentation.

Fortunately it is very easy to do. If you want to write a new applet, you just need to create a new directory in tichy/test/plugins/apps/. You can have a look at the other plug-ins to get an idea of how to do it. A basic app look like this :

import tichy
import tichy.gui as gui
import tichy.item as item
from tichy.application import Application

class MyApp(Application):
    name = "My Application"
    icon = 'icon.png'   # to be found in the app directory

    def run(self, parent):
        w = gui.Window(parent, modal = True)   # We run into a new modal window
        # Create a new frame with a "back" button on top
        frame = gui.ApplicationFrame(w, self, back_button=True)
        
        # This box is used to store the widgets
        box = gui.Box(frame, axis=1)
        
        # Create a text item
        text = item.Text('click to edit', editable = True)
        # Put a view of the item on the screen
        text.view(box)
        
        # Add a button
        button = gui.Button(box)
        gui.Label(button, "click me")
        
        def on_click(b):
            # "yield" means "block until the tasklet returns"
            yield gui.Message(w, you just clicked the button)
        button.connect('clicked', on_click) 
            
        yield Wait(frame, 'back')     # Wait until the back button is clicked
        w.close()                     # Don't forget to close the window

Authors

  • Guillaume "Charlie" Chereau, main developer
  • Michael "Goodwill" (Did the freedesktop app launcher plugin)

Sources

The sources can be found from svn repository on project.openmoko :

svn checkout svn://svn.projects.openmoko.org/svnroot/tichy

Running on the desktop

Thanks to the service system, that allows to provide several version of the same service, Tichy can run as well on a desktop computer as on the neo. When run on a desktop, tichy will simulate phone functionalities, when run on the neo, it will use the Framework.

To run it on the desktop, just download the sources, then go into test, and run

./tichy

Running on neo

You will need to compile some files, see the README for more information on how to do it.

Dependencies

You need python 2.5 and some libraries installed :

  • python-pygame
  • python-dbus
  • python-yaml
  • python-gst
  • python-gobject

ipkg package

We don't have a package for tichy yet...

Personal tools


tichy main window
tichy drawing app
tichy style app
tichy freedesktop app
tichy keyboard app

About

Tichy is a python applets manager for embedded devices.

The goal of the project is to make it easy to write many kind of applications for openmoko using the python language.

Tichy provides the following things :

  • Graphics User Interface widgets
  • Services registering and Requesting (for example an application that want to send a message will request for an application implementing the message sending service)
  • Tasklets system (This allow to write callback blocking application as if they where multi-threads)
  • Abstraction of Item / View (Just explain what you want to show, tichy will generate the widgets)

Authors

  • Guillaume "Charlie" Chereau, main developer
  • Michael "Goodwill" (Did the freedesktop app launcher plugin)

Sources

The sources can be found from svn repository on project.openmoko :

svn checkout svn://svn.projects.openmoko.org/svnroot/tichy

Running on the desktop

Thanks to the service system, that allow to provide several version of the same service, Tichy can run as well on a desktop computer as on the neo.

To run it on the desktop, just download the sources, then go into test, and run

./tichy

Running on neo

You will need to compile some files, see the README for more information on how to do it.

You need python 2.5 and some libraries installed :

  • python-pygame
  • python-dbus
  • python-yaml
  • python-gst
  • python-gobject