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

NAME

6       sane-hp5590      -      SANE      backend      for      Hewlett-Packard
7       4500C/4570C/5500C/5550C/5590/7650 Workgroup/Document scanners
8

DESCRIPTION

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
14       · ScanJet 4500C
15
16       · ScanJet 4570C
17
18       · ScanJet 5500C
19
20       · ScanJet 5550C
21
22       · ScanJet 5590
23
24       · ScanJet 7650
25
26       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(1)  or syslog) to us.  Even if
30       the scanner’s name is only slightly different from the models mentioned
31       above, please let us know.
32

OPTIONS

34       The options the backend supports can either be selected through command
35       line options to programs like scanimage(1) or through GUI  elements  in
36       xscanimage(1) or xsane(1).  Valid command line options and their syntax
37       can be listed by using:
38
39              scanimage --help -d hp5590:interface:device
40
41       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
46       Use the command:
47
48              scanimage -L
49
50       to list all devices recognized by your SANE installation.
51

DEVICE SPECIFIC OPTIONS

53       -l n   Top-left  X  position  of  scan area in mm.  Allowed range: 0 ..
54              215.889.
55
56       -t n   Top-left Y position of scan area in mm.   Allowed  range:  0  ..
57              297.699.
58
59       -x n   X width of scan-area in mm.  Allowed range: 0 ..  215.889.
60
61       -y n   Y height of scan-area in mm.  Allowed range: 0 ..  297.699.
62
63       By default, the maximum size will be scanned.
64
65       --mode mode
66              Select  color  mode.   mode  must be one of: “Color”, “Color (48
67              bits)”, “Gray”, “Lineart”.
68
69              · “Color” - Scanning is done with 3 * 8 bit RGB color values per
70                pixel.
71
72              · “Color (48 bits)” - Scanning is done with 3 * 16 bit RGB color
73                values per pixel.
74
75              · “Gray” - Scanning is done with 1 * 8 bit gray value per pixel.
76
77              · “Lineart” - Scanning is done with 1 bit black and white  value
78                per pixel.
79
80       --source source
81              Select  the  source  for  scanning.   source  must  be  one  of:
82              “Flatbed”, “ADF”, “ADF Duplex”, “TMA Slides”, “TMA Negatives”.
83
84              · “Flatbed” - Scan document on the flat document glass.
85
86              · “ADF” - Scan frontsides of documents with  automatic  document
87                feeder.
88
89              · “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
93              · “TMA  Slides” - Slide scanning with transparent media adapter.
94                (Not fully supported by hp5590 backend).
95
96              · “TMA Negatives” - Negative film scanning with transparent  me‐
97                dia adapter.  (Not fully supported by hp5590 backend).
98
99       --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
103       Default settings: Lineart, Flatbed, 100dpi.
104
105       --extend-lamp-timeout[=yes|no]
106              Extend lamp timeout period.  no = 15  minutes,  yes  =  1  hour.
107              (Default: no)
108
109       --wait-for-button[=yes|no]
110              Wait for button press before scanning starts.  (Default: no)
111
112       --preview[=yes|no]
113              Request a preview-quality scan.  (Default: no)
114
115       --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
119              the end-of-page status.  This is needed to detect the end of the
120              document sheet when the automatic document feeder (ADF) is used.
121              Unfortunately  the  end-of-page  pixels  are  also  generated in
122              flatbed scans.  It is recommended to hide these pixels.
123
124       --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
129              · “last” = repeat the last scan line (recommended),
130
131              · “raw” = read raw scan data (not recommended),
132
133              · “raster” = generate black and white pixel pattern,
134
135              · “white” = white pixels,
136
137              · “black” = black pixels,
138
139              · “color” = RGB or gray colored pixels (see next option).
140
141       --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  *
146              r  + 256 * g + b, with r, g, b being values in the range of 0 ..
147              255.
148

READ OUT OPTIONS

150       The following options allow reading out the button state, counter  val‐
151       ue,  color setting, and the state of document in ADF.  This can be used
152       to programmatically control corresponding scanner options like  switch‐
153       ing  between  flatbed and ADF mode, or triggering post processing tasks
154       after scanning.
155
156       --button-pressed
157              Get the id of the last button pressed.  Id  is  one  of  “none”,
158              “power”,  “scan”,  “collect”,  “file”,  “email”,  “copy”,  “up”,
159              “down”, “mode”, “cancel”.
160              The scanner stores the id of the last button pressed until it is
161              read.   After  read out, the state is reset and subsequent read‐
162              ings will return “none”.
163
164
165       --color-led
166              Get the state of the color LED indicators.  The state is  either
167              “color” or “black_white”.
168
169
170       --counter-value
171              Get  the  counter  value  as  shown on LCD.  The value is in the
172              range of 1 ..  99.
173
174
175       --doc-in-adf
176              Get the state of the document-available indicator of  the  auto‐
177              matic document feeder (ADF).  The state is either “yes” or “no”.
178
179

HINTS FOR USERS OF SCANBD

181       scanbd(8)  is  a  scanner button daemon, which can read scanner buttons
182       and trigger scan actions.
183
184       Do not use the old scanbuttond(8) interface with hp5590.  It is outdat‐
185       ed  and shall not be used any more.  The regular interface of scanbd(8)
186       is fully supported by the current version of the hp5590 backend.
187
188       This example shows a minimum configuration file and  the  corresponding
189       script file for scanbd(8) to be included in scanbd.conf.
190
191       · hp5590.conf
192
193         device hp5590 {
194             # Device matching
195             filter = "^hp5590.*"
196             desc = "HP5590 Scanner Family"
197
198             # Read out counter value and store in environment variable.
199             function function_lcd_counter {
200                 filter = "^counter-value.*"
201                 desc   = "hp5590: LCD counter"
202                 env    = "SCANBD_FUNCTION_LCD_COUNTER"
203             }
204
205             # Run scan script when button is pressed.
206             action do-scan {
207                 filter = "^button-pressed.*"
208                 desc   = "hp5590: Scan button pressed"
209                 script = "scan_action.script"
210                 string-trigger {
211                     from-value  = "none"
212                     to-value    = "scan"
213                 }
214             }
215         }
216
217       · scan_action.script
218
219         #!/bin/bash
220         echo device = $SCANBD_DEVICE
221         echo action = $SCANBD_ACTION
222         echo counter = $SCANBD_FUNCTION_LCD_COUNTER
223         scanfile="$HOME/tmp/scans/scan-$(date +%s).pnm"
224         case $SCANBD_ACTION in
225         do-scan)
226             scanimage -d "$SCANBD_DEVICE" > "$scanfile"
227             ;;
228         *)
229             echo Warning: Unknown scanbd action: "$SCANBD_ACTION"
230             ;;
231         esac
232

FILES

234       @LIBDIR@/libsane-hp5590.a
235              The static library implementing this backend.
236
237       @LIBDIR@/libsane-hp5590.so
238              The shared library implementing this backend (present on systems
239              that support dynamic loading).
240

ENVIRONMENT

242       If the library was compiled with debug support enabled,  this  environ‐
243       ment variable controls the debug level for this backend.
244
245       SANE_DEBUG_HP5590
246
247       Higher debug levels increase the verbosity of the output:
248
249              10 - generic processing
250              20 - verbose backend messages
251              40 - HP5590 high-level commands
252              50 - HP5590 low-level (USB-in-USB) commands
253
254       Example:
255              export SANE_DEBUG_HP5590=50
256

SEE ALSO

258       sane(7), sane-usb(5) scanbd(8), scanimage(1), xscanimage(1), xsane(1)
259
260

AUTHORS

262       Ilia Sotnikov <hostcc@gmail.com>.
263
264
265
266                                  13 Jul 2008                   sane-hp5590(5)
Impressum