| Version 76 (modified by , 16 years ago) ( diff ) |
|---|
Papywizard Developper Guide
Introduction
Papywizard is entirely written in python. It uses PyGTK (Python bindings for GTK) toolkit for the GUI, and a few additional modules, mainly for hardware control, pybluez and pyserial. Optionnaly, vpython (OpenGL-based module) can also be used to simulate the position of the head (note that this will be soon a separate application).
API
You can generate the complete API documentation by running the mkdoc.sh script; the documentation will then be available as web pages in the tmp/html/ directory.
Architecture
Papywizard uses a MVC-like pattern, which keeps the model separated from the views. This allows to use any other toolkit if needed; I recently switched from Tkinter to PyGTK, to run Papywizard on Nokia plateform. I hope, one day, to be able to run Papywizard on QTopia-based devices, like Openmoko. But I first need to get such device ;o)
Low-levels routines which control the hardware are also in their own package; I plan to made them even more modular, to be used in an external project to control the head. For know, only Merlin/Orion head is supported, but it is very easy to implement other heads.
A word about the simulation (to come).
Hardware
Merlin/Orion protocole
The head uses a simple ascii serial protocol; the serial line uses standard settings: 9600 8N1 (9600 bauds, 8 bits data, no parity, 1 stop bit). The head waits for incoming commands, and send response to them. The 2 axis are identical, and uses the same commands. They both wait for incoming commands; depending of the first value (see below), the command will be sent to one or the other axis.
A commands always starts with ':', and ends with '\r'. The head response always starts with '=', and also ends with '\r'. As TX/RX lines are wired together, the controller has to first readback its own command, before reading the head response. In the following documentation, the command readback is omitted, as the ':', '=' and '\r' chars.
Parameters used in the documentation:
| Parameter | What | Allowed value | Format | Note |
| <axis> | axis to control | 1 or 2 | 1 ascii digit | 1=yaw, 2=pitch axis |
| <pos> | position | 0 to 2²⁴-1 | 6 ascii digits, hex. | Low byte is sent first (A35483 is read 8354A3). When switched on, read value is 800000. Right sens increments axis 1; left sens decrements it. Up sens increments axis 2; down decrements it. A complete turn (360°) increments/decrements by 0E6600 (so, the axis can make almost 9 turns before the counter overflow) |
| <dir> | axis direction | 0 or 1 | 1 ascii digit | 0=increments (up/right), 1=decrements (down/left) |
| <status> | Axis status | 3 ascii digits | Second digit is 0 when axis is stopped | |
| <state> | State of the shutter contact | 1 ascii digit | 0 or 1 | 0 opens the contact, 1 closes the contact |
Merlin/Orion commands set
| Function | Command | Response | Note |
| Read axis position | j<axis> | <pos> | |
| Read axis status | f<axis> | <status> | |
| Stop moving | L<axis> | ||
| Init (at switch on) | F<axis> a<axis> D<axis> | 0E62D3 0006F9 | |
| Start moving | L<axis> G<axis>3<dir> I<axis>220000 J<axis> | 220000 seems to be the divider for the speed. The lower the value, the higher the speed | |
| Drive to position | L<axis> G<axis>00 S<axis><pos> J<axis> | ||
| Set shutter contact state | O<axis><state> | Both axis understand the command, but the contact is only set by yaw (0) axis | |
Merlin/Orion communication examples
When switched on:
command response :F1\r =\r :F2\r =\r :a1\r =D3620E\r :D1\r =F90600\r :a2\r =D3620E\r :D2\r =F90600\r :D2\r =F90600\r
Note: the last command is sent twice by the original remote control, but all works fine if sent only once (like Papywizard does).
Push up button in fast mode:
command response :L2\r =\r :G230\r =\r :I2220000\r =\r :J2\r =\r
Release up button if fast mode:
command response :L2\r =\r :f2\r =503\r
Model
View
Plugins
Hello Jones,
You seems to be familiar with programing. So, I will explain you the way to develop plugins for Papywizard. First, I suggest you use the svn repository:
svn co http://svn.gbiloba.org/papywizard/trunk papywizard
Plugins implements one or more 'capacity'. Possible capacities are:
- yawAxis
- pitchAxis
- shutter
The first two are responsible of yaw/pitch axis; the last is responsible of triggering the camera shutter.
A plugin needs to implement 2 classes (for each implemented capacity): one for the model (real work), and one for the controller (configuration dialog).
All model classes inherit from the AbstractPlugin class (defined in the papywizard/common/ package).
Then, plugins implementing 'yawAxis' and 'pitchAxis' capacities can inherit from AbstractAxisPlugin, and plugins implementing the 'shutter' capacity can inherits from AbstractShutterPlugin (defined in the papywizard/hardware/ package).
Controller classes inherits from AbstractPluginController class (defined in the papywizard/controller/ package). This abstract class inherits from other classes, which are responsible to load the .ui GUI defining file.
_defineGui()
Last, a plugin has to implement a register() function, which will be called at startup to register the plugin in Papywizard.
In you case, you need to implement the 'shutter' capacity.
Have a look at the default plugins, in the papywizard/plugins/ package to see concrete examples.
--
Frédéric
Output XML file
Papywizard can generate a xml data file. This file mainly contains all positions reached during shooting, and can be used by Autopano Giga to help positionning orphan pictures. This is very helpfull for high-resolution panos with deep blue sky, without details. Sift algorithm often fail to find control points in such areas.
The XML file is made of two parts: a header, containing global informations, and a shoot part, containing a list of all pictures positions. The exact header format depends of the mode.
This format is open, and can be used by anyone who wants to implement motorized panohead output data file. Feel free to contact me if you want to add some entries to support special features. The goal is to make some sort of standard format. More informations here.
Distributing
Before creating and distributing a package, make sure that the following files are up-to-date:
- ChangeLog
- papywizard/common/config.py (version number)
- setup.py (new/obsolete files)
Debian package
There is no debian packager yet.
Maemo package
Papywizard includes an distutils extension script to build maemo debian package in a easy way:
$ python maemo/setup.py bdist_debian
Move the packages to the web site dir; then run:
$ dpkg-scanpackages -m . /dev/null | gzip -c > dists/bora/free/binary-armel/Packages.gz
Note: dpkg-scanpackages removes the Maemo-Icon-26 entry, so you will need to manually edit the Packages.gz file, and add it again (from dist/control file).
Windows installer
This is a little bit tricky (as always on this plateform!). You first need to install all developpement tools and libraries:
- TODO
Then, build the executable, by launching the windows setup script. The easiest is to use Ipython:
In [1]: run windows/setup.py py2exe
Last, edit (version) and run the script windows/papywizard.nsi (need to install NSIS software) to build the installer itself.
Contribute
There are several ways to contribute:
Help coding
Test and report bugs
Internationalization
If you want to contribute but don't know how to code, you can make translation.
To do that, you just need to ask me for the corresponding papywizard.po file which contains all sentences and words used in the soft, translate them using Poedit (important; don't translate using a simple text editor), and send it back to me.
- strings starting with gtk- should not be translated
- keep strings length as close as the original ones
- if you are not sure about the usage of a word/sentence, feel free to ask about the context.
