1sane-gt68xx(5) SANE Scanner Access Now Easy sane-gt68xx(5)
2
3
4
6 sane-gt68xx - SANE backend for GT-68XX based USB flatbed scanners
7
9 The sane-gt68xx library implements a SANE (Scanner Access Now Easy)
10 backend that provides access to USB flatbed scanners based on the
11 Grandtech GT-6801 and GT-6816 chips. A list of supported scanners can
12 be found on the gt68xx backend homepage:
13 http://www.meier-geinitz.de/sane/gt68xx-backend/.
14
15 This is BETA software. Especially if you test new or untested scanners,
16 keep your hand at the scanner's plug and unplug it, if the head bumps
17 at the end of the scan area.
18
19 If you own a scanner other than the ones listed on the gt68xx homepage
20 that works with this backend, please let me know this by sending the
21 scanner's exact model name and the USB vendor and device ids (e.g. from
22 sane-find-scanner(1) or syslog) to me. Even if the scanner's name is
23 only slightly different from the models already listed as supported,
24 please let me know.
25
26 If you own a scanner that isn't detected by the gt68xx backend but has
27 a GT-6801 or GT-6816 chipset, you can try to add it to the backend.
28 Have a look at the following web page:
29 http://www.meier-geinitz.de/sane/gt68xx-backend/adding.html
30
32 Please use libusb-0.1.8 or later. Without libusb or with older libusb
33 versions all kinds of trouble can be expected. The scanner should be
34 found by sane-find-scanner(1) without further actions. For setting per‐
35 missions and general USB information, look at sane-usb(5).
36
38 You need a firmware file for your scanner. That's a small file contain‐
39 ing software that will be uploaded to the scanner's memory. It's usu‐
40 ally named *.usb, e.g. PS1fw.usb. It comes on the installation CD
41 that was provided by the manufacturer, but it may be packaged together
42 with the installation program in an .exe file. For Mustek scanners, the
43 file can be downloaded from the gt68xx backend homepage. For other
44 scanners, check the CD for .usb files. If you only find *.cab files,
45 try cabextract(1) to unpack. If everything else fails, you must install
46 the Windows driver and get the firmware from there (usually in the win‐
47 dows/system or system32 directories). Put that firmware file into
48 /usr/share/sane/gt68xx/. Make sure that it's readable by everyone.
49
50
52 The contents of the gt68xx.conf file is a list of usb lines containing
53 vendor and product ids that correspond to USB scanners. The file can
54 also contain option lines. Empty lines and lines starting with a hash
55 mark (#) are ignored. The scanners are autodetected by usb vendor_id
56 product_id statements which are already included into gt68xx.conf.
57 "vendor_id" and "product_id" are hexadecimal numbers that identify the
58 scanner.
59
60 The override, firmware, vendor, model, and afe options must be placed
61 after the usb line they refer to.
62
63 Option override is used to override the default model parameters.
64 That's necessary for some scanners that use the same vendor/product ids
65 but are different. For these scanners there are already commented out
66 override lines in the configuration file. override mustek-scanex‐
67 press-1200-ub-plus is necessary for the Mustek Scanexpress 1200 UB
68 Plus, the Medion/Lifetec/Tevion LT 9452, and the Trust Compact Scan USB
69 19200. override artec-ultima-2000 is used for the Artec Ultima 2000,
70 the Boeder SmartScan Slim Edition, the Medion/ Lifetec/ Tevion/ Cytron
71 MD/LT 9385, the Medion/ Lifetec/ Tevion MD 9458, and the Trust Flat
72 Scan USB 19200. override mustek-bearpaw-2400-cu is necessary for the
73 Mustek BearPaw 2400 CU and the Fujitsu 1200CUS. The override option
74 must be the first one after the usb line.
75
76 Option firmware selects the name and path of the firmware file. It's
77 only necessary if the default (or override) doesn't work. The default
78 firmware directory is /usr/share/sane/gt68xx/. You may need to create
79 this directory. If you want to place the firmware files at a different
80 path, use a firmware line.
81
82 The vendor and model options are not absolutely necessary but for con‐
83 venience. Quite a lot of scanners from different manufacturers share
84 the same vendor/product ids so you can set the "correct" name here.
85
86 The afe option allows one to set custom offset and gain values for the
87 Analog FrontEnd of the scanner. This option can be either used to se‐
88 lect the AFE values if automatic coarse calibration is disabled, or to
89 make automatic coarse calibration faster. For the latter usage, enable
90 debug level 3 (see below), scan an image and look for debug line string
91 with "afe". Copy this line to gt68xx.conf. The option has six parame‐
92 ters: red offset, red gain, green offset, green gain, blue offset, and
93 blue gain.
94
95 A sample configuration file is shown below:
96
97 usb 0x05d8 0x4002
98 override "mustek-scanexpress-1200-ub-plus"
99 firmware "/opt/gt68xx/SBfw.usb"
100 vendor "Trust"
101 model "Compact Scan USB 19200"
102 afe 0x20 0x02 0x22 0x03 0x1f 0x04
103
104
106 /etc/sane.d/gt68xx.conf
107 The backend configuration file (see also description of
108 SANE_CONFIG_DIR below).
109
110 /usr/lib64/sane/libsane-gt68xx.a
111 The static library implementing this backend.
112
113 /usr/lib64/sane/libsane-gt68xx.so
114 The shared library implementing this backend (present on systems
115 that support dynamic loading).
116
118 SANE_CONFIG_DIR
119 This environment variable specifies the list of directories that
120 may contain the configuration file. On *NIX systems, the direc‐
121 tories are separated by a colon (`:'), under OS/2, they are sep‐
122 arated by a semi-colon (`;'). If this variable is not set, the
123 configuration file is searched in two default directories:
124 first, the current working directory (".") and then in
125 /etc/sane.d. If the value of the environment variable ends with
126 the directory separator character, then the default directories
127 are searched after the explicitly specified directories. For
128 example, setting SANE_CONFIG_DIR to "/tmp/config:" would result
129 in directories tmp/config, ., and /etc/sane.d being searched (in
130 this order).
131
132 SANE_DEBUG_GT68XX
133 If the library was compiled with debug support enabled, this en‐
134 vironment variable controls the debug level for this backend.
135 Higher debug levels increase the verbosity of the output. If the
136 debug level is set to 1 or higher, some debug options become
137 available that are normally hidden. Handle them with care.
138
139 Example: export SANE_DEBUG_GT68XX=4
140
141
143 sane(7), sane-usb(5), sane-artec_eplus48u(5) sane-plustek(5),
144 sane-ma1509(5), sane-mustek_usb(5), sane-mustek(5), sane-mustek_pp(5),
145 cabextract(1)
146 /usr/share/doc/sane-backends/gt68xx/gt68xx.CHANGES
147 http://www.meier-geinitz.de/sane/gt68xx
148
149
151 Henning Meier-Geinitz <henning@meier-geinitz.de>
152 The original gt68xx driver was written by Sergey Vlasov, Andreas
153 Nowack, and David Stevenson. Thanks for sending patches and answering
154 questions to them and all the other contributors.
155
156
158 The first few lines of the image are garbage for the 2400 TA Plus.
159
160 Interpolation should be used instead of just copying data, when the X-
161 and Y-resolution differ.
162
163 Support for buttons is missing.
164
165 More detailed bug information is available at the gt68xx backend home‐
166 page http://www.meier-geinitz.de/sane/gt68xx-backend/.
167 Please contact us if you find a bug or missing feature: <sane-de‐
168 vel@alioth-lists.debian.net>.
169 Please send a debug log if your scanner isn't detected correctly (see
170 SANE_DEBUG_GT68XX above).
171
172
173
174 13 Jul 2008 sane-gt68xx(5)