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