Ngenuity TWAIN Data Source November 19, 2009 Contact Information Böwe Bell + Howell Scanners on the web: www.bbhscanners.com Corporate Office Böwe Bell + Howell Scanners, L.L.C. 760 South Wolf Road Wheeling, IL 60090-6232, USA Corporate Offices: 1-847-675-7600 SALES 1-800-SCAN-494 or 1-847-423-7330 SUPPORT 1-800-SCAN-495 or 1-585-781-8616 TTY Line: 1-847-423-3032 NOTICE...
Ngenuity TWAIN Data Source UPDATE HISTORY Date Author Mar 10/2009 Mihail Mikov Nov 19/2009 Roland Simonis Description Created Final review; driver rev. 1.18 November 19, 2009 Page 3 of 99...
3.2.3 Skimmer Out of Service ...15 3.2.4 Scanner Misfeed Error ...16 3.2.5 Scanner Paused by User...16 3.2.6 Scanner Stopped by USer ...16 3.2.7 Scanner Page Sensor Error ...16 3.2.8 Feeder Not in Manual Position ...17 3.2.9 Manual Overfeed Error ...17 3.2.10...
This document provides a complete description of the TWAIN Data Source (herein TDS) to support the BBH Ngenuity scanner. ESCRIPTION The BBH Ngenuity TDS implementation is designed to expose all necessary scanner functionality while adhering to the TWAIN 2.0 specification and achieving compatibility with all TWAIN compliant applications.
Ngenuity TWAIN Data Source SOFTWARE FUNCTIONAL SPECIFICATION This section contains a detailed description of the User Interface and TWAIN Programmatic interface for the Ngenuity Scanner TWAIN Data Source. NTERFACE 3.1.1 Navigation tree Equal sign means that Back Page will have the same settings as Front Page.
Ngenuity TWAIN Data Source If the user selects Custom from Page size combo box then “Custom Page Size Settings” a dialog box will appear. 3.1.3 Custom Page Size Settings 3.1.4 Image Settings 3.1.4.1 Black and White, Grayscale and Color November 19, 2009 Page 10 of 99...
Ngenuity TWAIN Data Source November 19, 2009 3.1.8 Imprinter Settings There are two similar windows for setting “Front Imprinter Prescan” and “Back Imprinter Postscan” If user presses button “>” (Dynamic Content), floating menu will appear to insert dynamic content. 3.1.8.1 Dynamic Content menu Page 13 of 99...
Ngenuity TWAIN Data Source November 19, 2009 3.1.9 Profiles Default Profile is always present and cannot be deleted or updated. If user presses right click, floating menu will appear to manage profiles. 3.1.9.1 Profile menus When user click on empty line: “New profile”...
Following those instructions, the Scanner Operator (typically) uses the Scanner Control Panel to clear the exception and then the scanner automatically resumes scanning automatically. The scanner control panel is located in front of the scanner device for easy operator access and quick recovery of those exceptions without going back to the Scan Application.
Ngenuity TWAIN Data Source 3.2.4 Scanner Misfeed Error 3.2.5 Scanner Paused by User 3.2.6 Scanner Stopped by USer 3.2.7 Scanner Page Sensor Error November 19, 2009 Page 16 of 99...
Ngenuity TWAIN Data Source 3.2.8 Feeder Not in Manual Position 3.2.9 Manual Overfeed Error 3.2.10 Cover Open 3.2.11 Scanner Offline November 19, 2009 Page 17 of 99...
Ngenuity TWAIN Data Source YSTEM Help files shown when clicking the Help button will be created at a later release date. (Note: help file to be in CHM or HTML format.) TWAIN O ANDATORY PERATIONS Mandatory Operations are those that are required to meet TWAIN Protocol Version 2.0 compliance as dictated by the published TWAIN Specification Version 2.0.
Ngenuity TWAIN Data Source DG_CONTROL|DG_IMAGE|DF_DS2 3.4.3 DG_CONTROL / DAT_STATUS Supported Messages: MSG_GET (state 4–7) Responds with the current status (from the last operation), and resets the value to TWCC_SUCCESS. Possible values: TWCC_BADPROTOCOL – unrecognized operation triplet TWCC_BADVALUE – parameter out of range TWCC_BUMMER –...
The response to a MSG_RESET shall be to reset the current values and all constraints applied to the requested capability to the state or value reported by MSG_GETDEFAULT. The response to a MSG_RESETALL shall be to reset all scanner settings to their default and remove all constraints. It can be used with CAP_SUPPORTEDCAPS only.
Ngenuity TWAIN Data Source 3.4.7 DG_CONTROL / DAT_USERINTERFACE Supported Messages: MSG_ENABLEDS (state 4), MSG_DISABLEDS (state 5), MSG_ENABLEDSUIONLY (*new 1.7) (state 4) In response to a MSG_ENABLEDS, if the value of ShowUI is set to TRUE, the “Setup and Scan” dialog shall be displayed. Should the value of ShowUI be set to FALSE, then the TDS will move to state 5 and issue a DG_CONTROL/DAT_NULL/MSG_XFERREADY.
Ngenuity TWAIN Data Source November 19, 2009 Columns = -1 Rows = -1 XOffset = -1 YOffset = -1 BytesWritten = # of bytes currently written If the transfer is not compressed, then the TW_IMAGEMEMXFER structure shall be filled out as follows: Compression = TWCP_NONE BytesPerRow = # of bytes per row (*always DWORD aligned)
Ngenuity TWAIN Data Source In response to MSG_RESET, if called during state 6, the software shall move to state 5 and set the Count Field to 0 regardless of the number of images remaining to be scanned, or the contents of the sheet feeder.
Ngenuity TWAIN Data Source Allowed Values: 1 if Current ICAP_PIXELTYPE is TWPT_BW 8 if Current ICAP_PIXELTYPE is TWPT_GRAY 24 if Current ICAP_PIXELTYPE is TWPT_RGB Default Value: 1 if Current ICAP_PIXELTYPE is TWPT_BW 8 if Current ICAP_PIXELTYPE is TWPT_GRAY 24 if Current ICAP_PIXELTYPE is TWPT_RGB Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry:...
MSG_GETDEFAULT - TW_ONEVALUE MSG_RESET – Not supported MSG_SET – Not supported MSG_QUERYSUPPORT - TW_ONEVALUE Allowed Values: Maximum width is read from the scanner Default Value: Maximum width is read from the scanner Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT Stored in registry:...
Shall provide appropriate responses for the following Extended Image Info Attributes 3.6.4.1 TWEI_DOCUMENTNUMBER This attribute reports the current document number. Since the Ngenuity scanner currently does not support any means of document separation or job control, this attribute always responds with 1. Value Type: TW_UINT32 Value: 1 (always) 3.6.4.2...
Ngenuity TWAIN Data Source Value Type: TW_UINT32 Value: TWPF_CHOCOLATE 3.6.5 DG_IMAGE / DAT_ICCPROFILE Supported Messages: MSG_GET (state 6, 7) This operation provides the application with the ICC profile associated with the image which is about to be transferred (state 6) or is being transferred (state 7). TWAIN C PTIONAL APABILITIES...
Ngenuity TWAIN Data Source 3.7.4 CAP_CAMERASIDE The scanner does not support multifeed detection in back page scanning only. When the application sets this capability to TWCS_BOTTOM it also needs to set BBH_CAP_MFD_ACTION to MFD_ACTION_DISABLE. Type: TW_INT16 Supported Messages: MSG_GET - TW_ENUMERATION...
TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT Stored in registry: No (Read Only capability) Stored in profile: No (Read Only capability) Note: Use Read/ScannerStatus with ReadScanner bit set to 1 to force scanner update the status. 3.7.10 CAP_FEEDERENABLED Type: TW_BOOL Supported Messages: MSG_GET - TW_ENUMERATION (for 2.0 applications), TW_ONEVALUE (for <2.0Applications)
Index Counters – left justified, trailing blanks padding %#2m m = [0..2] which index counter Scanner Identifier Replaced with scanner identifier ALT-codes %A0xxx where xxx = Replaced with single 128 - 255 character per Windows code page 1252 ALT code selection.
Ngenuity TWAIN Data Source Allowed Values: TWFT_NONE, TWFT_RED, TWFT_GREEN, TWFT_BLUE (only for Black and White (Bitonal) and Grayscale PixelType) Default Value: TWFT_NONE Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry: No (Has mandatory default TWFT_NONE) Stored in profile: 3.7.26 ICAP_FRAMES Type: TW_FRAME...
Ngenuity TWAIN Data Source Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry: No (Has mandatory default value) Stored in profile: No (Has mandatory default value) Note: If the Application sets this capability, then the image dimensions will be reported in state 7 after image has been transferred from DAT_IMAGEINFO 3.7.40 ICAP_XNATIVERESOLUTION Type:...
Page 59
Ngenuity TWAIN Data Source MSG_QUERYSUPPORT - TW_ONEVALUE Allowed Values: Default Value: Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT Stored in registry: No (Read only) Stored in profile: No (Read only) November 19, 2009 Page 59 of 99...
Ngenuity TWAIN Data Source Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry: Stored in profile: Note: 255 mean this window. 3.8.3 BBH_CAP_ACD_CONTENT Aggressiveness of the auto color detection algorithm. 0 – low aggressiveness (requires much color to detect image as color);...
Ngenuity TWAIN Data Source Stored in profile: 3.8.6 BBH_CAP_ACD_SUPPRESS_ENABLE If enabled and ACD is being performed, ignore the document background when determining if a document contains color. In this mode, if the document background is color but the rest of the document is not, it will be detected as non-color.
Stored in profile: 3.8.8 BBH_CAP_ADV_WND_ENABLE This capability specifies if the current window (specified by BBH_CAP_ADV_WND_ID) will be read from the scanner. It can be different on deferent windows. Type: TW_BOOL Supported Messages: MSG_GET - TW_ENUMERATION (for 2.0 applications), TW_ONEVALUE (for <2.0Applications)
Ngenuity TWAIN Data Source Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry: Stored in profile: 3.8.11 BBH_CAP_BKG_SAT_MODE Sets the format for performing color background saturation. It can be different on deferent windows. Type: TW_UINT8 Supported Messages: MSG_GET - TW_ENUMERATION MSG_GETCURRENT - TW_ONEVALUE MSG_GETDEFAULT - TW_ONEVALUE...
Ngenuity TWAIN Data Source Stored in profile: 3.8.14 BBH_CAP_CAM_BRIGHTNESS_ENABLE If enabled, enable the camera (input) brightness setting and use the value from the Camera Brightness parameter for its brightness. If sRGB mode or ICC Input is enabled, then this will have no effect.
Ngenuity TWAIN Data Source Allowed Values: 0 to 255 Default Value: Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry: Stored in profile: 3.8.16 BBH_CAP_CAM_CONTRAST_ENABLE If enabled, enable the camera (input) contrast setting and use the value from the Camera Contrast parameter for its contrast.
Camera Gamma parameter for its gamma. CAM_MODE_SRGB sets the camera so it scans using its sRGB input mode CAM_MODE_ICC configures the scanner camera for its “default” settings that are required so its ICC profile is correct. In CAM_MODE_SRGB and CAM_MODE_ICC mode, the enable camera brightness, enable camera contrast and enable camera gamma settings will not be used.
TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry: Stored in profile: 3.8.19 BBH_CAP_CAM_NEGATIVE If set, the scanner assumes the image is primarily a dark image with light text (reverse image input). This setting is ignored when scanning in color mode. Type: TW_BOOL Supported Messages: MSG_GET - TW_ENUMERATION (for 2.0 applications), TW_ONEVALUE (for...
TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry: Stored in profile: 3.8.23 BBH_CAP_DOC_IGNORE_HOLE Size of hole to ignore. If greater than 0, the scanner paper sensor should ignore holes in the page Type: TW_ FIX32 Supported Messages: MSG_GET - TW_RANGE...
Ngenuity TWAIN Data Source 0in to 1.7in (0 to 43mm) Default Value: 0in (0mm) Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry: Stored in profile: 3.8.24 BBH_CAP_DOC_MODE Specify paper type to be scanned. It may affect scanning speed. Type: TW_UINT8 Supported Messages:...
No (Non standard TWAIN mechanism) Stored in profile: 3.8.26 BBH_CAP_ENABLE_ADVANCED_FRAMES Setting this capability to true will enable using BBH_CAP_ADV_WND_ID. TWAIN Application will be able to access all properties of the scanner windows. Type: TW_BOOL Supported Messages: MSG_GET - TW_ENUMERATION (for 2.0 applications), TW_ONEVALUE (for <2.0Applications)
MFD_ACTION_NOTIFY - It will not stop scanning and will not report the multifeed to the host. Instead, it will only report the error through the operator interface (e.g. sound and LEDs). MFD_ACTION_STOP - scanner stops after a multifeed. Type: TW_UINT8...
Ngenuity TWAIN Data Source Allowed Values: FALSE, TRUE Default Value: FALSE Query Support Value: TWQC_GET |TWQC_GETDEFAULT |TWQC_GETCURRENT | MSG_SET| MSG_RESET Stored in registry: Stored in profile: 3.8.32 BBH_CAP_PRN_CNT_ENABLE If set, printer counter is enabled and will count, based upon the other settings for the counter. It can be different on different printers.
Rotation to use for the character string that is printed. It can be different on different printers. Type: TW_UINT16 Supported Messages: MSG_GET - TW_ENUMERATION MSG_GETCURRENT - TW_ONEVALUE MSG_GETDEFAULT - TW_ONEVALUE MSG_RESET – TW_ONEVALUE MSG_SET – TW_ONEVALUE, TW_ENUMERATION MSG_QUERYSUPPORT - TW_ONEVALUE Allowed Values: 0, 90, 180, 270 (Read from scanner) November 19, 2009 Page 82 of 99...
Ngenuity TWAIN Data Source Stored in registry: No (Read only) Stored in profile: No (Read only) 3.8.40 BBH_CAP_PRN_VOFFSET Vertical offset from the top of the page to the beginning of the print string. It can be different on different printers. Type: TW_FIX32 Supported Messages:...
Page 92
Ngenuity TWAIN Data Source BBH_CAP_PRN_ TW_UINT8 FONT BBH_CAP_PRN_ TW_UINT1 BBH_CAP_PRN_ TW_UINT8 SIZE BBH_CAP_PRN_ TW_UINT8 SPACE BBH_CAP_PRN_ TW_UINT3 TIME_DATE BBH_CAP_PRN_ TW_FIX32 VOFFSET 3.10 C APABILITIES TORED The table below present all capabilities stored in the registry and how they are stored. Capability CAP_AUTOFEED CAP_DUPLEXENABLED...
Page 93
Ngenuity TWAIN Data Source BBH_CAP_ACD_SUPPRESS_ENABLE BBH_CAP_BKG_SAT BBH_CAP_BKG_SAT_MODE BBH_CAP_BKG_SNAP_TO_WHITE BBH_CAP_CAM_BRIGHTNESS BBH_CAP_CAM_CONTRAST BBH_CAP_CAM_GAMMA BBH_CAP_CAM_MODE BBH_CAP_MFD_ACTION BBH_CAP_MFD_IGNORE_BY_SIZE BBH_CAP_MFD_SENSOR_ENABLE BBH_CAP_DOC_HIGH_SKEW BBH_CAP_DOC_IGNORE_HOLE BBH_CAP_DOC_MODE BBH_CAP_PRN_CNT_ENABLE BBH_CAP_PRN_CNT_MAX_DIG BBH_CAP_PRN_CNT_STEP BBH_CAP_PRN_FONT BBH_CAP_PRN_ROT BBH_CAP_PRN_SIZE BBH_CAP_PRN_SPACE BBH_CAP_PRN_VOFFSET BBH_CAP_ACD_ENABLE BBH_CAP_JPEG_SUBSAMPLING 3.11 APABILITIES EPENDENCIES The table below presents capabilities which depend on other capabilities. Capability CAP_CAMERAENABLED CAP_PRINTERENABLED...
Page 95
BBH_CAP_ADV_WND_ENABLE BBH_CAP_JPEG_SUBSAMPLING If CAP_CAMERSIDE is TWCS_BOTH, then Get message will return data from front side and set/reset message will change both sides. This is default scanner behavior. 3.12 S CANNING MODES These scanner modes are related to TWAIN DS API only.
Ngenuity TWAIN Data Source November 19, 2009 To turn on this mode set to TRUE capability BBH_CAP_ENABLE_ADVANCED_FRAMES. If this capability is TRUE, then TWAIN DS will ignore other scan modes. Every window can be addressed using capability BBH_CAP_ADV_WND_ID. See “Capabilities Dependencies”...
Page 97
Ngenuity TWAIN Data Source LOGGING To enable logging add these DWORD values: Name: DEBUG Data:1 Name: DEBUGTIMING Data: 1 to this registry key : HKEY_CURRENT_USER\Software\Böwe Bell+Howell\Ngenuity After opening the TDS , it will create registry value with name “DSLogFileName” under the same registry key.
Page 98
Image Contrast Image Gamma The following Camera parameters are set by the scanner manufacturer and are not considered to be user set parameters and should not be exposed to a scanner user (unless for the most advanced factory users): BBH_CAP_CAM_BRIGHTNESS...
Page 99
Imprinter: Ngenuity support 2 imprinters, a Front Page Prescan and/or a Back Page Post-scan. • When using the Back Page Post-scan imprinter, the scanner needs to scan in duplex mode, with Back Page scanning enabled. This dependency is not enforced by the driver.