1sane-hp5590(5) SANE Scanner Access Now Easy sane-hp5590(5)
2
6 sane-hp5590 - SANE backend for Hewlett-Packard
7 4500C/4570C/5500C/5550C/5590/7650 Workgroup/Document scanners
8
10 The sane-hp5590 library implements a SANE (Scanner Access Now Easy)
11 backend that provides access to the following Hewlett-Packard Work‐
12 group/Document scanners:
13 · ScanJet 4500C
15 · ScanJet 4570C
17 · ScanJet 5500C
19 · ScanJet 5550C
21 · ScanJet 5590
23 · ScanJet 7650
25 If you own a scanner other than the ones listed above that works with
27 this backend, please let us know this by sending the scanner’s exact
28 model name and the USB vendor and device ids (e.g. from
29 /sys/bus/usb/devices, sane-find-scanner or syslog) to us. Even if the
30 scanner’s name is only slightly different from the models mentioned
31 above, please let us know.
32
34 The options the backend supports can either be selected through command
35 line options to programs like scanimage or through GUI elements in xs‐
36 canimage or xsane. Valid command line options and their syntax can be
37 listed by using:
38 scanimage --help -d hp5590:interface:device
40 where interface and device specify the device in question, as in the
42 configuration file. Add --all-options to also list the hardware read-
43 out options. The -d parameter and its argument can be omitted to ob‐
44 tain information on the first scanner identified.
45 Use the command:
47 scanimage -L
49 to list all devices recognized by your SANE installation.
51
53 -l n Top-left X position of scan area in mm. Allowed range: 0 ..
54 215.889.
55 -t n Top-left Y position of scan area in mm. Allowed range: 0 ..
57 297.699.
58 -x n X width of scan-area in mm. Allowed range: 0 .. 215.889.
60 -y n Y height of scan-area in mm. Allowed range: 0 .. 297.699.
62 By default, the maximum size will be scanned.
64 --mode mode
66 Select color mode. mode must be one of: “Color”, “Color (48
67 bits)”, “Gray”, “Lineart”.
68 · “Color” - Scanning is done with 3 * 8 bit RGB color values per
70 pixel.
71 · “Color (48 bits)” - Scanning is done with 3 * 16 bit RGB color
73 values per pixel.
74 · “Gray” - Scanning is done with 1 * 8 bit gray value per pixel.
76 · “Lineart” - Scanning is done with 1 bit black and white value
78 per pixel.
79 --source source
81 Select the source for scanning. source must be one of:
82 “Flatbed”, “ADF”, “ADF Duplex”, “TMA Slides”, “TMA Negatives”.
83 · “Flatbed” - Scan document on the flat document glass.
85 · “ADF” - Scan frontsides of documents with automatic document
87 feeder.
88 · “ADF Duplex” - Scan front- and backsides of documents with au‐
90 tomatic document feeder. Note, the backside images must be
91 rotated in a separate post process step.
92 · “TMA Slides” - Slide scanning with transparent media adapter.
94 (Not fully supported by hp5590 backend).
95 · “TMA Negatives” - Negative film scanning with transparent me‐
97 dia adapter. (Not fully supported by hp5590 backend).
98 --resolution res
100 Set the resolution of the scanned image in dpi. res must be one
101 of: 100, 200, 300, 600, 1200, 2400.
102 Default settings: Lineart, Flatbed, 100dpi.
104 --extend-lamp-timeout[=yes|no]
106 Extend lamp timeout period. no = 15 minutes, yes = 1 hour.
107 (Default: no)
108 --wait-for-button[=yes|no]
110 Wait for button press before scanning starts. (Default: no)
111 --preview[=yes|no]
113 Request a preview-quality scan. (Default: no)
114 --hide-eop-pixel[=yes|no]
116 Hide end-of-page indicator pixels and overwrite with color of
117 next neighbor pixels. (Default: yes)
118 The scanner uses the last pixel in every scan line for storing the end-
119 of-page status. This is needed to detect the end of the document sheet
120 when the automatic document feeder (ADF) is used. Unfortunately the
121 end-of-page pixels are also generated in flatbed scans. It is recom‐
122 mended to hide these pixels.
123 --trailing-lines-mode mode
125 Filling mode of trailing lines after end of page when automatic
126 document feeder (ADF) is used. mode must be one of: “last”,
127 “raw”, “raster”, “white”, “black”, “color”. (Default: “last”)
128 · “last” = repeat the last scan line (recommended),
130 · “raw” = read raw scan data (not recommended),
132 · “raster” = generate black and white pixel pattern,
134 · “white” = white pixels,
136 · “black” = black pixels,
138 · “color” = RGB or gray colored pixels (see next option).
140 --trailing-lines-color n
142 Set color value for filling trailing scan lines in trailing
143 lines mode “color” (see previous option). (Default color: vio‐
144 let)
145 The RGB color value must be specified and calculated as 65536 * r + 256
146 * g + b, with r, g, b being values in the range of 0 .. 255.
147
149 The following options allow reading out the button state, counter val‐
150 ue, color setting, and the state of document in ADF. This can be used
151 to programmatically control corresponding scanner options like switch‐
152 ing between flatbed and ADF mode, or triggering prost processing tasks
153 after scanning.
154 --button-pressed
156 Get the id of the last button pressed. Id is one of “none”,
157 “power”, “scan”, “collect”, “file”, “email”, “copy”, “up”,
158 “down”, “mode”, “cancel”.
159 The scanner stores the id of the last button pressed until it is read.
160 After read out, the state is reset and subsequent readings will return
161 “none”.
162 --color-led
164 Get the state of the color LED indicators. The state is either
165 “color” or “black_white”.
166 --counter-value
168 Get the counter value as shown on LCD. The value is in the
169 range of 1 .. 99.
170 --doc-in-adf
172 Get the state of the document-available indicator of the auto‐
173 matic document feeder (ADF). The state is either “yes” or “no”.
174
176 Scanbd is a scanner button daemon, which can read scanner buttons and
177 trigger scan actions.
178 Do not use the old scanbuttond interface with hp5590. It is outdated
180 and shall not be used any more. Scanbd’s regular interface is fully
181 supported by the current version of the hp5590 backend.
182 This example shows a minimum configuration file and the corresponding
184 script file for scanbd to be included in scanbd.conf.
185 · hp5590.conf
187 device hp5590 {
189 # Device matching
190 filter = "^hp5590.*"
191 desc = "HP5590 Scanner Family"
192 # Read out counter value and store in environment variable.
194 function function_lcd_counter {
195 filter = "^counter-value.*"
196 desc = "hp5590: LCD counter"
197 env = "SCANBD_FUNCTION_LCD_COUNTER"
198 }
199 # Run scan script when button is pressed.
201 action do-scan {
202 filter = "^button-pressed.*"
203 desc = "hp5590: Scan button pressed"
204 script = "scan_action.script"
205 string-trigger {
206 from-value = "none"
207 to-value = "scan"
208 }
209 }
210 }
211 · scan_action.script
213 #!/bin/bash
215 echo device = $SCANBD_DEVICE
216 echo action = $SCANBD_ACTION
217 echo counter = $SCANBD_FUNCTION_LCD_COUNTER
218 scanfile="$HOME/tmp/scans/scan-$(date +%s).pnm"
219 case $SCANBD_ACTION in
220 do-scan)
221 scanimage -d "$SCANBD_DEVICE" > "$scanfile"
222 ;;
223 *)
224 echo Warning: Unknown scanbd action: "$SCANBD_ACTION"
225 ;;
226 esac
227
229 @LIBDIR@/libsane-hp5590.a
230 The static library implementing this backend.
231 @LIBDIR@/libsane-hp5590.so
233 The shared library implementing this backend (present on systems
234 that support dynamic loading).
235
237 If the library was compiled with debug support enabled, this environ‐
238 ment variable controls the debug level for this backend.
239 SANE_DEBUG_HP5590
241 Higher debug levels increase the verbosity of the output:
243 10 - generic processing
245 20 - verbose backend messages
246 40 - HP5590 high-level commands
247 50 - HP5590 low-level (USB-in-USB) commands
248 Example:
250 export SANE_DEBUG_HP5590=50
251
253 sane(7), sane-usb(5)
254
256 Ilia Sotnikov <hostcc@gmail.com>.
257 13 Jul 2008 sane-hp5590(5)