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

NAME

6       sane-plustek_pp  - SANE backend for Plustek parallel port flatbed scan‐
7       ners
8

DESCRIPTION

10       The sane-plustek_pp library implements a SANE (Scanner Access Now Easy)
11       backend  that  provides access to Plustek ASIC 9600[1/3] and P9800[1/3]
12       based parallel port flatbed scanners.  The access  of  the  scanner  is
13       either done directly by the backend or via kernel module, called pt_drv
14       which can be created out of the sane-plustek_pp backend code - see also
15       section BUILDING THE KERNEL MODULE for further information.
16
17

SUPPORTED DEVICES

19       At present, the following scanners should work with this backend and/or
20       the kernel module:
21
22       PLUSTEK SCANNERS
23
24       Parallelport Model:    ASIC: Properties:
25       ---------------------- ----- ------------------------
26       OpticPro PT12          98003 600x1200 dpi 36bit 512Kb
27       OpticPro P12           98003 600x1200 dpi 36bit 512Kb
28       OpticPro 9636T/12000T  98001 600x1200 dpi 36bit 512Kb
29       OpticPro 12000P Turbo  98001 600x1200 dpi 36bit 512Kb
30       OpticPro 9636P+/Turbo  98001 600x1200 dpi 36bit 512Kb
31       OpticPro 9636P         96003 600x1200 dpi 36bit 128Kb
32       OpticPro 12000P/96000P 96003 600x1200 dpi 36bit 128Kb
33       OpticPro 1236P         96003 600x1200 dpi 30bit 128Kb
34       OpticPro 9600P         96003 600x1200 dpi 30bit 128Kb
35       OpticPro 9630P/FBIV    96003 600x1200 dpi 30bit 128Kb
36       OpticPro 9630PL (14")  96003 600x1200 dpi 30bit 128Kb
37       OpticPro A3I           96003  400x800 dpi 36bit 128Kb
38       OpticPro 600P/6000P    96003  300x600 dpi 30bit  32Kb
39       OpticPro 4831P         96003  300x600 dpi 30bit  32Kb
40       OpticPro 4830P/FBIII   96003  300x600 dpi 30bit  32Kb
41       OpticPro 4800P/FBII    96001  300x600 dpi 24bit  32Kb
42
43       PRIMAX SCANNERS
44
45       There are some scanners sold by Primax, but they are  in  fact  Plustek
46       devices.  These  scanners are also supported.  The following table will
47       show the relationship:
48
49       Model:                      Plustek Model:  Remarks:
50       --------------------------- --------------  ------------
51       Colorado 4800               OpticPro 4800   not tested
52       Compact 4800 Direct         OpticPro 600    mov=2
53       Compact 4800 Direct 30bit   OpticPro 4830   mov=7
54       Compact 9600 Direct 30bit   OpticPro 9630   works
55
56       GENIUS SCANNERS
57
58       The following devices are sold as Genius  Scanners,  but  are  in  fact
59       Plustek devices.  The table will show the relationship:
60
61       Model:                      Remarks:
62       --------------------------- ----------------------------
63       Colorpage Vivid III V2      Like P12 but has two buttons
64                                   and Wolfson DAC
65
66       ARIES SCANNERS
67
68       There's  one  scanner  sold  as Aries Scanner, but is in fact a Plustek
69       device.  The following table will show the relationship:
70
71       Model:                      Plustek Model:  Remarks:
72       --------------------------- --------------  ------------
73       Scan-It 4800                OpticPro 600    mov=2
74
75       BrightScan SCANNERS
76
77       There's one scanner sold as BrightScan OpticPro Scanner, this is also a
78       rebadged  Plustek  device.  The following table will show the relation‐
79       ship:
80
81       Model:                      Remarks:
82       --------------------------- ----------------------------
83       BrightScan OpticPro         OpticPro P12
84
85

DEVICE NAMES

87       This backend works in two modes, the so called  "direct-mode"  and  the
88       "kernel-mode".  In direct-mode, the user-space backend is used, in ker‐
89       nel-mode, you should have a kernel-module named  pt_drv  loaded.   This
90       backends default device is:
91
92              0x378
93
94       This  "default  device"  will  be used, if no configuration file can be
95       found. It is rather the base address  of  the  parallel  port  on  i386
96       machines.
97
98       As  the  backend supports up to four devices, it is possible to specify
99       them in the configuration file
100
101              /etc/sane.d/plustek_pp.conf
102
103       See this file for examples.
104

CONFIGURATION

106       This section describes the backend's configuration file  entries.   The
107       file is located at: /etc/sane.d/plustek_pp.conf
108
109       For a proper setup, you will need at least two entries:
110
111              [direct]
112              device 0x378
113
114       or
115              [kernel]
116              device /dev/pt_drv
117
118       direct  tells  the  backend, that the following devicename (here 0x378)
119       has to be interpreted as parallel port scanner device. In  fact  it  is
120       the  address  to  use,  alternatively  you can use /dev/parport0 if the
121       backend has been compiled with libieee1284 support.  kernel should only
122       be  used,  when  a  kernel-module  has  been  built  out of the backend
123       sources. See below for more instructions about this.
124
125       Further options:
126
127       option warmup t
128              t specifies the warmup period in seconds
129
130       option lampOff t
131              t is the time in seconds for switching off the lamps in  standby
132              mode
133
134       option lOffonEnd b
135              b specifies the behaviour when closing the backend, 1 --> switch
136              lamps off, 0 --> do not change lamp status
137
138       option mov m
139              m is the model override switch, which only works in direct mode.
140
141              m = 0  default: no override
142
143              m = 1  OpticPro  9630PL  override  (works  if  OP9630  has  been
144                     detected) forces legal size (14")
145
146              m = 2  Primax  4800Direct  override  (works  if  OP600  has been
147                     detected) swaps red/green color
148
149              m = 3  OpticPro  9636  override  (works  if  OP9636   has   been
150                     detected)  disables  backends transparency/negative capa‐
151                     bilities
152
153              m = 4  OpticPro  9636P  override  (works  if  OP9636  has   been
154                     detected)  disables  backends transparency/negative capa‐
155                     bilities
156
157              m = 5  OpticPro  A3I  override  (works  if  OP12000   has   been
158                     detected) enables A3 scanning
159
160              m = 6  OpticPro   4800P   override  (works  if  OP600  has  been
161                     detected) swaps red/green color
162
163              m = 7  Primax 4800Direct 30bit override  (works  if  OP4830  has
164                     been detected)
165
166       See the plustek_pp.conf file for examples.
167

BUILDING THE KERNEL MODULE

169       As  mentioned before, the sane-plustek_pp backend code can also be com‐
170       piled and installed as linux kernel module. To do so, you will need the
171       source-files  of  this sane-backend installation.  Unpack this tar-ball
172       and go to the directory: sane-backends/doc/plustek.  Within this direc‐
173       tory,  you  should  find  a  script called: MakeModule.sh.  Now if your
174       Linux kernelsources are installed correctly, it should be  possible  to
175       build,  install and load the module pt_drv.  Please note, that the ker‐
176       nelsources need to be configured correctly.  Refer  to  your  distribu‐
177       tions manual on how this is done. As root user, try
178
179       ./MakeModule.sh
180
181       the  script  will try and get all necessary information about your run‐
182       ning kernel and will lead you through the whole installation process.
183       Note: Installing and loading the can only be done as superuser.
184

KERNEL MODULE SETUP

186       The configuration of the kernel module is done  by  providing  some  or
187       more options found below to the kernel module at load time. This can be
188       done by invoking insmod(8) with the appropriate parameters or appending
189       the options to the file /etc/modules.conf (kernel < 2.6.x) or /etc/mod‐
190       probe.conf (kernel >= 2.6.x)
191
192       The Options:
193       lampoff=lll
194              The value lll tells  the  driver,  after  how  many  seconds  to
195              switch-off  the  lamp(s). The default value is 180.  0 will dis‐
196              able this feature.
197              HINT: Do not use a  value  that  is  too  small,  because  often
198              switching on/off the lamps will reduce their lifetime.
199
200       port=ppp
201              ppp  specifies  the port base address, where the scanner is con‐
202              nected to. The default value is 0x378, which is normally a stan‐
203              dard.
204
205       warmup=www
206              www specifies the time in seconds, how long a lamp has to be on,
207              until the driver will start to scan. The default value is 30.
208
209       lOffonEnd=e
210              e specifies the behaviour  when  unloading  the  driver,  1  -->
211              switch lamps off, 0 --> do not change lamp status
212
213       slowIO=s
214              s specifies which I/O functions the driver should use, 1 --> use
215              delayed functions, 0 --> use the non-delayed ones
216
217       forceMode=fm
218              fm specifies port mode which should be used,  0  -->  autodetec‐
219              tion, 1 --> use SPP mode and 2 --> use EPP mode
220
221       mov=m
222
223              m = 0  default: no override
224
225              m = 1  OpticPro  9630PL  override  (works  if  OP9630  has  been
226                     detected) forces legal size (14")
227
228              m = 2  Primax 4800Direct  override  (works  if  OP600  has  been
229                     detected) swaps red/green color
230
231              m = 3  OpticPro   9636   override  (works  if  OP9636  has  been
232                     detected) disables backends  transparency/negative  capa‐
233                     bilities
234
235              m = 4  OpticPro   9636P  override  (works  if  OP9636  has  been
236                     detected) disables backends  transparency/negative  capa‐
237                     bilities
238
239              m = 5  OpticPro   A3I   override  (works  if  OP12000  has  been
240                     detected) enables A3 scanning
241
242              m = 6  OpticPro  4800P  override  (works  if  OP600   has   been
243                     detected) swaps red/green color
244
245              m = 7  Primax  4800Direct  30bit  override  (works if OP4830 has
246                     been detected)
247
248       Sample entry for file /etc/modules.conf:
249
250              alias char-major-40 pt_drv
251              pre-install pt_drv modprobe -k parport
252              options  pt_drv  lampoff=180  warmup=15  port=0x378  lOffonEnd=0
253              mov=0 slowIO=0 forceMode=0
254
255       For  multidevice  support, simply add values separated by commas to the
256       different options
257
258              options pt_drv port=0x378,0x278 mov=0,4 slowIO=0,1 forceMode=0,1
259
260       Remember to call depmod(8) after changing /etc/conf.modules.
261

PARALLEL PORT MODES

263       The current driver works best, when the parallel port has been  set  to
264       EPP-mode.  When detecting any other mode such as ECP or PS/2 the driver
265       tries to set to a faster, supported mode. If this fails,  it  will  use
266       the  SPP mode, as this mode should work with all Linux supported paral‐
267       lel ports. If in doubt, enter your BIOS and set it to any  mode  except
268       ECP.
269
270       Former Plustek scanner models (4830, 9630) supplied a ISA parallel port
271       adapter card. This card is not supported by the driver.
272
273       The ASIC 96001/3 based models have sometimes trouble with high  resolu‐
274       tion  modes.  If  you encounter sporadic corrupted images (parts dupli‐
275       cated or shifted horizontally) kill all other applications before scan‐
276       ning and (if sufficient memory available) disable swapping.
277
278       See the plustek_pp.conf file for examples.
279

FILES

281       /etc/sane.d/plustek_pp.conf
282              The backend configuration file
283
284       /usr/lib64/sane/libsane-plustek_pp.a
285              The static library implementing this backend.
286
287       /usr/lib64/sane/libsane-plustek_pp.so
288              The shared library implementing this backend (present on systems
289              that support dynamic loading).
290
291       /lib/modules/<Kernel-Version>/kernel/drivers/parport/pt_drv.o
292              The Linux kernelmodule for kernels < 2.6.x.
293
294       /lib/modules/<Kernel-Version>/kernel/drivers/parport/pt_drv.ko
295              The Linux kernelmodule for kernels >= 2.6.x.
296

ENVIRONMENT

298       SANE_CONFIG_DIR
299              This environment variable specifies the list of directories that
300              may contain the configuration file.  Under UNIX, the directories
301              are separated by a colon (`:'), under OS/2, they  are  separated
302              by a semi-colon (`;').  If this variable is not set, the config‐
303              uration file is searched in two default directories: first,  the
304              current working directory (".") and then in /etc/sane.d.  If the
305              value of the environment variable ends with the directory  sepa‐
306              rator character, then the default directories are searched after
307              the explicitly  specified  directories.   For  example,  setting
308              SANE_CONFIG_DIR  to  "/tmp/config:"  would result in directories
309              tmp/config, ., and /etc/sane.d being searched (in this order).
310
311       SANE_DEBUG_PLUSTEK_PP
312              If the library was compiled with  debug  support  enabled,  this
313              environment  variable controls the debug level for this backend.
314              Higher debug levels increase the verbosity of the output.
315
316              Example: export SANE_DEBUG_PLUSTEK_PP=10
317
318

SEE ALSO

320       sane(7), xscanimage(1),
321       /usr/share/doc/sane-backends/plustek/Plustek-PARPORT.changes
322
323

CONTACT AND BUG-REPORTS

325       Please send any information and bug-reports to:
326       SANE Mailing List
327
328       Additional info and hints can be obtained from our
329       Mailing-List archive at:
330       http://www.sane-project.org/mailing-lists.html
331
332       To obtain debug messages from the backend, please set the  environment-
333       variable  SANE_DEBUG_PLUSTEK_PP before calling your favorite scan-fron‐
334       tend (i.e.  xscanimage(1)),i.e.:
335       export SANE_DEBUG_PLUSTEK_PP=20 ; xscanimage
336
337       The value controls the verbosity of the backend.
338

KNOWN BUGS & RESTRICTIONS

340       * The Halftoning works, but the quality is poor
341
342       * Printers (especially HP models) will start to print during  scanning.
343       This  in  fact  is a problem to other printers too, using bidirectional
344       protocol (see www.plustek.com (TAIWAN) page for further details)
345
346       * The driver does not support these manic scalings up to 16  times  the
347       physical  resolution.  The  only scaling is done on resolutions between
348       the physical resolution of the CCD-sensor and the  stepper  motor  i.e.
349       you  have  a 600x1200 dpi scanner and you are scanning using 800dpi, so
350       scaling is necessary, because the sensor only delivers 600dpi  but  the
351       motor is capable to perform 800dpi steps.
352
353       * On some devices, the pictures seems bluish
354
355       ASIC 98001 based models:
356
357       * The 300dpi transparency and negative mode does not work correctly.
358
359       *  There  is  currently  no way to distinguish a model with and without
360       transparency unit.
361
362       * The scanned images seem to be too dark (P9636T)
363
364       ASIC 96003/1 based models:
365
366       * 30bit mode is currently not supported.
367
368       * On low end systems under heavy system load the driver may lose  data,
369       which  can  result in picture corruption or cause the sensor to hit the
370       scan bed.
371
372       * The scanning speed on 600x1200 dpi models is slow.
373
374       * The scanning quality of the A3I is poor.
375
376
377
378                                  14 Jul 2008               sane-plustek_pp(5)
Impressum