2008-02-14 01:57:19 +00:00
|
|
|
|
<HTML>
|
|
|
|
|
<HEAD>
|
|
|
|
|
<TITLE>sane-pixma.5</TITLE>
|
|
|
|
|
</HEAD>
|
2008-02-11 01:50:42 +00:00
|
|
|
|
<BODY BGCOLOR=#FFFFFF TEXT=#000000><H1 ALIGN=CENTER><IMG SRC="/images/sane.png" HEIGHT=117 WIDTH=346></H1>
|
2008-02-14 01:57:19 +00:00
|
|
|
|
<H1>sane-pixma.5</H1>
|
|
|
|
|
<HR>
|
|
|
|
|
<PRE>
|
|
|
|
|
<!-- Manpage converted by man2html 3.0.1 -->
|
|
|
|
|
<B><A HREF="sane-pixma.5.html">sane-pixma(5)</A></B> SANE Scanner Access Now Easy <B><A HREF="sane-pixma.5.html">sane-pixma(5)</A></B>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>NAME</H2><PRE>
|
2013-10-01 02:17:11 +00:00
|
|
|
|
sane-pixma - SANE backend for Canon Multi-Function Printers and
|
|
|
|
|
CanoScan Scanners
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>DESCRIPTION</H2><PRE>
|
2013-10-01 02:17:11 +00:00
|
|
|
|
The <B>sane-pixma</B> library implements a SANE (Scanner Access Now Easy)
|
|
|
|
|
backend that provides access to Canon PIXMA / i-SENSYS / imageCLASS /
|
|
|
|
|
imageRUNNER multi-function devices (All-in-one printers) and the Canon
|
|
|
|
|
CanoScan Flatbed/TPU scanners. The backend implements both USB inter‐
|
|
|
|
|
face and network interface using Canon's BJNP protocol. The network
|
|
|
|
|
interface supports scanners over IPv4 as well as IPv6.
|
2009-05-03 21:14:31 +00:00
|
|
|
|
|
2013-10-01 02:17:11 +00:00
|
|
|
|
Currently, the following models work with this backend:
|
|
|
|
|
|
|
|
|
|
PIXMA MG2100, MG3100, MG4200, MG5100, MG5200, MG5300
|
|
|
|
|
PIXMA MG6100, MG6200, MG6300, MG8200
|
2009-05-03 21:14:31 +00:00
|
|
|
|
PIXMA MP140, MP150, MP160, MP170, MP180, MP190
|
2013-10-01 02:17:11 +00:00
|
|
|
|
PIXMA MP210, MP220, MP230, MP240, MP250, MP260, MP270, MP280
|
2012-08-27 01:52:45 +00:00
|
|
|
|
PIXMA MP360, MP370, MP390
|
2010-04-26 02:18:46 +00:00
|
|
|
|
PIXMA MP450, MP460, MP470, MP480, MP490
|
|
|
|
|
PIXMA MP500, MP510, MP520, MP530, MP540, MP550, MP560
|
2012-08-27 01:52:45 +00:00
|
|
|
|
PIXMA MP600, MP600R, MP610, MP620, MP630, MP640
|
|
|
|
|
PIXMA MP700, MP710, MP730, PIXMA MP750 (no grayscale)
|
|
|
|
|
PIXMA MP800, MP800R, MP810, MP830
|
|
|
|
|
PIXMA MP960, MP970, MP980, MP990
|
2013-10-01 02:17:11 +00:00
|
|
|
|
PIXMA MX300, MX310, MX330, MX340, MX350, MX360, MX370
|
2012-08-27 01:52:45 +00:00
|
|
|
|
PIXMA MX420, MX700, MX7600
|
2013-10-01 02:17:11 +00:00
|
|
|
|
PIXMA MX850, MX860, MX870, MX882, MX885, MX890
|
|
|
|
|
imageCLASS MF3110, MF3240, MF4010, MF4018
|
|
|
|
|
imageCLASS MF4120, MF4122, MF4140, MF4150
|
|
|
|
|
imageCLASS MF4270, MF4350d, MF4370dn, MF4380dn
|
|
|
|
|
imageCLASS MF4410, MF4430, MF4660, MF4690, MF4770n
|
|
|
|
|
imageCLASS MF5730, MF5770, MF6550, D420, D480
|
|
|
|
|
i-SENSYS MF3010, MF4320d, MF4330d, MF4550d
|
|
|
|
|
imageRUNNER 1020/1024/1025
|
|
|
|
|
CanoScan 8800F, 9000F, 9000F Mark II
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
2009-05-03 21:14:31 +00:00
|
|
|
|
The following models are not well tested and/or the scanner sometimes
|
2008-02-14 01:57:19 +00:00
|
|
|
|
hangs and must be switched off and on.
|
|
|
|
|
|
2012-08-27 01:52:45 +00:00
|
|
|
|
PIXMA MP760, MP770, MP780, MP790
|
|
|
|
|
PIXMA MX360
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
2009-05-03 21:14:31 +00:00
|
|
|
|
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.
|
2012-08-27 01:52:45 +00:00
|
|
|
|
Feedback in the sane-devel mailing list welcome.
|
2009-05-03 21:14:31 +00:00
|
|
|
|
|
2013-10-01 02:17:11 +00:00
|
|
|
|
PIXMA E500, E510, E600, E610
|
|
|
|
|
PIXMA MG2200, MG2400, MG2500, MG3200, MG4100, MG5400, MG5500
|
|
|
|
|
PIXMA MG6400, MG6500, MG7100, MG8100
|
2012-08-27 01:52:45 +00:00
|
|
|
|
PIXMA MP375R, MP493, MP495, MP740
|
2013-10-01 02:17:11 +00:00
|
|
|
|
PIXMA MX320, MX390, MX410, MX430, MX450, MX510, MX520
|
|
|
|
|
PIXMA MX710, MX720, MX920
|
|
|
|
|
imageCLASS MF4570dw, MF5630, MF5650, MF5750, MF8030, MF8170c
|
|
|
|
|
imageRUNNER 1133
|
|
|
|
|
i-SENSYS MF5880dn, MF6680dn
|
2010-04-26 02:18:46 +00:00
|
|
|
|
|
|
|
|
|
The backend supports:
|
|
|
|
|
|
2013-10-01 02:17:11 +00:00
|
|
|
|
* resolutions of 75, 150, 300, 600, 1200, 2400, 4800, and 9600
|
2012-08-27 01:52:45 +00:00
|
|
|
|
DPI (some maybe buggy),
|
2013-10-01 02:17:11 +00:00
|
|
|
|
* color and grayscale mode, as well as lineart on certain mod‐
|
2012-08-27 01:52:45 +00:00
|
|
|
|
els,
|
2010-04-26 02:18:46 +00:00
|
|
|
|
* a custom gamma table,
|
|
|
|
|
* Automatic Document Feeder, Simplex and Duplex.
|
2013-10-01 02:17:11 +00:00
|
|
|
|
* Transparency Unit, 24 or 48 bits depth. Infrared channel on
|
|
|
|
|
certain models.
|
2010-04-26 02:18:46 +00:00
|
|
|
|
|
|
|
|
|
The device name for USB devices is in the form pixma:xxxxyyyy_zzzzz
|
2012-08-27 01:52:45 +00:00
|
|
|
|
where x, y and z are vendor ID, product ID and serial number respec‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
tively. Example: pixma:04A91709_123456 is a MP150.
|
|
|
|
|
|
|
|
|
|
Device names for BJNP devices is in the form pixma:aaaa_bbbbb where
|
|
|
|
|
aaaa is the scanners model and bbbb is the hostname or ip-adress.
|
|
|
|
|
|
|
|
|
|
This backend, based on cloning original Canon drivers protocols, is in
|
2012-08-27 01:52:45 +00:00
|
|
|
|
a production stage. Designed has been carried out without any applica‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
ble manufacturer documentation, probably never available. However, we
|
2013-10-01 02:17:11 +00:00
|
|
|
|
have tested it as well as we could, but it may not work in all situa‐
|
2009-05-03 21:14:31 +00:00
|
|
|
|
tions. You will find an up-to-date status at the project homepage. (See
|
2012-08-27 01:52:45 +00:00
|
|
|
|
below). Users feedback is essential to help improve features and per‐
|
|
|
|
|
formances.
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>OPTIONS</H2><PRE>
|
|
|
|
|
Besides "well-known" options (e.g. resolution, mode etc.) pixma backend
|
2010-04-26 02:18:46 +00:00
|
|
|
|
also provides the following options for button handling, i.e. the
|
2009-05-03 21:14:31 +00:00
|
|
|
|
options might change in the future.
|
2013-10-01 02:17:11 +00:00
|
|
|
|
The button status can be polled i.e. with 'scanimage -A'.
|
2010-04-26 02:18:46 +00:00
|
|
|
|
Button scan is disabled on MAC OS X due to darwin libusb not handling
|
2009-05-03 21:14:31 +00:00
|
|
|
|
timeouts in usb interrupt reads.
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
|
|
|
|
<I>button-controlled</I>
|
2013-10-01 02:17:11 +00:00
|
|
|
|
This option can be used by applications (like <B><A HREF="scanadf.1.html">scanadf(1)</A></B> and
|
|
|
|
|
<B><A HREF="scanimage.1.html">scanimage(1)</A></B>) 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.)
|
|
|
|
|
|
|
|
|
|
<I>button-update</I>
|
|
|
|
|
(write only) In the past this option was required to be set to
|
|
|
|
|
force reading of the button status for <I>button-1</I> and <I>button-2.</I>
|
|
|
|
|
The <B>sane-pixma</B> no longer requires this option to be used: if no
|
|
|
|
|
fresh data is available, it will be now requested automatically
|
|
|
|
|
from the scanner. This option is left for backward compatibility
|
|
|
|
|
reasons.
|
|
|
|
|
|
|
|
|
|
<I>button-1</I> <I>button-2</I>
|
|
|
|
|
(read only) These options will return the value of the respec‐
|
|
|
|
|
tive buttons. value 0 means that the button was not pressed, 1
|
|
|
|
|
is returned when the button was pressed. Some scanners with more
|
|
|
|
|
than two buttons send the button number as target.
|
|
|
|
|
|
|
|
|
|
<I>original</I>
|
|
|
|
|
(read only) Returns the value of the type or size of original to
|
|
|
|
|
be scanned if the scanner provides that data. Known values of
|
|
|
|
|
type: 1 = document, 2 = foto, 5 = film. Known values of size: 1
|
|
|
|
|
= A4, 2 = Letter, 8 = 10x15, 9 = 13x18, b = auto. Not all scan‐
|
|
|
|
|
ners can provide this data.
|
|
|
|
|
|
|
|
|
|
<I>target</I> (read only) Returns the value of the target of the scan opera‐
|
|
|
|
|
tion if the scanner provides that data. The values depend on the
|
|
|
|
|
scanner type. Known values: 1 = save to disk, 2 = save to pdf, 3
|
|
|
|
|
= send to email, 4 = send to application or 1 = JPEG, 2 = TIFF,
|
|
|
|
|
3 = PDF, 4 = Compact PDF. For some scanners this value is equiv‐
|
|
|
|
|
alent to the number of the pressed button. Not all scanners can
|
|
|
|
|
provide this data.
|
|
|
|
|
|
|
|
|
|
<I>scan-resolution</I>
|
|
|
|
|
(read only) Returns the resolution of the scan operation if the
|
|
|
|
|
scanner provides that data. Known values: 1 = 75 dpi, 2 = 150
|
|
|
|
|
dpi, 3 = 300 dpi, 4 = 600 dpi. Not all scanners can provide this
|
|
|
|
|
data.
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>FILES</H2><PRE>
|
|
|
|
|
<I>/usr/lib/sane/libsane-pixma.a</I>
|
|
|
|
|
The static library implementing this backend.
|
|
|
|
|
|
|
|
|
|
<I>/usr/lib/sane/libsane-pixma.so</I>
|
|
|
|
|
The shared library implementing this backend (present on systems
|
|
|
|
|
that support dynamic loading).
|
|
|
|
|
|
2010-04-26 02:18:46 +00:00
|
|
|
|
<I>/etc/sane.d/pixma.conf</I>
|
|
|
|
|
The backend configuration file (see also description of
|
|
|
|
|
<B>SANE_CONFIG_DIR</B> below). The files contains an optional list of
|
|
|
|
|
scanners. Normally only scanners that can not be auto-detected
|
|
|
|
|
because they are on a different subnet shall be listed here. If
|
|
|
|
|
your OS does not allow enumeration of interfaces (i.e. it does
|
|
|
|
|
not support the getifaddrs() function) you may need to add your
|
|
|
|
|
scanner here as well. Scanners shall be listed as:
|
|
|
|
|
|
|
|
|
|
<I>bjnp://<host></I>
|
|
|
|
|
where host is the hostname or IP address of the scanner, e.g.
|
2013-10-01 02:17:11 +00:00
|
|
|
|
bjnp://10.0.1.4 for IPv4,
|
|
|
|
|
bjnp://[2001:888:118e:18e2:21e:8fff:fe36:b64a] for a literal
|
|
|
|
|
IPv6-address or bjnp://myscanner.mydomain.org. Define each scan‐
|
|
|
|
|
ner on a new line.
|
2010-04-26 02:18:46 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>USB SUPPORT</H2><PRE>
|
|
|
|
|
USB scanners will be auto-detected and require no configuration.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>NETWORKING SUPPORT</H2><PRE>
|
|
|
|
|
The pixma backend supports network scanners using the so called Canon
|
2013-10-01 02:17:11 +00:00
|
|
|
|
BJNP protocol. Both IPv4 and IPv6 are supported.
|
|
|
|
|
|
|
|
|
|
Configuration is normally not required. The pixma backend will auto-
|
|
|
|
|
detect your scanner if it is within the same subnet as your computer if
|
|
|
|
|
your OS does support this.
|
2010-04-26 02:18:46 +00:00
|
|
|
|
|
|
|
|
|
If your scanner can not be auto-detected, you can add it to the pixma
|
|
|
|
|
configuration file (see above).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>FIREWALLING FOR NETWORKED SCANNERS</H2><PRE>
|
|
|
|
|
The sane pixma backend communicates with port 8612 on the scanner. So
|
2012-08-27 01:52:45 +00:00
|
|
|
|
you will have to allow outgoing traffic TO port 8612 on the common sub‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
net for scanning.
|
|
|
|
|
|
|
|
|
|
Scanner detection is slightly more complicated. The pixma backend sends
|
|
|
|
|
a broadcast on all direct connected subnets it can find (provided your
|
2013-10-01 02:17:11 +00:00
|
|
|
|
OS allows for enumeration of all netowrk interfaces). The broadcast is
|
|
|
|
|
sent FROM port 8612 TO port 8612 on the broadcast address of each
|
|
|
|
|
interface. The outgoing packets will be allowed by the rule described
|
|
|
|
|
above.
|
|
|
|
|
|
2010-04-26 02:18:46 +00:00
|
|
|
|
Responses from the scanner are sent back to the computer TO port 8612.
|
|
|
|
|
Connection tracking however does not see a match as the response does
|
|
|
|
|
not come from the broadcast address but from the scanners own address.
|
2013-10-01 02:17:11 +00:00
|
|
|
|
For automatic detection of your scanner, you will therefore have to
|
|
|
|
|
allow incoming packets TO port 8612 on your computer.
|
2010-04-26 02:18:46 +00:00
|
|
|
|
|
|
|
|
|
So in short: open the firewall for all traffic from your computer to
|
|
|
|
|
port 8612 AND to port 8612 to your computer.
|
|
|
|
|
|
|
|
|
|
With the firewall rules above there is no need to add the scanner to
|
|
|
|
|
the pixma.conf file, unless the scanner is on a network that is not
|
|
|
|
|
directly connected to your computer.
|
|
|
|
|
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>ENVIRONMENT</H2><PRE>
|
|
|
|
|
<B>SANE_DEBUG_PIXMA</B>
|
2010-04-26 02:18:46 +00:00
|
|
|
|
If the library was compiled with debug support enabled, this
|
2013-10-01 02:17:11 +00:00
|
|
|
|
environment variable controls the debug level for this backend
|
|
|
|
|
itself. Higher value increases the verbosity and includes the
|
|
|
|
|
information printed at the lower levels.
|
2008-02-14 01:57:19 +00:00
|
|
|
|
0 print nothing (default)
|
|
|
|
|
1 print error and warning messages (recommended)
|
|
|
|
|
2 print informational messages
|
|
|
|
|
3 print debug-level messages
|
2013-10-01 02:17:11 +00:00
|
|
|
|
11 dump USB traffic
|
|
|
|
|
21 full dump USB traffic
|
|
|
|
|
|
|
|
|
|
<B>SANE_DEBUG_BJNP</B>
|
|
|
|
|
If the library was compiled with debug support enabled, this
|
|
|
|
|
environment variable controls the debug level for the <B>BJNP</B> net‐
|
|
|
|
|
work protocol for this backend. Higher value increases the ver‐
|
|
|
|
|
bosity and includes the information printed at the lower levels.
|
|
|
|
|
0 print nothing (default)
|
|
|
|
|
1 Print error and warning messages (recommended)
|
|
|
|
|
2 Print high level function tracing information
|
|
|
|
|
3 Print more detailed protocol tracing information
|
|
|
|
|
4 Print protocol headers
|
|
|
|
|
5 Print full protocol contents
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
|
|
|
|
<B>PIXMA_EXPERIMENT</B>
|
2012-08-27 01:52:45 +00:00
|
|
|
|
Setting to a non-zero value will enable the support for experi‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
mental models. You should also set SANE_DEBUG_PIXMA to 11.
|
|
|
|
|
|
|
|
|
|
<B>SANE_CONFIG_DIR</B>
|
|
|
|
|
This environment variable specifies the list of directories that
|
|
|
|
|
may contain the configuration file. Under UNIX, the directories
|
2012-08-27 01:52:45 +00:00
|
|
|
|
are separated by a colon (`:'), under OS/2, they are separated
|
|
|
|
|
by a semi-colon (`;'). If this variable is not set, the config‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
uration file is searched in two default directories: first, the
|
|
|
|
|
current working directory (".") and then in /etc/sane.d. If the
|
2012-08-27 01:52:45 +00:00
|
|
|
|
value of the environment variable ends with the directory sepa‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
rator character, then the default directories are searched after
|
|
|
|
|
the explicitly specified directories. For example, setting
|
|
|
|
|
<B>SANE_CONFIG_DIR</B> to "/tmp/config:" would result in directories
|
|
|
|
|
"tmp/config", ".", and "/etc/sane.d" being searched (in this
|
|
|
|
|
order).
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SEE ALSO</H2><PRE>
|
2009-05-03 21:14:31 +00:00
|
|
|
|
<B><A HREF="sane.7.html">sane(7)</A></B>, <B><A HREF="sane-dll.5.html">sane-dll(5)</A></B>, <I>http://home.arcor.de/wittawat/pixma/,</I>
|
|
|
|
|
<I>http://mp610.blogspot.com/</I>
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
2010-04-26 02:18:46 +00:00
|
|
|
|
In case of trouble with a recent Pixma model, try the latest code for
|
|
|
|
|
the pixma backend, available in the Sane git repository at:
|
|
|
|
|
<I>http://git.debian.org/?p=sane/sane-backends.git</I>
|
|
|
|
|
|
|
|
|
|
You can also post into the Sane-devel mailing list for support.
|
|
|
|
|
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
|
|
|
|
</PRE>
|
2009-05-03 21:14:31 +00:00
|
|
|
|
<H2>AUTHORS</H2><PRE>
|
2012-08-27 01:52:45 +00:00
|
|
|
|
Wittawat Yamwong, Nicolas Martin, Dennis Lou, Louis Lagendijk, Rolf
|
|
|
|
|
Bensch
|
2008-02-14 01:57:19 +00:00
|
|
|
|
|
2012-08-27 01:52:45 +00:00
|
|
|
|
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
|
2008-02-14 01:57:19 +00:00
|
|
|
|
project homepage.
|
|
|
|
|
|
2013-10-01 02:17:11 +00:00
|
|
|
|
24 Sep 2013 <B><A HREF="sane-pixma.5.html">sane-pixma(5)</A></B>
|
2008-02-14 01:57:19 +00:00
|
|
|
|
</PRE>
|
|
|
|
|
<HR>
|
|
|
|
|
<ADDRESS>
|
|
|
|
|
Man(1) output converted with
|
|
|
|
|
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
|
|
|
|
|
</ADDRESS>
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|