Standards, Environments, and Macros sane-mustekpp(5)
NAME
sane-mustekpp - SANE backend for Mustek parallel port
flatbed scanners
DESCRIPTION
The sane-mustekpp library implements a SANE (Scanner Access
Now Easy) backend that provides access to Mustek parallel
port flatbed scanners and OEM versions.
There are 2 classes of Mustek parallel port scanners: regu-
lar CD (cold cathode device) scanners and CIS (contact
image sensor) scanners.
The current version of this backend supports both CD type
scanners and CIS type scanners.
The following scanners might work with this backend:
CD scanners
Model: ASIC ID: CD Type: works:
SE 6000 P 1013 00 yes
SM 4800 P 1013/1015 04/01 yes
SE 1200 ED Plus 1015 01 no
SM 1200 ED Plus 1015 01 no
SE 12000 P 1505 05 no
600 I EP Plus 1013/1015 00/01 yes
SE 600 SEP 1013 ?? yes
600 I EP ???? ?? no
MD9848 1015 00 yes
Gallery 4800 ???? ?? yes
Viviscan Compact I 1013 00 yes
CIS scanners
Model: ASIC ID: works:
Mustek 600 CP & 96 CP 1015 yes (*)
Mustek 1200 CP 1015 yes
Mustek 1200 CP] 1015 yes
OEM versions Original works
Medion/LifeTec/Tevion
MD/LT 9350/9351 1200 CP yes
MD/LT 9850/9851 1200 CP maybe (**)
MD/LT 9858 1200 CP probably
MD/LT 9890/9891 1200 CP yes
Targa
Funline TS12EP 1200 CP yes
Funline TS6EP 600 CP yes
Trust
SunOS 5.10 Last change: November 17 2003 1
Standards, Environments, and Macros sane-mustekpp(5)
Easy Connect 9600] 600 CP yes
Cybercom
9352 1200 CP yes (***)
(*) Calibration problems existed with earlier version of
this driver. They seem to be solved now.
(**) Problems have been reported in the past for the
MD/LT9850 type (striped scans, head moving in wrong
direction at some resolutions). It is not known whether
the current version of the driver still has these prob-
lems.
IF YOU HEAR LOUD CLICKING NOISES, (This holds for any type
of scanner).
(***) Possibly, the enginedelay parameter has to be set to
1 ms for accurate engine movements.
Please note that this backend is still under construction.
Certain models are currently not supported and some may
never be because the communication protocol is still unknown
(eg., SE 12000 P).
Some scanners work faster when EP/ECP is enabled in the
BIOS. EP mode however may lead to hard-locks on some Linux
systems. If that is the case for you, you can either disable
ECP/EP in your BIOS or disable it in the backend itself
(see GLOBAL OPTIONS).
Note that the backend needs to run as root or has to have
appropriate access rights to /dev/parport* if libieee1284
support is compiled in. To allow user access to the scanner
run the backend through the network interface (See saned(8)
and sane-net(5)). Note also that the backend does not sup-
port parport sharing, i.e. if you try printing while scan-
ning, your computer may crash. To enable parport sharing,
you have to enable libieee1284 at compile time. This backend
also conflicts with the sane-musteka4s2 backend. You can
only enable one of them in your dll.conf. However, you have
to enable the backend explicitly in your dll.conf, just
remove the hash mark in the line "mustekpp".
DEVICE DEFINITION
This backend allows multiple devices being defined and con-
figured via the mustekpp.conf file (even simultaneously,
provided that they are connected to different parallel
ports). Please make sure to edit this file before you use
the backend.
SunOS 5.10 Last change: November 17 2003 2
Standards, Environments, and Macros sane-mustekpp(5)
A device can be defined as follows:
scanner
where
is an arbitrary name for the device, optionally
enclosed by double quotes, for instance "LifeTec 9350".
is the name of the parallel port to which the
device is connected. In case libieee1284 is used for
communication with the port (default setup), valid port
names are parport0, parport1, and parport2.
In case the backend is configured for raw IO (old setup),
port addresses have to be used instead of port names:
0x378, 0x278, or 0x3BC. The mapping of parallel ports (lp0,
lp1, and lp2) to these addresses can be different for dif-
ferent Linux kernel versions. For instance, if you are using
a Kernel 2.2.x or better and you have only one parallel
port, this port is named lp0 regardless of the base address.
However, this backend requires the base address of your
port. If you are not sure which port your scanner is con-
nected to, have a look at your /etc/conf.modules,
/etc/modules.conf and/or /proc/ioports.
If you are unsure which port to use, you can use the magic
value * to probe for your scanner.
is the driver to use for this device. Currently
available drivers are:
cis600 : for 600 CP, 96 CP & OEM versions
cis1200 : for 1200 CP & OEM versions
cis1200] : for 1200 CP] & OEM versions
ccd300 : for 600 IE P & OEM version
Choosing the wrong driver can damage
Especially, using the 1200CP settings on a 600CP can be
harmful. If the scanner starts making a loud noise,
turn it off immediately !!!
Using the cis600 driver on a 1200CP or a 1200CP] is probably
not dangerous. The cis1200] driver also works for the
1200CP, and using the cis1200 driver on a 1200CP] will typi-
cally result in scans that cover only half of the width of
the scan area (also not dangerous).
If unsure about the exact model of your OEM version, check
the optical resolution in the manual or on the box: the
600CP has a maximum optical resolution of 300x600 DPI,
whereas the 1200CP and 1200CP] have a maximum optical
SunOS 5.10 Last change: November 17 2003 3
Standards, Environments, and Macros sane-mustekpp(5)
resolution of 600x1200 DPI.
Examples:
scanner "LifeTec 9350" 0x378 cis1200
scanner Mustek600CP 0x378 cis600
scanner Mustek600IEP * ccd300
If in doubt which port you have to use, or whether your
scanner is detected at all, you can use sane-find-scanner -p
to probe all configured ports.
CONFIGURATION
The contents of the mustekpp.conf file is a list of device
definitions and device options that correspond to Mustek
scanners. Empty lines and lines starting with a hash mark
(#) are ignored. Options have the following format:
option []
Depending on the nature of the option, a value may or may
not be present. Options always apply to the scanner defini-
tion that precedes them. There are no global options.
Options are also driver-specific: not all drivers support
all possible options.
Common options
bw
Black/white discrimination value to be used during
lineart scanning. Pixel values below this value are
assumed to be black, values above are assumed to be
white.
Default value: 127
Minimum: 0
Maximum: 255
Example: option bw 150
CIS driver options
topadjust
Vertical adjustment of the origin, expressed in millim-
eter (floating point). This option can be used to cali-
brate the position of the origin, within certain lim-
its. Note that CIS scanners are probably temperature
sensitive, and that a certain inaccuracy may be hard to
avoid. Differences in offset between runs in the order
of 1 to 2 mm are not unusual.
SunOS 5.10 Last change: November 17 2003 4
Standards, Environments, and Macros sane-mustekpp(5)
Default value: 0.0
Minimum: -5.0
Maximum: 5.0
Example: option topadjust -2.5
slowskip
Turns fast skipping to the start of the scan region
off. When the region to scan does not start at the ori-
gin, the driver will try to move the scanhead to the
start of the scan area at the fastest possible speed.
On some models, this may not work, resulting in large
inaccuracies (up to centimeters). By setting this
option, the driver is forced to use normal speed during
skipping, which can circumvent the accuracy problems.
Currently, there are no models for which these inaccu-
racy problems are known to occur.
By default, fast skipping is used.
Example: option slowskip
enginedelay
Under normal circumstances, it is sufficient for the
driver to wait for the scanner signaling that the
engine is stable, before a new engine command can be
transmitted. In rare cases, certain scanners and/or
parallel port chipsets appear to prevent reliable
detection of the engine state. As a result, engine com-
mands are transmitted too soon and the movement of the
scanner head becomes unreliable. Inaccuracies ranging
up to 10 cm over the whole vertical scan range have
been reported. To work around this problem, the
enginedelay option can be set. If it is set, the
driver waits an additional amount of time after every
engine command, equal to the enginedelay parameter,
expressed in milliseconds. It practice an enginedelay
of 1 ms is usually sufficient. The maximum delay is 100
ms.
Note that every additional ms of delay can add up to 14
seconds to the total scanning time (highest resolu-
tion), so an as small as possible value is preferred.
Default value: 0
Minimum: 0
Maximum: 100
Example: option enginedelay 1
top
Number of scanlines to skip to the start of the scan
SunOS 5.10 Last change: November 17 2003 5
Standards, Environments, and Macros sane-mustekpp(5)
area. The number can be any positive integer. Values
known to me are 47 and 56.
Default value: 47
Minimum: 0
Maximum: none
Example: option top 56
waitbank
The number of usecs to wait for a bank change. You
should not touch this value actually. May be any posi-
tive integer
Default value: 700
Minimum: 0
Maximum: none
Example: option waitbank 700
A sample configuration file is shown below:
#
# LifeTec/Medion 9350 on port 0x378
#
scanner "LifeTec 9350" 0x378 cis1200
# Some calibration options (examples!).
option bw 127
option topskip -0.8
#
# A Mustek 600CP on port 0x3BC
#
scanner "Mustek 600CP" 0x3BC cis600
# Some calibration options (examples!).
option bw 120
option topskip 1.2
#
# A Mustek 1200CP] on port 0x278
#
scanner "Mustek 1200CP plus" 0x278 cis1200]
# Some calibration options (examples!).
option bw 130
option topskip 0.2
#
# A Mustek 600 I EP on port parport0
#
SunOS 5.10 Last change: November 17 2003 6
Standards, Environments, and Macros sane-mustekpp(5)
scanner "Mustek 600 I EP" parport0 ccd300
# Some calibration options (examples!).
option bw 130
option top 56
GLOBAL OPTIONS
You can control the overall behaviour of the mustekpp back-
end by global options which precede any scanner definition
in the mustekpp.conf file.
Currently, there is only one global option:
Global options
noepp
Disable parallel port mode EP: works around a known
bug in the Linux parport code. Enable this option, if
the backend hangs when trying to access the parallel
port in EP mode.
Default value: use EP
Example: option noepp
FILES
/etc/sane.d/mustekpp.conf
The backend configuration file (see also description of
SANECONFIGDIR below).
/usr/lib/sane/libsane-mustekpp.a
The static library implementing this backend.
/usr/lib/sane/libsane-mustekpp.so
The shared library implementing this backend (present
on systems that support dynamic loading).
ENVIRONMENT
SANECONFIGDIR
This environment variable specifies the list of direc-
tories that may contain the configuration file. Under
UNIX, the directories are separated by a colon (`:'),
under OS/2, they are separated by a semi-colon (`;').
If this variable is not set, the configuration file is
searched in two default directories: first, the current
working directory (".") and then in /etc/sane.d. If
the value of the environment variable ends with the
directory separator character, then the default
SunOS 5.10 Last change: November 17 2003 7
Standards, Environments, and Macros sane-mustekpp(5)
directories are searched after the explicitly specified
directories. For example, setting SANECONFIGDIR to
"/tmp/config:" would result in directories
"tmp/config", ".", and "/etc/sane.d" being searched (in
this order).
SANEDEBUGMUSTEKP
If the library was compiled with debug support enabled,
this environment variable controls the debug level for
this backend. E.g., a value of 128 requests all debug
output to be printed. Smaller levels reduce verbosity.
level debug output
- -
0 nothing
1 errors
2 warnings & minor errors
3 additional information
4 debug information
5 code flow (not supported yet)
6 special debug information
SANEDEBUGSANEIPA4S2
This variable sets the debug level for the SANE inter-
face for the Mustek chipset A4S2. Note that enabling
this will spam your terminal with some million lines of
debug output.
level debug output
- -
0 nothing
1 errors
2 warnings
3 things nice to know
4 code flow
5 detailed code flow
6 everything
SEE ALSO
sane(7), sane-mustek(5), sane-net(5), saned(8), sane-find-
scanner(1)
For latest bug fixes and information see
http:/www.penguin-breeder.org/sane/mustekpp/
For additional information on the CIS driver, see
http:/home.scarlet.be/eddydegreef/
SunOS 5.10 Last change: November 17 2003 8
Standards, Environments, and Macros sane-mustekpp(5)
AUTHORS
Jochen Eisinger
Eddy De Greef
BUGS
Too many... please send bug reports to sane-
devel@lists.alioth.debian.org (note that you have to sub-
scribe first to the list before you can send emails... see
http:/www.sane-project.org/mailing-lists.html)
BUG REPORTS
If something doesn't work, please contact us (Jochen for the
CD scanners, Eddy for the CIS scanners). But we need some
information about your scanner to be able to help you...
SANE version
run "scanimage -V" to determine this
the backend version and your scanner
run "SANEDEBUGMUSTEKP=128 scanimage -L" as root. If
you don't get any output from the mustekpp backend,
make sure a line "mustekpp" is included into your
/etc/sane.d/dll.conf. If your scanner isn't detected,
make sure you've defined the right port address in your
mustekpp.conf.
the name of your scanner/vendor
also a worthy information. Please also include the opt-
ical resolution and lamp type of your scanner, both can
be found in the manual of your scanner.
any further comments
if you have comments about the documentation (what
could be done better), or you think I should know some-
thing, please include it.
some nice greetings
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.10 Last change: November 17 2003 9
Standards, Environments, and Macros sane-mustekpp(5)
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWsane-backend
Interface Stability Uncommitted
NOTES
Source for SANE is available on http:/opensolaris.org.
SunOS 5.10 Last change: November 17 2003 10
|