= papywizard User Guide =

 * [UserGuide#Installation Installation]
  * [UserGuide#Linux Linux]
  * [UserGuide#Nokia Nokia]
 * [UserGuide#Configuration Configuration] 
 * [UserGuide#Usageoverview Usage overview]
 * [UserGuide#Referencemanual Reference manual]
  * [UserGuide#Mainwindow Main window]
  * [UserGuide#Configurationdialog Configuration dialog]
  * [UserGuide#Manualmovedialog Manual move dialog]
  * [UserGuide#Shootdialog Shoot dialog]
 * [UserGuide#Keyboardshortcuts Keyboard shortcuts]

''This is the documentation of the subversion sources. It may or may not be up-to-date.''

== Installation ==

papywizard is entirely written in python, and uses some third-party modules:

 * [http://www.pygtk.org PyGTK] -- GTK+ for Python
 * [http://pyserial.sourceforge.net pySerial] -- serial bus access for python
 * [http://code.google.com/p/pybluez pybluez] -- bluetooth python wrapper
 * [http://www.vpython.org Visual Python] -- 3D Python project (optional)


=== Linux ===

As most distributions come with python and all needed modules (just install them through your application manager), there is no need to pre-build a package. Just install it with distutils tools:

{{{
$ python setup.py install --prefix=/usr/local
}}}

=== Nokia ===

As Nokia is based on Linux, it is possible to install papywizard through distutils tools (see previous section). However, it is easier to install the debian package, through the maemo application manager. Add this repository entry in the application manager:

||''Name''||gbiloba.org||
||''Address''||!http://www.gbiloba.org/debs||
||''Distribution''||bora||
||''Component''||free||

You also need the python repository:

||''Name''||Maemo extra||
||''Address''||!http://repository.maemo.org/extras||
||''Distribution''||bora (770/N800) or chinook (N810)||
||''Component''||free non-free||

''Note 1: on the 770, you need to install OS-2007 HE firmeware, in order to run python2.5. Then, you have to manually install '''python2.5-runtime''' package with dpkg (from x-term) before installing papywizard.''

''Note 2: on N800 and N810, you first need to install '''maemo-python-device-env''' package, from the application manager, before installing papywizard.''

== Configuration ==

No external configuration is needed; all parameters can be modified from papywizard config. menu.

== Usage overview ==

papywizard is very easy to use, and I hope the GUI is intuitive enough.

The first thing to do is to edit the configuration, to reflect you camera/lens/head/hardware config.

Second, you need to connect to the hardware (Menu ''Hardware > Connect''). If you use the bluetooth driver (default config), you need to enter the correct address of your adapter in the config menu (see above).

Then, just move the head either by opening the ''Manual move'' dialog, or using the shortcuts (see below), and set the start/end positions. As an alternative, you can automatically set the yaw to 360° and/or the pitch to 180°.

Once it is done, just open the shooting dialog and launch the entire process. That's it!

== Reference manual ==

=== Main window ===

==== Menus ====

 * '''File > Quit''': exit from papywizard [[BR]]
 * '''Hardware > Connect''': connect to the head hardware [[BR]]
 * '''Hardware > Set origin''': set the current position as origin (yaw=0.0°, pitch = 0.0°) [[BR]]
 * '''Hardware > Reset''': reset the head hardware [[BR]]
 * '''Help > About''': show the about dialog [[BR]]

==== labels ====

 * '''Position''': current position of the head [[BR]]
 * '''Start''': start shooting position [[BR]]
 * '''End''': end shooting position [[BR]]
 * '''Total Fov''': total shooting field of view [[BR]]
 * '''Nb picts''': shooting number of pictures [[BR]]
 * '''Real overlap''': real shooting overlap [[BR]]

==== buttons ====

 * '''Set from current''': set the start (end) shotting position from current position [[BR]]
 * '''Set to 360° (180°)''': automatically set start/end position to shoot 360° (180°) [[BR]]
 * '''Configuration''': open the config. dialog [[BR]]
 * '''Manual move...''': open the manual move dialog [[BR]]
 * '''Shoot...''': open the shooting dialog [[BR]]

=== Configuration dialog ===

==== Shooting tab ====

 * '''Stab. delay''': delay to wait before shooting to let the head stablizing [[BR]]
 * ''' Overlap''': minimum wanted overlap [[BR]]
 * '''Orientation''': camera orientation on the head

==== Camera tab ====

 * '''Tv''': delay to wait for shooting (Tv camera value) [[BR]]
 * '''Nb picts''': number of pictures to take at each position (bracketing) [[BR]]
 * '''Sensor ratio''': ratios to 24x36 sensor size and width/height

==== Lens tab ====

 * '''Focal''': real focal / flag for fisheye lens

==== Hardware tab ====

 * '''Driver''': hardware driver to use [[BR]]
 * '''BT device address''': bluetooth device address for 'bluetooth' driver [[BR]]
 * '''Serial port''': serial device port for 'serial' driver

==== Misc tab ====

 * '''Logger level''': level of informations to log

=== Manual move dialog ===

==== buttons ====

 * '''Set Start''': like '''Set from current''' for start position in main window [[BR]]
 * '''Set End''':  like '''Set from current''' for end position in main window [[BR]]
 * '''Yaw + / -''': move head on yaw axis [[BR]]
 * '''Pitch + / -''': move head on pitch axis [[BR]]
 * '''Set origin''': like menu '''Hardware > Set origin''' in main window [[BR]]

=== Shoot dialog ===

==== labels ====

 * '''Position''': curent position [[BR]]
 * '''Mosaic''': current mosaic position [[BR]]
 * '''Sequence''': current shooting sequence (moving/stabilizing/shooting/idle) [[BR]]
 * '''Progression''': overall progress bar

==== buttons ====

 * '''Manual shooting''': if checked, automatically go to suspend mode at the end of each move [[BR]]
 * '''Data file enable''': if checkd, write a xml data file for APP [[BR]]
 * '''Start''': start shooting process [[BR]]
 * '''Suspend''': suspend shooting process [[BR]]
 * '''Stop''': stop shooting process

== Keyboard shortcuts ==

papywizard main target is ''Nokia Internet Tablets'', so keyboard shortcuts are dedicated for that plateform (but works fine with normal PC). Here are defined shortcuts:

 * In main window:
||'''Nokia'''||'''PC'''||'''Function'''||
||[[Image(Right.png, 24, nolink)]]||Right|| Turn the head right (Yaw +)||
||[[Image(Left.png, 24, nolink)]]||Left||Turn the head left (Yaw -)||
||[[Image(Up.png, 24, nolink)]]||Up||Move the head up (Pitch +)||
||[[Image(Down.png, 24, nolink)]]||Down||Move the head down (Pitch -)||
||[[Image(F7-increase.png, 24, nolink)]]||Home||Set current position as start position||
||[[Image(F8-decrease.png, 24, nolink)]]||End||Set current position as end position||
||[[Image(Return.png, 24, nolink)]]||Return||Open shooting dialog||

 * In shooting dialog:
||'''Nokia'''||'''PC'''||'''Function'''||
||[[Image(Return.png, 24, nolink)]]||Return||Start/pause shooting||
||[[Image(Escape.png, 24, nolink)]]||Escape||Stop shooting - Return to main window||

 * In all dialogs:
||'''Nokia'''||'''PC'''||'''Function'''||
||[[Image(F4-menu.png, 24, nolink)]]||F10||Show menu||
||[[Image(F5-home.png, 24, nolink)]]||-||Standard maemo behaviour||
||[[Image(F6-fullscreen.png, 24, nolink)]]||F6||Toggle fullscreen mode||