Revert "Split non-ui functions in separate lib"
[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  turns on baclight, shows a big ACK button and flashes the AUX led for 30
114  seconds. It also plays some music.
115
116  You can use the big button on screen or the AUX button to acknowledge the
117  alarm and stop all the attention-seeking activities.
118  
119  If you want to change the alarm ringtone, you can set:
120  ringtone_alarm = "file:///some/where/file.ext"
121  in ~/.zavai/config; gstreamer is used, so mostly any audio file format will
122  work. I'm not sure what will happen if you choose a video format: that might
123  work as well.
124
125  Alarms (acknowledged or not) are logged in "~/.zavai/log-alarm/". Still
126  missing, howerver, is a way to show that an alarm rang and noone noticed.
127
128  Patches welcome.
129
130  Details: the alarms are scheduled with at(1): they stay scheduled even if
131  zavai is restarted, and you can see them with "atq". Please see omhacks for
132  simple suspend hooks that will wake up the phone to run scheduled at jobs.
133
134  * Calendar
135
136  You can reach the calendar from the menu or by clicking on the date in the
137  main screen.
138
139  The calendar shows notes on every day. You can add notes just by typing on the
140  white space below the calendar.
141
142  The notes are saved in ~/.zavai/cal/YEAR/MONTH/DAY.txt, feel free to:
143   - sync it with your main computer;
144   - create a tool that populates it using the information from your
145     favourite calendar system;
146   - interface zavai with a proper calendar system, without making the interface
147     harder to use (if you can).
148
149  * GSM
150
151  If you have a pin, add 'sim_pin = "1234"' to ~/.zavai/config
152
153  Don't start frameworkd at boot. Get rid of fso-usaged from your system (it
154  will be started by dbus when frameworkd starts, if it's there).
155
156  Now you can use zavai to turn on GSM, including powering up the antenna and
157  providing the PIN if required by the SIM.
158
159  It does not currently do anything else beside turning things on. It is useful,
160  however, to make GSM services available to simple scripts like SMS or contact
161  list dump tools.
162
163
164 Stability / design
165
166  Zavai currently focuses on the interface side, trying to make it easy for me
167  to reach the functions that I need. I try not to focus on hardware details
168  (yet) (when I can), so I build it on the freesmartphone framework, which is
169  unstable, underdocumented and sometimes untested, whose developers so far have
170  never answered my questions and whose API tends to change every now and again.
171
172  This said, I'm surprised it works for me so far.
173
174 TODO list / wish list
175
176  * FSO API "documentation":
177  http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/index.html;hb=HEAD
178
179  * Features to add:
180  - log
181     - write data to disk as log happens (to have at least partial logs if power
182       is cut)
183     - more detailed GPX data (dop, elev..)
184     - message (structured) (json?)
185  - turn on/off gsm
186     + start frameworkd as a subprocess, configured to only do phone
187     + go through the dbus motions of turning on this and that, and entering PIN
188       hardcoded in zavai config
189     + GSM status on main screen (with messages while coming online, and
190       operator, power and so on)
191     - log and refuse incoming calls and messages
192    to "move" the GSM device to my laptop:
193     socat FILE:/dev/ttySAC0 TCP-LISTEN:12345,bind=192.168.0.202
194     socat TCP:192.168.0.202:12345 PTY,link=/tmp/gps,raw,echo=0
195
196  - alarm
197     + play sound at alarm trigger
198     - leave expired alarm on screen until acknowledged
199       (alarm status icon that also brings to alarm menu)
200     - remember alarm names (on request, maybe with an add feature) and how
201       often they are triggered, and show them most frequent first
202     - show active alarms and allow to delete them
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  - audio notes
216     - record audio notes, logging start and stop so it gets an associated GPX
217     - shortcut icon in main screen
218  - check gobject introspection and dynamic loading
219     - there could be a basic loader core that just dynamically loads bits as
220       available/needed. Only the battery icon and calendar can be loaded on a
221       laptop, while on the moko one can also load the power menu.
222       Different bits can effectively work as plugins, to be there or not.
223       Alternative plugins can be loaded based on different technologies, too (a
224       gpsd satellite monitor, or a fso satellite monitor).
225  - zavai does not look good in landscape mode
226     - replace menus with a widget taking a list of actions, which then lays
227       them out according to the screen size
228  - set backlight with Randr (xrandr --prop shows "Backlight: 4 (0x00000004)     range:  (0,15)")
229    and xbacklight uses it
230    (note: the property is not available on the freerunner atm, it would be only
231     for desktop systems, to avoid chowning the device under /sys/something)
232  - volume control in power menu "Amp Spk"
233    (-> learn/test libalsamixer something)
234    /usr/share/vala/vapi/alsa.vapi
235  - space buttons from sliders, to avoid shutting down instead of lowering the volume
236  - battery without devkit: do the parsing via lua
237  - contacts: show as a fancy focus+context list (see prefuse)
238     - vcard on e-vcard.{h,c}
239     - ical on libical-dev
240     - vcard+index file
241     - lua functions to read things
242  - zavai-calendar as a separate app
243  - zavai-contacts as a separate app
244  - calendar
245     - next30: don't update if not shown currently on the notebook
246     - gtk_calendar_set_detail_func
247  - GPS FixNow mode for sleeping
248  - GSM power and network
249     - link to open SHR-dialer
250  - icon to show if there are new messages
251     - link to open SHR-messages
252  - switch backlight keep mode when on power/recharging
253     - the button changes the default for the current power mode
254  - unlock screen when receiving phone calls
255  - GPX status icon (off, waiting for fix, recording)
256  - GPX waypoint using AUX button
257  - GPX + Audio track
258  - track EPV (and similar) in gpx and kill trackpoints with bad accuracy
259  - Simple wireless scanner (code from guessnet, or minimal wicd client)
260  - Suspend phone if not calling and gps is not on and backlight is not on
261    (maybe with idle notifier?)
262  - Phone from kapula (or just running kapula)
263  - Timezone selector
264     - Location aware (show timezones in order of distance from current
265       location)
266  - Show timezone in clock
267
268  * To find out
269  + Why sometimes the phone will stop acting normal and will completely ignore
270    the screen for the purpose of screen dimming, that is, it will dim the
271    screen even if I'm using the touchscreen? (it was old ousaged brokenness)
272  - Is there a way to lock the screen completely turning off the touchscreen, so
273    that interrupts are not even generated?
274
275  * Not quite needed yet:
276  - GPX log with more features (quality, course, speed, ...)
277  - Take a waypoint then show a menu with a timeout
278     - Add a scribbled note
279     - Add an audio note
280     - Add a text note (tickling the text input method thing)
281    If timeout expires, leave the waypoint with the automatic name
282  - get fix events without requesting the GPX resource (and then? gpx log all the time? what for?)