1sane-canon_dr(5) SANE Scanner Access Now Easy sane-canon_dr(5)
2
6 sane-canon_dr - SANE backend for Canon DR-series scanners
7
10 The sane-canon_dr library implements a SANE (Scanner Access Now Easy)
11 backend which provides access to some Canon DR-series scanners.
12 This document describes backend version 60, which shipped with SANE
14 1.0.32.
15
18 This version has only been tested with a few scanner models. Please see
19 http://www.sane-project.org/sane-supported-devices.html for the most
20 recent list.
21 This backend may support other Canon scanners. The best way to deter‐
23 mine level of support is to test the scanner directly, or to collect a
24 trace of the windows driver in action. Please contact the author for
25 help or with test results.
26 In general, the larger machines (DR-4000 and up) which have been tested
28 use a fairly complete protocol, with hardware support for many modes,
29 resolutions and features. The smaller machines have many limitations,
30 like missing horizontal resolutions, missing binary mode, always scan‐
31 ning full-width, etc. There is code in the backend to address these
32 problems, but there seems to be no way to detect if they are required,
33 so they must be hard-coded.
34
37 Effort has been made to expose most hardware options, including:
38 --source Flatbed|ADF Front|ADF Back|ADF Duplex
40 Selects the source for the scan.
41 --mode Lineart|Halftone|Gray|Color
44 Selects the mode for the scan.
45 --resolution
48 Controls scan resolution.
49 --tl-x, --tl-y, --br-x, --br-y
52 Sets scan area upper left and lower right coordinates. These are
53 renamed -t, -l, -x, -y by some frontends.
54 --page-width, --page-height
57 Sets paper size. Used by scanner to determine centering of scan
58 coordinates when using the ADF (Automatic Document Feeder) and
59 to detect double feed errors.
60 Other options will be available based on the capabilities of the scan‐
63 ner: enhancement, compression, buttons and sensors, etc.
64 Additionally, several 'software' options are exposed by the backend.
66 These are reimplementations of features provided natively by larger
67 scanners, but running on the host computer. This enables smaller ma‐
68 chines to have similar capabilities. Please note that these features
69 are somewhat simplistic, and may not perform as well as the native im‐
70 plementations. Note also that these features all require that the
71 driver cache the entire image in memory. This will almost certainly re‐
72 sult in a reduction of scanning speed.
73 --swcrop
76 Requests the driver to detect the extremities of the paper
77 within the larger image, and crop the empty edges.
78 --swdeskew
81 Requests the driver to detect the rotation of the paper within
82 the larger image, and counter the rotation.
83 --swdespeck X
86 Requests the driver to find and remove dots of X diameter or
87 smaller from the image, and fill the space with the average sur‐
88 rounding color.
89 Use 'scanimage --help' to get a list, but be aware that some op‐
91 tions may be settable only when another option has been set, and
92 that advanced options may be hidden by some frontend programs.
93
96 The configuration file canon_dr.conf is used to tell the backend how to
97 look for scanners, and provide options controlling the operation of the
98 backend. This file is read each time the frontend asks the backend for
99 a list of scanners, generally only when the frontend starts. If the
100 configuration file is missing, the backend will fail to run.
101 Scanners can be specified in the configuration file in 4 ways:
103 "scsi CANON DR"
105 Requests backend to search all scsi buses in the system for a
106 device which reports itself to be a scanner made by 'CANON',
107 with a model name starting with 'DR'.
108 "scsi /dev/sg0" (or other scsi device file)
110 Requests backend to open the named scsi device. Only useful if
111 you have multiple compatible scanners connected to your system,
112 and need to specify one. Probably should not be used with the
113 other "scsi" line above.
114 "usb 0x04a9 0x1603" (or other vendor/product ids)
116 Requests backend to search all usb buses in the system for a de‐
117 vice which uses that vendor and product id. The device will then
118 be queried to determine if it is a Canon scanner.
119 "usb /dev/usb/scanner0" (or other device file)
121 Some systems use a kernel driver to access usb scanners. This
122 method is untested.
123 Besides the 'scsi' and 'usb' lines, the configuration file supports the
125 following 'option' lines:
126 "option buffer-size [number of bytes]"
128 Set the number of bytes in the data buffer to something other
129 than the compiled-in default of 4MB. Large values may cause
130 timeouts or hangs, small values may cause slow scans.
131 Note: The backend does not place an upper bound on this value,
133 as some users required it to be quite large. Values above the
134 default are not recommended, and may crash your OS or lockup
135 your scsi card driver. You have been warned.
136 "option vendor-name [string of text]"
138 "option model-name [string of text]"
139 "option version-name [string of text]"
140 These options can be used collectively to override the values
141 provided by the scanner, or to provide the values when the scan‐
142 ner cannot.
143 "option padded-read [0|1]"
145 Some scanners prepend all data transmitted to host with 12
146 bytes. Enable this option if the scanner fails to respond to
147 commands.
148 "option duplex-offset [integer]"
150 Some scanners pad the upper edge of one side of a duplex scan.
151 There is some variation in the amount of padding. Modify this
152 option if your unit shows an unwanted band of image data on only
153 one side.
154 NOTE: "option" lines may appear multiple times in the configuration
156 file. They only apply to scanners discovered by the next 'scsi/usb'
157 line.
158
160 The backend uses a single environment variable, SANE_DEBUG_CANON_DR,
161 which enables debugging output to stderr. Valid values are:
162 5 Errors
164 10 Function trace
165 15 Function detail
166 20 Option commands
167 25 SCSI/USB trace
168 30 SCSI/USB detail
169 35 Useless noise
170
173 This backend was entirely reverse engineered from usb traces of the
174 proprietary driver. Various advanced features of the machines may not
175 be enabled. Many machines have not been tested. Their protocol is un‐
176 known.
177
180 The various authors of the sane-fujitsu(5) backend provided useful
181 code.
182 Yabarana Corp. www.yabarana.com provided significant funding.
183 EvriChart, Inc. www.evrichart.com provided funding and loaned equip‐
184 ment.
185 Canon, USA. www.usa.canon.com loaned equipment.
186 HPrint hprint.com.br provided funding and testing for DR-2510 support.
187 Stone-IT www.stone-it.com provided funding for DR-2010 and DR-2050 sup‐
188 port.
189 Gerhard Pfeffer provided access and testing for P-208 and P-215.
190 Special thanks to: Alejandro Imass, Andre Shimakawa, Martijn van Brum‐
191 melen, Thanos Diacakis and Junren Shi for testing and feedback.
192
195 sane(7), sane-scsi(5), sane-usb(5)
196
199 m. allan noah: <kitno455 a t gmail d o t com>.
200 13 Feb 2021 sane-canon_dr(5)