[[TOC]]

= User guide (subversion) =

''This documentation try to follow the developement version of Papywizard. It may or may not be up-to-date ;o)''

For installation instructions, see [InstallationGuide here].

== 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. Basic settings are the delay to wait after moving (to let the head stop shaking), the delay to wait while shooting (camera Tv value), and the number of pictures to take at each position (bracketing). See below for specific mode settings.

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. Alternatively, you can get a list of all available bluetooth devices arround, and select the correct one.

Then, just move the head either using the big GUI arrows, or using the keys shortcuts (see below), and set the start/end positions.

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

== Advanced usage ==

Papywizard has 2 shooting modes: ''Mosaic'' mode, and ''Preset'' mode. The first one is mainly used for partial panos, and is especially designed for hi-res panos, using a large tele-lens. The second one is designed for full-spherical panos, using a wide-lens or a fisheye.

=== Mosaic mode ===

The mosaic mode computations are based on the following parameters:

 * minimum overlap
 * camera orientation
 * sensor coef. and ratio
 * focal lens

So, these settings must exactly reflect your configuration.

This mode also needs to know two opposite corners of the pano you want to shoot. There are 3 ways to proceed:

 * set the corners coordinates from the current position
 * give the total field of view for both directions; corners coordinates will be automatically computed arround the ''Home'' position (yaw=0, pitch=0)
 * give the number of pictures to take for both directions; corners coordinates will also be automatically computed arround the ''Home'' position (yaw=0, pitch=0)

Whatever corners you choose to define the pano, you will be able to choose from which corner the head will start shooting.

It is also possible to choose the initial shooting direction. Using ''yaw'' will shoot row by row; using ''pitch'' will shoot column by column. Same, the head can go back to the begining of the row/column before shooting the next one (see [TipsAndTricks#Shootingdirection Tips and tricks]).

=== Preset mode ===

This mode is very simple, and does not use any particular settings; it just shoots at all positions defined in the selected template. The only thing to do is to define the ''home'' position of the head (origin), which will be the reference for the template positions. In case the camera/lens can't be moved in all positions, it is possible to set some limits, to avoid potential colisions (limits are not saved in the current release, so they must be set each time the head is turned on).

==== Custom presets ====

Some default presets are provided with the software, but it is possible to add your own. For that, you need to create a xml file which describes them. The file must be named '''{{{presets.xml}}}''' and must be in the config directory: '''{{{~/.config/papywizard2/}}}''' on linux, '''{{{/home/user/.config/papywizard2/}}}''' on maemo, and '''{{{C:\Documents and settings\<user>\Application Data\papywizard2\}}}'''¹ on Windows.

''¹: you have to configure the Windows Explorater so it shows you ''system'' files and directories.

Here is the file structure:

{{{
#!xml
<?xml version="1.0" encoding="utf-8" ?>
<papywizard>
    <preset name="My custom preset">
        <tooltip>
            20D + 50mm
            12 picts @ +55°
            20 picts @ +40°
            50 picts @  10°/-10°
            20 picts @ -40°
            55 picts @ -70°
        </tooltip>
        <shoot>
            <pict yaw="0." pitch="55." />
            <pict yaw="30." pitch="55." />
            <pict yaw="60." pitch="55." />
            <pict yaw="90." pitch="55." />
            ...
        </shoot>
    </preset>
    <preset name="Another custom preset">
    ....
     </preset>
</papywizard>
}}}

Where:
 * {{{<preset> name attribute}}}: name used to present the preset in the GUI
 * {{{<tooltip>}}}: information for that preset (shown in the information presets template window)
 * {{{<shoot>}}}: list of all positions to shoot, described in {{{yaw/pitch}}} attributes of the {{{<pict>}}} tag (one tag per position)

''Note: it is possible to define several presets in the same file.''

To save time during shoot, take care of the order of positions. For example, don't ask the head to go back to the begining of the new row, it will take too long; instead, reverse the direction and go back for the next row.

You can also import a custom preset file from the ''File'' menu. Note that this file won't be automatically loaded at next startup; this is mainly to test your presets before putting them in your user config. dir.

If you add usefull templates, feel free to send them so they could be added as default ones.

== Shooting sequence ==

It is possible to suspend/resume the shooting sequence using the '''{{{Suspend/Resume}}}''' button. Once suspended, the shooting sequence can be modified; clicking on any position on the GUI will set the next position to shoot to that new position.

''Note: if you are shooting a high-resolution pano, there may be too much preview positions on the GUI to easily select one. In this case, just use the 2 button on both sides of the shooting area to rewind/forward the next shooting position. Arrow keys are also binded to these buttons.

If the '''{{{Step-by-step}}}''' box is checked, the shooting sequence will automatically go to suspend mode after each move (before running the camera shutter sequence), and after each camera shutter sequence (before moving to the next position). During the camera shutter sequence, the shutter will be triggered one or more times, depending of the bracketing parameter in the config; no pause will be done inside this sequence.

== Cutomization ==

=== Style sheet ===

Since release 1.9.1, Papywizard can load a user style sheet. This file must be name '''{{{papywizard.css}}}''', and must be located in the config directory.

Here is a sample file:

{{{
#!c
QPushButton {
    color: red;
}
}}}

''Note: a dedicated page for nice style sheets will soon be created. Feel free to send yours.''

== Tethered shooting ==

Tethered shooting is now done through plugins.

== Reference manual ==

=== Main window ===

==== menus ====

 * '''File > Quit''': exit from Papywizard
 * '''File > Import Preset File...''': Import presets from file
 * '''File > Load Style Sheet...''': load style sheet
 * '''Hardware > Connect''': connect to the head hardware
 * '''Hardware > Set limit...''': set the selected limit to curent position
 * '''Hardware > Clear limits''': reset all limits
 * '''Hardware > Goto Reference...''': goto reference position
 * '''Hardware > Goto Initial...''': goto inital position
 * '''Hardware > Plugins...''': open the plugins selection dialog
 * '''Help > Manual''': open this documentation (network connection needed)
 * '''Help > View Log...''': open log dialog
 * '''Help > About Papywizard''': open the Papywizard about dialog
 * '''Help > About Qt''': open the Qt about dialog

==== displays ====

Mosaic tab:
 * '''Corner 0''': first shooting corner
 * '''Corner 1''': second shooting corner
 * '''Total Fov''': total shooting field of view
 * '''Nb picts''': shooting number of pictures
 * '''Real overlap''': real shooting overlap
 * '''Resolution''': resolution of the pano
Preset tab:
 * '''Name''': name of the preset
Common:
 * '''Move''': current position of the head

==== buttons ====

 * '''Mosaic/Preset''': switch between mosaic and preset mode
Mosaic tab:
 * '''Corner 0/Yaw/Pitch''': set the first corner of the shooting position from current position (for both, yaw or pitch)
 * '''Corner 1/Yaw/Pitch''': set the second corner of the shooting position from current position (for both, yaw or pitch)
 * '''Total fov''': open a dialog to specify the wanted yaw/pitch fov
 * '''Nb picts''': open a dialog to specify the wanted yaw/pitch nb picts
Preset tab:
 * '''Name''': template defining all positions
Common:
 * '''Left/Right yaw arrows''': move head on yaw axis
 * '''Up/Down pitch arrows''': move head on pitch axis
 * '''Set reference''': set the current position as reference (yaw=0.0°, pitch=0.0°)
 * '''Configuration...''': open the config. dialog
 * '''Shoot...''': open the shooting dialog

==== Status bar ====

 * '''Messages'''
 * '''Manual speed'''
 * '''Connection status'''

=== Plugins dialog ===

==== Plugins tab ====

 * '''Yaw''': plugin to use for yaw axis / driver for this plugin
 * '''Pitch''':  plugin to use for pitch axis / driver for this plugin
 * '''Shutter''':  plugin to use for shutter / driver for this plugin

==== Driver tab ====

 * '''BT device address''': bluetooth device address
 * '''Choose...''': open the bluetooth chooser dialog
 * '''Serial port''': serial device port (either a int or a string, like {{{COM1}}} or {{{/dev/ttyS0}}})
 * '''Ethernet host/port''': ethernet hostname (or IP) / port number

==== Communication tab ====

 * '''Timout''': driver timout
 * '''Retry''': number of retry when error occurs

=== Configuration dialog ===

==== Shooting tab ====

 * '''Head orientation''': orientation of the head
 * '''Camera orientation''': camera orientation on the head (if combobox is set to ''custom'', real orientation can be given)
 * '''Stabilization delay''': delay to wait after the head has stopped, and before shooting, to let the head stablizing

==== Mosaic tab ====

 * '''Overlap''': minimum wanted overlap
 * '''Start from''': start position
 * '''Initial direction''': initial moving direction
 * '''CR''': if set, go back to the start of the row/columns before starting a new one

==== Camera/lens tab ====

 * '''Sensor (coef, ratio)''': ratio to 24x36 size, width vs height ratio
 * '''Sensor resolution''': resolution of the sensor
 * '''Lens (type, focal)''': type of the lens (''rectilinear'' or ''fisheye''), real focal of the lens (''rectilinear'' only)
 * '''Optical multiplier''': optional optical multiplier coef. (''rectilinear'' only)

==== Plugins tab ====

 * '''Configure...''': button to configure each plugin

==== Data tab ====

 * '''Data storage dir''': set the directory where data file are written
 * '''Data file''': format to use for the output data file name. The final name is {{{papywizard_<format>.xml}}}
  * {{{%(date)s}}}: expands to start shooting date
  * {{{%(time)s}}}: expands to start shooting time
  * {{{%(date_time)s}}}: same as {{{%(date)s_%(time)s}}}
  * {{{%(mode)s}}}: expands to shooting mode (mosaic or preset)
 * '''Enable''': flag to enable the data file
 * '''Title''': title of the pano
 * '''GPS''': GPS informations of the pano
 * '''Comment''': comment on the pano

==== Timer tab ====

 * '''Start after''': delay to wait before starting
 * '''Enable''': switch to enable the '''Start after''' timer
 * '''Repeat''': number of repeats
 * '''Enable''': switch to enable the '''Repeat''' feature
 * '''Repeat every''': shoot panos every given time

==== Misc tab ====

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

==== buttons ====

 * '''OK''': validate settings and close dialog
 * '''Cancel''': revert to previous settings and close dialog

=== Bluetooth dialog ===

This dialog shows the list of availabe bluetooth devices.

=== Shoot dialog ===

==== displays ====

 * ''shooting scene'': display the shooting position. Clicking on this area while paused set the next position to shoot
 * ''text shooting area'': display the shooting position in text mode
 * ''sequence'': display the current shooting sequence
 * ''repeat counter'': display the current repeat value
 * ''elapsed time'': display the shooting time and total elapsed time
 * ''progress bar'': shooting process progression (for current repeat and all repeats)

==== buttons ====

 * '''Text''': toggle text/gaphical shooting areas
 * '''Rewind''': while paused, rewind the next position to shoot
 * '''Forward''': while paused, forward the next position to shoot
 * '''Data''': direct access button to the Data tab of configuration dialog
 * '''Timer''': direct access button to the Timer tab of configuration dialog
 * '''Step-by-step''': if checked, each step (moving, shooting) will need to be validated use the Pause/Resume button
 * '''Start''': start shooting process
 * '''Pause/Resume/Step''': pause/resume/step shooting process
 * '''Stop/Finish''': stop shooting process/reset GUI state
 * '''Close''': close shooting dialog

=== Log dialog ===

==== buttons ====

 * '''Clear Log''': clear the log window
 * '''Save Log''': save the log to file (in the data storage dir)

== Plugins ==

Plugins architecture is the main new feature of the 2.x branch. It is now very simple to support new hardware/tethered shooting programs.

=== Yaw/pitch axis plugins ===

==== Common ====

Common params for all yaw/axis plugins.

Main tab:
 * ''''Low limit''': low limit for the axis
 * ''''High limit''': high limit for the axis

==== !GigaPanBot ====

No additional params

==== Merlin-Orion ====

Hard tab:
 * ''''Alternate drive''': external closed loop for moves < 6° (faster than internal one)
 * ''''Inertia angle''': angle to stop the motor before launching a final positionning

==== !PixOrb ====

Main tab:
 * '''Speed index''': index for maximum speed table
Hard tab:
 * ''''Axis with break''': Check if the axis has breaks
 * ''''Axis accuracy''': the head won't move below this value

==== Pololu Servo ====

Main' tab:
 * '''Speed''': speed of the axis
Servo tab:
 * '''Direction''': set the direction of the servo
 * '''Angle for 1ms''': angle the servo moves for 1ms signal difference
 * '''Neutral position''': used to set up the neutral position of teh servo

==== Simulation ====

Main tab:
 * '''Speed''': speed of the axis

=== Shutter plugins ===

==== DSLR Remote Pro ====

Main tab:
 * '''Program path''': path to '''{{{DSLRRemoteTest.exe}}}''' program
 * '''Mirror lockup''': lockup the mirror before shooting (NOT YET USED!!!)
 * '''User exposure compensation list''': list of exposure compensation values to used for bracketing (coma separated list)
 * '''Dry run''': if checked, don't actually execute the command
Camera tab:
 * '''Output directory''': directory where to put downloaded images
 * '''File name prefix''': images prefix
 * '''Camera exposure compensation list''': camera bracketing setting

''Note: the DSLR Remote Pro GUI must be launched before using the plugin.''

==== EOS Utility ====

Main tab:
 * '''Program path''': path to '''{{{EOSBracket.exe}}}''' program
 * '''EOS Utility version''': version of the EOS Utility program
 * '''Bracketing nb picts''': number of times to release the shutter
 * '''Bracketing stops''': exposure compensation value to use between 2 picts
 * '''Bracketing type''': order of compensation values
 * '''Dry run''':  if checked, don't actually execute the command
Bulb tab:
 * '''Enable''': enable bulb mode
 * '''Base exposure''': exposure time
Focus tab:
 * '''Enable''': enable focus stacking mode
 * '''Direction''': focus stacking direction
 * '''Step''': focus stacking step
 * '''Step count''': ???
 * '''Nb picts''': number of times to release the shutter in focus stacking mode

''Note: this plugin needs additional utility. See: GIVE LINK.'''

==== Generic Tethered ====

Main tab:
 * '''Mirror lockup''': lockup the mirror before shooting
 * '''Mirror lockup command''': command to use to lockup the mirror
 * '''Shoot command''': command to use to trigger the shutter
 * '''Bracketing nb picts''': number of times to release the shutter

''Note: brackting step missing.''

==== !GigaPanBot ====

Main tab:
 * '''Time value''': time to wait during shutter release
 * '''Mirror lockup''': lockup the mirror before shooting (do a first shutter release before real one)
 * '''Bracketing nb picts''': number of times to release the shutter
Hard tab:
 * '''Pulse width high''': time during the shutter contact is closed
 * '''Pulse width low''': time during the shutter contact remains low before next pulse high

==== Gphoto ====

Main tab:
 * '''Mirror lockup''': lockup the mirror before shooting (do a first shutter release before real one)
 * '''Bracketing nb picts''': number of times to release the shutter
 * '''Bracketing step''': exposure compensation value to use between 2 picts

''Note: not yet functional.''

==== Merlin-Orion ====

Main tab:
 * '''Time value''': time to wait during shutter release
 * '''Mirror lockup''': lockup the mirror before shooting (do a first shutter release before real one)
 * '''Bracketing nb picts''': number of times to release the shutter
Hard tab:
 * '''Pulse width high''': time during the shutter contact is closed
 * '''Pulse width low''': time during the shutter contact remains low before next pulse high

==== NK Remote ====

Same as DSLR Remote Pro plugin, but for Nikon cameras.

==== !PixOrb ====

Main tab:
 * '''Time value''': time to wait during shutter release
 * '''Mirror lockup''': lockup the mirror before shooting (do a first shutter release before real one)
 * '''Bracketing nb picts''': number of times to release the shutter
Hard tab:
 * '''Pulse width high''': time during the shutter contact is closed
 * '''Pulse width low''': time during the shutter contact remains low before next pulse high

==== Pololu Servo ====

Main tab:
 * '''Time value''': time to wait during shutter release
 * '''Mirror lockup''': lockup the mirror before shooting (do a first shutter release before real one)
 * '''Bracketing nb picts''': number of times to release the shutter
Hard tab:
 * '''Pulse width high''': time during the shutter contact is closed
 * '''Pulse width low''': time during the shutter contact remains low before next pulse high
Servo tab:
 * '''Value off''': value to send to the pseudo-servo to open the contact
 * '''Value on''': value to send to the pseudo-servo to close the contact

==== Simulation ====

Main tab:
 * '''Time value''': time to wait during shutter release
 * '''Mirror lockup''': lockup the mirror before shooting (do a first shutter release before real one)
 * '''Bracketing nb picts''': number of times to release the shutter

==== Timelord ====

Main tab:
 * '''Program path''': path to '''{{{Timelord.exe}}}''' program
 * '''LRD file''': path to '''{{{.lrd}}}''' config file

==== Ursa Minor USB ====

Main tab:
 * '''Time value''': time to wait during shutter release
 * '''Mirror lockup''': lockup the mirror before shooting (do a first shutter release before real one)
 * '''Bracketing nb picts''': number of times to release the shutter
Hard tab:
 * '''Pulse width high''': time during the shutter contact is closed
 * '''Pulse width low''': time during the shutter contact remains low before next pulse high
 * '''Trigger line''': seria line to use to trigger the shutter
 * '''Line inverted''': invert trigger line active signal

== 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(F7-increase.png, 24, nolink)]]||End||Increase the manual speed||
||[[Image(F8-decrease.png, 24, nolink)]]||Home||Decrease the manual speed||
||[[Image(Escape.png, 24, nolink)]]||Escape||Quit the application||
||||Ctrl-q||Quit the application||
||||Alt-F4||Quit the application||
||[[Image(F6-fullscreen.png, 24, nolink)]]||F11||Toggle fullscreen mode||

 * In shooting dialog:
||'''Nokia'''||'''PC'''||'''Function'''||
||[[Image(Escape.png, 24, nolink)]]||Escape||Stop/finish 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||