sane-pixma(5)

NAME
sane-pixma - SANE backend for Canon PIXMA MP series

DESCRIPTION
The sane-pixma library implements a SANE (Scanner Access Now Easy) backend that provides access to Canon PIXMA multi-function devices (All-in-one printers). The backend implements both USB interface and Network LAN interface using Canon's BJNP protocol. Currently, the following models work with this backend:

    PIXMA MP140, MP150, MP160, MP170, MP180, MP190
    PIXMA MP210, MP220, MP240
    PIXMA MP450, MP460, MP470, MP480
    PIXMA MP500, MP510, MP520, MP530, MP540
    PIXMA MP600, MP600R, MP610, MP620, MP630, MP710
    PIXMA MP800, MP800R, MP810, MP830, MP960, MP970, MP980
    PIXMA MX300, MX310, MX700, MX850, MX7600
    MultiPASS MP700, PIXMA MP750 (no grayscale)
    ImageCLASS MF4010, MF4018, MF4120, MF4122, MF4140, MF4150
    ImageCLASS MF4270

The following models are not well tested and/or the scanner sometimes hangs and must be switched off and on.

    SmartBase MP360, MP370, MP390
    MultiPASS MP730, PIXMA MP760, PIXMA MP780

The following models may use the same Pixma protocol as those listed above, but have not yet been reported to work (or not). They are declared in the backend so that they get recognized and activated. Feedback in the Sane-dev mailing list welcome.

    PIXMA MP740
    PIXMA MP260
    ImageCLASS MF3110, MF3240
    ImageCLASS MF5630, MF5650, MF5730, MF5750, MF5770, MF8170c

The backend supports
* resolutions at 75,150,300,600,1200,2400 and 4800 DPI (some maybe buggy),
* color and grayscale mode,
* a custom gamma table,
* Automatic Document Feeder (Duplex for some models).
* Transparency Unit, 24 or 48 bits depth.

The device name is in the form pixma:xxxxyyyy_zzzzz where x, y and z are vendor ID, product ID and serial number respectively. Example: pixma:04A91709_123456 is a MP150.

This backend, based on cloning original Canon drivers protocols, is in a production stage. Designed has been carried out without any applicable manufacturer documentation, probably never available. However, we have tested it as well as we could, but it may not work in every situations. You will find an up-to-date status at the project homepage. (See below). Users feedback is essential to help improve features and performances.

OPTIONS
Besides "well-known" options (e.g. resolution, mode etc.) pixma backend also provides the following options for button handling, i.e. the options might change in the future.
Button scan is disabled on MAC OS X due to darwin libusb not handling timeouts in usb interrupt reads.

button-controlled
    This option can be used in combination with scanadf(1) and scanimage(1) in batch mode, for example when you want to scan many photos or multiple-page documents. If it is enabled (i.e. is set to true or yes), the backend waits before every scan until the user presses the "SCAN" button (for MP150) or the color-scan button (for other models). Just put the first page in the scanner, press the button, then the next page, press the button and so on. When you finished, press the gray-scan button. (For MP150 you have to stop the frontend by pressing Ctrl-C for example.)

button-update button-1 button-2
    These options are interesting for developers. To check button status: (1) set button-1 and button-2 to zero, (2) set button-update (Its type is SANE_TYPE_BUTTON.), (3) get button-1 and button-2. If the result is not zero, the corresponding button was pressed.

FILES

/usr/local/lib/sane/libsane-pixma.a
    The static library implementing this backend.

/usr/local/lib/sane/libsane-pixma.so
    The shared library implementing this backend (present on systems that support dynamic loading).

ENVIRONMENT

SANE_DEBUG_PIXMA
    If the library was compiled with debug support enabled, this environment variable controls the debug level for this backend. Higher value increases the verbosity.

    0 print nothing (default)
    1 print error and warning messages (recommended)
    2 print informational messages
    3 print debug-level messages
    11 dump USB traffics
    21 full dump USB traffics

PIXMA_EXPERIMENT
    Setting to a non-zero value will enable the support for experimental models. You should also set SANE_DEBUG_PIXMA to 10.

SEE ALSO
sane(7), sane-dll(5), http://home.arcor.de/wittawat/pixma/, http://mp610.blogspot.com/

AUTHORS
Wittawat Yamwong, Nicolas Martin, Dennis Lou, Louis Lagendijk

We would like to thank all testers and helpers. Without them we could not be able to write subdrivers for models we don't have. See also the project homepage.