Use X11 to handle the screen turning off
[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 vibrates
101  for 5 seconds.
102
103  It is planned to use the AUX button to acknowledge the alarm and stop the
104  vibration; when this will happen, vibration can go on for more than 5 seconds.
105  
106  When I'll implement some audio playing infrastructure, I'll implement playing
107  an audio file as well.
108
109  Also missing are a popup that tells that an alarm is ringing, and a notifier
110  for unacknowledged popups.
111
112  Patches welcome.
113
114  * Calendar
115
116  You can reach the calendar from the menu or by clicking on the date in the
117  main screen.
118
119  The calendar shows notes on every day. You can add notes just by typing on the
120  white space below the calendar.
121
122  The notes are saved in ~/.zavai/cal/YEAR/MONTH/DAY.txt, feel free to:
123   - sync it with your main computer;
124   - create a tool that populates it using the information from your
125     favourite calendar system;
126   - interface zavai with a proper calendar system, without making the interface
127     harder to use (if you can).
128
129 Stability / design
130
131  Zavai currently focuses on the interface side, trying to make it easy for me
132  to reach the functions that I need. I try not to focus on hardware details
133  (yet) (when I can), so I build it on the freesmartphone framework, which is
134  unstable, underdocumented and sometimes untested, whose developers so far have
135  never answered my questions and whose API tends to change every now and again.
136
137  This said, I'm surprised it works for me so far.
138
139 TODO list / wish list
140
141  * FSO API "documentation":
142  http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/index.html;hb=HEAD
143
144  * Features to add:
145  - GSM power and network
146     - link to open SHR-dialer
147  - icon to show if there are new messages
148     - link to open SHR-messages
149  - switch backlight keep mode when on power/recharging
150     - the button changes the default for the current power mode
151  - alarm
152     + vibrate at alarm trigger
153     - play sound at alarm trigger
154     - acknowledge alarms with AUX button
155        - then, vibrate and play sound for longer
156     - popup that tells that an alarm is ringing
157     - leave expired alarm on screen until acknowledged
158       (alarm status icon that also brings to alarm menu)
159     - remember alarm names (on request, maybe with an add feature) and how
160       often they are triggered, and show them most frequent first
161     - remember unexpired alarms persistently (again, a table in sqlite?) so
162       that they can be reinstated if zavai is restarted
163     - show active alarms and allow to delete them
164  - unlock screen when receiving phone calls
165  - GPX status icon (off, waiting for fix, recording)
166  - GPX waypoint using AUX button
167  - GPX + Audio track
168  - track EPV (and similar) in gpx and kill trackpoints with bad accuracy
169  - Audio note
170     - shortcut icon in main screen
171  - Toggle wireless
172     - turn on/off chip
173     - start/stop wicd
174     - start/stop wicd-client
175  - Simple wireless scanner (code from guessnet)
176  - Suspend phone if not calling and gps is not on and backlight is not on
177    (maybe with idle notifier?)
178  - Phone from kapula (or just running kapula)
179  - Split polygen applet in a separate app, ran via a .desktop file
180    (faster zavai startup time, can then integrate a browser in the polygen
181     applet, makes more sense altogether)
182  - Is there a way to lock the screen completely turning off the touchscreen, so
183    that interrupts are not even generated?
184  - Timezone selector
185     - Location aware (show timezones in order of distance from current
186       location)
187  - Show timezone in clock
188
189  * To find out
190  - Why sometimes the phone will stop acting normal and will completely ignore
191    the screen for the purpose of screen dimming, that is, it will dim the
192    screen even if I'm using the touchscreen?
193
194  * Not quite needed yet:
195  - GPX log with more features (quality, course, speed, ...)
196  - Take a waypoint then show a menu with a timeout
197     - Add a scribbled note
198     - Add an audio note
199     - Add a text note (tickling the text input method thing)
200    If timeout expires, leave the waypoint with the automatic name
201  - restart zavai
202    (also on dbus fuckup)
203    (can be done by just quitting and let the runner script restart it)
204  - get fix events without requesting the GPX resource (and then? gpx log all the time? what for?)