Added a README
[gregoa/zavai.git] / README
1 README for zavai
2
3 "zavai" is a word of the Bolognese language which means "useless thing of no
4 value". The idea that I'm trying to do what I can with what I have.
5
6 It is written with the purpose of working for me; everything else is optional.
7 Feature requests for things that I don't need will likely be ignored unless
8 of course they come with patches.
9
10 Getting it to work:
11
12  * Install dependencies
13
14    apt-get install valac libglib2.0-dev libdbus-glib-1-dev libgee-dev libgtk2.0-dev libwnck-dev
15
16    Optional: apt-get install polygen polygen-data
17
18  * Compile
19
20    ./configure; make
21
22  * Install dbus.d configuration file
23
24    cp conf/zavai.conf /etc/dbus-1/system.d/
25
26  * Copy the .desktop files of the applications you use more often in ~/.zavai
27
28    For example:
29
30    mkdir ~/.zavai
31    cp /usr/share/applications/tangogps.desktop ~/.zavai
32    cp /usr/share/applications/navit.desktop ~/.zavai
33    cp /usr/share/applications/vala-terminal.desktop ~/.zavai
34    cp /usr/share/applications/midori.desktop ~/.zavai
35    cp /usr/share/applications/zhone.desktop ~/.zavai
36    cp /usr/share/applications/FBReader.desktop ~/.zavai
37    cp conf/satmon.desktop ~/.zavai
38
39  * Update the information about the polygen grammars installed in the system
40    (optional) 
41
42    src/update-polygen-info
43
44  * Run zavai
45
46    ./run
47
48    This will run zavai and restart it if it quits/crashes. If you want to
49    restart zavai (for example after you build a new version) just choose
50    debug/quit.
51
52 Features / guide
53
54  * Power menu
55
56  Push the power button to get the power menu, with options to
57  suspend/shutdown/reboot, lock the screen and keep the backlight always on
58  (useful if you are using the openmoko as a satellite navigator in the car)
59
60  * Lock screen
61
62  Hold the power button longer to lock / unlock the screen. If the screen is
63  locked you see a lock icon in the traybar.
64
65  A short push of the power button while locked will turn on the backlight for a
66  bit, which is useful if you want to check the map for a moment. Another short
67  push will show the main zavai window, which is useful if you want to see the
68  time. Another short push will hide the main zavai window.
69
70  * Main window
71
72  In the main window you see the time. If your GPS has a fix, the time comes
73  from the GPS.
74
75  In the top left there is a gps icon. Push it to toggle the GPS to be always on
76  (useful to restart tangogps or navit without needing to reacquire a fix).
77
78  In the bottom there is a button to access the main menu.
79
80  * Tray bar
81
82  Zavai shows several tray bar buttons. One kills the current application (or
83  goes back in the menu if the current application is zavai).
84
85  One hides and shows zavai.
86
87  One hides and shows the keyboard.
88  
89  One shows the status of the battery.
90
91  * The menu
92
93  The menu should be self-explanatory. It has options for simple GPS management
94  tasks, setting an alarm, running applications, a task switcher, and a polygen
95  interface.
96
97  * Alarms
98
99  It is possible to set an alarm, which will be shown in the alarm window. When
100  the alarm expires, the phone wakes up if it is suspended, and zavai does
101  nothing but print an error message on standard error.
102  
103  When there will be a documented API to turn OFF the vibrator, I'll implement
104  vibration on alarm.  When I'll implement some audio playing infrastructure,
105  I'll implement playing an audio file as well.
106
107  Patches welcome.
108
109 Stability / design
110
111  Zavai currently focuses on the interface side, trying to make it easy for me
112  to reach the functions that I need. I try not to focus on hardware details
113  (yet) (when I can), so I build it on the freesmartphone framework, which is
114  unstable, underdocumented and sometimes untested, whose developers so far have
115  never answered my questions and whose API tends to change every now and again.
116
117  This said, I'm surprised it works for me so far.
118
119 TODO list / wish list
120
121  * FSO API "documentation":
122  http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/index.html;hb=HEAD
123
124  * Features to add:
125  - "GPS has crashed" button that turns off and on the GPS
126     - After pushing, turn into a "GPS crashed AGAIN" button that turns the GPS
127       off, removes /var/lib/freesmartphone/ogpsd.pickle and then turns it back
128       on again.
129  - icon linking to "current apps" in the main screen
130  - alarm
131     - vibrate at alarm trigger
132     - play sound at alarm trigger
133     - leave expired alarm on screen until acknowledged
134       (alarm status icon that also brings to alarm menu)
135     - remember alarm names (on request, maybe with an add feature) and how
136       often they are triggered, and show them most frequent first
137     - remember unexpired alarms persistently (again, a table in sqlite?) so
138       that they can be reinstated if zavai is restarted
139     - show active alarms and allow to delete them
140  - calendar, just the GTK calendar widget with buttons to go back, forth and
141    current (fill in with opimd if it will make sense)
142     - fill in day info with data coming from the laptop, but just read only,
143       without edit features. Good to check what's on for the day, and notes can
144       be taken with pen and paper for now
145  - GPX status icon (off, waiting for fix, recording)
146  - GPX waypoint using AUX button
147  - GPX + Audio track
148  - track EPV (and similar) in gpx and kill trackpoints with bad accuracy
149  - Audio note
150     - shortcut icon in main screen
151  - Wake up alarm
152  - Toggle wireless
153     - turn on/off chip
154     - start/stop wicd
155     - start/stop wicd-client
156  - Suspend phone if not calling and gps is not on and backlight is not on
157    (maybe with idle notifier?)
158  - Phone from kapula (or just running kapula)
159  - Split polygen applet in a separate app, ran via a .desktop file
160    (faster zavai startup time, can then integrate a browser in the polygen
161     applet, makes more sense altogether)
162  - Is there a way to lock the screen completely turning off the touchscreen, so
163    that interrupts are not even generated?
164
165  * Not quite needed yet:
166  - GPX log with more features (quality, course, speed, ...)
167  - Take a waypoint then show a menu with a timeout
168     - Add a scribbled note
169     - Add an audio note
170     - Add a text note (tickling the text input method thing)
171    If timeout expires, leave the waypoint with the automatic name
172  - restart zavai
173    (also on dbus fuckup)
174    (can be done by just quitting and let the runner script restart it)
175  - get fix events without requesting the GPX resource (and then? gpx log all the time? what for?)