kopia lustrzana https://gitlab.com/sane-project/website
357 wiersze
17 KiB
HTML
357 wiersze
17 KiB
HTML
<HTML>
|
||
<HEAD>
|
||
<TITLE>sane-pixma.5</TITLE>
|
||
</HEAD>
|
||
<BODY BGCOLOR=#FFFFFF TEXT=#000000><H1 ALIGN=CENTER><IMG SRC="/images/sane.png" HEIGHT=117 WIDTH=346></H1>
|
||
<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>
|
||
sane-pixma - SANE backend for Canon Multi-Function Printers and
|
||
CanoScan Scanners
|
||
|
||
|
||
</PRE>
|
||
<H2>DESCRIPTION</H2><PRE>
|
||
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 the USB
|
||
interface and network interface (using Canon's BJNP and MFNP proto‐
|
||
cols). The network interface supports scanners over IPv4 as well as
|
||
IPv6 (MFNP over IPv6 is untested).
|
||
|
||
Currently, the following models work with this backend:
|
||
|
||
PIXMA MG2100, MG2200, MG2400, MG2500, MG2900, MG3100, MG3200
|
||
PIXMA MG3500, MG3600, MG4200, MG5100, MG5200, MG5300, MG5400
|
||
PIXMA MG5500, MG5600, MG5700, MG6100, MG6200, MG6300, MG6400
|
||
PIXMA MG7100, MG7500, MG7700, MG8200
|
||
PIXMA MP140, MP150, MP160, MP170, MP180, MP190
|
||
PIXMA MP210, MP220, MP230, MP240, MP250, MP260, MP270, MP280
|
||
PIXMA MP360, MP370, MP390
|
||
PIXMA MP450, MP460, MP470, MP480, MP490
|
||
PIXMA MP500, MP510, MP520, MP530, MP540, MP550, MP560
|
||
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
|
||
PIXMA MX300, MX310, MX330, MX340, MX350, MX360, MX370
|
||
PIXMA MX410, MX420, MX470, MX510, MX520, MX530, MX700, MX720
|
||
PIXMA MX850, MX860, MX870, MX882, MX885, MX890, MX920, MX7600
|
||
PIXUS MP10
|
||
imageCLASS MF3110, MF3240, MF4010, MF4018
|
||
imageCLASS MF4120, MF4122, MF4140, MF4150
|
||
imageCLASS MF4270, MF4350d, MF4370dn, MF4380dn
|
||
imageCLASS MF4410, MF4430, MF4570dw, MF4660, MF4690
|
||
imageCLASS MF5730, MF5770, MF6550, MPC200, D420, D480, D530
|
||
i-SENSYS MF230, MF240, MF3010, MF4320d, MF4330d, MF4500, MF4700
|
||
i-SENSYS MF4800, MF6100, MF8200C, MF8300
|
||
imageRUNNER 1020/1024/1025
|
||
CanoScan 8800F, 9000F, 9000F Mark II
|
||
MAXIFY MB5000 (ADF is not working)
|
||
|
||
The following models are not well tested and/or the scanner sometimes
|
||
hangs and must be switched off and on.
|
||
|
||
PIXMA MP760, MP770, MP780, MP790
|
||
|
||
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-devel mailing list welcome.
|
||
|
||
PIXMA E400, E460, E470, E480, E500, E510, E560, E600, E610
|
||
PIXMA MG3000, MG4100, MG6500, MG6600, MG6800, MG6900, MG8100
|
||
PIXMA MP375R, MP493, MP495, MP740
|
||
PIXMA MX320, MX390, MX430, MX450, MX490, MX710
|
||
PIXMA G3000
|
||
PIXMA TS9000, TS800, TS6000, TS5000
|
||
PIXUS MP5
|
||
imageCLASS MF810/820, MF5630, MF5650, MF5750, MF8030, MF8170c
|
||
imageCLASS MPC190
|
||
imageRUNNER 1133
|
||
i-SENSYS MF210, MF220, MF5880dn, MF5900, MF6680dn, MF8500C
|
||
MAXIFY MB2000, MB2300, MB5300
|
||
|
||
The backend supports:
|
||
|
||
* resolutions of 75, 150, 300, 600, 1200, 2400, 4800, and 9600
|
||
DPI (some maybe buggy),
|
||
* color and grayscale mode, as well as lineart on certain mod‐
|
||
els,
|
||
* a custom gamma table,
|
||
* Automatic Document Feeder, Simplex and Duplex.
|
||
* Transparency Unit, 24 or 48 bits depth. Infrared channel on
|
||
certain models.
|
||
|
||
The device name for USB devices is in the form pixma:xxxxyyyy_zzzzz
|
||
where x, y and z are vendor ID, product ID and serial number respec‐
|
||
tively.
|
||
|
||
Example: pixma:04A91709_123456 is a MP150.
|
||
|
||
Device names for BJNP/MFNP devices is in the form pixma:aaaa_bbbbb
|
||
where aaaa is the scanners model and bbbb is the hostname or ip-adress.
|
||
|
||
Example: pixma:MF4800_192.168.1.45 is a MF4800 Series multi-function
|
||
peripheral.
|
||
|
||
This backend, based on cloning original Canon drivers protocols, is in
|
||
a production stage. Designed has been carried out without any applica‐
|
||
ble manufacturer documentation, probably never available. However, we
|
||
have tested it as well as we could, but it may not work in all situa‐
|
||
tions. You will find an up-to-date status at the project homepage. (See
|
||
below). Users feedback is essential to help improve features and per‐
|
||
formances.
|
||
|
||
|
||
</PRE>
|
||
<H2>OPTIONS</H2><PRE>
|
||
Besides "well-known" options (e.g. resolution, mode etc.) pixma backend
|
||
also provides the following options, i.e. the options might change in
|
||
the future.
|
||
The button status can be polled i.e. with 'scanimage -A'.
|
||
Button scan is disabled on MAC OS X due to darwin libusb not handling
|
||
timeouts in usb interrupt reads, but may work when using the network
|
||
protocol.
|
||
|
||
<I>adf-wait</I>
|
||
This option enables and sets the time in seconds waiting for a
|
||
document inserted into the <B>Automatic</B> <B>Document</B> <B>Feeder</B>. The maxi‐
|
||
mum allowed waiting time is 3600 sec (= 1 hour).
|
||
|
||
<I>button-controlled</I>
|
||
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> <I>(deprecated)</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.
|
||
|
||
|
||
</PRE>
|
||
<H2>FILES</H2><PRE>
|
||
<I>/usr/local/lib/sane/libsane-pixma.a</I>
|
||
The static library implementing this backend.
|
||
|
||
<I>/usr/local/lib/sane/libsane-pixma.so</I>
|
||
The shared library implementing this backend (present on systems
|
||
that support dynamic loading).
|
||
|
||
<I>/usr/local/etc/sane.d/pixma.conf</I>
|
||
The backend configuration file (see also description of
|
||
<B>SANE_CONFIG_DIR</B> below). The file contains an optional list of
|
||
networked scanners. Normally only scanners that cannot 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 also may need
|
||
to add your scanner here as well.
|
||
|
||
<I>Scanners</I> <I>shall</I> <I>be</I> <I>listed</I> <I>in</I> <I>the</I> <I>configuraton</I> <I>file</I> <I>as</I> <I>follows:</I>
|
||
|
||
<I><method>://<host>[:port][/timeout=<value>]</I>
|
||
|
||
where method indicates the protocol used (bjnp is used for
|
||
inkjet multi-functionals and mfnp is used for laser multi-func‐
|
||
tionals).
|
||
|
||
host is the hostname or IP address of the scanner, e.g.
|
||
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 for a hostname.
|
||
|
||
The port number is optional and in normally implied by the
|
||
method. Port 8610 is the standard port for mfnp, 8612 for bjnp.
|
||
|
||
A scanner specific timeout value for the network protocol can be
|
||
set using the bjnp-timeout parameter. The value is in ms.
|
||
|
||
Define scanners each on a new line.
|
||
|
||
More globally applicable tinmeouts can be set using the bjnp-
|
||
timeout parameter as folllows:
|
||
|
||
<I>bjnp-timeout=<value></I>
|
||
|
||
A timeout defined using bjnp-timeout will apply to the following
|
||
scanner definitions in the file. If required the bjnp-timeout
|
||
setting can be defined multiple times, where each settng will
|
||
apply only to the scanners that follow the setting. The last
|
||
setting is used for the auto discovered scanners. If not
|
||
explicitely set, the default 1000ms setting will apply.
|
||
|
||
Setting timeouts should only be required in exceptional cases.
|
||
|
||
|
||
</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
|
||
BJNP protocol and MFNP protocol. Both IPv4 and IPv6 are supported, but
|
||
IPv6 is as yet untested with MFNP. Please report your results on the
|
||
mailing list.
|
||
|
||
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.
|
||
|
||
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 8610 for MFNP or port
|
||
8612 for BJNP on the scanner. So you will have to allow outgoing traf‐
|
||
fic TO port 8610 or 8612 on the common subnet for scanning.
|
||
|
||
Scanner detection is slightly more complicated. The pixma backend sends
|
||
a broadcast on all direct connected subnets it can find (provided your
|
||
OS allows for enumeration of all netowrk interfaces). The broadcast is
|
||
sent FROM port 8612 TO port 8610 or 8612 on the broadcast address of
|
||
each interface. The outgoing packets will be allowed by the rule
|
||
described above.
|
||
|
||
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.
|
||
For automatic detection of your scanner, you will therefore have to
|
||
allow incoming packets TO port 8612 on your computer. This applies to
|
||
both MFNP and BJNP.
|
||
|
||
So in short: open the firewall for all traffic from your computer to
|
||
port 8610 (for MFNP) or 8612 (for BJNP) AND to port 8612 (for both BJNP
|
||
and MFNP) 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.
|
||
|
||
|
||
</PRE>
|
||
<H2>ENVIRONMENT</H2><PRE>
|
||
<B>SANE_DEBUG_PIXMA</B>
|
||
If the library was compiled with debug support enabled, this
|
||
environment variable controls the debug level for this backend
|
||
itself. Higher value increases the verbosity and includes the
|
||
information printed at the lower levels.
|
||
0 print nothing (default)
|
||
1 print error and warning messages (recommended)
|
||
2 print informational messages
|
||
3 print debug-level messages
|
||
4 print verbose debug-level messages
|
||
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> <B>and</B>
|
||
<B>MFNP</B> network protocols for this backend. Higher value increases
|
||
the verbosity 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
|
||
|
||
<B>PIXMA_EXPERIMENT</B>
|
||
Setting to a non-zero value will enable the support for experi‐
|
||
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
|
||
are separated by a colon (`:'), under OS/2, they are separated
|
||
by a semi-colon (`;'). If this variable is not set, the config‐
|
||
uration file is searched in two default directories: first, the
|
||
current working directory (".") and then in
|
||
/usr/local/etc/sane.d. If the value of the environment variable
|
||
ends with the directory separator character, then the default
|
||
directories are searched after the explicitly specified directo‐
|
||
ries. For example, setting <B>SANE_CONFIG_DIR</B> to "/tmp/config:"
|
||
would result in directories "tmp/config", ".", and
|
||
"/usr/local/etc/sane.d" being searched (in this order).
|
||
|
||
|
||
</PRE>
|
||
<H2>SEE ALSO</H2><PRE>
|
||
<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>
|
||
|
||
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>https://gitlab.com/sane-project/backends.git</I>
|
||
|
||
You can also post into the Sane-devel mailing list for support.
|
||
|
||
|
||
</PRE>
|
||
<H2>AUTHORS</H2><PRE>
|
||
Wittawat Yamwong, Nicolas Martin, Dennis Lou, Louis Lagendijk, Rolf
|
||
Bensch
|
||
|
||
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.
|
||
|
||
20 May 2017 <B><A HREF="sane-pixma.5.html">sane-pixma(5)</A></B>
|
||
</PRE>
|
||
<HR>
|
||
<ADDRESS>
|
||
Man(1) output converted with
|
||
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
|
||
</ADDRESS>
|
||
</BODY>
|
||
</HTML>
|