| 1 |
.TH sane\-plustek 5 "03 Nov 2017" "" "SANE Scanner Access Now Easy" |
| 2 |
.IX sane\-plustek |
| 3 |
.SH NAME |
| 4 |
sane\-plustek \- SANE backend for LM983[1/2/3] based |
| 5 |
USB flatbed scanners |
| 6 |
.SH DESCRIPTION |
| 7 |
The |
| 8 |
.B sane\-plustek |
| 9 |
library implements a SANE (Scanner Access Now Easy) backend that |
| 10 |
provides access to USB flatbed scanners based on National Semiconductor |
| 11 |
Merlin chipsets (LM9831, 9832 and 9833). |
| 12 |
If you're looking for parallel-port support for Plustek scanner |
| 13 |
please refer to the |
| 14 |
.BR sane\-plustek_pp (5) |
| 15 |
backend. |
| 16 |
|
| 17 |
.SH "SUPPORTED DEVICES" |
| 18 |
The Backend is able to support USB scanner based on the National |
| 19 |
Semiconductor chipsets LM9831, LM9832 and LM9833. The following tables |
| 20 |
show various devices which are currently reported to work. If your |
| 21 |
Plustek scanner has another Product ID, then the device is |
| 22 |
.B NOT |
| 23 |
supported by this backend. |
| 24 |
.br |
| 25 |
|
| 26 |
Vendor Plustek \- ID: 0x07B3 |
| 27 |
.br |
| 28 |
.ft CR |
| 29 |
.nf |
| 30 |
---------------------------------------------------------- |
| 31 |
USB Model: ASIC: Properties: Prod-ID |
| 32 |
---------------------------------------------------------- |
| 33 |
OpticPro U12 LM9831 600x1200dpi 42bit 512Kb 0x0010 |
| 34 |
OpticPro UT12 LM9831 600x1200dpi 42bit 512Kb 0x0013 |
| 35 |
OpticPro UT12 LM9832 600x1200dpi 42bit 512Kb 0x0017 |
| 36 |
OpticPro UT16 LM9832 600x1200dpi 42bit 512Kb 0x0017 |
| 37 |
OpticPro U24 LM9831 1200x2400dpi 42bit 2Mb 0x0011 |
| 38 |
OpticPro U24 LM9832 1200x2400dpi 42bit 2Mb 0x0015 |
| 39 |
OpticPro UT24 LM9832 1200x2400dpi 42bit 2Mb 0x0017 |
| 40 |
.fi |
| 41 |
.ft R |
| 42 |
.PP |
| 43 |
|
| 44 |
Vendor KYE/Genius \- ID: 0x0458 |
| 45 |
.br |
| 46 |
.ft CR |
| 47 |
.nf |
| 48 |
---------------------------------------------------------- |
| 49 |
USB Model: ASIC: Properties: Prod-ID |
| 50 |
---------------------------------------------------------- |
| 51 |
Colorpage HR6 V2 LM9832 600x1200dpi 42bit 512Kb 0x2007 |
| 52 |
Colorpage HR6 V2 LM9832 600x1200dpi 42bit 512Kb 0x2008 |
| 53 |
Colorpage HR6A LM9832 600x1200dpi 42bit 512Kb 0x2009 |
| 54 |
Colorpage HR7 LM9832 600x1200dpi 42bit 512Kb 0x2013 |
| 55 |
Colorpage HR7LE LM9832 600x1200dpi 42bit 512Kb 0x2015 |
| 56 |
Colorpage HR6X LM9832 600x1200dpi 42bit 512Kb 0x2016 |
| 57 |
.fi |
| 58 |
.ft R |
| 59 |
.PP |
| 60 |
|
| 61 |
Vendor Hewlett-Packard \- ID: 0x03F0 |
| 62 |
.br |
| 63 |
.ft CR |
| 64 |
.nf |
| 65 |
---------------------------------------------------------- |
| 66 |
USB Model: ASIC: Properties: Prod-ID |
| 67 |
---------------------------------------------------------- |
| 68 |
ScanJet 2100C LM9831 600x1200dpi 42bit 512Kb 0x0505 |
| 69 |
ScanJet 2200C LM9832 600x1200dpi 42bit 512Kb 0x0605 |
| 70 |
.fi |
| 71 |
.ft R |
| 72 |
.PP |
| 73 |
|
| 74 |
Vendor Mustek \- ID: 0x0400 |
| 75 |
.br |
| 76 |
.ft CR |
| 77 |
.nf |
| 78 |
---------------------------------------------------------- |
| 79 |
USB Model: ASIC: Properties: Prod-ID |
| 80 |
---------------------------------------------------------- |
| 81 |
BearPaw 1200 LM9831 600x1200dpi 42bit 512Kb 0x1000 |
| 82 |
BearPaw 1200 LM9832 600x1200dpi 42bit 512Kb 0x1001* |
| 83 |
BearPaw 2400 LM9832 1200x2400dpi 42bit 2Mb 0x1001 |
| 84 |
.fi |
| 85 |
.ft R |
| 86 |
* see also description for model override switch below! |
| 87 |
.PP |
| 88 |
|
| 89 |
Vendor UMAX \- ID: 0x1606 |
| 90 |
.br |
| 91 |
.ft CR |
| 92 |
.nf |
| 93 |
---------------------------------------------------------- |
| 94 |
USB Model: ASIC: Properties: Prod-ID |
| 95 |
---------------------------------------------------------- |
| 96 |
UMAX 3400 LM9832 600x1200dpi 42bit 512Kb 0x0050 |
| 97 |
UMAX 3400/3450 LM9832 600x1200dpi 42bit 512Kb 0x0060 |
| 98 |
UMAX 5400 LM9832 1200x2400dpi 42bit 512Kb 0x0160 |
| 99 |
.fi |
| 100 |
.ft R |
| 101 |
.PP |
| 102 |
|
| 103 |
Vendor COMPAQ \- ID: 0x049F |
| 104 |
.br |
| 105 |
.ft CR |
| 106 |
.nf |
| 107 |
---------------------------------------------------------- |
| 108 |
USB Model: ASIC: Properties: Prod-ID |
| 109 |
---------------------------------------------------------- |
| 110 |
S4-100 LM9832 600x1200dpi 42bit 512Kb 0x001A |
| 111 |
.fi |
| 112 |
.ft R |
| 113 |
.PP |
| 114 |
|
| 115 |
Vendor Epson \- ID: 0x04B8 |
| 116 |
.br |
| 117 |
.ft CR |
| 118 |
.nf |
| 119 |
---------------------------------------------------------- |
| 120 |
USB Model: ASIC: Properties: Prod-ID |
| 121 |
---------------------------------------------------------- |
| 122 |
Perfection 1250 LM9832 1200x2400dpi 42bit 512Kb 0x010F |
| 123 |
Perfection 1260 LM9832 1200x2400dpi 42bit 512Kb 0x011D |
| 124 |
.fi |
| 125 |
.ft R |
| 126 |
.PP |
| 127 |
|
| 128 |
Vendor CANON \- ID: 0x04A9 |
| 129 |
.br |
| 130 |
.ft CR |
| 131 |
.nf |
| 132 |
---------------------------------------------------------- |
| 133 |
USB Model: ASIC: Properties: Prod-ID |
| 134 |
---------------------------------------------------------- |
| 135 |
CanoScan N650/656U LM9832 600x1200dpi 42bit 512Kb 0x2206 |
| 136 |
CanoScan N1220U LM9832 1200x2400dpi 42bit 512Kb 0x2207 |
| 137 |
CanoScan D660U LM9832 600x1200dpi 42bit 512Kb 0x2208 |
| 138 |
CanoScan N670/676U LM9833 600x1200dpi 48bit 512Kb 0x220D |
| 139 |
CanoScan N1240U LM9833 1200x2400dpi 48bit 512Kb 0x220E |
| 140 |
CanoScan LIDE20 LM9833 600x1200dpi 48bit 512Kb 0x220D |
| 141 |
CanoScan LIDE25 LM9833 1200x2400dpi 48bit 512Kb 0x2220 |
| 142 |
CanoScan LIDE30 LM9833 1200x2400dpi 48bit 512Kb 0x220E |
| 143 |
.fi |
| 144 |
.ft R |
| 145 |
.PP |
| 146 |
|
| 147 |
Vendor Syscan \- ID: 0x0A82 |
| 148 |
.br |
| 149 |
.ft CR |
| 150 |
.nf |
| 151 |
---------------------------------------------------------- |
| 152 |
USB Model: ASIC: Properties: Prod-ID |
| 153 |
---------------------------------------------------------- |
| 154 |
Travelscan 662 LM9833 600x1200dpi 48bit 512Kb 0x6620 |
| 155 |
Travelscan 464 LM9833 600x1200dpi 48bit 512Kb 0x4600 |
| 156 |
.fi |
| 157 |
.ft R |
| 158 |
.PP |
| 159 |
|
| 160 |
Vendor Portable Peripheral Co., Ltd. \- ID: 0x0A53 |
| 161 |
.br |
| 162 |
.ft CR |
| 163 |
.nf |
| 164 |
---------------------------------------------------------- |
| 165 |
USB Model: ASIC: Properties: Prod-ID |
| 166 |
---------------------------------------------------------- |
| 167 |
Q-Scan USB001 LM9832 300x600dpi 42bit 512Kb 0x1000 |
| 168 |
Q-Scan USB201 LM9832 300x600dpi 42bit 512Kb 0x2000 |
| 169 |
.fi |
| 170 |
.ft R |
| 171 |
.PP |
| 172 |
|
| 173 |
Vendor Visioneer \- ID: 0x04A7 |
| 174 |
.br |
| 175 |
.ft CR |
| 176 |
.nf |
| 177 |
---------------------------------------------------------- |
| 178 |
USB Model: ASIC: Properties: Prod-ID |
| 179 |
---------------------------------------------------------- |
| 180 |
Strobe XP100 LM9833 600x1200dpi 48bit 512Kb 0x0427 |
| 181 |
.fi |
| 182 |
.ft R |
| 183 |
.PP |
| 184 |
|
| 185 |
.SH "OTHER PLUSTEK SCANNERS" |
| 186 |
For parallelport device support see the |
| 187 |
.BR sane\-plustek_pp (5) |
| 188 |
backend. |
| 189 |
.br |
| 190 |
The SCSI scanner OpticPro 19200S is a rebadged Artec AM12S scanner |
| 191 |
and is supported by the |
| 192 |
.BR sane\-artec (5) |
| 193 |
backend. |
| 194 |
.br |
| 195 |
Only the National Semiconductor LM983[1/2/] based devices of Plustek |
| 196 |
are supported by this backend. Older versions of the U12, the UT12, |
| 197 |
the U1212 and U1248 (GrandTech chipset) are not supported. |
| 198 |
.PP |
| 199 |
.ft CR |
| 200 |
.nf |
| 201 |
Model Chipset backend |
| 202 |
------------------------------------ |
| 203 |
U1248 GrandTech gt68xx |
| 204 |
UT16B GrandTech gt68xx |
| 205 |
OpticSlim 1200 GrandTech gt68xx |
| 206 |
OpticSlim 2400 GrandTech gt68xx |
| 207 |
U12 P98003 u12 |
| 208 |
UT12 P98003 u12 |
| 209 |
1212U P98003 u12 |
| 210 |
.fi |
| 211 |
.ft R |
| 212 |
For a more complete and up to date list see: |
| 213 |
.IR http://www.sane\-project.org/sane\-supported\-devices.html . |
| 214 |
|
| 215 |
.SH "CONFIGURATION" |
| 216 |
To use your scanner with this backend, you need at least two |
| 217 |
entries in the configuration file |
| 218 |
.I /etc/sane.d/plustek.conf |
| 219 |
.RS |
| 220 |
.PP |
| 221 |
.I [usb] vendor-id product-id |
| 222 |
.br |
| 223 |
.I device /dev/usbscanner |
| 224 |
.RE |
| 225 |
.PP |
| 226 |
.I [usb] |
| 227 |
tells the backend, that the following devicename (here |
| 228 |
.IR /dev/usbscanner ) |
| 229 |
has to be interpreted as USB scanner device. If vendor- and |
| 230 |
product-id has not been specified, the backend tries to |
| 231 |
detect this by its own. If device is set to |
| 232 |
.I auto |
| 233 |
then the next matching device is used. |
| 234 |
.br |
| 235 |
The following options can be used for a default setup of |
| 236 |
your device. Most of them are also available through |
| 237 |
the frontend. |
| 238 |
.PP |
| 239 |
.B |
| 240 |
The Options: |
| 241 |
.PP |
| 242 |
option warmup t |
| 243 |
.RS |
| 244 |
.I t |
| 245 |
specifies the warmup period in seconds, if set to \-1, the |
| 246 |
automatic warmup function will be used |
| 247 |
.RE |
| 248 |
.PP |
| 249 |
option lampOff t |
| 250 |
.RS |
| 251 |
.I t |
| 252 |
is the time in seconds for switching off the lamps in |
| 253 |
standby mode |
| 254 |
.RE |
| 255 |
.PP |
| 256 |
option lOffonEnd b |
| 257 |
.RS |
| 258 |
.I b |
| 259 |
specifies the behaviour when closing the backend, 1 --> switch |
| 260 |
lamps off, 0 --> do not change lamp status |
| 261 |
.RE |
| 262 |
.PP |
| 263 |
option mov m |
| 264 |
.RS |
| 265 |
.I m |
| 266 |
is the model override switch. It works only with Mustek |
| 267 |
BearPaw devices. |
| 268 |
.br |
| 269 |
.br |
| 270 |
.ft CR |
| 271 |
.nf |
| 272 |
m/PID | 0x1000 | 0x1001 |
| 273 |
------+--------------+-------------- |
| 274 |
0 | BearPaw 1200 | BearPaw 2400 |
| 275 |
1 | no function | BearPaw 1200 |
| 276 |
.fi |
| 277 |
.ft R |
| 278 |
.RE |
| 279 |
.PP |
| 280 |
option invertNegatives b |
| 281 |
.RS |
| 282 |
.I b |
| 283 |
0 --> do not invert the picture during negative scans, |
| 284 |
.br |
| 285 |
1 --> invert picture |
| 286 |
.RE |
| 287 |
.PP |
| 288 |
option cacheCalData b |
| 289 |
.RS |
| 290 |
.I b |
| 291 |
0 --> do not save calibration results, |
| 292 |
.br |
| 293 |
1 --> save results of calibration in |
| 294 |
.I ~/.sane/ |
| 295 |
directory |
| 296 |
.RE |
| 297 |
.PP |
| 298 |
option altCalibration b |
| 299 |
.RS |
| 300 |
.I b |
| 301 |
0 --> use standard calibration routines, |
| 302 |
.br |
| 303 |
1 --> use alternate calibration (only non Plustek devices, standard for CIS devices) |
| 304 |
.RE |
| 305 |
.PP |
| 306 |
option skipFine b |
| 307 |
.RS |
| 308 |
.I b |
| 309 |
0 --> perform fine calibration, |
| 310 |
.br |
| 311 |
1 --> skip fine calibration (only non Plustek devices) |
| 312 |
.RE |
| 313 |
.PP |
| 314 |
option skipFineWhite b |
| 315 |
.RS |
| 316 |
.I b |
| 317 |
0 --> perform white fine calibration, |
| 318 |
.br |
| 319 |
1 --> skip white fine calibration (only non Plustek devices) |
| 320 |
.RE |
| 321 |
.PP |
| 322 |
option skipDarkStrip b |
| 323 |
.RS |
| 324 |
.I b |
| 325 |
0 --> perform dark calibration, with enabled lamp using the |
| 326 |
dark calibration strip of the scanner. If the scanner does |
| 327 |
not have such a strip, the alternative way is to switch off |
| 328 |
the lamp during this step. |
| 329 |
.br |
| 330 |
1 --> always switch off the lamp for dark calibration, even |
| 331 |
a black strip is available |
| 332 |
.RE |
| 333 |
.PP |
| 334 |
option skipCalibration b |
| 335 |
.RS |
| 336 |
.I b |
| 337 |
0 --> perform calibration, |
| 338 |
.br |
| 339 |
1 --> skip calibration (only non Plustek devices) |
| 340 |
.RE |
| 341 |
.PP |
| 342 |
option enableTPA b |
| 343 |
.RS |
| 344 |
.I b |
| 345 |
0 --> default behaviour, specified by the internal tables, |
| 346 |
.br |
| 347 |
1 --> override internal tables and allow TPA mode (EPSON/UMAX only) |
| 348 |
.RE |
| 349 |
|
| 350 |
.PP |
| 351 |
option posOffX x |
| 352 |
.br |
| 353 |
option posOffY y |
| 354 |
.br |
| 355 |
option tpaOffX x |
| 356 |
.br |
| 357 |
option tpaOffY y |
| 358 |
.br |
| 359 |
option negOffX x |
| 360 |
.br |
| 361 |
option negOffY y |
| 362 |
.RS |
| 363 |
.I x y |
| 364 |
By using this settings, the user can adjust the given image |
| 365 |
positions. |
| 366 |
.B Please note, that there's no internal range checking for |
| 367 |
.B this feature. |
| 368 |
.RE |
| 369 |
.PP |
| 370 |
option posShadingY p |
| 371 |
.br |
| 372 |
option tpaShadingY p |
| 373 |
.br |
| 374 |
option negShadingY p |
| 375 |
.RS |
| 376 |
.I p |
| 377 |
overrides the internal shading position. The values are in steps. |
| 378 |
.B Please note, that there's no internal range checking for |
| 379 |
.B this feature. |
| 380 |
.RE |
| 381 |
.PP |
| 382 |
option redGamma r |
| 383 |
.br |
| 384 |
option greenGamma g |
| 385 |
.br |
| 386 |
option blueGamma b |
| 387 |
.br |
| 388 |
option grayGamma gr |
| 389 |
.RS |
| 390 |
.I r g b gr |
| 391 |
.RE |
| 392 |
By using these values, the internal linear gamma table (r,g,b,gr = 1.0) |
| 393 |
can be adjusted. |
| 394 |
.PP |
| 395 |
option red_gain r |
| 396 |
.br |
| 397 |
option red_offset ro |
| 398 |
.br |
| 399 |
option green_gain g |
| 400 |
.br |
| 401 |
option green_offset go |
| 402 |
.br |
| 403 |
option blue_gain b |
| 404 |
.br |
| 405 |
option blue_offset bo |
| 406 |
.RS |
| 407 |
.I r g b ro go bo |
| 408 |
These values can be used to set the gain and offset values of |
| 409 |
the AFE for each channel. The range is between 0 and 63. \-1 |
| 410 |
means autocalibration. |
| 411 |
.RE |
| 412 |
|
| 413 |
.PP |
| 414 |
See the |
| 415 |
.I plustek.conf |
| 416 |
file for examples. |
| 417 |
.PP |
| 418 |
.B Note: |
| 419 |
.br |
| 420 |
You have to make sure, that the USB subsystem is loaded |
| 421 |
correctly and you have access to the device-node. For |
| 422 |
more details see |
| 423 |
.BR sane\-usb (5) |
| 424 |
manpage. You might use |
| 425 |
.BR sane\-find\-scanner (1) |
| 426 |
to check that you have access to your device. |
| 427 |
.PP |
| 428 |
.B Note: |
| 429 |
.br |
| 430 |
If there's no configuration file, the backend defaults to |
| 431 |
.B device auto |
| 432 |
|
| 433 |
.SH FILES |
| 434 |
.TP |
| 435 |
.I /etc/sane.d/plustek.conf |
| 436 |
The backend configuration file |
| 437 |
.TP |
| 438 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-plustek.a |
| 439 |
The static library implementing this backend. |
| 440 |
.TP |
| 441 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-plustek.so |
| 442 |
The shared library implementing this backend (present on systems that |
| 443 |
support dynamic loading). |
| 444 |
|
| 445 |
.SH ENVIRONMENT |
| 446 |
.TP |
| 447 |
.B SANE_CONFIG_DIR |
| 448 |
This environment variable specifies the list of directories that may |
| 449 |
contain the configuration file. On *NIX systems, the directories are |
| 450 |
separated by a colon (`:'), under OS/2, they are separated by a |
| 451 |
semi-colon (`;'). If this variable is not set, the configuration file |
| 452 |
is searched in two default directories: first, the current working |
| 453 |
directory (".") and then in |
| 454 |
.IR /etc/sane.d . |
| 455 |
If the value of the |
| 456 |
environment variable ends with the directory separator character, then |
| 457 |
the default directories are searched after the explicitly specified |
| 458 |
directories. For example, setting |
| 459 |
.B SANE_CONFIG_DIR |
| 460 |
to "/tmp/config:" would result in directories |
| 461 |
.IR "tmp/config" , |
| 462 |
.IR "." , |
| 463 |
and |
| 464 |
.I "/etc/sane.d" |
| 465 |
being searched (in this order). |
| 466 |
.TP |
| 467 |
.B SANE_DEBUG_PLUSTEK |
| 468 |
If the library was compiled with debug support enabled, this |
| 469 |
environment variable controls the debug level for this backend. Higher |
| 470 |
debug levels increase the verbosity of the output. |
| 471 |
|
| 472 |
Example: |
| 473 |
export SANE_DEBUG_PLUSTEK=10 |
| 474 |
|
| 475 |
.SH "SEE ALSO" |
| 476 |
.BR sane (7), |
| 477 |
.BR sane\-usb (5), |
| 478 |
.BR sane\-u12 (5), |
| 479 |
.BR sane\-gt68xx (5), |
| 480 |
.BR sane\-mustek_pp (5), |
| 481 |
.BR sane\-find\-scanner (1), |
| 482 |
.BR scanimage (1) |
| 483 |
.br |
| 484 |
.I /usr/share/doc/libsane/plustek/Plustek-USB.changes |
| 485 |
|
| 486 |
.SH "CONTACT AND BUG-REPORTS" |
| 487 |
Please send any information and bug-reports to: |
| 488 |
.br |
| 489 |
.B SANE Mailing List |
| 490 |
.PP |
| 491 |
Additional info and hints can be obtained from our mailing-List archive at: |
| 492 |
.IR http://www.sane\-project.org/mailing\-lists.html . |
| 493 |
.PP |
| 494 |
To obtain debug messages from the backend, please set the |
| 495 |
environment-variable |
| 496 |
.B SANE_DEBUG_PLUSTEK |
| 497 |
before calling your favorite SANE frontend (e.g. |
| 498 |
.BR scanimage (1)): |
| 499 |
.PP |
| 500 |
.I export SANE_DEBUG_PLUSTEK=20 ; scanimage |
| 501 |
.PP |
| 502 |
The value controls the verbosity of the output. Please note that |
| 503 |
values greater than 24 force the backend to output raw data files |
| 504 |
which could be rather large. The suffix of these files is ".raw". |
| 505 |
For problem reports it should be enough the set the verbosity to |
| 506 |
13. |
| 507 |
|
| 508 |
.SH "KNOWN BUGS & RESTRICTIONS" |
| 509 |
|
| 510 |
.PP |
| 511 |
* The driver does not support these manic scalings up |
| 512 |
to 16 times the physical resolution. The only scaling |
| 513 |
is done on resolutions between the physical resolution |
| 514 |
of the CCD-/CIS-sensor and the stepper motor i.e. you |
| 515 |
have a 600x1200 dpi scanner and you are scanning using |
| 516 |
800dpi, so scaling is necessary, because the sensor only |
| 517 |
delivers 600dpi but the motor is capable to perform |
| 518 |
1200dpi steps. |
| 519 |
.PP |
| 520 |
* Plusteks' model policy is somewhat inconsistent. They |
| 521 |
sell technically different devices under the |
| 522 |
same product name. Therefore it is possible that some |
| 523 |
devices like the UT12 or U12 won't work \- please check |
| 524 |
the model list above and compare the product-id to |
| 525 |
the one your device has. |
| 526 |
.PP |
| 527 |
* Negative/Slide scanning quality is poor. |