1sane-hp(5) SANE Scanner Access Now Easy sane-hp(5)
2
6 sane-hp - SANE backend for HP ScanJet scanners
7
9 The sane-hp library implements a SANE (Scanner Access Now Easy) backend
10 that provides access to HP ScanJet scanners which support SCL (Scanner
11 Control Language by HP). The following scanners are known positively
12 to work with this backend:
13 Model: Product id: Interface:
15 ---------- ----------- ----------
16 ScanJet Plus C9195A HP Parallel Interface Card
17 ScanJet IIc C1750A 3226 SCSI
18 ScanJet IIcx C2500A 3332 SCSI
19 ScanJet IIp C1790A SCSI
20 ScanJet 3C C2520A 3503 SCSI
21 ScanJet 3P C2570A 3406 SCSI
22 ScanJet 4C C2520A SCSI
23 ScanJet 4P C1130A 3540 SCSI
24 ScanJet 4100C C6290A USB
25 ScanJet 5P C5110A SCSI
26 ScanJet 5100C C5190A parallel port
27 ScanJet 5200C C7190A 3846 parallel port/USB
28 ScanJet 6100C C2520A 3644 SCSI
29 ScanJet 6200C C6270A 3828 SCSI/USB
30 ScanJet 6250C C6270A 3828 SCSI/USB
31 ScanJet 6300C C7670A SCSI/USB
32 ScanJet 6350C C7670A SCSI/USB
33 ScanJet 6390C C7670A SCSI/USB
34 PhotoSmart C5100A R029,R030,R032 SCSI
35 Support for models 5100C/5200C connected to the parallel port requires
37 the ppSCSI driver available at http://cyberelk.net/tim/par‐
38 port/ppscsi.html and http://penguin-breeder.org/kernel/download/.
39 Support for models 5200C/62X0C/63X0C connected to the USB require the
42 kernel scanner driver or libusb. See sane-usb(5) for more details.
43 The sane-hp backend no longer supports OfficeJet multi-function periph‐
45 erals. For these devices use the external "hpoj" backend in version
46 0.90 and later of the "HP OfficeJet Linux driver", available at
47 http://hpoj.sourceforge.net
48 Because Hewlett-Packard does no longer produce scanners that support
50 SCL (beside the OfficeJets), the above list of supported scanners is
51 complete. Other HP scanners are not supported by the sane-hp backend,
52 but might be supported by another one. See
53 http://www.sane-project.org/. You can also watch the sane-devel mail‐
54 ing list at http://www.sane-project.org/mailing-lists.html.
55 More details about the hp backend can be found on its homepage
57 http://www.kirchgessner.net/sane.html.
58
60 This backend expects device names of the form:
61 special
63 Where special is the UNIX path-name for the special device that corre‐
65 sponds to the scanner. For SCSI scanners the special device name must
66 be a generic SCSI device or a symlink to such a device. Under Linux,
67 such a device name could be /dev/sga or /dev/sg2, for example. If the
68 special device name contains "usb", "uscanner" or "ugen", it is assumed
69 that the scanner is connected by USB. For the HP ScanJet Plus the spe‐
70 cial device name must be the device that corresponds to the parallel
71 interface card that was shipped with the scanner. That is /dev/hpscan.
72 A special driver is required for this card. See
73 ftp://rvs.ctrl-c.liu.se/pub/wingel/hpscan for details. If the link does
74 not work, try ftp://sunsite.unc.edu/pub/Linux/kernel/patches/scanners.
75
77 The contents of the hp.conf file is a list of options and device names
78 that correspond to HP ScanJet scanners. Empty lines and lines starting
79 with a hash mark (#) are ignored. See sane-scsi(5) and sane-usb(5) on
80 details of what constitutes a valid device name.
81 Options specified in front of the first line that contains a device
83 name are defaults for all devices. Options specified below a line that
84 contains a device name apply just to the most recently mentioned
85 device.
86 Supported options are connect-scsi, connect-device,
88 enable-image-buffering, and dumb-read.
89 Option connect-scsi specifies that the scanner is connected to the sys‐
91 tem by SCSI. Input/output is performed using SCSI-commands. This is
92 the default. But if your SCSI device name contains "usb", "uscanner"
93 or "ugen", option connect-scsi must be specified. Otherwise it is
94 assumed that the scanner is connected by USB.
95 Option connect-device specifies that the scanner is connected to the
97 system by a special device. Input/output is performed by
98 read()/write()-operations on the device. This option must be used for
99 HP ScanJet Plus or scanners connected to USB which are accessed through
100 a named device (e.g. /dev/usb/scanner0). For device names that con‐
101 tain "usb", "uscanner" or "ugen", it is not necessary to specify option
102 connect-device.
103 Option enable-image-buffering stores the scanned image in memory before
105 passing it to the frontend. Could be used in case of forward/backward
106 moving scanner lamp.
107 Option dumb-read can be used to work around problems with "Error during
109 device I/O". These problems may occur with certain SCSI-to-USB convert‐
110 ers or Buslogic SCSI cards. The option should not be used for SCSI
111 devices which are working correctly. Otherwise startup of frontends
112 and changing parameters might be slower.
113 A sample configuration file is shown below:
115 /dev/scanner
117 # this is a comment
118 /dev/hpscan
119 option connect-device
120 /dev/scanner is typically a symlink to the actual SCSI scanner device.
122
124 /etc/sane.d/hp.conf
125 The backend configuration file (see also description of
126 SANE_CONFIG_DIR below).
127 /usr/lib64/sane/libsane-hp.a
129 The static library implementing this backend.
130 /usr/lib64/sane/libsane-hp.so
132 The shared library implementing this backend (present on systems
133 that support dynamic loading).
134 $HOME/.sane/calib-hp:<device>.dat
136 Calibration data for HP PhotoSmart PhotoScanner that is
137 retrieved from the scanner after calibration. The data is
138 uploaded to the scanner at start of the backend if it is in
139 media mode 'print media' or if the media mode is changed to
140 'print media'.
141
143 SANE_CONFIG_DIR
144 This environment variable specifies the list of directories that
145 may contain the configuration file. Under UNIX, the directories
146 are separated by a colon (`:'), under OS/2, they are separated
147 by a semi-colon (`;'). If this variable is not set, the config‐
148 uration file is searched in two default directories: first, the
149 current working directory (.) and then in /etc/sane.d. If the
150 value of the environment variable ends with the directory sepa‐
151 rator character, then the default directories are searched after
152 the explicitly specified directories. For example, setting
153 SANE_CONFIG_DIR to "/tmp/config:" would result in directories
154 tmp/config, ., and /etc/sane.d being searched (in this order).
155 SANE_DEBUG_HP
157 If the library was compiled with debug support enabled, this
158 environment variable controls the debug level for this backend.
159 E.g., a value of 128 requests all debug output to be printed.
160 Smaller levels reduce verbosity.
161 SANE_HOME_HP
163 Only used for OS/2 and along with use of HP PhotoSmart Photo‐
164 Scanner. Must be set to the directory where the directory .sane
165 is located. Is used to save and read the calibration file.
166 SANE_HP_KEEPOPEN_SCSI
168 SANE_HP_KEEPOPEN_USB
170 SANE_HP_KEEPOPEN_DEVICE
172 For each type of connection (connect-scsi, connect-usb, con‐
173 nect-device) it can be specified if the connection to the device
174 should be kept open ("1") or not ("0"). Usually the connections
175 are closed after an operation is performed. Keeping connection
176 open to SCSI-devices can result in errors during device IO when
177 the scanner has not been used for some time. By default, USB-
178 connections are kept open. Other connections are closed.
179 SANE_HP_RDREDO
181 Specifies number of retries for read operation before returning
182 an EOF error. Only supported for non-SCSI devices. Default: 1
183 retry. Time between retries is 0.1 seconds.
184
187 HP PhotoSmart PhotoScanner
188 In media mode 'slide' and 'negative', scan resolutions are
189 rounded to multiple of 300 dpi. The scanner does not scale the
190 data correctly on other resolutions. Some newer models (firmware
191 code R030 and later) do not support adjustment of con‐
192 trast/intensity level and tone map. The backend will simulate
193 this by software, but only for gray and 24 bit color.
194 Automatic Document Feeder (ADF)
196 For use of the ADF with xscanimage(1), first place paper in the
197 ADF and then change option scan source to 'ADF'. Press 'change
198 document' to load a sheet. Then press 'scan' to start a scan.
199 Maybe it is sufficient to press 'scan' without 'change document'
200 for repeated scans. The use of the preview window is not recom‐
201 mended when working with the ADF. Setting a window to scan from
202 ADF is not supported with xscanimage(1). Try xsane(1).
203 Immediate actions
205 Some actions in xscanimage(1) (i.e. unload, select media, cali‐
206 brate) have an immediate effect on the scanner without starting
207 a scan. These options can not be used with scanimage(1).
208
211 HP PhotoSmart PhotoScanner
212 PhotoScanners with firmware release R030 and up have no firmware
213 support for contrast/brightness/gamma table. In the current
214 backend this is simulated by software on 24 bits data. Simula‐
215 tion on 30 bits should give better results.
216 Data widths greater than 8 bits
218 Custom gamma table does not work.
219 Parallel scanner support
221 Beside the ScanJet Plus which came with its own parallel inter‐
222 face card, currently only the HP ScanJet 5100C/5200C are sup‐
223 ported. These scanners are using an internal parallel-to-SCSI
224 converter which is supported by the ppSCSI-driver (see above).
225
228 sane(7), sane-scsi(5), sane-usb(5) scanimage(1), xscanimage(1), scanim‐
229 age(1)
230
233 The sane-hp backend was written by Geoffrey T. Dairiki.
234 HP PhotoSmart PhotoScanner support by Peter Kirchgessner.
235 13 Jul 2008 sane-hp(5)