1sane-pixma(5) SANE Scanner Access Now Easy sane-pixma(5)
2
6 sane-pixma - SANE backend for Canon Multi-Function Printers and
7 CanoScan Scanners
8
10 The sane-pixma library implements a SANE (Scanner Access Now Easy)
11 backend that provides access to Canon PIXMA / i-SENSYS / imageCLASS /
12 imageRUNNER multi-function devices (All-in-one printers) and the Canon
13 CanoScan Flatbed/TPU scanners. The backend implements both the USB
14 interface and network interface (using Canon's BJNP and MFNP proto‐
15 cols). The network interface supports scanners over IPv4 as well as
16 IPv6 (MFNP over IPv6 is untested).
17 Currently, the following models work with this backend:
19 PIXMA E510
21 PIXMA G2000, G2010, G2100
22 PIXMA MG2100, MG2200, MG2400, MG2500, MG2900, MG3000, MG3100
23 PIXMA MG3200, MG3500, MG3600, MG4200, MG5100, MG5200, MG5300
24 PIXMA MG5400, MG5500, MG5600, MG5700, MG6100, MG6200, MG6300
25 PIXMA MG6400, MG7100, MG7500, MG7700, MG8200
26 PIXMA MP140, MP150, MP160, MP170, MP180, MP190
27 PIXMA MP210, MP220, MP230, MP240, MP250, MP260, MP270, MP280
28 PIXMA MP360, MP370, MP390
29 PIXMA MP450, MP460, MP470, MP480, MP490
30 PIXMA MP500, MP510, MP520, MP530, MP540, MP550, MP560
31 PIXMA MP600, MP600R, MP610, MP620, MP630, MP640
32 PIXMA MP700, MP710, MP730, PIXMA MP750 (no grayscale)
33 PIXMA MP800, MP800R, MP810, MP830
34 PIXMA MP960, MP970, MP980, MP990
35 PIXMA MX300, MX310, MX330, MX340, MX350, MX360, MX370
36 PIXMA MX410, MX420, MX470, MX510, MX520, MX530, MX700, MX720
37 PIXMA MX850, MX860, MX870, MX882, MX885, MX890, MX920, MX7600
38 PIXMA TS3100, TS5000, TS6100, TS6200, TS8000, TS8200
39 PIXUS MP10
40 imageCLASS MF634Cdw, MF733Cdw
41 imageCLASS MF3110, MF3240, MF4010, MF4018
42 imageCLASS MF4120, MF4122, MF4140, MF4150
43 imageCLASS MF4270, MF4350d, MF4370dn, MF4380dn
44 imageCLASS MF4410, MF4430, MF4570dw, MF4660, MF4690
45 imageCLASS MF5730, MF5770, MF6550, MPC200
46 imageCLASS D420, D480, D530, D570
47 i-SENSYS MF210, MF230, MF240, MF620, MF630, MF640, MF645C, MF730
48 i-SENSYS MF731/733, MF741/743, MF3010, MF4320d, MF4330d, MF4500
49 i-SENSYS MF4700, MF4800, MF6100, MF8030, MF8200C, MF8300
50 imageRUNNER 1020/1024/1025, 1133
51 CanoScan 8800F, 9000F, 9000F Mark II
52 CanoScan LiDE 300, 400
53 MAXIFY MB2000, MB2100, MB2300, MB2700, MB5000, MB5400
54 The following models are not well tested and/or the scanner sometimes
56 hangs and must be switched off and on.
57 PIXMA MP760, MP770, MP780, MP790
59 The following models may use the same Pixma protocol as those listed
61 above, but have not yet been reported to work (or not). They are
62 declared in the backend so that they get recognized and activated.
63 Feedback in the sane-devel mailing list welcome.
64 PIXMA E400, E410, E460, E470, E480, E500, E560, E600, E610
66 PIXMA E3100, E3300, E4200
67 PIXMA MG4100, MG6500, MG6600, MG6800, MG6900, MG8100
68 PIXMA MP375R, MP493, MP495, MP740
69 PIXMA MX320, MX390, MX430, MX450, MX490, MX710
70 PIXMA G3000, G3010, G4000, G4010, G6000, G6080
71 PIXMA TR4500, TR7500, TR7530, TR8500, TR8530, TR8580, TR9530
72 PIXMA TS5100, TS6000, TS6130, TS6180, TS6230, TS6280, TS6300
73 PIXMA TS6330, TS6380, TS7330, TS8100, TS8130, TS8180, TS8230
74 PIXMA TS8280,, TS8300, TS8330, TS8380, TS9000, TS9100, TS9180
75 PIXMA TS9500, TS9580
76 PIXUS MP5, XK50, XK60, XK70, XK80
77 imageCLASS MF810/820, MF5630, MF5650, MF5750, MF8170c
78 imageCLASS MPC190, D550
79 i-SENSYS MF110, MF220, MF260, MF410, MF420, MF510, MF520, MF740
80 i-SENSYS MF5880dn, MF5900, MF6680dn, MF8500C
81 MAXIFY MB5100, MB5300
82 The following models may use partly the same Pixma protocol as other
84 devices listed above, but may still need some work. They are declared
85 in the backend as experimental and need the environment variable
86 PIXMA_EXPERIMENT=1 to get recognized and activated. Snoop logs are
87 required to further investigate, please contact the sane-devel mailing
88 list.
89 -- none --
91 The backend supports:
93 * resolutions of 75, 150, 300, 600, 1200, 2400, 4800, and 9600
95 DPI (some maybe buggy),
96 * color and grayscale mode, as well as lineart on certain mod‐
97 els,
98 * a custom gamma table,
99 * Automatic Document Feeder, Simplex and Duplex.
100 * Transparency Unit, 24 or 48 bits depth. Infrared channel on
101 certain models.
102 The device name for USB devices is in the form pixma:xxxxyyyy_zzzzz
104 where x, y and z are vendor ID, product ID and serial number respec‐
105 tively.
106 Example: pixma:04A91709_123456 is a MP150.
108 Device names for BJNP/MFNP devices is in the form pixma:aaaa_bbbbb
110 where aaaa is the scanners model and bbbb is the hostname or ip-adress.
111 Example: pixma:MF4800_192.168.1.45 is a MF4800 Series multi-function
113 peripheral.
114 This backend, based on cloning original Canon drivers protocols, is in
116 a production stage. Designed has been carried out without any applica‐
117 ble manufacturer documentation, probably never available. However, we
118 have tested it as well as we could, but it may not work in all situa‐
119 tions. You will find an up-to-date status at the project homepage. (See
120 below). Users feedback is essential to help improve features and per‐
121 formances.
122
124 Besides "well-known" options (e.g. resolution, mode etc.) pixma backend
125 also provides the following options, i.e. the options might change in
126 the future.
127 The button status can be polled i.e. with 'scanimage -A'.
128 Button scan is disabled on MAC OS X due to darwin libusb not handling
129 timeouts in usb interrupt reads, but may work when using the network
130 protocol.
131 adf-wait
133 This option enables and sets the time in seconds waiting for a
134 document inserted into the Automatic Document Feeder. The maxi‐
135 mum allowed waiting time is 3600 sec (= 1 hour).
136 button-controlled
138 This option can be used by applications (like scanadf(1) and
139 scanimage(1)) in batch mode, for example when you want to scan
140 many photos or multiple-page documents. If it is enabled (i.e.
141 is set to true or yes), the backend waits before every scan
142 until the user presses the "SCAN" button (for MP150) or the
143 color-scan button (for other models). Just put the first page in
144 the scanner, press the button, then the next page, press the
145 button and so on. When you finished, press the gray-scan button.
146 (For MP150 you have to stop the frontend by pressing Ctrl-C for
147 example.)
148 button-update (deprecated)
150 (write only) In the past this option was required to be set to
151 force reading of the button status for button-1 and button-2.
152 The sane-pixma no longer requires this option to be used: if no
153 fresh data is available, it will be now requested automatically
154 from the scanner. This option is left for backward compatibility
155 reasons.
156 button-1 button-2
158 (read only) These options will return the value of the respec‐
159 tive buttons. value 0 means that the button was not pressed, 1
160 is returned when the button was pressed. Some scanners with more
161 than two buttons send the button number as target.
162 original
164 (read only) Returns the value of the type or size of original to
165 be scanned if the scanner provides that data. Known values of
166 type: 1 = document, 2 = foto, 5 = film. Known values of size: 1
167 = A4, 2 = Letter, 8 = 10x15, 9 = 13x18, b = auto. Not all scan‐
168 ners can provide this data.
169 target (read only) Returns the value of the target of the scan opera‐
171 tion if the scanner provides that data. The values depend on the
172 scanner type. Known values: 1 = save to disk, 2 = save to pdf, 3
173 = send to email, 4 = send to application or 1 = JPEG, 2 = TIFF,
174 3 = PDF, 4 = Compact PDF. For some scanners this value is equiv‐
175 alent to the number of the pressed button. Not all scanners can
176 provide this data.
177 scan-resolution
179 (read only) Returns the resolution of the scan operation if the
180 scanner provides that data. Known values: 1 = 75 dpi, 2 = 150
181 dpi, 3 = 300 dpi, 4 = 600 dpi. Not all scanners can provide this
182 data.
183
185 /usr/lib64/sane/libsane-pixma.a
186 The static library implementing this backend.
187 /usr/lib64/sane/libsane-pixma.so
189 The shared library implementing this backend (present on systems
190 that support dynamic loading).
191 /etc/sane.d/pixma.conf
193 The backend configuration file (see also description of
194 SANE_CONFIG_DIR below).
195 The file contains an optional list of networked scanners using
197 the BJNP or MFNP protools (See below for datails on networking
198 support for scanners). Normally only scanners that cannot be
199 auto-detected because they are on a different subnet shall be
200 listed here. If you do not use Linux and your OS does not allow
201 enumeration of interfaces (i.e. it does not support the getifad‐
202 drs() function) you also may need to add your scanner here as
203 well.
204 Scanners shall be listed in the configuration file as follows:
206 <method>://<host>[:port][/timeout=<value>]
208 where method indicates the protocol used (bjnp is used for
210 inkjet multi-functionals and mfnp is used for laser multi-func‐
211 tionals).
212 host is the hostname or IP address of the scanner, e.g.
214 bjnp://10.0.1.4 for IPv4,
215 bjnp://[2001:888:118e:18e2:21e:8fff:fe36:b64a] for a literal
216 IPv6-address or bjnp://myscanner.mydomain.org for a hostname.
217 The port number is optional and in normally implied by the
219 method. Port 8610 is the standard port for mfnp, 8612 for bjnp.
220 A scanner specific timeout value for the network protocol can be
222 set using the bjnp-timeout parameter. The value is in ms.
223 Define scanners each on a new line.
225 More globally applicable timeouts can be set using the bjnp-
227 timeout parameter as follows:
228 bjnp-timeout=<value>
230 A timeout defined using bjnp-timeout will apply to the following
232 scanner definitions in the file. If required the bjnp-timeout
233 setting can be defined multiple times, where each settng will
234 apply only to the scanners that follow the setting. The last
235 setting is used for the auto discovered scanners. If not
236 explicitly set, the default 1000ms setting will apply.
237 Setting timeouts should only be required in exceptional cases.
239 If so desired networking can be disbled as follows:
241 - If the first non-commented line contains networking=no
243 all networking will be disabled. This will cause all
244 further statements in the configuration file to be
245 ignored.
246 - A line that contains auto_detection=no will cause auto-
248 detection to be skipped. Explicitely defined network
249 scanners will still be probed.
250
252 USB scanners will be auto-detected and require no configuration.
253
255 The pixma backend supports network scanners using the so called Canon
256 BJNP and MFNP protocols.
257 Canon seems to be dropping support for these protocols in recent scan‐
259 ners. To verify if your scanner supports one of these protocols, check
260 the content of the _scanner._tcp service entry in mDNS/DNS-SD (using
261 for example avahi-discover). If that does not list port 8610 or 8612
262 your scanner probably does not support the mfmp or bjnp protols.
263 Both IPv4 and IPv6 are supported, but IPv6 is as yet untested with
265 MFNP. Please report your results on the mailing list.
266 Configuration is normally not required. The pixma backend will auto-
268 detect your scanner if it is within the same subnet as your computer if
269 your OS does support this.
270 If your scanner can not be auto-detected, you can add it to the pixma
272 configuration file (see above).
273
275 The sane pixma backend communicates with port 8610 for MFNP or port
276 8612 for BJNP on the scanner. So you will have to allow outgoing traf‐
277 fic TO port 8610 or 8612 on the common subnet for scanning.
278 Scanner detection is slightly more complicated. The pixma backend sends
280 a broadcast on all direct connected subnets it can find (provided your
281 OS allows for enumeration of all netowrk interfaces). The broadcast is
282 sent FROM port 8612 TO port 8610 or 8612 on the broadcast address of
283 each interface. The outgoing packets will be allowed by the rule
284 described above.
285 Responses from the scanner are sent back to the computer TO port 8612.
287 Connection tracking however does not see a match as the response does
288 not come from the broadcast address but from the scanners own address.
289 For automatic detection of your scanner, you will therefore have to
290 allow incoming packets TO port 8612 on your computer. This applies to
291 both MFNP and BJNP.
292 So in short: open the firewall for all traffic from your computer to
294 port 8610 (for MFNP) or 8612 (for BJNP) AND to port 8612 (for both BJNP
295 and MFNP) to your computer.
296 With the firewall rules above there is no need to add the scanner to
298 the pixma.conf file, unless the scanner is on a network that is not
299 directly connected to your computer.
300
302 SANE_DEBUG_PIXMA
303 If the library was compiled with debug support enabled, this
304 environment variable controls the debug level for this backend
305 itself. Higher value increases the verbosity and includes the
306 information printed at the lower levels.
307 0 print nothing (default)
308 1 print error and warning messages (recommended)
309 2 print informational messages
310 3 print debug-level messages
311 4 print verbose debug-level messages
312 11 dump USB traffic
313 21 full dump USB traffic
314 SANE_DEBUG_BJNP
316 If the library was compiled with debug support enabled, this
317 environment variable controls the debug level for the BJNP and
318 MFNP network protocols for this backend. Higher value increases
319 the verbosity and includes the information printed at the lower
320 levels.
321 0 print nothing (default)
322 1 Print error and warning messages (recommended)
323 2 Print high level function tracing information
324 3 Print more detailed protocol tracing information
325 4 Print protocol headers
326 5 Print full protocol contents
327 PIXMA_EXPERIMENT
329 Setting to a non-zero value will enable the support for experi‐
330 mental models. You should also set SANE_DEBUG_PIXMA to 11.
331 SANE_CONFIG_DIR
333 This environment variable specifies the list of directories that
334 may contain the configuration file. Under UNIX, the directories
335 are separated by a colon (`:'), under OS/2, they are separated
336 by a semi-colon (`;'). If this variable is not set, the config‐
337 uration file is searched in two default directories: first, the
338 current working directory (".") and then in /etc/sane.d. If the
339 value of the environment variable ends with the directory sepa‐
340 rator character, then the default directories are searched after
341 the explicitly specified directories. For example, setting
342 SANE_CONFIG_DIR to "/tmp/config:" would result in directories
343 "tmp/config", ".", and "/etc/sane.d" being searched (in this
344 order).
345
347 sane(7), sane-dll(5),
348 In case of trouble with a recent Pixma model, try the latest code for
350 the pixma backend, available in the Sane git repository at:
351 https://gitlab.com/sane-project/backends.git
352 You can also post into the Sane-devel mailing list for support.
354
357 Wittawat Yamwong, Nicolas Martin, Dennis Lou, Louis Lagendijk, Rolf
358 Bensch
359 We would like to thank all testers and helpers. Without them we could
361 not be able to write subdrivers for models we don't have. See also the
362 project homepage.
363 28 Dec 2019 sane-pixma(5)