home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 10 / 10.iso / m / m055 / 1.img / SAPI.DO_ / SAPI.bin
Encoding:
Text File  |  1992-10-14  |  11.7 KB  |  306 lines

  1.  
  2.                               SAPI scanner driver
  3.                                    SAPI.EXE
  4.                                 October 14, 1992
  5.  
  6. The SAPI scanner driver is a revision 6.10 scanner driver (see REV6.DOC for 
  7. more information) providing black and white, gray scale and color scanning 
  8. for the current ZSoft products.
  9.  
  10. The ZSoft SAPI scanner driver requires the presence of a manufacturer 
  11. supplied scanner driver (referred to in this document as SAPI.SYS since the 
  12. actual name varies from manufacturer to manufacturer. For example, 
  13. Logitech's SAPI driver is called HHSCAND.SYS). SAPI.SYS should be 
  14. loaded before the ZSoft driver.
  15.  
  16. SAPI.EXE also REQUIRES that the scanner hardware be set up for interrupts. 
  17. This has NOT been the case for previous ZSoft scanner drivers.
  18.  
  19. The commands provided by the SAPI scanner driver are listed below in the 
  20. example of the /H parameter.
  21.  
  22.         ZSoft Scanner Driver, version 6.10
  23.         Copyright (C) ZSoft Corp. 1991,1992.  All rights reserved.
  24.  
  25.         Valid commands:
  26.  
  27.         /Bxxx  = interrupt Buffer size in K (default is 8K, max 63K)
  28.         /Cx    = application Code (1-4)
  29.         /H     = display this Help text
  30.         /?     = display this help text
  31.         /Tx    = do diagnostic Testing (verify communication with scanner)
  32.         /V     = Verbose messages and status displays
  33.         /U     = Unload driver
  34.         /N<dev>= Name of manufacturer's device driver
  35.         /Wx    = Watchdog timeout in seconds
  36.         /0     = Filters (manufacturer specific)
  37.         /1     = Light Sources (manufacturer specific)
  38.  
  39. /N
  40. ==
  41.  
  42. The ZSoft SAPI driver requires a "helper" driver supplied by the scanner 
  43. manufacturer. Normally, this device driver is named "HH$SCAN" (not to be 
  44. confused with the DOS file name of something like "SPECTRA.SYS")  The SAPI 
  45. 3.1 specification allows for multiple device drivers under sequential names, 
  46. such as "HH$SCAN1" or "HH$SCAN2"  The /N command allows the user to specify 
  47. the device driver name to look for.
  48.  
  49.  
  50. /W
  51. ==
  52.  
  53. If a watchdog timer is desired to prevent the SAPI driver from locking up 
  54. the system in case of a hardware failure, the /W command can be used.  The 
  55. default value is 0 - no timer is used.  The timer values can range from 1 to
  56. 255 seconds.
  57.  
  58.  
  59. /0 /1
  60. =====
  61.  
  62. The SAPI 3.1 specification defines some controls that are manufacturer 
  63. specific, namely filters and light sources. The /0 and /1 parameters allow 
  64. the user to set the text used in the application's scanner-defined user 
  65. interface for these controls. The syntax for /0 and /1 is:
  66.  
  67.         /0String_1,String_2[,String_3...]
  68.  
  69. Note that the comma is used to separate the items. Spaces are not allowed. 
  70. If you want a space, use an underscore (_) character. If the /0 and /1 
  71. parameters are not used, the default text will be sequential numbers starting 
  72. with 1.
  73.  
  74. For example, the Niscan Spectra scanner implements the light sources control. 
  75. The names of the controls are "Reflective" and "Transparency."  Using the 
  76. parameter "/1Reflective,Transparency" sets the text for the Light Sources 
  77. options in the application user interface.
  78.  
  79. Under some graphical user interfaces, such as Microsoft Windows, keyboard 
  80. shortcuts or accelerators are used to allow the user to quickly navigate 
  81. through a dialog box or menu structure. Keyboard shortcuts can be defined 
  82. in the /0 and /1 parameters by preceding the accelerator character with an 
  83. ampersand (&) character. The accelerators A, H, F, L, S, and U are reserved 
  84. by the SAPI driver and should not be used. Depending on the application, 
  85. the choices for filters or light sources may be implemented as a list box. 
  86. In this case, the accelerators are not used.
  87.  
  88.  
  89. Manufacturer Notes
  90. ==================
  91.  
  92. At this time only the Intel Satisfaxtion, Logitech ScanMan, ScanMan+, 
  93. ScanMan 256, Niscan/GS, and Niscan Spectra have been tested with the SAPI.EXE 
  94. scanner driver. Any black and white, gray scale, or color scanner that is 
  95. compliant with the SAPI specification should work with this driver.
  96.  
  97. The following sections discuss the operaion of the SAPI driver in conbination 
  98. with the various supported scanners. Please note that all of the features 
  99. listed may not be supported by your application. For example, only the first 
  100. four or six resolutions may be available in some ZSoft applications.
  101.  
  102. INTEL SATISFAXTION
  103. ------------------
  104. This configuration supports the following features:
  105.  
  106.         FEATURE         DRIVER SUPPORT
  107. ======================= ===============
  108. Brightness Settings     Set on scanner
  109. Contrast Settings       N/A
  110. Automatic Brightness    No
  111. Automatic Contrast      No
  112. Resolutions             400x400, 300x300, 200x200, 100x100
  113. Scan Modes              B/W, GS16, GS64, GS256
  114. Halftones               Set on scanner
  115. Enhancements            None
  116. Maximum Scan Area       4.0" x 50.00"
  117. Custom Settings         None
  118.  
  119. Due to the lack of software control over the Logitech and Intel 
  120. Satisfaxtion scanners, the SAPI driver can sometimes return invalid 
  121. data for a scan. In order to avoid this problem, be sure that the 
  122. switch settings on the hand scanner are set to match the selections 
  123. made in the application. For these scanners, be sure that the mode
  124. switch is set to 256 BEFORE SAPI.EXE is loaded or gray scale may 
  125. not be available as an option within the application.
  126.  
  127.  
  128. LOGITECH SCANMAN
  129. ----------------
  130. This configuration supports the following features:
  131.  
  132.         FEATURE         DRIVER SUPPORT
  133. ======================= ===============
  134. Brightness Settings     Set on scanner
  135. Contrast Settings       N/A
  136. Automatic Brightness    No
  137. Automatic Contrast      No
  138. Resolutions             400x400, 300x300, 200x200, 100x100
  139. Scan Modes              B/W
  140. Halftones               Set on Scanner
  141. Enhancements            None
  142. Maximum Scan Area       2.5" x 50.00"
  143. Custom Settings         None
  144.  
  145. Due to the lack of software control over the Logitech and Intel 
  146. Satisfaxtion scanners, the SAPI driver can sometimes return invalid 
  147. data for a scan. In order to avoid this problem, be sure that the 
  148. switch settings on the hand scanner are set to match the selections 
  149. made in the application. For these scanners, be sure that the mode
  150. switch is set to 256 BEFORE SAPI.EXE is loaded or gray scale may 
  151. not be available as an option within the application.
  152.  
  153.  
  154. LOGITECH SCANMAN PLUS / SCANMAN 32
  155. ----------------------------------
  156. This configuration supports the following features:
  157.  
  158.         FEATURE         DRIVER SUPPORT
  159. ======================= ===============
  160. Brightness Settings     Set on scanner
  161. Contrast Settings       N/A
  162. Automatic Brightness    No
  163. Automatic Contrast      No
  164. Resolutions             400x400, 300x300, 200x200, 100x100
  165. Scan Modes              B/W
  166. Halftones               Set on Scanner
  167. Enhancements            None
  168. Maximum Scan Area       4.0" x 50.00"
  169. Custom Settings         None
  170.  
  171. Due to the lack of software control over the Logitech and Intel 
  172. Satisfaxtion scanners, the SAPI driver can sometimes return invalid 
  173. data for a scan. In order to avoid this problem, be sure that the 
  174. switch settings on the hand scanner are set to match the selections 
  175. made in the application. For these scanners, be sure that the mode
  176. switch is set to 256 BEFORE SAPI.EXE is loaded or gray scale may 
  177. not be available as an option within the application.
  178.  
  179.  
  180. LOGITECH SCANMAN 256
  181. --------------------
  182. This configuration supports the following features:
  183.  
  184.         FEATURE         DRIVER SUPPORT
  185. ======================= ===============
  186. Brightness Settings     Set on scanner
  187. Contrast Settings       N/A
  188. Automatic Brightness    No
  189. Automatic Contrast      No
  190. Resolutions             400x400, 300x300, 200x200, 100x100
  191. Scan Modes              B/W, GS16, GS64, GS256
  192. Halftones               Set on Scanner
  193. Enhancements            None
  194. Maximum Scan Area       4.0" x 50.00"
  195. Custom Settings         None
  196.  
  197. Due to the lack of software control over the Logitech and Intel 
  198. Satisfaxtion scanners, the SAPI driver can sometimes return invalid 
  199. data for a scan. In order to avoid this problem, be sure that the 
  200. switch settings on the hand scanner are set to match the selections 
  201. made in the application. For these scanners, be sure that the mode
  202. switch is set to 256 BEFORE SAPI.EXE is loaded or gray scale may 
  203. not be available as an option within the application.
  204.  
  205.  
  206. NISCAN/GS
  207. ---------
  208. This configuration supports the following features:
  209.  
  210.         FEATURE         DRIVER SUPPORT
  211. ======================= ===============
  212. Brightness Settings     1 to 32
  213. Contrast Settings       1 to 32
  214. Automatic Brightness    No
  215. Automatic Contrast      No
  216. Resolutions             100x100, 200x200, 300x300, 400x400, 50x50, 150x150,
  217.                         250x250, 350x350, 25x25, 125x125, 225x225, 325x325,
  218.                         75x75, 175x175, 275x275, 375x375,
  219.                         Custom [25..400 by 25, Independent]
  220. Scan Modes              B/W, B/W Dither, GS16, GS256
  221. Halftones               Bayer, Coarse Fatting, Fine Fatting, Horizontal Line,
  222.                         Vertical Line, Mesh
  223. Enhancements            None
  224. Maximum Scan Area       4.16" x 11.00"
  225. Custom Settings         None
  226.  
  227.  
  228. NISCAN SPECTRA
  229. --------------
  230. When using SAPI.EXE with the Niscan Spectra driver SPECTRA.SYS, include the
  231. following command:
  232.         /1&Reflective,&Transparency
  233.  
  234. This configuration supports the following features:
  235.  
  236.         FEATURE         DRIVER SUPPORT
  237. ======================= ===============
  238. Brightness Settings     1 to 7
  239. Contrast Settings       1
  240. Automatic Brightness    Yes
  241. Automatic Contrast      No
  242. Resolutions             50x50, 100x100, 200x200, 400x400, 75x75, 125x125,
  243.                         150x150, 175x175, 225x225, 250x250, 275x275, 300x300,
  244.                         325x325, 350x350, 375x375,
  245.                         Custom [50..400 by 25, Independent]
  246. Scan Modes              B/W, B/W Dither, GS4, GS16, GS64, GS256, Color 24-bit
  247. Halftones               Bayer, Coarse Fatting, Fine Fatting
  248. Enhancements            None
  249. Maximum Scan Area       3.96" x 5.96"
  250. Custom Settings         Hue [0..4]
  251.                         Light Sources [Reflective, Transparency]
  252. NOTE: Not all ZSoft applications support Custom Settings.
  253.  
  254.  
  255.  
  256. SAPI Messages
  257. =============
  258.  
  259.         Supporting: ???????????
  260.  
  261. This message is displayed upon successful initialization of the SAPI
  262. scanner. The name and model of the scanner found will be displayed.
  263.  
  264.  
  265. SAPI Error Messages
  266. ===================
  267.  
  268.         Manufacturer's device driver `HH$SCAN ' not found.
  269.  
  270. This message is displayed when the scanner driver cannot find the "helper" 
  271. driver (provided by the scanner maufacturer). The ZSoft SAPI scanner 
  272. driver requires that this driver be loaded before it can load.
  273.  
  274.  
  275.         Buffer size cannot be larger than 63k
  276.  
  277. This message is displayed when the argument to the /B parameter is greater 
  278. than 63.
  279.  
  280.  
  281.         Watchdog timer value cannot be larger than 255
  282.  
  283. This message is displayed when the argument to the /W parameter is greater 
  284. than 255.
  285.  
  286.  
  287.         Scanner not responding (do you have the right address?)
  288.  
  289. This message is displayed at initialization time if the scanner driver cannot 
  290. successfully communicate with the scanner.
  291.  
  292.  
  293.         Error communicating with manufacturer's driver (????)
  294.  
  295. This message is displayed when an error occurs while sending or receiving 
  296. information from the manufacturer supplied driver. An error code is 
  297. included in the message to help identify the problem.
  298.  
  299.  
  300.         Scanner hardware not configured for interrupts
  301.  
  302. The SAPI.EXE driver requires interrupts to function. The scanner 
  303. hardware interface must be configured to use interrupts. With most 
  304. manufacturer's drivers the interrupt can be set with a command line 
  305. parameter to the driver (e.g. /I=7, sets interrupt 7).
  306.