An item off the todo list
[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    # Build time
15    apt-get install valac libglib2.0-dev libdbus-glib-1-dev libgee-dev libgtk2.0-dev libwnck-dev libdevkit-power-gobject-dev
16
17    # Runtime
18    apt-get install devicekit-power
19
20    # Optional runtime
21    apt-get install polygen polygen-data
22
23  * Compile
24
25    ./configure; make
26
27  * Install dbus.d configuration file
28
29    cp conf/zavai.conf /etc/dbus-1/system.d/
30
31  * Copy the .desktop files of the applications you use more often in ~/.zavai
32
33    For example:
34
35    mkdir ~/.zavai
36    cp /usr/share/applications/tangogps.desktop ~/.zavai
37    cp /usr/share/applications/navit.desktop ~/.zavai
38    cp /usr/share/applications/vala-terminal.desktop ~/.zavai
39    cp /usr/share/applications/midori.desktop ~/.zavai
40    cp /usr/share/applications/zhone.desktop ~/.zavai
41    cp /usr/share/applications/FBReader.desktop ~/.zavai
42    cp conf/satmon.desktop ~/.zavai
43
44  * Copy accessory scripts in ~/.zavai
45
46    cp hooks/display ~/.zavai
47    cp hooks/keyboard ~/.zavai
48
49  * Update the information about the polygen grammars installed in the system
50    (optional) 
51
52    src/update-polygen-info
53
54  * Run zavai
55
56    ./run
57
58    This will run zavai and restart it if it quits/crashes. If you want to
59    restart zavai (for example after you build a new version) just choose
60    debug/quit.
61
62 Features / guide
63
64  * Power menu
65
66  Push the power button to get the power menu, with options to
67  suspend/shutdown/reboot, lock the screen and keep the backlight always on
68  (useful if you are using the openmoko as a satellite navigator in the car)
69
70  * Lock screen
71
72  Hold the power button longer to lock / unlock the screen. If the screen is
73  locked you see a lock icon in the traybar.
74
75  A short push of the power button while locked will turn on the backlight for a
76  bit, which is useful if you want to check the map for a moment. Another short
77  push will show the main zavai window, which is useful if you want to see the
78  time. Another short push will hide the main zavai window.
79
80  * Main window
81
82  In the main window you see the time. If your GPS has a fix, the time comes
83  from the GPS.
84
85  In the top left there is a gps icon. Push it to toggle the GPS to be always on
86  (useful to restart tangogps or navit without needing to reacquire a fix).
87
88  In the bottom there is a button to access the main menu.
89
90  * Tray bar
91
92  Zavai shows several tray bar buttons. One kills the current application (or
93  goes back in the menu if the current application is zavai).
94
95  One hides and shows zavai.
96
97  One hides and shows the keyboard.
98  
99  One shows the status of the battery.
100
101  * The menu
102
103  The menu should be self-explanatory. It has options for simple GPS management
104  tasks, setting an alarm, running applications, a task switcher, and a polygen
105  interface.
106
107  * Alarms
108
109  It is possible to set an alarm, which will be shown in the alarm window. When
110  the alarm expires, the phone wakes up if it is suspended, and zavai vibrates
111  for 5 seconds.
112
113  It is planned to use the AUX button to acknowledge the alarm and stop the
114  vibration; when this will happen, vibration can go on for more than 5 seconds.
115  
116  When I'll implement some audio playing infrastructure, I'll implement playing
117  an audio file as well.
118
119  Also missing are a popup that tells that an alarm is ringing, and a notifier
120  for unacknowledged popups.
121
122  Patches welcome.
123
124  * Calendar
125
126  You can reach the calendar from the menu or by clicking on the date in the
127  main screen.
128
129  The calendar shows notes on every day. You can add notes just by typing on the
130  white space below the calendar.
131
132  The notes are saved in ~/.zavai/cal/YEAR/MONTH/DAY.txt, feel free to:
133   - sync it with your main computer;
134   - create a tool that populates it using the information from your
135     favourite calendar system;
136   - interface zavai with a proper calendar system, without making the interface
137     harder to use (if you can).
138
139 Stability / design
140
141  Zavai currently focuses on the interface side, trying to make it easy for me
142  to reach the functions that I need. I try not to focus on hardware details
143  (yet) (when I can), so I build it on the freesmartphone framework, which is
144  unstable, underdocumented and sometimes untested, whose developers so far have
145  never answered my questions and whose API tends to change every now and again.
146
147  This said, I'm surprised it works for me so far.
148
149 TODO list / wish list
150
151  * FSO API "documentation":
152  http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/index.html;hb=HEAD
153
154  * Features to add:
155  - zavai calendar: show month notes
156  - zavai calendar: show global notes
157  - contacts: show as a fancy focus+context list (see prefuse)
158  - GSM power and network
159     - link to open SHR-dialer
160  - icon to show if there are new messages
161     - link to open SHR-messages
162  - switch backlight keep mode when on power/recharging
163     - the button changes the default for the current power mode
164  - alarm
165     + vibrate at alarm trigger
166     - play sound at alarm trigger
167     - acknowledge alarms with AUX button
168        - then, vibrate and play sound for longer
169     - popup that tells that an alarm is ringing
170     - leave expired alarm on screen until acknowledged
171       (alarm status icon that also brings to alarm menu)
172     - remember alarm names (on request, maybe with an add feature) and how
173       often they are triggered, and show them most frequent first
174     - remember unexpired alarms persistently (again, a table in sqlite?) so
175       that they can be reinstated if zavai is restarted
176     - show active alarms and allow to delete them
177  - unlock screen when receiving phone calls
178  - GPX status icon (off, waiting for fix, recording)
179  - GPX waypoint using AUX button
180  - GPX + Audio track
181  - track EPV (and similar) in gpx and kill trackpoints with bad accuracy
182  - Audio note
183     - shortcut icon in main screen
184  - Toggle wireless
185     - turn on/off chip
186     - start/stop wicd
187     - start/stop wicd-client
188  - Simple wireless scanner (code from guessnet)
189  - Suspend phone if not calling and gps is not on and backlight is not on
190    (maybe with idle notifier?)
191  - Phone from kapula (or just running kapula)
192  - Split polygen applet in a separate app, ran via a .desktop file
193    (faster zavai startup time, can then integrate a browser in the polygen
194     applet, makes more sense altogether)
195  - Is there a way to lock the screen completely turning off the touchscreen, so
196    that interrupts are not even generated?
197  - Timezone selector
198     - Location aware (show timezones in order of distance from current
199       location)
200  - Show timezone in clock
201
202  * To find out
203  - Why sometimes the phone will stop acting normal and will completely ignore
204    the screen for the purpose of screen dimming, that is, it will dim the
205    screen even if I'm using the touchscreen?
206
207  * Not quite needed yet:
208  - GPX log with more features (quality, course, speed, ...)
209  - Take a waypoint then show a menu with a timeout
210     - Add a scribbled note
211     - Add an audio note
212     - Add a text note (tickling the text input method thing)
213    If timeout expires, leave the waypoint with the automatic name
214  - restart zavai
215    (also on dbus fuckup)
216    (can be done by just quitting and let the runner script restart it)
217  - get fix events without requesting the GPX resource (and then? gpx log all the time? what for?)