Show gps time when available
[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 \
16                    libwnck-dev libdevkit-power-gobject-dev \
17                    libomhacks-dev liblua5.1-dev
18
19    # Runtime
20    apt-get install devicekit-power
21
22    # Optional runtime
23    apt-get install polygen polygen-data
24
25  * Compile
26
27    ./configure; make
28
29  * Install dbus.d configuration file
30
31    cp conf/zavai.conf /etc/dbus-1/system.d/
32
33  * Copy the .desktop files of the applications you use more often in ~/.zavai
34
35    For example:
36
37    mkdir ~/.zavai
38    cp /usr/share/applications/tangogps.desktop ~/.zavai
39    cp /usr/share/applications/navit.desktop ~/.zavai
40    cp /usr/share/applications/vala-terminal.desktop ~/.zavai
41    cp /usr/share/applications/midori.desktop ~/.zavai
42    cp /usr/share/applications/zhone.desktop ~/.zavai
43    cp /usr/share/applications/FBReader.desktop ~/.zavai
44    cp conf/satmon.desktop ~/.zavai
45
46  * Copy accessory scripts in ~/.zavai
47
48    cp hooks/display ~/.zavai
49    cp hooks/keyboard ~/.zavai
50
51  * Update the information about the polygen grammars installed in the system
52    (optional) 
53
54    src/update-polygen-info
55
56  * Run zavai
57
58    ./run
59
60    This will run zavai and restart it if it quits/crashes. If you want to
61    restart zavai (for example after you build a new version) just choose
62    debug/quit.
63
64 Features / guide
65
66  * Power menu
67
68  Push the power button to get the power menu, with options to
69  suspend/shutdown/reboot, lock the screen and keep the backlight always on
70  (useful if you are using the openmoko as a satellite navigator in the car)
71
72  * Lock screen
73
74  Hold the power button longer to lock / unlock the screen. If the screen is
75  locked you see a lock icon in the traybar.
76
77  A short push of the power button while locked will turn on the backlight for a
78  bit, which is useful if you want to check the map for a moment. Another short
79  push will show the main zavai window, which is useful if you want to see the
80  time. Another short push will hide the main zavai window.
81
82  * Main window
83
84  In the main window you see the time. If your GPS has a fix, the time comes
85  from the GPS.
86
87  In the top left there is a gps icon. Push it to toggle the GPS to be always on
88  (useful to restart tangogps or navit without needing to reacquire a fix).
89
90  In the bottom there is a button to access the main menu.
91
92  * Tray bar
93
94  Zavai shows several tray bar buttons. One kills the current application (or
95  goes back in the menu if the current application is zavai).
96
97  One hides and shows zavai.
98
99  One hides and shows the keyboard.
100  
101  One shows the status of the battery.
102
103  * The menu
104
105  The menu should be self-explanatory. It has options for simple GPS management
106  tasks, setting an alarm, running applications, a task switcher, and a polygen
107  interface.
108
109  * Alarms
110
111  It is possible to set an alarm, which will be shown in the alarm window. When
112  the alarm expires, the phone wakes up if it is suspended, and zavai vibrates
113  for 5 seconds.
114
115  It is planned to use the AUX button to acknowledge the alarm and stop the
116  vibration; when this will happen, vibration can go on for more than 5 seconds.
117  
118  When I'll implement some audio playing infrastructure, I'll implement playing
119  an audio file as well.
120
121  Also missing are a popup that tells that an alarm is ringing, and a notifier
122  for unacknowledged popups.
123
124  Patches welcome.
125
126  Details: the alarms are scheduled with at(1). Please see omhacks for simple
127  suspend hooks that will wake up the phone to run scheduled at jobs.
128
129  * Calendar
130
131  You can reach the calendar from the menu or by clicking on the date in the
132  main screen.
133
134  The calendar shows notes on every day. You can add notes just by typing on the
135  white space below the calendar.
136
137  The notes are saved in ~/.zavai/cal/YEAR/MONTH/DAY.txt, feel free to:
138   - sync it with your main computer;
139   - create a tool that populates it using the information from your
140     favourite calendar system;
141   - interface zavai with a proper calendar system, without making the interface
142     harder to use (if you can).
143
144 Stability / design
145
146  Zavai currently focuses on the interface side, trying to make it easy for me
147  to reach the functions that I need. I try not to focus on hardware details
148  (yet) (when I can), so I build it on the freesmartphone framework, which is
149  unstable, underdocumented and sometimes untested, whose developers so far have
150  never answered my questions and whose API tends to change every now and again.
151
152  This said, I'm surprised it works for me so far.
153
154 TODO list / wish list
155
156  * FSO API "documentation":
157  http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/index.html;hb=HEAD
158
159  * Features to add:
160  - work without ogpsd
161     + power on/off the gps and start/stop gpsd
162     + set to keep the GPS on during suspend
163     + use the gpsd protocol to know if there is a fix or not
164     + time from the GPS in main clock
165     - suspend/resume hooks to put the GPS into low power mode
166     - GPS FixNow mode for sleeping
167  - log
168     - timestamp, coordinates
169     - message (structured) (json?)
170     - instant or period (start, end). Period have timestamp and coordinates at
171       start and end. And GPX track of trip.
172  - alarm
173     - log unacked alarms
174     - play sound at alarm trigger
175     - leave expired alarm on screen until acknowledged
176       (alarm status icon that also brings to alarm menu)
177     - remember alarm names (on request, maybe with an add feature) and how
178       often they are triggered, and show them most frequent first
179     - show active alarms and allow to delete them
180  - turn on/off gsm
181     - start frameworkd as a subprocess, configured to only do phone
182     - go through the dbus motions of turning on this and that, and entering PIN
183       hardcoded in zavai config
184     - log and refuse incoming calls and messages
185  - check gobject introspection and dynamic loading
186     - there could be a basic loader core that just dynamically loads bits as
187       available/needed. Only the battery icon and calendar can be loaded on a
188       laptop, while on the moko one can also load the power menu.
189       Different bits can effectively work as plugins, to be there or not.
190       Alternative plugins can be loaded based on different technologies, too (a
191       gpsd satellite monitor, or a fso satellite monitor).
192  - zavai does not look good in landscape mode
193     - replace menus with a widget taking a list of actions, which then lays
194       them out according to the screen size
195  - set backlight with Randr (xrandr --prop shows "Backlight: 4 (0x00000004)     range:  (0,15)")
196    and xbacklight uses it
197    (note: the property is not available on the freerunner atm, it would be only
198     for desktop systems, to avoid chowning the device under /sys/something)
199  - volume control in power menu "Amp Spk"
200    (-> learn/test libalsamixer something)
201    /usr/share/vala/vapi/alsa.vapi
202  - space buttons from sliders, to avoid shutting down instead of lowering the volume
203  - fisheye list music player
204    (-> learn/test gstreamer libs)
205     - player page with seek/skip controls
206     - playlist editor
207     - chosen song start playing if nothing is being played
208     - chosen song moves to playlist editor: play, add to playlist, add dir to playlist
209       (show a standard list multiselectable with all the songs in the dir and
210       only the selected song selected; allow to select others, select all, add
211       selected to playlist)
212     - playlist as reorderable standard list, allow to delete tracks, reorder tracks
213     - save playlist to file to reload later
214     - pause with headset button
215  - battery without devkit: do the parsing via lua
216  - contacts: show as a fancy focus+context list (see prefuse)
217     - vcard on e-vcard.{h,c}
218     - ical on libical-dev
219     - vcard+index file
220     - lua functions to read things
221  - zavai-calendar as a separate app
222  - zavai-contacts as a separate app
223  - next30: don't update if not shown currently on the notebook
224  - gtk_calendar_set_detail_func
225  - GSM power and network
226     - link to open SHR-dialer
227  - icon to show if there are new messages
228     - link to open SHR-messages
229  - switch backlight keep mode when on power/recharging
230     - the button changes the default for the current power mode
231  - unlock screen when receiving phone calls
232  - GPX status icon (off, waiting for fix, recording)
233  - GPX waypoint using AUX button
234  - GPX + Audio track
235  - track EPV (and similar) in gpx and kill trackpoints with bad accuracy
236  - Audio note
237     - shortcut icon in main screen
238  - Toggle wireless
239     - turn on/off chip
240     - start/stop wicd
241     - start/stop wicd-client
242  - Simple wireless scanner (code from guessnet, or minimal wicd client)
243  - Suspend phone if not calling and gps is not on and backlight is not on
244    (maybe with idle notifier?)
245  - Phone from kapula (or just running kapula)
246  - Timezone selector
247     - Location aware (show timezones in order of distance from current
248       location)
249  - Show timezone in clock
250
251  * To find out
252  + Why sometimes the phone will stop acting normal and will completely ignore
253    the screen for the purpose of screen dimming, that is, it will dim the
254    screen even if I'm using the touchscreen? (it was old ousaged brokenness)
255  - Is there a way to lock the screen completely turning off the touchscreen, so
256    that interrupts are not even generated?
257
258  * Not quite needed yet:
259  - GPX log with more features (quality, course, speed, ...)
260  - Take a waypoint then show a menu with a timeout
261     - Add a scribbled note
262     - Add an audio note
263     - Add a text note (tickling the text input method thing)
264    If timeout expires, leave the waypoint with the automatic name
265  - get fix events without requesting the GPX resource (and then? gpx log all the time? what for?)