1sane-canon_dr(5)         SANE Scanner Access Now Easy         sane-canon_dr(5)
2
3
4

NAME

6       sane-canon_dr - SANE backend for Canon DR-series scanners
7
8

DESCRIPTION

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
13       This document describes backend version 41,  which  shipped  with  SANE
14       1.0.24.
15
16

SUPPORTED HARDWARE

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
22       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
27       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
35

OPTIONS

37       Effort has been made to expose most hardware options, including:
38
39       source s
40              Selects the source for the scan. Options may include  "Flatbed",
41              "ADF Front", "ADF Back", "ADF Duplex".
42
43       mode m
44              Selects  the  mode  for the scan. Options may include "Lineart",
45              "Halftone", "Gray", and "Color".
46
47       resolution
48              Controls scan resolution.
49
50       tl-x, tl-y, br-x, br-y
51              Sets scan area upper left and lower right coordinates. These are
52              renamed t, l, x, y by some frontends.
53
54       page-width, page-height
55              Sets  paper size. Used by scanner to determine centering of scan
56              coordinates when using ADF and to detect double feed errors.
57
58       Other options will be available based on the capabilities of the  scan‐
59       ner: enhancement, compression, buttons and sensors, etc.
60
61       Additionally,  several  'software'  options are exposed by the backend.
62       These are reimplementations of features  provided  natively  by  larger
63       scanners,  but  running  on  the  host  computer.  This enables smaller
64       machines to have similar capabilities. Please note that these  features
65       are  somewhat  simplistic,  and  may  not perform as well as the native
66       implementations. Note also that these features  all  require  that  the
67       driver  cache  the  entire  image in memory. This will almost certainly
68       result in a reduction of scanning speed.
69
70       swcrop
71              Requests the driver to  detect  the  extremities  of  the  paper
72              within the larger image, and crop the empty edges.
73
74       swdeskew
75              Requests  the  driver to detect the rotation of the paper within
76              the larger image, and counter the rotation.
77
78       swdespeck X
79              Requests the driver to find and remove dots  of  X  diameter  or
80              smaller from the image, and fill the space with the average sur‐
81              rounding color.
82
83       Use 'scanimage --help' to get a list, but be aware  that  some  options
84       may  be  settable  only  when  another  option  has  been set, and that
85       advanced options may be hidden by some frontend programs.
86

CONFIGURATION FILE

88       The configuration file "canon_dr.conf" is used to tell the backend  how
89       to  look for scanners, and provide options controlling the operation of
90       the backend.  This file is read each time the frontend asks the backend
91       for a list of scanners, generally only when the frontend starts. If the
92       configuration file is missing, the backend will fail to run.
93
94       Scanners can be specified in the configuration file in 4 ways:
95
96       "scsi CANON DR"
97              Requests backend to search all scsi busses in the system  for  a
98              device  which  reports  itself  to be a scanner made by 'CANON',
99              with a model name starting with 'DR'.
100
101       "scsi /dev/sg0" (or other scsi device file)
102              Requests backend to open the named scsi device. Only  useful  if
103              you  have multiple compatible scanners connected to your system,
104              and need to specify one. Probably should not be  used  with  the
105              other "scsi" line above.
106
107       "usb 0x04a9 0x1603" (or other vendor/product ids)
108              Requests  backend  to  search all usb busses in the system for a
109              device which uses that vendor and product id.  The  device  will
110              then be queried to determine if it is a Canon scanner.
111
112       "usb /dev/usb/scanner0" (or other device file)
113              Some  systems  use  a kernel driver to access usb scanners. This
114              method is untested.
115
116       Besides the 'scsi' and 'usb' lines, the configuration file supports the
117       following 'option' lines:
118
119       "option buffer-size [number of bytes]"
120              Set  the  number  of bytes in the data buffer to something other
121              than the compiled-in default of  4MB.  Large  values  may  cause
122              timeouts or hangs, small values may cause slow scans.
123
124              Note:  The  backend does not place an upper bound on this value,
125              as some users required it to be quite large.  Values  above  the
126              default  are  not  recommended,  and may crash your OS or lockup
127              your scsi card driver. You have been warned.
128
129       "option vendor-name [string of text]"
130       "option model-name [string of text]"
131       "option version-name [string of text]"
132              These options can be used collectively to  override  the  values
133              provided by the scanner, or to provide the values when the scan‐
134              ner cannot.
135
136       "option padded-read [0|1]"
137              Some scanners prepend all  data  transmitted  to  host  with  12
138              bytes.  Enable  this  option  if the scanner fails to respond to
139              commands.
140
141       "option duplex-offset [integer]"
142              Some scanners pad the upper edge of one side of a  duplex  scan.
143              There  is  some  variation in the amount of padding. Modify this
144              option if your unit shows an unwanted band of image data on only
145              one side.
146
147       Note:  'option'  lines  may  appear multiple times in the configuration
148       file.  They only apply to scanners discovered by  the  next  'scsi/usb'
149       line.
150

ENVIRONMENT

152       The  backend  uses  a single environment variable, SANE_DEBUG_CANON_DR,
153       which enables debugging output to stderr. Valid values are:
154
155              5  Errors
156              10 Function trace
157              15 Function detail
158              20 Option commands
159              25 SCSI/USB trace
160              30 SCSI/USB detail
161              35 Useless noise
162
163

KNOWN ISSUES

165       This backend was entirely reverse engineered from  usb  traces  of  the
166       proprietary  driver.  Various advanced features of the machines may not
167       be enabled. Many machines have  not  been  tested.  Their  protocol  is
168       unknown.
169
170

CREDITS

172       The various authors of the sane-fujitsu backend provided useful code
173       Yabarana Corp. www.yabarana.com provided significant funding
174       EvriChart, Inc. www.evrichart.com provided funding and loaned equipment
175       Canon, USA. www.usa.canon.com loaned equipment
176       HPrint hprint.com.br provided funding and testing for DR-2510 support
177       Stone-IT www.stone-it.com provided funding for DR-2010 and DR-2050 sup‐
178       port
179       Gerhard Pfeffer provided access and testing for P-208 and P-215
180       Special thanks to: Alejandro Imass, Andre Shimakawa, Martijn van  Brum‐
181       melen, Thanos Diacakis and Junren Shi for testing and feedback.
182
183

SEE ALSO

185       sane(7), sane-scsi(5), sane-usb(5)
186
187

AUTHOR

189       m. allan noah: <kitno455 a t gmail d o t com>
190
191
192
193
194                                  16 Sep 2013                 sane-canon_dr(5)
Impressum