README cleanup
[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  Details: the alarms are scheduled with at(1). Please see omhacks for simple
125  suspend hooks that will wake up the phone to run scheduled at jobs.
126
127  * Calendar
128
129  You can reach the calendar from the menu or by clicking on the date in the
130  main screen.
131
132  The calendar shows notes on every day. You can add notes just by typing on the
133  white space below the calendar.
134
135  The notes are saved in ~/.zavai/cal/YEAR/MONTH/DAY.txt, feel free to:
136   - sync it with your main computer;
137   - create a tool that populates it using the information from your
138     favourite calendar system;
139   - interface zavai with a proper calendar system, without making the interface
140     harder to use (if you can).
141
142 Stability / design
143
144  Zavai currently focuses on the interface side, trying to make it easy for me
145  to reach the functions that I need. I try not to focus on hardware details
146  (yet) (when I can), so I build it on the freesmartphone framework, which is
147  unstable, underdocumented and sometimes untested, whose developers so far have
148  never answered my questions and whose API tends to change every now and again.
149
150  This said, I'm surprised it works for me so far.
151
152 TODO list / wish list
153
154  * FSO API "documentation":
155  http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/index.html;hb=HEAD
156
157  * Features to add:
158  - fisheye list music player
159     - player page with seek/skip controls
160     - playlist editor
161     - chosen song start playing if nothing is being played
162     - chosen song moves to playlist editor: play, add to playlist, add dir to playlist
163       (show a standard list multiselectable with all the songs in the dir and
164       only the selected song selected; allow to select others, select all, add
165       selected to playlist)
166     - playlist as reorderable standard list, allow to delete tracks, reorder tracks
167     - save playlist to file to reload later
168     - pause with headset button
169  - volume control in power menu
170  - space buttons from sliders, to avoid shutting down instead of lowering the volume
171  - lua config
172  - battery without devkit: do the parsing via lua
173  - contacts: show as a fancy focus+context list (see prefuse)
174     - vcard on e-vcard.{h,c}
175     - ical on libical-dev
176     - vcard+index file
177     - lua functions to read things
178  - zavai-calendar as a separate app
179  - zavai-contacts as a separate app
180  - alarm
181     - vibrate at alarm trigger
182     - play sound at alarm trigger
183     - acknowledge alarms with AUX button
184        - then, vibrate and play sound for longer
185     - popup that tells that an alarm is ringing
186     - leave expired alarm on screen until acknowledged
187       (alarm status icon that also brings to alarm menu)
188     - remember alarm names (on request, maybe with an add feature) and how
189       often they are triggered, and show them most frequent first
190     - remember unexpired alarms persistently (again, a table in sqlite?) so
191       that they can be reinstated if zavai is restarted
192     - show active alarms and allow to delete them
193  - work without ogpsd
194     + power on/off the gps and start/stop gpsd
195     + set to keep the GPS on during suspend
196     - use the gpsd protocol to know if there is a fix or not
197     - suspend/resume hooks to put the GPS into low power mode
198  - next30: don't update if not shown currently on the notebook
199  - gtk_calendar_set_detail_func
200  - GSM power and network
201     - link to open SHR-dialer
202  - icon to show if there are new messages
203     - link to open SHR-messages
204  - switch backlight keep mode when on power/recharging
205     - the button changes the default for the current power mode
206  - unlock screen when receiving phone calls
207  - GPX status icon (off, waiting for fix, recording)
208  - GPX waypoint using AUX button
209  - GPX + Audio track
210  - track EPV (and similar) in gpx and kill trackpoints with bad accuracy
211  - Audio note
212     - shortcut icon in main screen
213  - Toggle wireless
214     - turn on/off chip
215     - start/stop wicd
216     - start/stop wicd-client
217  - Simple wireless scanner (code from guessnet, or minimal wicd client)
218  - Suspend phone if not calling and gps is not on and backlight is not on
219    (maybe with idle notifier?)
220  - Phone from kapula (or just running kapula)
221  - Timezone selector
222     - Location aware (show timezones in order of distance from current
223       location)
224  - Show timezone in clock
225
226  * To find out
227  + Why sometimes the phone will stop acting normal and will completely ignore
228    the screen for the purpose of screen dimming, that is, it will dim the
229    screen even if I'm using the touchscreen? (it was old ousaged brokenness)
230  - Is there a way to lock the screen completely turning off the touchscreen, so
231    that interrupts are not even generated?
232
233  * Not quite needed yet:
234  - GPX log with more features (quality, course, speed, ...)
235  - Take a waypoint then show a menu with a timeout
236     - Add a scribbled note
237     - Add an audio note
238     - Add a text note (tickling the text input method thing)
239    If timeout expires, leave the waypoint with the automatic name
240  - get fix events without requesting the GPX resource (and then? gpx log all the time? what for?)