first release file for stv680 backend

merge-requests/1/head
Gerard Klaver 2006-06-05 18:19:56 +00:00
rodzic 1e0f5dac6d
commit 67ab594a6c
2 zmienionych plików z 212 dodań i 0 usunięć

Wyświetl plik

@ -0,0 +1,63 @@
;
; SANE Backend specification file
;
; It's basically emacs-lisp --- so ";" indicates comment to end of line.
; All syntactic elements are keyword tokens, followed by a string or
; keyword argument, as specified.
;
; ":backend" *must* be specified.
; All other information is optional (but what good is the file without it?).
;
:backend "stv680" ; name of backend
:version "1.0-1" ; version of backend
:manpage "sane-stv680"
:url "http://gkall.hobby.nl/stv680-aiptek.html" ; backend's web page
:comment "This vidcam backend is for the stv0680 chipset, See the website for more info."
:devicetype :vidcam ; start of a list of devices....
; other types: :stillcam, :vidcam,
; :meta, :api
:mfg "Aiptek" ; name a manufacturer
:url "http://www.aiptek.com.tw"
; name models for above-specified mfg.
:model "Aiptek Pencam"
:interface "USB"
:usbid "0x0553" "0x0202"
:status :minimal
:comment "image is OK for CIF and QCIF, VGA and QVGA untested, streaming video is a problem"
:mfg "Konica" ; name a manufacturer
:url "http://www.konicaminolta.com"
; name models for above-specified mfg.
:model "e-mini"
:interface "USB"
:usbid "0x04c8" "0x0722"
:status :untested
:comment " "
:mfg "Digital Dream" ; name a manufacturer
:url "http://www.digitaldreamco.com/en/index.shtml"
; name models for above-specified mfg.
:model "l' espion XS"
:interface "USB"
:usbid "0x1183" "0x0001"
:status :untested
:comment " "
:mfg "Creative" ; name a manufacturer
:url "http://www.creative.com/"
; name models for above-specified mfg.
:model "WebCam Go Mini"
:interface "USB"
:usbid "0x041e" "0x4007"
:status :untested
:comment " "
; :comment and :url specifiers are optional after :mfg, :model, :desc,
; and at the top-level.

149
doc/sane-stv680.man 100644
Wyświetl plik

@ -0,0 +1,149 @@
.TH sane-stv680 5 "05 June 2005" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
.IX sane-stv680
.SH NAME
sane-stv680 \- SANE backend for STV680 camera's
.SH DESCRIPTION
The
.B sane-stv680
library implements a SANE (Scanner Access Now Easy) backend that
provides access to some STV680 camera's. This backend
should be considered
.B beta-quality
software! STV680 camera's are sold under
various brands like Aiptek.
This backend may or may not support yours.
.PP
The camera's that should work with this backend are:
.PP
.RS
Vendor Model USB Vendor id USB product id status
.br
---------------------- -------------- ----------- ----------
.br
AIPTEK stv680 0x0553 0x0202 basic
Konica e-mini 0x04c8 0x0722 untested
DigitalDream l'espion XS 0x1183 0x0001 untested
Creative WebCam Go mini 0x041e 0x4007 untested
.RE
For all these camera's, see the backend home page (under AUTHOR)
for the exact status of each scanner.
For problems with the untested camera's, you
should contact the author for that.
The options the backend supports can either be selected through
command line options to programs like scanimage or through GUI
elements in xcam. For both programs use the -B option
.br
If you have any success with a camera not listed here, or if you have
any strange behavior, please report to the backend maintainer or to
the SANE mailing list.
Valid command line options and their syntax can be listed by using
.RS
scanimage --help -d stv680
.RE
.TP
.B Scan Mode
.TP
.B --mode
selects the basic mode of operation of the webcams valid choices.
The read resolution mode is 8 bits, output resolution is 24 bits.
Selects the resolution for a scan.
The camera can do only the resolutions listed.
.TP
.B --Raw
In this mode raw data is displayed
.TP
.B --Color
In this mode the bayer unshuffle is done but no color correction
.TP
.B --Color_RGB
Bayer unshuffle, color correction
.TP
.B --Color_RGB_TXT
Bayer unshuffle, color correction, textline with date and time is added
.TP
.B Enhancement options
.TP
.B --white-level-r
Selects what red radiance level should be
considered "white", when scanning some sheets by changing the calibration
value loaded into the scanner. Scale -32 .. 0..+32 in steps of 1.
.TP
.B --white-level-g
Selects what green radiance level should be
considered "white", when scanning some sheets by changing the calibration i
value loaded into the scanner. Scale -32 ..0..+32 in steps of 1.
.TP
.B --white-level-b
Selects what blue radiance level should be
considered "white", when scanning some sheets by changing the calibration
value loaded into the scanner. Scale -32 ..0..+32 in steps of 1.
.SH CONFIGURATION FILE
The configuration file @CONFIGDIR@/stv680.conf supports only one
information: the device name to use (eg usb 0x.... 0x ....).
.SH FILES
.TP
.I @LIBDIR@/libsane-stv680.a
The static library implementing this backend.
.TP
.I @LIBDIR@/libsane-stv680.so
The shared library implementing this backend (present on systems that
support dynamic loading).
.SH ENVIRONMENT
.TP
.B SANE_DEBUG_STV680
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.
.SH LIMITATIONS
The windows TWAIN driver has many more options than this SANE
backend. However they are only software adjustments. This backend only
implements what the webcam can support.
.SH BUGS
Plenty. Parts of this backend are still under development.
1. Some untested camera's.
2. Video streaming slow and stops sometimes (scanimage).
3. Sometimes 1/3 of image is NOK (xcam).
.SH "SEE ALSO"
sane\-sane-usb(5),scanimage(1), xcam(1), sane(7)
.SH AUTHORS
Gerard Klaver http://gkall.hobby.nl/stv680-aiptek.html
.SH CREDITS
Thanks to developers of the other stv680 programs:
.TP
STV680 kernel module,
pencam2 program,
libghoto2 program (camlib stv0680)